GET v3/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 .
FacilityV3| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId |
The client id. |
globally unique identifier |
None. |
| Id |
The facility id. |
integer |
None. |
| Name |
The facility name. This field cannot be updated via the PUT v3/Clients/{clientId}/Facilities/{facilityId} endpoint. |
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. |
| StateID |
The state id number. |
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 can be retrieved from v1/Clients/{clientId}/References?type=FacilityStatus. |
integer |
None. |
| GasBrandReferenceId |
The Gas Brand. Valid values can be retrieved from v1/Clients/{clientId}/References?type=GasBrand. |
integer |
None. |
| DivisionReferenceId |
The Division. Valid values can be retrieved from v1/Clients/{clientId}/References?type=Division. |
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. |
Response Formats
application/json, text/json
{
"ClientId": "8a3844d0-4ab1-4502-af2b-d0adf421fc5b",
"Id": 2,
"Name": "sample string 3",
"SiteNumber": "sample string 4",
"StateID": "sample string 5",
"DisplayName": "sample string 3",
"FacilityStatusReferenceId": 1,
"GasBrandReferenceId": 1,
"DivisionReferenceId": 1,
"Address1": "sample string 6",
"Address2": "sample string 7",
"City": "sample string 8",
"StateProvinceCode": "sample string 9",
"PostalCode": "sample string 10",
"CountryCode": "sample string 11",
"PhoneNumber": "sample string 12",
"EmailAddress": "sample string 13"
}
application/xml
Sample not available.
text/xml
Sample not available.