Skip to main content
 
 
 
BluINFO

GetOccupancyById

Overview 

Returns a single OccupancyViewModel if the API token has rights to view it

Request Information


Method

GET - api/Occupancy/GetOccupancyById/{OccupancyId}

URI Parameters

Name Description Type Additional information
OccupancyId

 

globally unique identifier

Required

Body Parameters

None.

Response Information 


Resource Description

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": "a8faa21d-34c2-48fd-8ccb-1af667f01eb2",
  "Name": "sample string 2",
  "ACSystemId": "db6086a2-c6ca-411f-a2b4-393523c584c9",
  "ACSystemName": "sample string 4",
  "FacilityId": "eed29aac-8eaa-493e-a074-c89889ae6832",
  "FacilityName": "sample string 6",
  "CompanyId": "df7dbd21-4ad0-4c28-b2ba-bbc871ee5c03",
  "CompanyName": "sample string 8",
  "StreetAddress1": "sample string 9",
  "StreetAddress2": "sample string 10",
  "City": "sample string 11",
  "RegionId": "eb1ba8e6-7228-4571-978e-edd056088080",
  "RegionName": "sample string 13",
  "CountryId": "2828fbab-8af5-4d5b-8f40-9f56584227c2",
  "CountryName": "sample string 15",
  "PostalCode": "sample string 16",
  "Website": "sample string 17",
  "Phone": "sample string 18",
  "DefaultBadgeTemplateId": "94108f54-d521-47f1-84c4-37fc26b5f8c5",
  "DefaultBadgeTemplateName": "sample string 19",
  "Deleted": true
}

XML

<OccupancyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
  <ACSystemId>db6086a2-c6ca-411f-a2b4-393523c584c9</ACSystemId>
  <ACSystemName>sample string 4</ACSystemName>
  <City>sample string 11</City>
  <CompanyId>df7dbd21-4ad0-4c28-b2ba-bbc871ee5c03</CompanyId>
  <CompanyName>sample string 8</CompanyName>
  <CountryId>2828fbab-8af5-4d5b-8f40-9f56584227c2</CountryId>
  <CountryName>sample string 15</CountryName>
  <DefaultBadgeTemplateId>94108f54-d521-47f1-84c4-37fc26b5f8c5</DefaultBadgeTemplateId>
  <DefaultBadgeTemplateName>sample string 19</DefaultBadgeTemplateName>
  <Deleted>true</Deleted>
  <FacilityId>eed29aac-8eaa-493e-a074-c89889ae6832</FacilityId>
  <FacilityName>sample string 6</FacilityName>
  <Name>sample string 2</Name>
  <OccupantId>a8faa21d-34c2-48fd-8ccb-1af667f01eb2</OccupantId>
  <Phone>sample string 18</Phone>
  <PostalCode>sample string 16</PostalCode>
  <RegionId>eb1ba8e6-7228-4571-978e-edd056088080</RegionId>
  <RegionName>sample string 13</RegionName>
  <StreetAddress1>sample string 9</StreetAddress1>
  <StreetAddress2>sample string 10</StreetAddress2>
  <Website>sample string 17</Website>
</OccupancyViewModel>
  • Was this article helpful?