GET v1/Clients/{clientId}/References?type={type}
Gets all active references that match the query, if provided.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId |
Client identifier. |
globally unique identifier |
Required |
type | string |
None. |
Body Parameters
None.
Response Information
Resource Description
A list.
Collection of ReferenceV1Name | Description | Type | Additional information |
---|---|---|---|
ClientId |
The client id. |
globally unique identifier |
None. |
Id |
The reference id. |
integer |
None. |
Type |
The reference type. |
string |
None. |
Description |
The reference description. |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ClientId": "343c1737-457e-4cbf-8920-f806758efab6", "Id": 1519831453, "Type": "FacilityStatus", "Description": "Software Only" }, { "ClientId": "1a10ef5c-a489-4bf5-a39b-9821762546a4", "Id": 1519831453, "Type": "FacilityStatus", "Description": "Managed (by Company)" } ]
application/xml, text/xml
Sample:
<ArrayOfReference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models"> <Reference> <ClientId>343c1737-457e-4cbf-8920-f806758efab6</ClientId> <Description>Software Only</Description> <Id>1519831453</Id> <Type>FacilityStatus</Type> </Reference> <Reference> <ClientId>1a10ef5c-a489-4bf5-a39b-9821762546a4</ClientId> <Description>Managed (by Company)</Description> <Id>1519831453</Id> <Type>FacilityStatus</Type> </Reference> </ArrayOfReference>