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
| Name | Description | Type | Additional information |
|---|---|---|---|
| FacilityId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
FacilityViewModel| Name | Description | Type | Additional 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
{
"FacilityId": "ff133828-c612-4ff8-83f5-818430ed8ee3",
"Name": "sample string 2",
"ACSystemId": "4bbe3306-429c-4e3d-acad-0d77a896d14e",
"ACSystemName": "sample string 3",
"Deleted": true,
"TimeZoneInfoId": "sample string 5",
"StreetAddress1": "sample string 6",
"StreetAddress2": "sample string 7",
"City": "sample string 8",
"sRegionId": "235204f8-03ec-4368-898b-ea55631b364b",
"RegionName": "sample string 10",
"sCountryId": "7b616fbe-5e39-4ae9-99c1-8cafb38cdbd1",
"CountryName": "sample string 12",
"PostalCode": "sample string 13",
"Website": "sample string 14"
}
application/xml, text/xml
<FacilityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <ACSystemId>4bbe3306-429c-4e3d-acad-0d77a896d14e</ACSystemId> <ACSystemName>sample string 3</ACSystemName> <City>sample string 8</City> <CountryName>sample string 12</CountryName> <Deleted>true</Deleted> <FacilityId>ff133828-c612-4ff8-83f5-818430ed8ee3</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>7b616fbe-5e39-4ae9-99c1-8cafb38cdbd1</sCountryId> <sRegionId>235204f8-03ec-4368-898b-ea55631b364b</sRegionId> </FacilityViewModel>