Page Comparison

Scroll ignore

scroll-pdf	true
scroll-office	true
scroll-chm	true
scroll-docbook	true
scroll-eclipsehelp	true
scroll-epub	true
scroll-html	true

#F0F0F0#F0F0F0

3

truetruetruetrue

Scroll export button

scope	current
template-id	4fda9400-a7df-4ede-a95f-e4ae5fcf4796
caption	Download this Page
add-on	Scroll PDF Exporter

Use this API you can create an User with details such as user level, designation, manager, contact number, User Type allocation, and so on .

To authenticate the below API, see API Authentication and Authorization.

Service Name	HTTP Method
ADM_CreateorUpdateUser	POST

Sample Request

DJango

Code Block

theme

title	Sample Request
linenumbers	true

{
    "ServiceName": "ADM_CreateorUpdateUser",
    "objCommonParameters": {
        "_ProxyDetails": {
            "APIKey": "XXXXXXXXXXXXXXXXXXXXXXXX",
            "AuthType": "APIKEY",
            "ProxyID": 0,
            "ReturnType": "JSON",
            "orgid": 1
        },
        "UniqueField": "EmpId",
        "Users": [
            {
                "UserName": "john",
                "EmployeeId": "S1234",
                "Password": "XXXXXXXX",
                "Login_ID": "john@xyz.com",
                "DomainName": "xyz",
                "EmailId": "john@xyz.com",
                "ManagerEmailId": "ryan@xyz.com",
                "ManagerEmployeeID": "S123",
                "Manager_NT_UID": "SUS1233455",
                "MobileNumber": "9123456780",
                "NT_UID": "",
                "RoleTemplate": "Super Admin",
                "Designation": "Lead",
                "Joindate": "05/02/2020",
                "Address": "Gollastreet,Mumbai",
                "Location": "mumbai-911",
                "City": "Vijayawada",
                "ContactNumber": "+81-0944022338789",
                "State": "Maharastra",
                "Country": "India",
                "Customer": "SUMMIT",
                "TimeZone": "(UTC - 02:00) FNT - Fernando de Noronha Time",
                "UserLevel": "level5",
                "ZipCode": "534235",
                "LoginType": "FORM",
                "APIKeyExpiry": "2020-08-21",
                "Remarks": "This is created by me",
                "UserType": "Analyst",
                "AlternateMailID1": "test11@xyz.in",
                "AlternateMailID2": "test12@xyz.in",
                "AlternateMailID3": "test13@xyz.in",
                "AlternateMailID4": "test14@xyz.in",
                "SortOrder": "0",
                "IsLocked": "0",
                "checkboxcustomattributes": [
                    {
                        "Attr_Name": "Multiple Unit",
                        "Attr_Value": "0100001 - Board Of Directors",
                        "Group_Name": "Default Group"
                    },
                    {
                        "Attr_Name": "manual chk",
                        "Attr_Value": "B",
                        "Group_Name": "Default Group"
                    }
                ],
                "CustomAttributes": [
                    {
                        "Attr_Name": "Drop",
                        "Attr_Value": "bangalore",
                        "Group_Name": "Default Group"
                    },
                    {
                        "Attr_Name": "User Text Area",
                        "Attr_Value": "Yes",
                        "Group_Name": "Default Group"
                    }
                ]
            }
        ]
    }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

CM_ID

Status

colour	Green
title	string

Unique identification number of the Common Master. This parameter is mandatory while updating a specific Master Type.

Status

colour	Green
title	True

MaterType

Status

colour	Green
title	string

Name of the MasterType.

Status

colour	Green
title	True

MasterValue

Status

colour	Green
title	string

Value of the specified MasterType.

Status

colour	Green
title	True

ParentMasterType

Status

colour	Green
title	string

Name of the Parent MasterType.

Status

colour	Green
title	True

ParentValue

Status

colour	Green
title	string

Value of the specified ParentMasterType.

Status

colour	Green
title	True

Active

Status

colour	Green
title	string

Status of the configuration. Specify the value as 1 to make the configuration active or 0 to make the configuration inactive.

Status

colour	Green
title	True

Parameter Name

Type

Mandatory

Description

Notes

UniqueField

Status

colour	Green
title	string

Status

colour	Green
title	True

Unique Field value can be one of the following:

EmpId
EmailId
NT_UID

If the value of this parameter is EmpId, the EmployeeId parameter is mandatory.
If the value of this parameter is EmailId, the EmailId parameter is mandatory.
If the value of this parameter is NT_UID, the NT_UID parameter is mandatory.

Users

Status

colour	Yellow
title	array

Status

colour	Green
title	True

Under Users array, you can add multiple Users.

UserName

Status

colour	Green
title	string

Status

colour	Green
title	True

Name of the User.

EmployeeId

Status

colour	Green
title	string

Employee identification number of the User.

Password

Status

colour	Green
title	string

Status

colour	Green
title	True

Enter the password of your choice.

This parameter is mandatory when the LoginType parameter value is entered as Form Login.

Login_ID

Status

colour	Green
title	string

Status

colour	Green
title	True

Configured login ID of the User for Form Login.

This parameter is mandatory when the LoginType parameter value is entered as Form Login.

DomainName

Status

colour	Green
title	string

Status

colour	Green
title	True

Domain name of the User.

EmailId

Status

colour	Green
title	string

Status

title	False

E-mail ID of the User.

ManagerEmailId

Status

colour	Green
title	string

Status

title	False

E-mail ID of the User's Manager.

You can enter ManagerEmailId or ManagerEmployeeID or Manager_NT_UID. Also, you can enter all these parameter values.
If the entered values for ManagerEmailId, ManagerEmployeeID, and Manager_NT_UID are valid, the User ID of the manager gets the precedence over the other two parameters.

ManagerEmployeeID

Status

colour	Green
title	string

Status

title	False

Employee identification number of the User's Manager.

Manager_NT_UID

Status

colour	Green
title	string

Status

title	False

NT login ID of the User's Manager.

MobileNumber

Status

colour	Green
title	string

Status

title	False

Mobile number of the User.

NT_UID

Status

colour	Green
title	string

Status

colour	Green
title	True

NT login ID of the User to log in.

This parameter is mandatory when the LoginType parameter value is entered as NT Login.

RoleTemplate

Status

colour	Green
title	string

Status

colour	Green
title	True

Assign Role Templates to the User by clicking the Select check box next to the Role Template name. Based on this mapping, the User is able to view the module menu options, drop-down list options, and edit the page details.

Designation

Status

colour	Green
title	string

Status

title	False

Designation of the User.

Joindate

Status

colour	Green
title	string

Status

title	False

Joining date of the User.

Address

Status

colour	Green
title	string

Status

title	False

Address of the User.

Location

Status

colour	Green
title	string

Status

title	False

Specify the location.. The user can view the list of incidents logged by other users who are mapped to the location specified in this parameter. The user can specify multiple locations.

City

Status

colour	Green
title	string

Status

title	False

City name of the User.

ContactNumber

Status

colour	Green
title	string

Status

title	False

Contact number of the User. This can be the User's landline number or a desk extension.

State

Status

colour	Green
title	string

Status

title	False

State name of the User.

Country

Status

colour	Green
title	string

Status

title	False

Country name of the User.

Customer

Status

colour	Green
title	string

Status

title	False

Specify the customer name. The user can view the list of incidents logged by other users who are mapped to the customer specified in this parameter. The user can select multiple customers.

TimeZone

Status

colour	Green
title	string

Status

colour	Green
title	True

Time zone for the User.

UserLevel

Status

colour	Green
title	string

Status

title	False

Grade of the User in the Organization.

ZipCode

Status

colour	Green
title	string

Status

title	False

Zip code of the City.

LoginType

Status

colour	Green
title	string

Status

colour	Green
title	True

Login type of the User.

The value can be one of the following:

NT Login
Form Login
API Key.

APIKeyExpiry

Status

colour	Green
title	string

Status

title	False

Specify a future date for the expiry of the API Key.

If no value is specified, the API considers the expiry date as 1 year from the date of user creation.

Remarks

Status

colour	Green
title	string

Status

title	False

Additional information about the User.

UserType

Status

colour	Green
title	string

Status

title	False

Type of the User.

Example: End User, Analyst, or Administrator.

AlternateMailID

Status

colour	Green
title	string

Status

title	False

Enter alternative E-mail IDs for the user. You can configure a maximum of four additional E-mail IDs. When an Incident is logged for the User, an E-mail is sent to the configured primary or alternate E-mail ids.

You can enter four alternate E-mail IDs using AlternateMailID1, AlternateMailID2, AlternateMailID3, and AlternateMailID4.
While updating any one of the alternate E-mail ID, the User must update all four E-mail IDs. Otherwise, the entered single E-mail ID will not get updated.

SortOrder

Status

colour	Blue
title	boolean

Status

title	False

The order in which User names gets sorted or displayed.

IsLocked

Status

colour	Green
title	string

Status

title	False

Is the Account of the User locked?

The value is either 0 or 1.

checkboxcustomattributes

Status

colour	Green
title	Array

Status

colour	Green
title	true

Custom attributes that can be specified and shown in as a check box in the Application. These Custom Fields include the following parameters:

GroupName
AttributeName
AttributeValue

CustomAttributes

Status

colour	Green
title	aray

Status

colour	Green
title	true

Custom attributes for a specified User. These Custom Fields include the following parameters:

GroupName
AttributeName
AttributeValue

DJango

Code Block

theme

title	Sample Response
linenumbers	true

{
    "Errors": "",
    "Input": null,
    "Message": "0 Users Updated Succesfully.1 Users created Succesfully.",
    "OrgID": 0,
    "Output": "0 Users Updated Succesfully.1 Users created Succesfully.",
    "OutputID": 0,
    "OutputObject": "{\"Inserted_Records\":[{\"Id\":\"428270\",\"UniqueId\":\"manik123\",\"APIKey\":\"\"}],\"Updated_Records\":null}",
    "TokenID": "3607726A11AC867B6030FBF353413C8B6617A8C76EA89B5522C5E25B7A4FE4C460C265BE170C89A5C2C4D5B57FCB1243988FB1BE7D600AE139467DC5211BB4552D0
E77EFCA76EE99FB70396D63B11ABB499C2B301806BA38E545A51DC9A69E91D107C610CAF64CC53A6EB0F3D4FCB820D3A5E2CA139D41747555689F54D16AA87C6AEFCD14A1AC8F
D8671DD2809A9F2A8A9F70929BB55124CE9700981740A4208061449C"
}

Response Parameters

Parameter Name

Type

Description

Inserted_Records

Status

colour	Yellow
title	array

Displays the list of records created or updated.

Id

Status

colour	Green
title	string

Unique Identification number of the user

UniqueId

Status

colour	Green
title	string

Based on the UniqueField Request parameter, the value is displayed. The value can be the Employee ID or the Email ID or the login ID of the User.

APIKey

Status

colour	Green
title	string

Displays the allocated API Key. This value gets created if the Login Type is API Key.

Updated_Records

Status

colour	Green
title	string

Displays the number of updated records.

Status and Error Codes

For more information, see Status and Error Messages

Scroll ignore

scroll-pdf	true
scroll-office	true
scroll-chm	true
scroll-docbook	true
scroll-eclipsehelp	true
scroll-epub	true
scroll-html	true

1

Versions Compared

Old Version 1

New Version Current

Key

Sample Request

Request Parameters

Response Parameters

Status and Error Codes

| |