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 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	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": "4207f9f3-3ca4-43ac-a081-c93050f21a80",
    "Name": "sample string 2",
    "ACSystemId": "c27bc685-fe26-4cfa-b05d-c40654569b80",
    "ACSystemName": "sample string 4",
    "FacilityId": "899b1a67-3b01-462b-861b-a5ec1428ff93",
    "FacilityName": "sample string 6",
    "CompanyId": "a981ccb8-f841-428c-b090-ff1134762b59",
    "CompanyName": "sample string 7",
    "StreetAddress1": "sample string 8",
    "StreetAddress2": "sample string 9",
    "City": "sample string 10",
    "RegionId": "8653004b-15c5-4403-b850-f23707ed9ea9",
    "RegionName": "sample string 12",
    "CountryId": "02a79269-5a07-4667-aefc-c4dc8fdfcb61",
    "CountryName": "sample string 14",
    "PostalCode": "sample string 15",
    "Website": "sample string 16",
    "Phone": "sample string 17",
    "DefaultBadgeTemplateId": "82350ab4-f454-4f07-9e1d-15b67eb07555",
    "DefaultBadgeTemplateName": "sample string 18",
    "Deleted": true,
    "EmailAddressUsernameFormula": "sample string 20",
    "EmailAddressDomainFormula": "sample string 21",
    "sAvailableEmailAddressFormulaTemplateId": 0
  },
  {
    "OccupantId": "4207f9f3-3ca4-43ac-a081-c93050f21a80",
    "Name": "sample string 2",
    "ACSystemId": "c27bc685-fe26-4cfa-b05d-c40654569b80",
    "ACSystemName": "sample string 4",
    "FacilityId": "899b1a67-3b01-462b-861b-a5ec1428ff93",
    "FacilityName": "sample string 6",
    "CompanyId": "a981ccb8-f841-428c-b090-ff1134762b59",
    "CompanyName": "sample string 7",
    "StreetAddress1": "sample string 8",
    "StreetAddress2": "sample string 9",
    "City": "sample string 10",
    "RegionId": "8653004b-15c5-4403-b850-f23707ed9ea9",
    "RegionName": "sample string 12",
    "CountryId": "02a79269-5a07-4667-aefc-c4dc8fdfcb61",
    "CountryName": "sample string 14",
    "PostalCode": "sample string 15",
    "Website": "sample string 16",
    "Phone": "sample string 17",
    "DefaultBadgeTemplateId": "82350ab4-f454-4f07-9e1d-15b67eb07555",
    "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>c27bc685-fe26-4cfa-b05d-c40654569b80</ACSystemId>
    <ACSystemName>sample string 4</ACSystemName>
    <City>sample string 10</City>
    <CompanyId>a981ccb8-f841-428c-b090-ff1134762b59</CompanyId>
    <CompanyName>sample string 7</CompanyName>
    <CountryId>02a79269-5a07-4667-aefc-c4dc8fdfcb61</CountryId>
    <CountryName>sample string 14</CountryName>
    <DefaultBadgeTemplateId>82350ab4-f454-4f07-9e1d-15b67eb07555</DefaultBadgeTemplateId>
    <DefaultBadgeTemplateName>sample string 18</DefaultBadgeTemplateName>
    <Deleted>true</Deleted>
    <EmailAddressDomainFormula>sample string 21</EmailAddressDomainFormula>
    <EmailAddressUsernameFormula>sample string 20</EmailAddressUsernameFormula>
    <FacilityId>899b1a67-3b01-462b-861b-a5ec1428ff93</FacilityId>
    <FacilityName>sample string 6</FacilityName>
    <Name>sample string 2</Name>
    <OccupantId>4207f9f3-3ca4-43ac-a081-c93050f21a80</OccupantId>
    <Phone>sample string 17</Phone>
    <PostalCode>sample string 15</PostalCode>
    <RegionId>8653004b-15c5-4403-b850-f23707ed9ea9</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>c27bc685-fe26-4cfa-b05d-c40654569b80</ACSystemId>
    <ACSystemName>sample string 4</ACSystemName>
    <City>sample string 10</City>
    <CompanyId>a981ccb8-f841-428c-b090-ff1134762b59</CompanyId>
    <CompanyName>sample string 7</CompanyName>
    <CountryId>02a79269-5a07-4667-aefc-c4dc8fdfcb61</CountryId>
    <CountryName>sample string 14</CountryName>
    <DefaultBadgeTemplateId>82350ab4-f454-4f07-9e1d-15b67eb07555</DefaultBadgeTemplateId>
    <DefaultBadgeTemplateName>sample string 18</DefaultBadgeTemplateName>
    <Deleted>true</Deleted>
    <EmailAddressDomainFormula>sample string 21</EmailAddressDomainFormula>
    <EmailAddressUsernameFormula>sample string 20</EmailAddressUsernameFormula>
    <FacilityId>899b1a67-3b01-462b-861b-a5ec1428ff93</FacilityId>
    <FacilityName>sample string 6</FacilityName>
    <Name>sample string 2</Name>
    <OccupantId>4207f9f3-3ca4-43ac-a081-c93050f21a80</OccupantId>
    <Phone>sample string 17</Phone>
    <PostalCode>sample string 15</PostalCode>
    <RegionId>8653004b-15c5-4403-b850-f23707ed9ea9</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>