PUT api/v7/Users/{userId}
Add or Update an existing user. Please note that ** API supports multiple job codes per user. This will be supported by the POS in a future release. **
Tables Impacted
UserProfile, Address, webpages_membership
Request Information
URI Parameters
| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| userId * |
Id of the user |
string |
Yes |
None. |
Body Parameters
The user information to be added / updated
New User Information| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| password * |
Password for the user |
string |
Conditional |
Conditionally required: If the user doesn't exist in database, password is required. Passwords can be updated through this API String length: between 1 and 128, inclusive |
| roles |
Roles of the User |
Collection of Role |
No |
None. |
| orgName * |
Organization Name User Belong to |
string |
Yes |
String length: between 1 and 50, inclusive |
| disableInitialPwdReset |
Flag denoting if initial password reset is to be enforced |
boolean |
No |
None. |
| active |
Flag denoting if user is active |
boolean |
No |
None. |
| startDate |
Start Date of User Activity |
date |
No |
None. |
| endDate |
End date of user activity |
date |
No |
None. |
| contactInfo |
Contact Information of the User |
Contact Information |
No |
None. |
| addressInfo |
Address Information of the User |
Address Information |
No |
None. |
| userId * |
User Id |
string |
Yes |
String length: between 1 and 32, inclusive |
| firstName |
First Name of the User |
string |
No |
String length: between 1 and 50, inclusive |
| lastName |
Last Name of the User |
string |
No |
String length: between 1 and 50, inclusive |
| displayName |
Preferred Display Name |
string |
No |
String length: between 1 and 50, inclusive |
| alternateId |
Alternate user Id |
string |
No |
String length: between 1 and 32, inclusive |
| primaryLanguage |
Primary Language of User |
string |
No |
String length: between 1 and 50, inclusive |
| secondaryLanguage |
Secondary Language of the User |
string |
No |
String length: between 1 and 50, inclusive |
| customerAuditDate |
Last modified audit information |
date |
No |
None. |
Request Formats
application/json, text/json
{
"password": "enter password here",
"roles": [
{
"roleCode": "100",
"roleName": "admin"
},
{
"roleCode": "30",
"roleName": "cashier"
}
],
"orgName": "111",
"disableInitialPwdReset": false,
"active": false,
"contactInfo": {
"homePhone": "(770)123-4567",
"workPhone": "(770)234-5678",
"cellPhone": "(770)345-6789",
"email": "John.Doe@ncr.com"
},
"addressInfo": {
"addressLine1": "2651 Satellite Bld",
"addressLine2": "Engineer Building",
"addressLine3": "Section E",
"city": "Duluth",
"administrativeArea": "Georgia",
"postalCode": "30097",
"country": "United States"
},
"userId": "8001",
"firstName": "John",
"lastName": "Doe",
"displayName": "John D",
"alternateId": "alt8001",
"primaryLanguage": "en-US",
"secondaryLanguage": "fr",
"customerAuditDate": "2018-01-01T00:00:00"
}
application/xml, text/xml
<User xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<userId>8001</userId>
<firstName>John</firstName>
<lastName>Doe</lastName>
<displayName>John D</displayName>
<alternateId>alt8001</alternateId>
<primaryLanguage>en-US</primaryLanguage>
<secondaryLanguage>fr</secondaryLanguage>
<customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
<active>false</active>
<startDate xsi:nil="true" />
<endDate xsi:nil="true" />
<contactInfo>
<homePhone>(770)123-4567</homePhone>
<workPhone>(770)234-5678</workPhone>
<cellPhone>(770)345-6789</cellPhone>
<email>John.Doe@ncr.com</email>
</contactInfo>
<addressInfo>
<addressLine1>2651 Satellite Bld</addressLine1>
<addressLine2>Engineer Building</addressLine2>
<addressLine3>Section E</addressLine3>
<city>Duluth</city>
<administrativeArea>Georgia</administrativeArea>
<postalCode>30097</postalCode>
<country>United States</country>
</addressInfo>
<roles>
<Role>
<roleCode>100</roleCode>
<roleName>admin</roleName>
<customerAuditDate xsi:nil="true" />
</Role>
<Role>
<roleCode>30</roleCode>
<roleName>cashier</roleName>
<customerAuditDate xsi:nil="true" />
</Role>
</roles>
<orgName>111</orgName>
<disableInitialPwdReset>false</disableInitialPwdReset>
<password>enter password here</password>
</User>
Response Information
Resource Description
Returns a HTTPResponse Message stating the success/failure of API Action
HttpResponseMessage| Name | Description | Type |
|---|---|---|
| Version | Version | |
| Content | HttpContent | |
| StatusCode | HttpStatusCode | |
| ReasonPhrase | string | |
| Headers | Collection of Object | |
| RequestMessage | HttpRequestMessage | |
| IsSuccessStatusCode | boolean |