| 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. |