GET api/v1/VisitorRequests?HostId={HostId}
Returns a list of VisitorViewModels going to see a particular Host that the API token has rights to view
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
HostId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of VisitorViewModelName | Description | Type | Additional information |
---|---|---|---|
VisitorRequestId |
Represents the PK of an existing Visitor Request in BluSKY |
globally unique identifier |
None. |
GuestPersonId |
Represents the PK of an existing Visitor Request Guest in BluSKY |
globally unique identifier |
None. |
GuestFirstName |
Represents the Guest's first/given name. |
string |
None. |
GuestLastName |
Represents the Guest's last name / surname. |
string |
None. |
GuestEmail |
Represents the email address of the Guest |
string |
None. |
GuestPhone |
Represents the phone number of the Guest |
string |
None. |
GuestCompanyName |
Represents the name of the occupancy or vendor instance that the Guest belongs to |
string |
None. |
GroupHashTag |
Represents the group name that the Guest may belong to (if provided) |
string |
None. |
VisitationPattern |
Represents the visitation pattern that has been requested for the Guest |
string |
None. |
Message |
Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives |
string |
None. |
VisitorTypeId |
Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives |
globally unique identifier |
None. |
HostPersonId |
Represents the PK of an existing Visitor Request Host in BluSKY |
globally unique identifier |
None. |
HostFirstName |
Represents the Host's first/given name. |
string |
None. |
HostLastName |
Represents the Host's last name / surname. |
string |
None. |
HostEmail |
Represents the email address of the Host |
string |
None. |
HostPhone |
Represents the phone number of the Host |
string |
None. |
HostCompanyName |
Represents the name of the occupancy or vendor instance that the Host belongs to |
string |
None. |
FacilityId |
Represents the PK of the facility that the Guest is expected at |
globally unique identifier |
None. |
FacilityName |
Represents the name of the facility that the Guest is expected at |
string |
None. |
ACSystemId |
Represents the PK of the Access Control System that the Host is located in |
globally unique identifier |
None. |
ACSystemName |
Represents the name of the Access Control System that the Host is located in |
string |
None. |
RequestedAccessLevel |
Represents an Access Level assignments requested by the Requestor for the Visitor |
AccessLevelViewModel |
None. |
Deleted |
Represents whether the Visitor Request is deleted or not. |
boolean |
None. |
Response Formats
application/json, text/json
[ { "VisitorRequestId": "364bc35b-4ae8-4381-83cf-9b7b8cff8f1c", "GuestPersonId": "95dc5315-a9f0-4b54-b35f-7b9b9ffe1cb7", "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": "b4f028cc-5894-43a8-90cc-e3425c2cb7e8", "HostPersonId": "b87af4d7-46a7-44c7-b6e8-e34304117a88", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "25de48e4-6e70-4ec8-82cd-147eb5118fe4", "FacilityName": "sample string 18", "ACSystemId": "fac13566-29b3-4129-9a6b-c8a895e0204c", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2025-07-02T10:33:51.925941+00:00", "AccessLevelEndDate": "2025-07-02T10:33:51.925941+00:00", "Deleted": true, "ACSystemId": "48d70edc-bda2-4fec-8e0e-5ffb251d3e1a", "CompanyId": "ae65a246-0a51-491a-8d76-9ebe1aadf5f4", "ApplyByDefault": true, "AccessLevelTypeId": "2d5f8ecb-1c74-4988-a309-fc8bc3d32acb", "FacilityId": "82468375-ec8b-4d6e-8e93-0bb4f50470de" }, "Deleted": true }, { "VisitorRequestId": "364bc35b-4ae8-4381-83cf-9b7b8cff8f1c", "GuestPersonId": "95dc5315-a9f0-4b54-b35f-7b9b9ffe1cb7", "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": "b4f028cc-5894-43a8-90cc-e3425c2cb7e8", "HostPersonId": "b87af4d7-46a7-44c7-b6e8-e34304117a88", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "25de48e4-6e70-4ec8-82cd-147eb5118fe4", "FacilityName": "sample string 18", "ACSystemId": "fac13566-29b3-4129-9a6b-c8a895e0204c", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2025-07-02T10:33:51.925941+00:00", "AccessLevelEndDate": "2025-07-02T10:33:51.925941+00:00", "Deleted": true, "ACSystemId": "48d70edc-bda2-4fec-8e0e-5ffb251d3e1a", "CompanyId": "ae65a246-0a51-491a-8d76-9ebe1aadf5f4", "ApplyByDefault": true, "AccessLevelTypeId": "2d5f8ecb-1c74-4988-a309-fc8bc3d32acb", "FacilityId": "82468375-ec8b-4d6e-8e93-0bb4f50470de" }, "Deleted": true } ]
application/xml, text/xml
<ArrayOfVisitorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <VisitorViewModel> <ACSystemId>fac13566-29b3-4129-9a6b-c8a895e0204c</ACSystemId> <ACSystemName>sample string 19</ACSystemName> <Deleted>true</Deleted> <FacilityId>25de48e4-6e70-4ec8-82cd-147eb5118fe4</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>95dc5315-a9f0-4b54-b35f-7b9b9ffe1cb7</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>b87af4d7-46a7-44c7-b6e8-e34304117a88</HostPersonId> <HostPhone>sample string 16</HostPhone> <Message>sample string 10</Message> <RequestedAccessLevel> <ACSystemId>48d70edc-bda2-4fec-8e0e-5ffb251d3e1a</ACSystemId> <AccessLevelEndDate>2025-07-02T10:33:51.925941+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2025-07-02T10:33:51.925941+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>ae65a246-0a51-491a-8d76-9ebe1aadf5f4</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </RequestedAccessLevel> <VisitationPattern>sample string 9</VisitationPattern> <VisitorRequestId>364bc35b-4ae8-4381-83cf-9b7b8cff8f1c</VisitorRequestId> <VisitorTypeId>b4f028cc-5894-43a8-90cc-e3425c2cb7e8</VisitorTypeId> </VisitorViewModel> <VisitorViewModel> <ACSystemId>fac13566-29b3-4129-9a6b-c8a895e0204c</ACSystemId> <ACSystemName>sample string 19</ACSystemName> <Deleted>true</Deleted> <FacilityId>25de48e4-6e70-4ec8-82cd-147eb5118fe4</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>95dc5315-a9f0-4b54-b35f-7b9b9ffe1cb7</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>b87af4d7-46a7-44c7-b6e8-e34304117a88</HostPersonId> <HostPhone>sample string 16</HostPhone> <Message>sample string 10</Message> <RequestedAccessLevel> <ACSystemId>48d70edc-bda2-4fec-8e0e-5ffb251d3e1a</ACSystemId> <AccessLevelEndDate>2025-07-02T10:33:51.925941+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2025-07-02T10:33:51.925941+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>ae65a246-0a51-491a-8d76-9ebe1aadf5f4</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </RequestedAccessLevel> <VisitationPattern>sample string 9</VisitationPattern> <VisitorRequestId>364bc35b-4ae8-4381-83cf-9b7b8cff8f1c</VisitorRequestId> <VisitorTypeId>b4f028cc-5894-43a8-90cc-e3425c2cb7e8</VisitorTypeId> </VisitorViewModel> </ArrayOfVisitorViewModel>