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 ReferenceV1

Name	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": "351f0dc7-15a1-47a7-aa4c-d1a6c9b1c1a2",
    "Id": 1367955055,
    "Type": "FacilityStatus",
    "Description": "Software Only"
  },
  {
    "ClientId": "33103ed4-4917-4848-8772-0043d3968021",
    "Id": 1367955055,
    "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>351f0dc7-15a1-47a7-aa4c-d1a6c9b1c1a2</ClientId>
    <Description>Software Only</Description>
    <Id>1367955055</Id>
    <Type>FacilityStatus</Type>
  </Reference>
  <Reference>
    <ClientId>33103ed4-4917-4848-8772-0043d3968021</ClientId>
    <Description>Managed (by Company)</Description>
    <Id>1367955055</Id>
    <Type>FacilityStatus</Type>
  </Reference>
</ArrayOfReference>