StratusVue API Services Internal

UserGetRequest

Internal API: Get User.

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

**UserGetRequest** Parameters:
Name	Parameter	Data Type	Required	Description
UserId	body	int	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
AuthSessionKey	form	string	No
AdditionalInfo	form	List<ItemNameValue>	No

**ItemNameValue** Parameters:
Name	Parameter	Data Type	Required	Description
PropertyName	form	string	No
PropertyValue	form	string	No

**UserGetResponse** Parameters:
Name	Parameter	Data Type	Required	Description
User	form	User	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

**User** Parameters:
Name	Parameter	Data Type	Required
UserId	form	int	No
UserLogin	form	string	No
UserPassword	form	string	No
ExtUserPassword	form	string	No
FirstName	form	string	No
LastName	form	string	No
Email	form	string	No
UserCompany	form	string	No
IsAdmin	form	bool	No
DefaultRole	form	int	No
LocationId	form	int	No
OrganizationID	form	int	No
Address	form	Address	No
Phone	form	string	No
Extension	form	string	No
Fax	form	string	No
RegistrationNotes	form	string	No
SecretQuestion	form	string	No
SecretAnswer	form	string	No
Cell	form	string	No
IsActive	form	bool	No
NotificationEmail	form	string	No
LastLogin	form	DateTime	No
LastIP	form	string	No
LoginCount	form	int	No
AdditionalInfo	form	string	No

**Address** Parameters:
Name	Parameter	Data Type	Required
Line1	form	string	No
Line2	form	string	No
City	form	string	No
Zip	form	string	No
State	form	string	No
County	form	string	No
Country	form	string	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/UserGetRequest HTTP/1.1 
Host: api.sagecpc.com 
Content-Type: application/json
Content-Length: length

{"userId":0,"authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}

HTTP/1.1 200 OK
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"},"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}