Contact
A Contact belongs to a client, and is defined by name, e-mail, phone and mobile number.
Contacts are typically used in service events, or in the creation of alarms.
URL Structure is:
https://api.trackunit.com/public/Contact
GetContact
Will list parameters on a specified contact.
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. |
clientId | String | N/A | FALSE | Unique identifier of client. |
name | String | N/A | FALSE | Name of contact. |
email | String | N/A | TRUE | Contact email. |
phone | String | N/A | TRUE | Contact phone number. |
mobile | String | N/A | TRUE | Contact mobile number. |
Request (example)
{
"id": "35718"
}
Response
{
"list":[
{
"id": "35718",
"clientId": "38171",
"name": "Anna Milowich",
"email": "[email protected]",
"phone": "472222339901",
"mobile": "472232336909"
}
]
}
CreateContact
Will create a new contact.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
clientId * | String | N/A | Unique identifier of client. |
name * | String | N/A | Name of contact |
email | String | N/A | Contact email. |
phone | String | N/A | Contact phone number. |
mobile | String | N/A | Contact mobile. |
Request (example)
{
"clientId": "38171",
"name": "Mirko Ziegler",
"email": "[email protected]",
"mobile": "475206346911"
}
Response
{
"id": "35719"
}
UpdateContact
Will update parameters on an existing contact.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
id * | String | N/A | Unique identifier |
clientId | String | N/A | Unique identifier of client. |
name | String | N/A | Name of contact. |
email | String | N/A | Contact email. |
phone | String | N/A | Contact phone number |
mobile | String | N/A | Contact mobile. |
Request (example)
{
"id": "35718",
"email": "[email protected]",
"mobile": "475186346911"
}
Response
{}
DeleteContact
Will delete an existing contact.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
id * | String | N/A | Unique identifier. |
Request (example)
{
"id": "35717"
}
Response
{}
Updated less than a minute ago