Client
A Client is essentially a company which can be associated with one or more units. A client is defined by a name, address details, and possible notes on this. For any client, a range of contacts can be created.
URL Structure is:
https://api.trackunit.com/public/Client
GetClient
Will list parameters on a specified client.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
id * | String | N/A | Unique identifier. |
Columns
Name | Data type | Unit of measurement | Nullability | Note |
---|---|---|---|---|
id | String | N/A | FALSE | Unique identifier. |
name | String | N/A | FALSE | Name of client. |
note | String | N/A | TRUE | A note/text of any kind. |
address | Address | N/A | TRUE | Geographical location. |
Request (example)
{
"id": "38171"
}
Response
{
"list":[
{
"id":"38171",
"name":"Chemnitz Bau- & Materiel",
"address":{
"country":"DE",
"zipCode":"",
"city":"Chemnitz",
"streetAddress":""
}
}
]
}
CreateClient
Will create a new client.
Parameters
Name | Date type | Unit of measurement | Note |
---|---|---|---|
name * | String | N/A | Name of client. |
note | String | N/A | A note/text of any kind. |
address | Address | N/A | Geographical location. |
Request (example)
{
"name": "Nordic Papermaking Inc.",
"note": "General papermaking",
"address": {
"country": "SE",
"zipCode": "84080",
"city": "Bäckby",
"streetAddress": "Lindströmsvegan 12"
}
}
Response
{
"id": "39471"
}
UpdateClient
Will update parameters on an existing client.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
id * | String | N/A | Unique identifier |
name | String | N/A | Name of client. |
note | String | N/A | A note/text of any kind. |
address | Address | N/A | Geographical location. |
Request (example)
{
"id": "38170",
"name": "Nordic Papermaking Inc.",
"note": "A leading papermaking company"
}
Response
{}
DeleteClient
Will delete an existing client.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
id * | String | N/A | Unique identifier. |
Request (example)
{
"id": "38171"
}
Response
{}
Updated less than a minute ago