GetOccupanciesByFacilityId
Overview
Request Information
Method
GET - api/Occupancy/GetOccupanciesByFacilityId/{FacilityId}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
FacilityId |
|
globally unique identifier |
Required |
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 |
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
01 | [ |
02 | { |
03 | "OccupantId" : "553471be-1aa5-4d3a-8a4e-5247f90f4530" , |
04 | "Name" : "sample string 2" , |
05 | "ACSystemId" : "e66421bf-dc79-4d51-b34a-8e97dc91983e" , |
06 | "ACSystemName" : "sample string 4" , |
07 | "FacilityId" : "b4ce182e-1e23-4429-a697-91725e2d93b5" , |
08 | "FacilityName" : "sample string 6" , |
09 | "CompanyId" : "55f7dfd7-196b-4913-b505-e51cab17cb13" , |
10 | "CompanyName" : "sample string 8" , |
11 | "StreetAddress1" : "sample string 9" , |
12 | "StreetAddress2" : "sample string 10" , |
13 | "City" : "sample string 11" , |
14 | "RegionId" : "4d385a11-ab96-4aa3-83e9-459adfd31993" , |
15 | "RegionName" : "sample string 13" , |
16 | "CountryId" : "2291118e-cb69-44cd-aaa5-20da26ecf23c" , |
17 | "CountryName" : "sample string 15" , |
18 | "PostalCode" : "sample string 16" , |
19 | "Website" : "sample string 17" , |
20 | "Phone" : "sample string 18" , |
21 | "DefaultBadgeTemplateId" : "d78707eb-f1f2-4328-85ec-d7c19500115d" , |
22 | "DefaultBadgeTemplateName" : "sample string 19" , |
23 | "Deleted" : true |
24 | }, |
25 | { |
26 | "OccupantId" : "553471be-1aa5-4d3a-8a4e-5247f90f4530" , |
27 | "Name" : "sample string 2" , |
28 | "ACSystemId" : "e66421bf-dc79-4d51-b34a-8e97dc91983e" , |
29 | "ACSystemName" : "sample string 4" , |
30 | "FacilityId" : "b4ce182e-1e23-4429-a697-91725e2d93b5" , |
31 | "FacilityName" : "sample string 6" , |
32 | "CompanyId" : "55f7dfd7-196b-4913-b505-e51cab17cb13" , |
33 | "CompanyName" : "sample string 8" , |
34 | "StreetAddress1" : "sample string 9" , |
35 | "StreetAddress2" : "sample string 10" , |
36 | "City" : "sample string 11" , |
37 | "RegionId" : "4d385a11-ab96-4aa3-83e9-459adfd31993" , |
38 | "RegionName" : "sample string 13" , |
39 | "CountryId" : "2291118e-cb69-44cd-aaa5-20da26ecf23c" , |
40 | "CountryName" : "sample string 15" , |
41 | "PostalCode" : "sample string 16" , |
42 | "Website" : "sample string 17" , |
43 | "Phone" : "sample string 18" , |
44 | "DefaultBadgeTemplateId" : "d78707eb-f1f2-4328-85ec-d7c19500115d" , |
45 | "DefaultBadgeTemplateName" : "sample string 19" , |
46 | "Deleted" : true |
47 | } |
48 | ] |
XML
01 | < ArrayOfOccupancyViewModel xmlns:i = "http://www.w3.org/2001/XMLSchema-instance" xmlns = "http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers" > |
02 | < OccupancyViewModel > |
03 | < ACSystemId >e66421bf-dc79-4d51-b34a-8e97dc91983e</ ACSystemId > |
04 | < ACSystemName >sample string 4</ ACSystemName > |
05 | < City >sample string 11</ City > |
06 | < CompanyId >55f7dfd7-196b-4913-b505-e51cab17cb13</ CompanyId > |
07 | < CompanyName >sample string 8</ CompanyName > |
08 | < CountryId >2291118e-cb69-44cd-aaa5-20da26ecf23c</ CountryId > |
09 | < CountryName >sample string 15</ CountryName > |
10 | < DefaultBadgeTemplateId >d78707eb-f1f2-4328-85ec-d7c19500115d</ DefaultBadgeTemplateId > |
11 | < DefaultBadgeTemplateName >sample string 19</ DefaultBadgeTemplateName > |
12 | < Deleted >true</ Deleted > |
13 | < FacilityId >b4ce182e-1e23-4429-a697-91725e2d93b5</ FacilityId > |
14 | < FacilityName >sample string 6</ FacilityName > |
15 | < Name >sample string 2</ Name > |
16 | < OccupantId >553471be-1aa5-4d3a-8a4e-5247f90f4530</ OccupantId > |
17 | < Phone >sample string 18</ Phone > |
18 | < PostalCode >sample string 16</ PostalCode > |
19 | < RegionId >4d385a11-ab96-4aa3-83e9-459adfd31993</ RegionId > |
20 | < RegionName >sample string 13</ RegionName > |
21 | < StreetAddress1 >sample string 9</ StreetAddress1 > |
22 | < StreetAddress2 >sample string 10</ StreetAddress2 > |
23 | < Website >sample string 17</ Website > |
24 | </ OccupancyViewModel > |
25 | < OccupancyViewModel > |
26 | < ACSystemId >e66421bf-dc79-4d51-b34a-8e97dc91983e</ ACSystemId > |
27 | < ACSystemName >sample string 4</ ACSystemName > |
28 | < City >sample string 11</ City > |
29 | < CompanyId >55f7dfd7-196b-4913-b505-e51cab17cb13</ CompanyId > |
30 | < CompanyName >sample string 8</ CompanyName > |
31 | < CountryId >2291118e-cb69-44cd-aaa5-20da26ecf23c</ CountryId > |
32 | < CountryName >sample string 15</ CountryName > |
33 | < DefaultBadgeTemplateId >d78707eb-f1f2-4328-85ec-d7c19500115d</ DefaultBadgeTemplateId > |
34 | < DefaultBadgeTemplateName >sample string 19</ DefaultBadgeTemplateName > |
35 | < Deleted >true</ Deleted > |
36 | < FacilityId >b4ce182e-1e23-4429-a697-91725e2d93b5</ FacilityId > |
37 | < FacilityName >sample string 6</ FacilityName > |
38 | < Name >sample string 2</ Name > |
39 | < OccupantId >553471be-1aa5-4d3a-8a4e-5247f90f4530</ OccupantId > |
40 | < Phone >sample string 18</ Phone > |
41 | < PostalCode >sample string 16</ PostalCode > |
42 | < RegionId >4d385a11-ab96-4aa3-83e9-459adfd31993</ RegionId > |
43 | < RegionName >sample string 13</ RegionName > |
44 | < StreetAddress1 >sample string 9</ StreetAddress1 > |
45 | < StreetAddress2 >sample string 10</ StreetAddress2 > |
46 | < Website >sample string 17</ Website > |
47 | </ OccupancyViewModel > |
48 | </ ArrayOfOccupancyViewModel > |