GET api/v1/VisitorRequests?OccupancyId={OccupancyId}
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 |
---|---|---|---|
OccupancyId | 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": "0d78ec2d-6561-41e6-a3b1-4fd5f890ee1e", "GuestPersonId": "0bac99a8-e9bd-41ae-8e64-9df515146d63", "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": "91a48f9e-7811-40f8-ad42-3bdbbaec1d85", "HostPersonId": "b19a5191-9303-42c1-8d49-58a47922af37", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "28dce556-1bf9-49e0-ad8b-6616ea166091", "FacilityName": "sample string 18", "ACSystemId": "f7d3bd1c-4cb2-44ed-9bb8-1e849662e9df", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2024-05-01T21:54:06.2887941+00:00", "AccessLevelEndDate": "2024-05-01T21:54:06.2887941+00:00", "Deleted": true, "ACSystemId": "645007f7-2747-49a3-8348-14480d725549", "CompanyId": "071c28db-4986-4fb5-b498-dfc7839885d8", "ApplyByDefault": true, "AccessLevelTypeId": "b63fc441-a793-4dd4-a8a7-6178bcc4f1a7", "FacilityId": "d2a2c3fe-cfb5-4d2f-ac5d-ff3f03f80278" }, "Deleted": true }, { "VisitorRequestId": "0d78ec2d-6561-41e6-a3b1-4fd5f890ee1e", "GuestPersonId": "0bac99a8-e9bd-41ae-8e64-9df515146d63", "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": "91a48f9e-7811-40f8-ad42-3bdbbaec1d85", "HostPersonId": "b19a5191-9303-42c1-8d49-58a47922af37", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "28dce556-1bf9-49e0-ad8b-6616ea166091", "FacilityName": "sample string 18", "ACSystemId": "f7d3bd1c-4cb2-44ed-9bb8-1e849662e9df", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2024-05-01T21:54:06.2887941+00:00", "AccessLevelEndDate": "2024-05-01T21:54:06.2887941+00:00", "Deleted": true, "ACSystemId": "645007f7-2747-49a3-8348-14480d725549", "CompanyId": "071c28db-4986-4fb5-b498-dfc7839885d8", "ApplyByDefault": true, "AccessLevelTypeId": "b63fc441-a793-4dd4-a8a7-6178bcc4f1a7", "FacilityId": "d2a2c3fe-cfb5-4d2f-ac5d-ff3f03f80278" }, "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>f7d3bd1c-4cb2-44ed-9bb8-1e849662e9df</ACSystemId> <ACSystemName>sample string 19</ACSystemName> <Deleted>true</Deleted> <FacilityId>28dce556-1bf9-49e0-ad8b-6616ea166091</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>0bac99a8-e9bd-41ae-8e64-9df515146d63</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>b19a5191-9303-42c1-8d49-58a47922af37</HostPersonId> <HostPhone>sample string 16</HostPhone> <Message>sample string 10</Message> <RequestedAccessLevel> <ACSystemId>645007f7-2747-49a3-8348-14480d725549</ACSystemId> <AccessLevelEndDate>2024-05-01T21:54:06.2887941+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2024-05-01T21:54:06.2887941+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>071c28db-4986-4fb5-b498-dfc7839885d8</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </RequestedAccessLevel> <VisitationPattern>sample string 9</VisitationPattern> <VisitorRequestId>0d78ec2d-6561-41e6-a3b1-4fd5f890ee1e</VisitorRequestId> <VisitorTypeId>91a48f9e-7811-40f8-ad42-3bdbbaec1d85</VisitorTypeId> </VisitorViewModel> <VisitorViewModel> <ACSystemId>f7d3bd1c-4cb2-44ed-9bb8-1e849662e9df</ACSystemId> <ACSystemName>sample string 19</ACSystemName> <Deleted>true</Deleted> <FacilityId>28dce556-1bf9-49e0-ad8b-6616ea166091</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>0bac99a8-e9bd-41ae-8e64-9df515146d63</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>b19a5191-9303-42c1-8d49-58a47922af37</HostPersonId> <HostPhone>sample string 16</HostPhone> <Message>sample string 10</Message> <RequestedAccessLevel> <ACSystemId>645007f7-2747-49a3-8348-14480d725549</ACSystemId> <AccessLevelEndDate>2024-05-01T21:54:06.2887941+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2024-05-01T21:54:06.2887941+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>071c28db-4986-4fb5-b498-dfc7839885d8</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </RequestedAccessLevel> <VisitationPattern>sample string 9</VisitationPattern> <VisitorRequestId>0d78ec2d-6561-41e6-a3b1-4fd5f890ee1e</VisitorRequestId> <VisitorTypeId>91a48f9e-7811-40f8-ad42-3bdbbaec1d85</VisitorTypeId> </VisitorViewModel> </ArrayOfVisitorViewModel>