GET api/v1/Occupancies?IncludeDeleted={IncludeDeleted}

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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IncludeDeleted

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of OccupancyViewModel
NameDescriptionTypeAdditional 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.
EmailAddressUsernameFormula

Represents the email address format of the Occupancy.

 string

None.
EmailAddressDomainFormula

Represents the email address of the Occupancy.

 string

None.
sAvailableEmailAddressFormulaTemplateId

Represents the email address formula template id of the Occupancy.

 AvailableEmailAddressFormulaTemplateEnum

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "OccupantId": "488ae655-d746-4287-9323-27a2c7c2a94a",
    "Name": "sample string 2",
    "ACSystemId": "04e4b4e9-3792-4476-a4ff-2836aff2c277",
    "ACSystemName": "sample string 4",
    "FacilityId": "8328b65f-f70d-40cd-ab72-de7f911b3140",
    "FacilityName": "sample string 6",
    "CompanyId": "cd846ed5-11c2-477b-bb31-4f2ff3b2b2bb",
    "CompanyName": "sample string 7",
    "StreetAddress1": "sample string 8",
    "StreetAddress2": "sample string 9",
    "City": "sample string 10",
    "RegionId": "6bc1e395-9d8b-41cd-af65-41aeaf9569ae",
    "RegionName": "sample string 12",
    "CountryId": "d3f432b6-5f02-447a-b49d-acef99169d2c",
    "CountryName": "sample string 14",
    "PostalCode": "sample string 15",
    "Website": "sample string 16",
    "Phone": "sample string 17",
    "DefaultBadgeTemplateId": "3d8e050d-7923-4c62-8c4d-dd97742fb5cb",
    "DefaultBadgeTemplateName": "sample string 18",
    "Deleted": true,
    "EmailAddressUsernameFormula": "sample string 20",
    "EmailAddressDomainFormula": "sample string 21",
    "sAvailableEmailAddressFormulaTemplateId": 0
  },
  {
    "OccupantId": "488ae655-d746-4287-9323-27a2c7c2a94a",
    "Name": "sample string 2",
    "ACSystemId": "04e4b4e9-3792-4476-a4ff-2836aff2c277",
    "ACSystemName": "sample string 4",
    "FacilityId": "8328b65f-f70d-40cd-ab72-de7f911b3140",
    "FacilityName": "sample string 6",
    "CompanyId": "cd846ed5-11c2-477b-bb31-4f2ff3b2b2bb",
    "CompanyName": "sample string 7",
    "StreetAddress1": "sample string 8",
    "StreetAddress2": "sample string 9",
    "City": "sample string 10",
    "RegionId": "6bc1e395-9d8b-41cd-af65-41aeaf9569ae",
    "RegionName": "sample string 12",
    "CountryId": "d3f432b6-5f02-447a-b49d-acef99169d2c",
    "CountryName": "sample string 14",
    "PostalCode": "sample string 15",
    "Website": "sample string 16",
    "Phone": "sample string 17",
    "DefaultBadgeTemplateId": "3d8e050d-7923-4c62-8c4d-dd97742fb5cb",
    "DefaultBadgeTemplateName": "sample string 18",
    "Deleted": true,
    "EmailAddressUsernameFormula": "sample string 20",
    "EmailAddressDomainFormula": "sample string 21",
    "sAvailableEmailAddressFormulaTemplateId": 0
  }
]

application/xml, text/xml

Sample: 
<ArrayOfOccupancyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <OccupancyViewModel>
    <ACSystemId>04e4b4e9-3792-4476-a4ff-2836aff2c277</ACSystemId>
    <ACSystemName>sample string 4</ACSystemName>
    <City>sample string 10</City>
    <CompanyId>cd846ed5-11c2-477b-bb31-4f2ff3b2b2bb</CompanyId>
    <CompanyName>sample string 7</CompanyName>
    <CountryId>d3f432b6-5f02-447a-b49d-acef99169d2c</CountryId>
    <CountryName>sample string 14</CountryName>
    <DefaultBadgeTemplateId>3d8e050d-7923-4c62-8c4d-dd97742fb5cb</DefaultBadgeTemplateId>
    <DefaultBadgeTemplateName>sample string 18</DefaultBadgeTemplateName>
    <Deleted>true</Deleted>
    <EmailAddressDomainFormula>sample string 21</EmailAddressDomainFormula>
    <EmailAddressUsernameFormula>sample string 20</EmailAddressUsernameFormula>
    <FacilityId>8328b65f-f70d-40cd-ab72-de7f911b3140</FacilityId>
    <FacilityName>sample string 6</FacilityName>
    <Name>sample string 2</Name>
    <OccupantId>488ae655-d746-4287-9323-27a2c7c2a94a</OccupantId>
    <Phone>sample string 17</Phone>
    <PostalCode>sample string 15</PostalCode>
    <RegionId>6bc1e395-9d8b-41cd-af65-41aeaf9569ae</RegionId>
    <RegionName>sample string 12</RegionName>
    <StreetAddress1>sample string 8</StreetAddress1>
    <StreetAddress2>sample string 9</StreetAddress2>
    <Website>sample string 16</Website>
    <sAvailableEmailAddressFormulaTemplateId>Custom</sAvailableEmailAddressFormulaTemplateId>
  </OccupancyViewModel>
  <OccupancyViewModel>
    <ACSystemId>04e4b4e9-3792-4476-a4ff-2836aff2c277</ACSystemId>
    <ACSystemName>sample string 4</ACSystemName>
    <City>sample string 10</City>
    <CompanyId>cd846ed5-11c2-477b-bb31-4f2ff3b2b2bb</CompanyId>
    <CompanyName>sample string 7</CompanyName>
    <CountryId>d3f432b6-5f02-447a-b49d-acef99169d2c</CountryId>
    <CountryName>sample string 14</CountryName>
    <DefaultBadgeTemplateId>3d8e050d-7923-4c62-8c4d-dd97742fb5cb</DefaultBadgeTemplateId>
    <DefaultBadgeTemplateName>sample string 18</DefaultBadgeTemplateName>
    <Deleted>true</Deleted>
    <EmailAddressDomainFormula>sample string 21</EmailAddressDomainFormula>
    <EmailAddressUsernameFormula>sample string 20</EmailAddressUsernameFormula>
    <FacilityId>8328b65f-f70d-40cd-ab72-de7f911b3140</FacilityId>
    <FacilityName>sample string 6</FacilityName>
    <Name>sample string 2</Name>
    <OccupantId>488ae655-d746-4287-9323-27a2c7c2a94a</OccupantId>
    <Phone>sample string 17</Phone>
    <PostalCode>sample string 15</PostalCode>
    <RegionId>6bc1e395-9d8b-41cd-af65-41aeaf9569ae</RegionId>
    <RegionName>sample string 12</RegionName>
    <StreetAddress1>sample string 8</StreetAddress1>
    <StreetAddress2>sample string 9</StreetAddress2>
    <Website>sample string 16</Website>
    <sAvailableEmailAddressFormulaTemplateId>Custom</sAvailableEmailAddressFormulaTemplateId>
  </OccupancyViewModel>
</ArrayOfOccupancyViewModel>