Skip to main content

GetAllVisitorRequestsByOccupancyId

Overview​

Returns a list of VisitorViewModels from a given Facility that the API token has rights to view.

Request Information​

Method​

GET - api/Visitor/GetAllVisitorRequestsByOccupancyId/{OccupancyId}

URI Parameters​

NameDescriptionTypeAdditional information
OccupancyIdglobally unique identifierRequired

Body Parameters​

None.

Response Information​

Resource Description​

Collection of VisitorViewModel

NameDescriptionTypeAdditional information
VisitorRequestIdRepresents the PK of an existing Visitor Request in BluSKYglobally unique identifierNone.
GuestPersonIdRepresents the PK of an existing Visitor Request Guest in BluSKYglobally unique identifierNone.
GuestFirstNameRepresents the Guest's first/given name.stringNone.
GuestLastNameRepresents the Guest's last name / surname.stringNone.
GuestEmailRepresents the email address of the GueststringNone.
GuestPhoneRepresents the phone number of the GueststringNone.
GuestCompanyNameRepresents the name of the occupancy or vendor instance that the Guest belongs tostringNone.
GroupHashTagRepresents the group name that the Guest may belong to (if provided)stringNone.
VisitationPatternRepresents the visitation pattern that has been requested for the GueststringNone.
MessageRepresents a supplemental message that will be viewable by Security/Reception when the Guest arrivesstringNone.
VisitorTypeIdRepresents a supplemental message that will be viewable by Security/Reception when the Guest arrivesglobally unique identifierNone.
HostPersonIdRepresents the PK of an existing Visitor Request Host in BluSKYglobally unique identifierNone.
HostFirstNameRepresents the Host's first/given name.stringNone.
HostLastNameRepresents the Host's last name / surname.stringNone.
HostEmailRepresents the email address of the HoststringNone.
HostPhoneRepresents the phone number of the HoststringNone.
HostCompanyNameRepresents the name of the occupancy or vendor instance that the Host belongs tostringNone.
FacilityIdRepresents the PK of the facility that the Guest is expected atglobally unique identifierNone.
FacilityNameRepresents the name of the facility that the Guest is expected atstringNone.
ACSystemIdRepresents the PK of the Access Control System that the Host is located inglobally unique identifierNone.
ACSystemNameRepresents the name of the Access Control System that the Host is located instringNone.
RequestedAccessLevelRepresents an Access Level assignments requested by the Requestor for the VisitorAccessLevelViewModelNone.
DeletedRepresents whether the Visitor Request is deleted or not.booleanNone.

Response Formats​

JSON​

\\\\[ { "VisitorRequestId": "9e53d8e1-f71d-485c-bfa8-ec09d5e43959", "GuestPersonId": "2e83f97c-70d5-4a42-9f32-74b9d0a2fb4a", "GuestFirstName": "sample string 3", "GuestLastName": "sample string 4", "GuestEmail": "sample string 5", "GuestPhone": "sample string 6", "GuestCompanyName": "sample string 7", "GroupHashTag": "sample string 8", "VisitationPattern": "sample string 9", "Message": "sample string 10", "VisitorTypeId": "913772b0-52b9-4068-b099-8f1926b7d908", "HostPersonId": "20025a88-fd12-4cf3-8d5f-41c51342c92c", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "aed6fadb-621c-489b-a146-d595fc860158", "FacilityName": "sample string 18", "ACSystemId": "b418e2f4-2e0b-44d4-bba2-4e60e4690fb9", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2" }, "Deleted": true }, { "VisitorRequestId": "9e53d8e1-f71d-485c-bfa8-ec09d5e43959", "GuestPersonId": "2e83f97c-70d5-4a42-9f32-74b9d0a2fb4a", "GuestFirstName": "sample string 3", "GuestLastName": "sample string 4", "GuestEmail": "sample string 5", "GuestPhone": "sample string 6", "GuestCompanyName": "sample string 7", "GroupHashTag": "sample string 8", "VisitationPattern": "sample string 9", "Message": "sample string 10", "VisitorTypeId": "913772b0-52b9-4068-b099-8f1926b7d908", "HostPersonId": "20025a88-fd12-4cf3-8d5f-41c51342c92c", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "aed6fadb-621c-489b-a146-d595fc860158", "FacilityName": "sample string 18", "ACSystemId": "b418e2f4-2e0b-44d4-bba2-4e60e4690fb9", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2" }, "Deleted": true } ]

