StratusVue API Services Internal

LocationGetRequest

Internal API: Get Location.

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

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

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

**Location** Parameters:
Name	Parameter	Data Type	Required
LocationId	form	int	No
OrganizationId	form	int	No
LocationName	form	string	No
Address	form	Address	No
LocationPhone	form	string	No
LocationFax	form	string	No
LocationLogo	form	int	No
LocationIsDisabled	form	bool	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/LocationGetRequest HTTP/1.1 
Host: api.sagecpc.com 
Content-Type: application/json
Content-Length: length

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

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

{"location":{"locationId":0,"organizationId":0,"locationName":"String","address":{"line1":"String","line2":"String","city":"String","zip":"String","state":"String","county":"String","country":"String"},"locationPhone":"String","locationFax":"String","locationLogo":0,"locationIsDisabled":false},"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}