All Verbs | /configurations/devices |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
IsActive | form | bool | No | |
ProductInstances | form | List<ProductInstanceRef> | No | |
TimeZone | form | Reference | No | |
Currency | form | Reference | No | |
Language | form | Reference | No | |
Location | form | LocationRef | No | |
Organization | form | OrganizationRef | 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 |
---|---|---|---|---|
Id | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
Group | form | Reference | No | |
Address | form | Address | No | |
IntegrationData | form | Dictionary<string, 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 | |
Address | form | Address | No | |
IntegrationData | form | Dictionary<string, string> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /configurations/devices HTTP/1.1
Host: api.mozzart.ath.cx
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { id: String, name: String, isActive: False, productInstances: [ { id: String, name: String, product: { id: String, value: String, category: String, productProvider: { id: String, value: String } } } ], timeZone: { id: String, value: String }, currency: { id: String, value: String }, language: { id: String, value: String }, location: { id: String, name: String, group: { id: String, value: String }, address: { street: String, city: String, state: String, zipCode: String, country: String, coordinates: { lat: 0, lng: 0 } }, integrationData: { String: String } }, organization: { id: String, name: String, address: { street: String, city: String, state: String, zipCode: String, country: String, coordinates: { lat: 0, lng: 0 } }, integrationData: { String: String } } }