XML​

<ArrayOfVisitorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
 <VisitorViewModel>
 <ACSystemId>b418e2f4-2e0b-44d4-bba2-4e60e4690fb9</ACSystemId>
 <ACSystemName>sample string 19</ACSystemName>
 <Deleted>true</Deleted>
 <FacilityId>aed6fadb-621c-489b-a146-d595fc860158</FacilityId>
 <FacilityName>sample string 18</FacilityName>
 <GroupHashTag>sample string 8</GroupHashTag>
 <GuestCompanyName>sample string 7</GuestCompanyName>
 <GuestEmail>sample string 5</GuestEmail>
 <GuestFirstName>sample string 3</GuestFirstName>
 <GuestLastName>sample string 4</GuestLastName>
 <GuestPersonId>2e83f97c-70d5-4a42-9f32-74b9d0a2fb4a</GuestPersonId>
 <GuestPhone>sample string 6</GuestPhone>
 <HostCompanyName>sample string 17</HostCompanyName>
 <HostEmail>sample string 15</HostEmail>
 <HostFirstName>sample string 13</HostFirstName>
 <HostLastName>sample string 14</HostLastName>
 <HostPersonId>20025a88-fd12-4cf3-8d5f-41c51342c92c</HostPersonId>
 <HostPhone>sample string 16</HostPhone>
 <Message>sample string 10</Message>
 <RequestedAccessLevel>
 <AccessLevelId>1</AccessLevelId>
 `<Name>`sample string 2</Name>
 </RequestedAccessLevel>
 <VisitationPattern>sample string 9</VisitationPattern>
 <VisitorRequestId>9e53d8e1-f71d-485c-bfa8-ec09d5e43959</VisitorRequestId>
 <VisitorTypeId>913772b0-52b9-4068-b099-8f1926b7d908</VisitorTypeId>
 </VisitorViewModel>
 <VisitorViewModel>
 <ACSystemId>b418e2f4-2e0b-44d4-bba2-4e60e4690fb9</ACSystemId>
 <ACSystemName>sample string 19</ACSystemName>
 <Deleted>true</Deleted>
 <FacilityId>aed6fadb-621c-489b-a146-d595fc860158</FacilityId>
 <FacilityName>sample string 18</FacilityName>
 <GroupHashTag>sample string 8</GroupHashTag>
 <GuestCompanyName>sample string 7</GuestCompanyName>
 <GuestEmail>sample string 5</GuestEmail>
 <GuestFirstName>sample string 3</GuestFirstName>
 <GuestLastName>sample string 4</GuestLastName>
 <GuestPersonId>2e83f97c-70d5-4a42-9f32-74b9d0a2fb4a</GuestPersonId>
 <GuestPhone>sample string 6</GuestPhone>
 <HostCompanyName>sample string 17</HostCompanyName>
 <HostEmail>sample string 15</HostEmail>
 <HostFirstName>sample string 13</HostFirstName>
 <HostLastName>sample string 14</HostLastName>
 <HostPersonId>20025a88-fd12-4cf3-8d5f-41c51342c92c</HostPersonId>
 <HostPhone>sample string 16</HostPhone>
 <Message>sample string 10</Message>
 <RequestedAccessLevel>
 <AccessLevelId>1</AccessLevelId>
 `<Name>`sample string 2</Name>
 </RequestedAccessLevel>
 <VisitationPattern>sample string 9</VisitationPattern>
 <VisitorRequestId>9e53d8e1-f71d-485c-bfa8-ec09d5e43959</VisitorRequestId>
 <VisitorTypeId>913772b0-52b9-4068-b099-8f1926b7d908</VisitorTypeId>
 </VisitorViewModel>
</ArrayOfVisitorViewModel>