GET api/v1/VisitorRequests?FacilityId={FacilityId}
Returns a list of VisitorViewModels from 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 |
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": "90d73e78-2955-40be-8252-3a9a62c832a5", "GuestPersonId": "aa497b13-a321-44d1-b036-db8131cdc4a3", "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": "039ba83d-5cc8-4201-b61d-c7bc1aa4b01c", "HostPersonId": "e3a342b5-c998-470e-a566-f46987770ae4", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "d10b5246-cb1b-4ed9-ae59-a61917cf702d", "FacilityName": "sample string 18", "ACSystemId": "22b8046a-2671-4f3e-8bb9-1d8ce4cf9e55", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2024-04-25T09:12:40.1949508+00:00", "AccessLevelEndDate": "2024-04-25T09:12:40.1949508+00:00", "Deleted": true, "ACSystemId": "6d51d769-baed-496e-8d7a-bad061bdd6db", "CompanyId": "0ad888c7-b8b0-46c1-8494-0ea592cc7581", "ApplyByDefault": true, "AccessLevelTypeId": "1b62b577-cb5d-47bd-9386-e7b2da557f8f", "FacilityId": "0e2b8553-1a22-4297-9b02-8a3454e3664a" }, "Deleted": true }, { "VisitorRequestId": "90d73e78-2955-40be-8252-3a9a62c832a5", "GuestPersonId": "aa497b13-a321-44d1-b036-db8131cdc4a3", "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": "039ba83d-5cc8-4201-b61d-c7bc1aa4b01c", "HostPersonId": "e3a342b5-c998-470e-a566-f46987770ae4", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "d10b5246-cb1b-4ed9-ae59-a61917cf702d", "FacilityName": "sample string 18", "ACSystemId": "22b8046a-2671-4f3e-8bb9-1d8ce4cf9e55", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2024-04-25T09:12:40.1949508+00:00", "AccessLevelEndDate": "2024-04-25T09:12:40.1949508+00:00", "Deleted": true, "ACSystemId": "6d51d769-baed-496e-8d7a-bad061bdd6db", "CompanyId": "0ad888c7-b8b0-46c1-8494-0ea592cc7581", "ApplyByDefault": true, "AccessLevelTypeId": "1b62b577-cb5d-47bd-9386-e7b2da557f8f", "FacilityId": "0e2b8553-1a22-4297-9b02-8a3454e3664a" }, "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>22b8046a-2671-4f3e-8bb9-1d8ce4cf9e55</ACSystemId> <ACSystemName>sample string 19</ACSystemName> <Deleted>true</Deleted> <FacilityId>d10b5246-cb1b-4ed9-ae59-a61917cf702d</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>aa497b13-a321-44d1-b036-db8131cdc4a3</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>e3a342b5-c998-470e-a566-f46987770ae4</HostPersonId> <HostPhone>sample string 16</HostPhone> <Message>sample string 10</Message> <RequestedAccessLevel> <ACSystemId>6d51d769-baed-496e-8d7a-bad061bdd6db</ACSystemId> <AccessLevelEndDate>2024-04-25T09:12:40.1949508+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2024-04-25T09:12:40.1949508+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>0ad888c7-b8b0-46c1-8494-0ea592cc7581</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </RequestedAccessLevel> <VisitationPattern>sample string 9</VisitationPattern> <VisitorRequestId>90d73e78-2955-40be-8252-3a9a62c832a5</VisitorRequestId> <VisitorTypeId>039ba83d-5cc8-4201-b61d-c7bc1aa4b01c</VisitorTypeId> </VisitorViewModel> <VisitorViewModel> <ACSystemId>22b8046a-2671-4f3e-8bb9-1d8ce4cf9e55</ACSystemId> <ACSystemName>sample string 19</ACSystemName> <Deleted>true</Deleted> <FacilityId>d10b5246-cb1b-4ed9-ae59-a61917cf702d</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>aa497b13-a321-44d1-b036-db8131cdc4a3</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>e3a342b5-c998-470e-a566-f46987770ae4</HostPersonId> <HostPhone>sample string 16</HostPhone> <Message>sample string 10</Message> <RequestedAccessLevel> <ACSystemId>6d51d769-baed-496e-8d7a-bad061bdd6db</ACSystemId> <AccessLevelEndDate>2024-04-25T09:12:40.1949508+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2024-04-25T09:12:40.1949508+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>0ad888c7-b8b0-46c1-8494-0ea592cc7581</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </RequestedAccessLevel> <VisitationPattern>sample string 9</VisitationPattern> <VisitorRequestId>90d73e78-2955-40be-8252-3a9a62c832a5</VisitorRequestId> <VisitorTypeId>039ba83d-5cc8-4201-b61d-c7bc1aa4b01c</VisitorTypeId> </VisitorViewModel> </ArrayOfVisitorViewModel>