POST | /machines |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | body | string | No | |
Type | body | string | No | |
ManufacturedOn | body | DateOnly | No | |
Location | body | string | No | |
Timezone | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Machine | form | Machine | No | |
ApiKey | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Type | form | string | No | |
ManufacturedOn | form | DateOnly | No | |
Location | form | string | No | |
Configuration | form | string | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Machine | form | Machine | No | |
ApiKey | form | 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 /machines HTTP/1.1
Host: foundrystage-api-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
name: String,
type: String,
manufacturedOn: 0001-01-01,
location: String,
timezone: String,
organisationId: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, machine: { name: String, type: String, manufacturedOn: 0001-01-01, location: String, configuration: String, id: String }, apiKey: String }