GetOccupanciesByFacilityId
Overview
Returns a list of Occupancies for a given Facility that the API token has rights to view.
Request Information
Method
GET - api/Occupancy/GetOccupanciesByFacilityId/{FacilityId}
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| FacilityId | globally unique identifier | Required |
Body Parameters
None.
Response Information
Resource Description
Collection of OccupancyViewModel
| Name | Description | Type | Additional information |
|---|---|---|---|
| OccupantId | Represents the PK of the Occupancy | globally unique identifier | None. |
| Name | Represents the name of the Occupancy | string | None. |
| ACSystemId | Represents the PK of the Access Control System for the Occupancy | globally unique identifier | None. |
| ACSystemName | Represents the name of the Access Control System for the Occupancy | string | None. |
| FacilityId | Represents the PK of the Facility the Occupancy is in within BluSKY | globally unique identifier | None. |
| FacilityName | Represents the name of the Facility the Occupancy is in within BluSKY | string | None. |
| CompanyId | Represents the PK of the global company that the Occupancy is an instance of. | globally unique identifier | None. |
| CompanyName | Represents the name of the global company that the Occupancy is an instance of. | string | None. |
| StreetAddress1 | Represents the primary street address of the Occupancy | string | None. |
| StreetAddress2 | Represents the secondary street address of the Occupancy | string | None. |
| City | Represents the city of the Occupancy | string | None. |
| RegionId | Represents the PK of the region (State, Province, County, etc) of the Occupancy | globally unique identifier | None. |
| RegionName | Represents the name of the region (State, Province, County, etc) of the Occupancy | string | None. |
| CountryId | Represents the PK of the country of the Occupancy | globally unique identifier | None. |
| CountryName | Represents the name of the country of the Occupancy | string | None. |
| PostalCode | Represents the Postal Code/Zip Code of the Occupancy | string | None. |
| Website | Represents the URL of the website associated with the Occupancy | string | None. |
| Phone | Represents the primary phone number of the Occupancy | string | None. |
| DefaultBadgeTemplateId | Represents the PK of the default Badge Template for the Occupancy | globally unique identifier | None. |
| DefaultBadgeTemplateName | Represents the name of the default Badge Template for the Occupancy | string | None. |
| Deleted | Represents the deleted status of the Occupancy | boolean | None. |
Response Formats
JSON
\\\\[ { "OccupantId": "553471be-1aa5-4d3a-8a4e-5247f90f4530", "Name": "sample string 2", "ACSystemId": "e66421bf-dc79-4d51-b34a-8e97dc91983e", "ACSystemName": "sample string 4", "FacilityId": "b4ce182e-1e23-4429-a697-91725e2d93b5", "FacilityName": "sample string 6", "CompanyId": "55f7dfd7-196b-4913-b505-e51cab17cb13", "CompanyName": "sample string 8", "StreetAddress1": "sample string 9", "StreetAddress2": "sample string 10", "City": "sample string 11", "RegionId": "4d385a11-ab96-4aa3-83e9-459adfd31993", "RegionName": "sample string 13", "CountryId": "2291118e-cb69-44cd-aaa5-20da26ecf23c", "CountryName": "sample string 15", "PostalCode": "sample string 16", "Website": "sample string 17", "Phone": "sample string 18", "DefaultBadgeTemplateId": "d78707eb-f1f2-4328-85ec-d7c19500115d", "DefaultBadgeTemplateName": "sample string 19", "Deleted": true }, { "OccupantId": "553471be-1aa5-4d3a-8a4e-5247f90f4530", "Name": "sample string 2", "ACSystemId": "e66421bf-dc79-4d51-b34a-8e97dc91983e", "ACSystemName": "sample string 4", "FacilityId": "b4ce182e-1e23-4429-a697-91725e2d93b5", "FacilityName": "sample string 6", "CompanyId": "55f7dfd7-196b-4913-b505-e51cab17cb13", "CompanyName": "sample string 8", "StreetAddress1": "sample string 9", "StreetAddress2": "sample string 10", "City": "sample string 11", "RegionId": "4d385a11-ab96-4aa3-83e9-459adfd31993", "RegionName": "sample string 13", "CountryId": "2291118e-cb69-44cd-aaa5-20da26ecf23c", "CountryName": "sample string 15", "PostalCode": "sample string 16", "Website": "sample string 17", "Phone": "sample string 18", "DefaultBadgeTemplateId": "d78707eb-f1f2-4328-85ec-d7c19500115d", "DefaultBadgeTemplateName": "sample string 19", "Deleted": true } ]
XML
<ArrayOfOccupancyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
<OccupancyViewModel>
<ACSystemId>e66421bf-dc79-4d51-b34a-8e97dc91983e</ACSystemId>
<ACSystemName>sample string 4</ACSystemName>
<City>sample string 11</City>
<CompanyId>55f7dfd7-196b-4913-b505-e51cab17cb13</CompanyId>
<CompanyName>sample string 8</CompanyName>
<CountryId>2291118e-cb69-44cd-aaa5-20da26ecf23c</CountryId>
<CountryName>sample string 15</CountryName>
<DefaultBadgeTemplateId>d78707eb-f1f2-4328-85ec-d7c19500115d</DefaultBadgeTemplateId>
<DefaultBadgeTemplateName>sample string 19</DefaultBadgeTemplateName>
<Deleted>true</Deleted>
<FacilityId>b4ce182e-1e23-4429-a697-91725e2d93b5</FacilityId>
<FacilityName>sample string 6</FacilityName>
<Name>sample string 2</Name>
<OccupantId>553471be-1aa5-4d3a-8a4e-5247f90f4530</OccupantId>
<Phone>sample string 18</Phone>
<PostalCode>sample string 16</PostalCode>
<RegionId>4d385a11-ab96-4aa3-83e9-459adfd31993</RegionId>
<RegionName>sample string 13</RegionName>
<StreetAddress1>sample string 9</StreetAddress1>
<StreetAddress2>sample string 10</StreetAddress2>
<Website>sample string 17</Website>
</OccupancyViewModel>
<OccupancyViewModel>
<ACSystemId>e66421bf-dc79-4d51-b34a-8e97dc91983e</ACSystemId>
<ACSystemName>sample string 4</ACSystemName>
<City>sample string 11</City>
<CompanyId>55f7dfd7-196b-4913-b505-e51cab17cb13</CompanyId>
<CompanyName>sample string 8</CompanyName>
<CountryId>2291118e-cb69-44cd-aaa5-20da26ecf23c</CountryId>
<CountryName>sample string 15</CountryName>
<DefaultBadgeTemplateId>d78707eb-f1f2-4328-85ec-d7c19500115d</DefaultBadgeTemplateId>
<DefaultBadgeTemplateName>sample string 19</DefaultBadgeTemplateName>
<Deleted>true</Deleted>
<FacilityId>b4ce182e-1e23-4429-a697-91725e2d93b5</FacilityId>
<FacilityName>sample string 6</FacilityName>
<Name>sample string 2</Name>
<OccupantId>553471be-1aa5-4d3a-8a4e-5247f90f4530</OccupantId>
<Phone>sample string 18</Phone>
<PostalCode>sample string 16</PostalCode>
<RegionId>4d385a11-ab96-4aa3-83e9-459adfd31993</RegionId>
<RegionName>sample string 13</RegionName>
<StreetAddress1>sample string 9</StreetAddress1>
<StreetAddress2>sample string 10</StreetAddress2>
<Website>sample string 17</Website>
</OccupancyViewModel>
</ArrayOfOccupancyViewModel>