GET api/Clients?objectID={objectID}&objectType={objectType}
Get the Client ID and Name for a specific object based on the provided details
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| objectID |
Integer ID of the object to retrieve Client details for |
integer |
Required |
| objectType |
Type of the object to retrieve Client details for |
OwnerType |
Required |
Body Parameters
None.
Response Information
Resource Description
ID and Name of the object's Client, if available
GetClientIDResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientID |
Integer ID of the relevant Client |
integer |
None. |
| ClientName |
Name of the relevant Client |
string |
None. |
| Messages |
Array of messages |
Collection of Message |
None. |
| ServerInformation |
Relevant information regarding the Server |
ServerInformation |
None. |
| VersionInformation |
Relevant information regarding the API's version |
VersionInformation |
None. |
Response Formats
application/json, text/json, text/html
Sample:
{
"Messages": [
{
"Severity": 0,
"MessageCode": 1,
"CodeDesc": 2,
"MessageText": "sample string 3",
"RecordNumber": 4
},
{
"Severity": 0,
"MessageCode": 1,
"CodeDesc": 2,
"MessageText": "sample string 3",
"RecordNumber": 4
}
],
"ServerInformation": {
"CurrentTimeUTC": "2026-08-07T08:27:55.6936196+10:00",
"BuildDateUTC": "2026-08-07T08:27:55.6936196+10:00"
},
"VersionInformation": {
"Major": 1,
"Minor": 8,
"Hotfix": 0,
"Beta": true,
"Version": "1.8.0.BETA"
},
"ClientID": 1,
"ClientName": "sample string 2"
}