GetAllFacilities

Last updated

Dec 14, 2016
Save as PDF
Share
1. Share
2. Tweet
3. Share

Overview

Returns a list of FacilityViewModels that the API token has rights to view.

Request Information

Method

GET - api/Facility/GetAllFacilities

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

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

JSON

01[
02  {
03    "FacilityId": "37369c4f-0a46-4746-8998-ff77a5e401c1",
04    "Name": "sample string 2",
05    "ACSystemId": "e78caaa0-3e2c-4ae4-afa3-afd20b2a4716",
06    "ACSystemName": "sample string 4",
07    "Deleted": true,
08    "TimeZoneInfoId": "sample string 6",
09    "StreetAddress1": "sample string 7",
10    "StreetAddress2": "sample string 8",
11    "City": "sample string 9",
12    "sRegionId": "72784b99-34d5-43b6-8888-4f007b351b38",
13    "RegionName": "sample string 11",
14    "sCountryId": "80e5685b-25a1-47cc-aa7c-d22770142861",
15    "CountryName": "sample string 13",
16    "PostalCode": "sample string 14",
17    "Website": "sample string 15"
18  },
19  {
20    "FacilityId": "37369c4f-0a46-4746-8998-ff77a5e401c1",
21    "Name": "sample string 2",
22    "ACSystemId": "e78caaa0-3e2c-4ae4-afa3-afd20b2a4716",
23    "ACSystemName": "sample string 4",
24    "Deleted": true,
25    "TimeZoneInfoId": "sample string 6",
26    "StreetAddress1": "sample string 7",
27    "StreetAddress2": "sample string 8",
28    "City": "sample string 9",
29    "sRegionId": "72784b99-34d5-43b6-8888-4f007b351b38",
30    "RegionName": "sample string 11",
31    "sCountryId": "80e5685b-25a1-47cc-aa7c-d22770142861",
32    "CountryName": "sample string 13",
33    "PostalCode": "sample string 14",
34    "Website": "sample string 15"
35  }
36]

XML

01<ArrayOfFacilityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
02  <FacilityViewModel>
03    <ACSystemId>e78caaa0-3e2c-4ae4-afa3-afd20b2a4716</ACSystemId>
04    <ACSystemName>sample string 4</ACSystemName>
05    <City>sample string 9</City>
06    <CountryName>sample string 13</CountryName>
07    <Deleted>true</Deleted>
08    <FacilityId>37369c4f-0a46-4746-8998-ff77a5e401c1</FacilityId>
09    <Name>sample string 2</Name>
10    <PostalCode>sample string 14</PostalCode>
11    <RegionName>sample string 11</RegionName>
12    <StreetAddress1>sample string 7</StreetAddress1>
13    <StreetAddress2>sample string 8</StreetAddress2>
14    <TimeZoneInfoId>sample string 6</TimeZoneInfoId>
15    <Website>sample string 15</Website>
16    <sCountryId>80e5685b-25a1-47cc-aa7c-d22770142861</sCountryId>
17    <sRegionId>72784b99-34d5-43b6-8888-4f007b351b38</sRegionId>
18  </FacilityViewModel>
19  <FacilityViewModel>
20    <ACSystemId>e78caaa0-3e2c-4ae4-afa3-afd20b2a4716</ACSystemId>
21    <ACSystemName>sample string 4</ACSystemName>
22    <City>sample string 9</City>
23    <CountryName>sample string 13</CountryName>
24    <Deleted>true</Deleted>
25    <FacilityId>37369c4f-0a46-4746-8998-ff77a5e401c1</FacilityId>
26    <Name>sample string 2</Name>
27    <PostalCode>sample string 14</PostalCode>
28    <RegionName>sample string 11</RegionName>
29    <StreetAddress1>sample string 7</StreetAddress1>
30    <StreetAddress2>sample string 8</StreetAddress2>
31    <TimeZoneInfoId>sample string 6</TimeZoneInfoId>
32    <Website>sample string 15</Website>
33    <sCountryId>80e5685b-25a1-47cc-aa7c-d22770142861</sCountryId>
34    <sRegionId>72784b99-34d5-43b6-8888-4f007b351b38</sRegionId>
35  </FacilityViewModel>
36</ArrayOfFacilityViewModel>