POST | /api/internal/authenticateuser |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserName | body | string | No | |
Password | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AuthSessionKey | form | string | No | |
APIKey | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UiErrorMessage | form | string | No | |
UiDevErrorMessage | form | string | No | |
ErrorOccured | form | bool | No | |
LogMessageType | form | ErrorMessageType | No | |
ResponseStatus | form | ResponseStatus | No | |
NumberOfRecordsEffected | form | int | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/InternalUserAuthenticationRequest HTTP/1.1
Host: api.sampson.sagecpc.com
Content-Type: application/json
Content-Length: length
{"userName":"String","password":"String"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"authSessionKey":"String","apiKey":"String","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}