StratusVue API Services Internal

<back to all web services

UserUpdateRequest

Internal API: Update User.

The following routes are available for this service:
POST/api/internal/user/update
UserUpdateRequest Parameters:
NameParameterData TypeRequiredDescription
UserbodyUserNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
AuthSessionKeyformstringNo
AdditionalInfoformList<ItemNameValue>No
ItemNameValue Parameters:
NameParameterData TypeRequiredDescription
PropertyNameformstringNo
PropertyValueformstringNo
User Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UserLoginformstringNo
UserPasswordformstringNo
ExtUserPasswordformstringNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
UserCompanyformstringNo
IsAdminformboolNo
DefaultRoleformintNo
LocationIdformintNo
OrganizationIDformintNo
AddressformAddressNo
PhoneformstringNo
ExtensionformstringNo
FaxformstringNo
RegistrationNotesformstringNo
SecretQuestionformstringNo
SecretAnswerformstringNo
CellformstringNo
IsActiveformboolNo
NotificationEmailformstringNo
LastLoginformDateTimeNo
LastIPformstringNo
LoginCountformintNo
AdditionalInfoformstringNo
Address Parameters:
NameParameterData TypeRequiredDescription
Line1formstringNo
Line2formstringNo
CityformstringNo
ZipformstringNo
StateformstringNo
CountyformstringNo
CountryformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
UiErrorMessageformstringNo
UiDevErrorMessageformstringNo
ErrorOccuredformboolNo
LogMessageTypeformErrorMessageTypeNo
ResponseStatusformResponseStatusNo
NumberOfRecordsEffectedformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/UserUpdateRequest HTTP/1.1 
Host: api.sampson.sagecpc.com 
Content-Type: application/json
Content-Length: length

{"user":{"userId":0,"userLogin":"String","userPassword":"String","extUserPassword":"String","firstName":"String","lastName":"String","email":"String","userCompany":"String","isAdmin":false,"defaultRole":0,"locationId":0,"organizationID":0,"address":{"line1":"String","line2":"String","city":"String","zip":"String","state":"String","county":"String","country":"String"},"phone":"String","extension":"String","fax":"String","registrationNotes":"String","secretQuestion":"String","secretAnswer":"String","cell":"String","isActive":false,"notificationEmail":"String","lastLogin":"\/Date(-62135596800000-0000)\/","lastIP":"String","loginCount":0,"additionalInfo":"String"},"authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"uiErrorMessage":"String","uiDevErrorMessage":"String","errorOccured":false,"logMessageType":"DEBUG","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"numberOfRecordsEffected":0}