| GET | /sites/locations/{LocationID} | Returns a location details |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserID | query | Guid | Yes | The UserID that authorizes the caller to complete the request. Contact your eQuip admin. |
| LocationID | path | string | Yes | The ID of the location. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LocationID | body | string | No | Location ID |
| LocationCategoryID | body | string | No | Location Category ID |
| UL_LocationID | body | string | No | UL Location ID |
| SiteID | body | string | No | Site ID |
| PlanID | body | string | No | Plan ID |
| ZoneID | body | string | No | Zone ID |
| LocationBarcode | body | string | No | Location Barcode |
| LocationName | body | string | No | Location Name |
| LocationDescription | body | string | No | Location Description |
| LocationX | body | string | No | LocationX |
| LocationY | body | string | No | LocationY |
| Width | body | string | No | Width |
| Height | body | string | No | Height |
| SizeType | body | string | No | Size Type |
| Opacity | body | string | No | Opacity |
| Color | body | string | No | Color |
| DisplayOnScanner | body | string | No | Display On Scanner |
| FileLocatorCode | body | string | No | File Locator Code |
| DateCreated | body | string | No | Date Created |
| DateModified | body | string | No | Date Modified |
| UseMap | body | string | No | Use Map? |
| CustomFields | body | List<CustomKeyPair> | No | Custom Fields |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldName | body | string | No | The name of field |
| FieldValue | body | object | No | The value of field |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/GetLocationDetails HTTP/1.1
Host: equipstage2.e-isg.com
Content-Type: text/csv
Content-Length: length
{"UserID":"String","LocationID":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"LocationID":0,"LocationCategoryID":0,"UL_LocationID":0,"SiteID":0,"PlanID":0,"ZoneID":0,"LocationBarcode":"String","LocationName":"String","LocationDescription":"String","LocationX":0,"LocationY":0,"Width":0,"Height":0,"SizeType":"String","Opacity":"String","Color":"String","DisplayOnScanner":false,"FileLocatorCode":"String","DateCreated":"\/Date(-62135596800000-0000)\/","DateModified":"\/Date(-62135596800000-0000)\/","UseMap":false,"CustomFields":[{"FieldName":"String","FieldValue":{}}]}