GET v3/Clients/{clientId}/Facilities?updatedSinceUtc={updatedSinceUtc}&createdSinceUtc={createdSinceUtc}&facilityIds={facilityIds}&includeDeleted={includeDeleted}&facilityNameMatch={facilityNameMatch}

Gets facilities.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Client identifier.	globally unique identifier	Required
updatedSinceUtc	Date since facility was last updated.	date	None.
createdSinceUtc	Date since facility was created.	date	None.
facilityIds	Facility identifiers in CSV format.	string	None.
includeDeleted	If deleted facilities should be included.	boolean	None.
facilityNameMatch	Facility name; will try to do a match for any part of the facility name instead of a full match.	string	None.

Body Parameters

None.

Response Information

Resource Description

A list.

Collection of 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

Sample:

[
  {
    "ClientId": "5bda4c27-b3b0-49f2-9fc8-7c4f5f078b19",
    "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"
  },
  {
    "ClientId": "5bda4c27-b3b0-49f2-9fc8-7c4f5f078b19",
    "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:

Sample not available.

text/xml

Sample:

Sample not available.