GET api/v1/Facilities?FacilityId={FacilityId}

Returns a single FacilityViewModel that the API token has rights to view based on a parameterized PK.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
FacilityId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

FacilityViewModel
NameDescriptionTypeAdditional information
FacilityId

Represents the PK of an existing Facility in BluSKY

globally unique identifier

None.

Name

Represents the name of an existing Facility in BluSKY

string

None.

ACSystemId

Represents the PK of the Access Control System for the Facility

globally unique identifier

None.

ACSystemName

Represents the name of the Access Control System for the Facility

string

None.

Deleted

Represents whether the Facility is deleted or not.

boolean

None.

TimeZoneInfoId

Represents the TimeZone of the Facility

string

None.

StreetAddress1

Represents the primary street address of the Facility

string

None.

StreetAddress2

Represents the secondary street address of the Facility

string

None.

City

Represents the city of the Facility

string

None.

sRegionId

Represents the PK of the region (State, Province, County, etc) of the Facility

globally unique identifier

None.

RegionName

Represents the name of the region (State, Province, County, etc) of the Facility

string

None.

sCountryId

Represents the PK of the country of the Facility

globally unique identifier

None.

CountryName

Represents the name of the country of the Facility

string

None.

PostalCode

Represents the Postal Code/Zip Code of the Facility

string

None.

Website

Represents the URL of the website associated with the Facility

string

None.

Response Formats

application/json, text/json

Sample:
{
  "FacilityId": "00d35782-1794-414d-8c74-33fa13985555",
  "Name": "sample string 2",
  "ACSystemId": "b007f05c-5e70-4542-9714-07e22b498b62",
  "ACSystemName": "sample string 3",
  "Deleted": true,
  "TimeZoneInfoId": "sample string 5",
  "StreetAddress1": "sample string 6",
  "StreetAddress2": "sample string 7",
  "City": "sample string 8",
  "sRegionId": "d0494f4a-56c6-46c3-998b-86c84a28cf8e",
  "RegionName": "sample string 10",
  "sCountryId": "e97b3c85-5a05-43dd-bfd6-12a66ffd8ab3",
  "CountryName": "sample string 12",
  "PostalCode": "sample string 13",
  "Website": "sample string 14"
}

application/xml, text/xml

Sample:
<FacilityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <ACSystemId>b007f05c-5e70-4542-9714-07e22b498b62</ACSystemId>
  <ACSystemName>sample string 3</ACSystemName>
  <City>sample string 8</City>
  <CountryName>sample string 12</CountryName>
  <Deleted>true</Deleted>
  <FacilityId>00d35782-1794-414d-8c74-33fa13985555</FacilityId>
  <Name>sample string 2</Name>
  <PostalCode>sample string 13</PostalCode>
  <RegionName>sample string 10</RegionName>
  <StreetAddress1>sample string 6</StreetAddress1>
  <StreetAddress2>sample string 7</StreetAddress2>
  <TimeZoneInfoId>sample string 5</TimeZoneInfoId>
  <Website>sample string 14</Website>
  <sCountryId>e97b3c85-5a05-43dd-bfd6-12a66ffd8ab3</sCountryId>
  <sRegionId>d0494f4a-56c6-46c3-998b-86c84a28cf8e</sRegionId>
</FacilityViewModel>