GET api/v1/Occupancies?FacilityId={FacilityId}&IncludeDeleted={IncludeDeleted}
Returns a list of Occupancies for a given Facility that the API token has rights to view.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
FacilityId | globally unique identifier |
Required |
|
IncludeDeleted | boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Collection of OccupancyViewModelName | 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 |
Optional: 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
application/json, text/json
[ { "OccupantId": "a14e436b-5f6f-45bc-8a42-31abf4bfb2e6", "Name": "sample string 2", "ACSystemId": "4ee25aeb-a34a-47e2-b08a-cb1fb89f2fa6", "ACSystemName": "sample string 4", "FacilityId": "15cb1ba2-4a2a-405e-8890-ec2c2f31f634", "FacilityName": "sample string 6", "CompanyId": "eaba3d54-e09d-4a14-a60c-efd5a596bc1e", "CompanyName": "sample string 7", "StreetAddress1": "sample string 8", "StreetAddress2": "sample string 9", "City": "sample string 10", "RegionId": "6e9d099b-1eed-4384-b43a-83c8e4a87e36", "RegionName": "sample string 12", "CountryId": "171e9602-14bd-43a3-adfe-6c0fc68a9e45", "CountryName": "sample string 14", "PostalCode": "sample string 15", "Website": "sample string 16", "Phone": "sample string 17", "DefaultBadgeTemplateId": "765739cc-acdf-455c-9dd1-6540f30f2917", "DefaultBadgeTemplateName": "sample string 18", "Deleted": true }, { "OccupantId": "a14e436b-5f6f-45bc-8a42-31abf4bfb2e6", "Name": "sample string 2", "ACSystemId": "4ee25aeb-a34a-47e2-b08a-cb1fb89f2fa6", "ACSystemName": "sample string 4", "FacilityId": "15cb1ba2-4a2a-405e-8890-ec2c2f31f634", "FacilityName": "sample string 6", "CompanyId": "eaba3d54-e09d-4a14-a60c-efd5a596bc1e", "CompanyName": "sample string 7", "StreetAddress1": "sample string 8", "StreetAddress2": "sample string 9", "City": "sample string 10", "RegionId": "6e9d099b-1eed-4384-b43a-83c8e4a87e36", "RegionName": "sample string 12", "CountryId": "171e9602-14bd-43a3-adfe-6c0fc68a9e45", "CountryName": "sample string 14", "PostalCode": "sample string 15", "Website": "sample string 16", "Phone": "sample string 17", "DefaultBadgeTemplateId": "765739cc-acdf-455c-9dd1-6540f30f2917", "DefaultBadgeTemplateName": "sample string 18", "Deleted": true } ]
application/xml, text/xml
<ArrayOfOccupancyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <OccupancyViewModel> <ACSystemId>4ee25aeb-a34a-47e2-b08a-cb1fb89f2fa6</ACSystemId> <ACSystemName>sample string 4</ACSystemName> <City>sample string 10</City> <CompanyId>eaba3d54-e09d-4a14-a60c-efd5a596bc1e</CompanyId> <CompanyName>sample string 7</CompanyName> <CountryId>171e9602-14bd-43a3-adfe-6c0fc68a9e45</CountryId> <CountryName>sample string 14</CountryName> <DefaultBadgeTemplateId>765739cc-acdf-455c-9dd1-6540f30f2917</DefaultBadgeTemplateId> <DefaultBadgeTemplateName>sample string 18</DefaultBadgeTemplateName> <Deleted>true</Deleted> <FacilityId>15cb1ba2-4a2a-405e-8890-ec2c2f31f634</FacilityId> <FacilityName>sample string 6</FacilityName> <Name>sample string 2</Name> <OccupantId>a14e436b-5f6f-45bc-8a42-31abf4bfb2e6</OccupantId> <Phone>sample string 17</Phone> <PostalCode>sample string 15</PostalCode> <RegionId>6e9d099b-1eed-4384-b43a-83c8e4a87e36</RegionId> <RegionName>sample string 12</RegionName> <StreetAddress1>sample string 8</StreetAddress1> <StreetAddress2>sample string 9</StreetAddress2> <Website>sample string 16</Website> </OccupancyViewModel> <OccupancyViewModel> <ACSystemId>4ee25aeb-a34a-47e2-b08a-cb1fb89f2fa6</ACSystemId> <ACSystemName>sample string 4</ACSystemName> <City>sample string 10</City> <CompanyId>eaba3d54-e09d-4a14-a60c-efd5a596bc1e</CompanyId> <CompanyName>sample string 7</CompanyName> <CountryId>171e9602-14bd-43a3-adfe-6c0fc68a9e45</CountryId> <CountryName>sample string 14</CountryName> <DefaultBadgeTemplateId>765739cc-acdf-455c-9dd1-6540f30f2917</DefaultBadgeTemplateId> <DefaultBadgeTemplateName>sample string 18</DefaultBadgeTemplateName> <Deleted>true</Deleted> <FacilityId>15cb1ba2-4a2a-405e-8890-ec2c2f31f634</FacilityId> <FacilityName>sample string 6</FacilityName> <Name>sample string 2</Name> <OccupantId>a14e436b-5f6f-45bc-8a42-31abf4bfb2e6</OccupantId> <Phone>sample string 17</Phone> <PostalCode>sample string 15</PostalCode> <RegionId>6e9d099b-1eed-4384-b43a-83c8e4a87e36</RegionId> <RegionName>sample string 12</RegionName> <StreetAddress1>sample string 8</StreetAddress1> <StreetAddress2>sample string 9</StreetAddress2> <Website>sample string 16</Website> </OccupancyViewModel> </ArrayOfOccupancyViewModel>