POST | /locations |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | body | string | No | |
Name | body | string | No | |
Organization | body | Reference | No | |
Group | body | Reference | No | |
Address | body | Address | No | |
Devices | body | List<Device> | No | |
ProductInstances | body | List<ProductInstanceRef> | No | |
Locale | body | Locale | No | |
IntegrationData | body | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Street | form | string | No | |
City | form | string | No | |
State | form | string | No | |
ZipCode | form | string | No | |
Country | form | string | No | |
Coordinates | form | GPSCoordinates | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Lat | form | double | No | |
Lng | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
IsActive | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
Product | form | ProductReference | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Value | form | string | No | |
Category | form | string | No | |
ProductProvider | form | Reference | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TimeZone | form | Reference | No | |
Currency | form | Reference | No | |
Language | form | Reference | 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /locations HTTP/1.1
Host: api.mozzart.ath.cx
Accept: application/json
Content-Type: application/json
Content-Length: length
{"id":"String","name":"String","organization":{"id":"String","value":"String"},"group":{"id":"String","value":"String"},"address":{"street":"String","city":"String","state":"String","zipCode":"String","country":"String","coordinates":{"lat":0,"lng":0}},"devices":[{"id":"String","name":"String","isActive":false}],"productInstances":[{"id":"String","name":"String","product":{"id":"String","value":"String","category":"String","productProvider":{"id":"String","value":"String"}}}],"locale":{"timeZone":{"id":"String","value":"String"},"currency":{"id":"String","value":"String"},"language":{"id":"String","value":"String"}},"integrationData":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}