GET v1/Clients/{clientId}/Facilities/{facilityId}
Gets the specified facility.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
Client identifier. |
globally unique identifier |
Required |
| facilityId |
Facility identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A .
FacilityV1| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId |
The client id. |
globally unique identifier |
None. |
| Id |
The facility id. |
integer |
None. |
| Name |
The facility name. |
string |
None. |
| SiteNumber |
The facility site number. Note, this field is commonly used as an alternative name for the Facility and its usage varies for each client. |
string |
None. |
| DisplayName |
The facility display name. This will return Name if populated, otherwise will return SiteNumber in parenthesis (i.e. (123456)). |
string |
None. |
| FacilityStatusReferenceId |
The facility status. Valid values include can be retrieved from v1/Clients/{clientId}/References?type=FacilityStatus. |
integer |
None. |
| Address1 |
The address line 1. |
string |
None. |
| Address2 |
The address line 2. |
string |
None. |
| City |
The city. |
string |
None. |
| StateProvinceCode |
The state/province. Valid values can be retrieved from v1/Common/StateProvinceCodes?country={country}. |
string |
None. |
| PostalCode |
The postal code. |
string |
None. |
| CountryCode |
The country code. Valid values can be retrieved from v1/Common/CountryCodes. |
string |
None. |
| PhoneNumber |
The phone number. |
string |
None. |
| EmailAddress |
The email address. |
string |
None. |
| StateID |
The state id number. |
string |
None. |
Response Formats
application/json, text/json
{
"ClientId": "49bb822c-b14d-4ea0-827e-811c008f60ce",
"Id": 1146896503,
"Name": "Sample Facility",
"SiteNumber": "1234567",
"DisplayName": "Sample Facility",
"FacilityStatusReferenceId": 1146896503,
"Address1": "4031 Aspen Grove Dr, Suite 240",
"Address2": null,
"City": "Franklin",
"StateProvinceCode": "TN",
"PostalCode": "37067",
"CountryCode": "US",
"PhoneNumber": "(555) 555-5555",
"EmailAddress": "sample@email.com",
"StateID": "2222222"
}
application/xml
Sample not available.
text/xml
Sample not available.