This function will add a new user record to the database. INPUTS==> user information (FIRST NAME, LAST NAME, USER ID, ...). RETURN==> (result)
None.
AddUserRequest.
AddUserRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| FirstName |
First Name. |
string |
Required |
| MiddleName |
Middle Name / Nickname |
string |
None. |
| LastName |
Last Name. |
string |
Required |
| EmployeeId |
EmployeeId. |
string |
Required |
| Location |
Location. |
string |
None. |
| Pin |
PIN. |
string |
Required Matching regular expression pattern: ([0-9]+) Max length: 4 Min length: 4 |
| GroupId |
Group ID |
string |
None. |
| PhoneNo |
Phone No. |
string |
None. |
| PagerNo |
Pager No. |
string |
None. |
| UserType |
User Type. |
string |
Required |
| UserLevel |
User Level. |
string |
Required |
| LocationId |
Location ID |
string |
None. |
| TouchKeys |
Touch keys assigned to this user |
Collection of string |
None. |
{
"FirstName": "John",
"MiddleName": "A",
"LastName": "Smith",
"EmployeeId": "RH7182",
"Location": "Spare",
"Pin": "1234",
"GroupId": "Group",
"PhoneNo": "887-2057",
"PagerNo": "887-2053",
"UserType": "Multiple",
"UserLevel": "U",
"LocationId": "123456",
"TouchKeys": [
"C300000018AD830A",
"1600000023FB5E0C"
]
}
<AddUserRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.User">
<EmployeeId>RH7182</EmployeeId>
<FirstName>John</FirstName>
<GroupId>Group</GroupId>
<LastName>Smith</LastName>
<Location>Spare</Location>
<LocationId>123456</LocationId>
<MiddleName>A</MiddleName>
<PagerNo>887-2053</PagerNo>
<PhoneNo>887-2057</PhoneNo>
<Pin>1234</Pin>
<TouchKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>C300000018AD830A</d2p1:string>
<d2p1:string>1600000023FB5E0C</d2p1:string>
</TouchKeys>
<UserLevel>U</UserLevel>
<UserType>Multiple</UserType>
</AddUserRequest>
FirstName=John&MiddleName=A&LastName=Smith&EmployeeId=RH7182&Location=Spare&Pin=1234&GroupId=Group&PhoneNo=887-2057&PagerNo=887-2053&UserType=Multiple&UserLevel=U&LocationId=123456&TouchKeys=System.Collections.Generic.List`1[System.String]
AddUserResponse
AddUserResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ResponseHeader |
None. |
|
| Body | AddUserResponseBody |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Message |
Message |
string |
None. |
| StatusCode |
Status code |
ResponseStatus |
None. |
| Status |
Status |
string |
None. |
| ErrorId |
Error id |
string |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| UserSaved |
Flag to show if user successfully added |
boolean |
None. |
{
"Header": {
"Message": "",
"StatusCode": 0,
"Status": "Ok",
"ErrorId": null
},
"Body": {
"UserSaved": true
}
}
<AddUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.User">
<Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.User" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
<d2p1:UserSaved>true</d2p1:UserSaved>
</Body>
<Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
<ErrorId i:nil="true" />
<Message></Message>
<Status>Ok</Status>
<StatusCode>Ok</StatusCode>
</Header>
</AddUserResponse>