StratusVue API Services Internal

UserLoginRequest

Authentication attempt request.

The following routes are available for this service:
POST	/api/internal/userlogin

**UserLoginRequest** Parameters:
Name	Parameter	Data Type	Required
UserName	body	string	No
Password	body	string	No
SessionId	body	string	No
LoginMethod	body	string	No

**UserLoginResponse** Parameters:
Name	Parameter	Data Type	Required	Description
AuthSessionKey	form	string	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
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

HTTP + JSON

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

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

{"userName":"String","password":"String","sessionId":"String","loginMethod":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"authSessionKey":"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}