| Required permission: | Location-Setup.GET |
| GET | /Locations | Location (Outlets) records | List of location available |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Locations | form | List<AcLocation> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcLocationId | form | string | Yes | Location ID |
| AcLocationDesc | form | string | Yes | Description |
| AcCompanyID | form | string | Yes | Company ID |
| Address1 | form | string | No | Address 1 |
| Address2 | form | string | No | Address 2 |
| Address3 | form | string | No | Address 3 |
| Address4 | form | string | No | Address 4 |
| Phone1 | form | string | No | Phone 1 |
| Phone2 | form | string | No | Phone 2 |
| Fax | form | string | No | Fax Number |
| Contact1 | form | string | No | Contact 1 |
| Contact2 | form | string | No | Contact 2 |
| Attention | form | string | No | Attention |
| IsActive | form | string | No | Active? |
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.
GET /Locations HTTP/1.1 Host: snr2u.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Locations":[{"AcLocationId":"String","AcLocationDesc":"String","AcCompanyID":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","Phone1":"String","Phone2":"String","Fax":"String","Contact1":"String","Contact2":"String","Attention":"String","IsActive":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}