GET api/v1/Occupancies?IncludeDeleted={IncludeDeleted}
Returns a list of Occupancies that the API token has rights to view.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
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": "55ba2d37-362c-40dc-af95-681f5a794914", "Name": "sample string 2", "ACSystemId": "f7329bae-2488-4d92-8e43-d8bfe4c23891", "ACSystemName": "sample string 4", "FacilityId": "b929a304-a7af-4794-a3ac-f22b4295fc18", "FacilityName": "sample string 6", "CompanyId": "c2a80746-5aca-4d64-9135-444c08bb38d7", "CompanyName": "sample string 7", "StreetAddress1": "sample string 8", "StreetAddress2": "sample string 9", "City": "sample string 10", "RegionId": "260a451a-62b9-4c37-b51a-17ac693efe0b", "RegionName": "sample string 12", "CountryId": "94d719dc-a0bc-48d7-9dc0-6eda676dd061", "CountryName": "sample string 14", "PostalCode": "sample string 15", "Website": "sample string 16", "Phone": "sample string 17", "DefaultBadgeTemplateId": "1bf31e66-172a-422c-8da4-ec79ea7fed2c", "DefaultBadgeTemplateName": "sample string 18", "Deleted": true }, { "OccupantId": "55ba2d37-362c-40dc-af95-681f5a794914", "Name": "sample string 2", "ACSystemId": "f7329bae-2488-4d92-8e43-d8bfe4c23891", "ACSystemName": "sample string 4", "FacilityId": "b929a304-a7af-4794-a3ac-f22b4295fc18", "FacilityName": "sample string 6", "CompanyId": "c2a80746-5aca-4d64-9135-444c08bb38d7", "CompanyName": "sample string 7", "StreetAddress1": "sample string 8", "StreetAddress2": "sample string 9", "City": "sample string 10", "RegionId": "260a451a-62b9-4c37-b51a-17ac693efe0b", "RegionName": "sample string 12", "CountryId": "94d719dc-a0bc-48d7-9dc0-6eda676dd061", "CountryName": "sample string 14", "PostalCode": "sample string 15", "Website": "sample string 16", "Phone": "sample string 17", "DefaultBadgeTemplateId": "1bf31e66-172a-422c-8da4-ec79ea7fed2c", "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>f7329bae-2488-4d92-8e43-d8bfe4c23891</ACSystemId> <ACSystemName>sample string 4</ACSystemName> <City>sample string 10</City> <CompanyId>c2a80746-5aca-4d64-9135-444c08bb38d7</CompanyId> <CompanyName>sample string 7</CompanyName> <CountryId>94d719dc-a0bc-48d7-9dc0-6eda676dd061</CountryId> <CountryName>sample string 14</CountryName> <DefaultBadgeTemplateId>1bf31e66-172a-422c-8da4-ec79ea7fed2c</DefaultBadgeTemplateId> <DefaultBadgeTemplateName>sample string 18</DefaultBadgeTemplateName> <Deleted>true</Deleted> <FacilityId>b929a304-a7af-4794-a3ac-f22b4295fc18</FacilityId> <FacilityName>sample string 6</FacilityName> <Name>sample string 2</Name> <OccupantId>55ba2d37-362c-40dc-af95-681f5a794914</OccupantId> <Phone>sample string 17</Phone> <PostalCode>sample string 15</PostalCode> <RegionId>260a451a-62b9-4c37-b51a-17ac693efe0b</RegionId> <RegionName>sample string 12</RegionName> <StreetAddress1>sample string 8</StreetAddress1> <StreetAddress2>sample string 9</StreetAddress2> <Website>sample string 16</Website> </OccupancyViewModel> <OccupancyViewModel> <ACSystemId>f7329bae-2488-4d92-8e43-d8bfe4c23891</ACSystemId> <ACSystemName>sample string 4</ACSystemName> <City>sample string 10</City> <CompanyId>c2a80746-5aca-4d64-9135-444c08bb38d7</CompanyId> <CompanyName>sample string 7</CompanyName> <CountryId>94d719dc-a0bc-48d7-9dc0-6eda676dd061</CountryId> <CountryName>sample string 14</CountryName> <DefaultBadgeTemplateId>1bf31e66-172a-422c-8da4-ec79ea7fed2c</DefaultBadgeTemplateId> <DefaultBadgeTemplateName>sample string 18</DefaultBadgeTemplateName> <Deleted>true</Deleted> <FacilityId>b929a304-a7af-4794-a3ac-f22b4295fc18</FacilityId> <FacilityName>sample string 6</FacilityName> <Name>sample string 2</Name> <OccupantId>55ba2d37-362c-40dc-af95-681f5a794914</OccupantId> <Phone>sample string 17</Phone> <PostalCode>sample string 15</PostalCode> <RegionId>260a451a-62b9-4c37-b51a-17ac693efe0b</RegionId> <RegionName>sample string 12</RegionName> <StreetAddress1>sample string 8</StreetAddress1> <StreetAddress2>sample string 9</StreetAddress2> <Website>sample string 16</Website> </OccupancyViewModel> </ArrayOfOccupancyViewModel>