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": "fd264f2d-02dc-43c2-b3af-972db7a06e9f", "GuestPersonId": "244d3390-cf54-4b06-8a3b-bc471883f4c0", "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": "8473267d-3187-4fb5-9961-197351b5f4b9", "HostPersonId": "fe374d2d-8636-4722-9f15-26e11498f6c8", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "d2aa7d68-8c69-4467-978c-a6673b8c65f5", "FacilityName": "sample string 18", "ACSystemId": "c80faaee-e25c-4ec7-b19a-18c23482ff22", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2025-04-05T11:48:31.1418531+00:00", "AccessLevelEndDate": "2025-04-05T11:48:31.1418531+00:00", "Deleted": true, "ACSystemId": "fbc8ecc3-ba68-4e22-9f79-ca750c889982", "CompanyId": "14190dc7-6c27-4b77-a99d-8589e98e113c", "ApplyByDefault": true, "AccessLevelTypeId": "8db767fa-cc21-44b4-9bd4-fa572b72cad2", "FacilityId": "faaf5e53-4ecb-4043-899d-3f894d2480bf" }, "Deleted": true }, { "VisitorRequestId": "fd264f2d-02dc-43c2-b3af-972db7a06e9f", "GuestPersonId": "244d3390-cf54-4b06-8a3b-bc471883f4c0", "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": "8473267d-3187-4fb5-9961-197351b5f4b9", "HostPersonId": "fe374d2d-8636-4722-9f15-26e11498f6c8", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "d2aa7d68-8c69-4467-978c-a6673b8c65f5", "FacilityName": "sample string 18", "ACSystemId": "c80faaee-e25c-4ec7-b19a-18c23482ff22", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2025-04-05T11:48:31.1418531+00:00", "AccessLevelEndDate": "2025-04-05T11:48:31.1418531+00:00", "Deleted": true, "ACSystemId": "fbc8ecc3-ba68-4e22-9f79-ca750c889982", "CompanyId": "14190dc7-6c27-4b77-a99d-8589e98e113c", "ApplyByDefault": true, "AccessLevelTypeId": "8db767fa-cc21-44b4-9bd4-fa572b72cad2", "FacilityId": "faaf5e53-4ecb-4043-899d-3f894d2480bf" }, "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>c80faaee-e25c-4ec7-b19a-18c23482ff22</ACSystemId> <ACSystemName>sample string 19</ACSystemName> <Deleted>true</Deleted> <FacilityId>d2aa7d68-8c69-4467-978c-a6673b8c65f5</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>244d3390-cf54-4b06-8a3b-bc471883f4c0</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>fe374d2d-8636-4722-9f15-26e11498f6c8</HostPersonId> <HostPhone>sample string 16</HostPhone> <Message>sample string 10</Message> <RequestedAccessLevel> <ACSystemId>fbc8ecc3-ba68-4e22-9f79-ca750c889982</ACSystemId> <AccessLevelEndDate>2025-04-05T11:48:31.1418531+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2025-04-05T11:48:31.1418531+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>14190dc7-6c27-4b77-a99d-8589e98e113c</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </RequestedAccessLevel> <VisitationPattern>sample string 9</VisitationPattern> <VisitorRequestId>fd264f2d-02dc-43c2-b3af-972db7a06e9f</VisitorRequestId> <VisitorTypeId>8473267d-3187-4fb5-9961-197351b5f4b9</VisitorTypeId> </VisitorViewModel> <VisitorViewModel> <ACSystemId>c80faaee-e25c-4ec7-b19a-18c23482ff22</ACSystemId> <ACSystemName>sample string 19</ACSystemName> <Deleted>true</Deleted> <FacilityId>d2aa7d68-8c69-4467-978c-a6673b8c65f5</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>244d3390-cf54-4b06-8a3b-bc471883f4c0</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>fe374d2d-8636-4722-9f15-26e11498f6c8</HostPersonId> <HostPhone>sample string 16</HostPhone> <Message>sample string 10</Message> <RequestedAccessLevel> <ACSystemId>fbc8ecc3-ba68-4e22-9f79-ca750c889982</ACSystemId> <AccessLevelEndDate>2025-04-05T11:48:31.1418531+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2025-04-05T11:48:31.1418531+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>14190dc7-6c27-4b77-a99d-8589e98e113c</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </RequestedAccessLevel> <VisitationPattern>sample string 9</VisitationPattern> <VisitorRequestId>fd264f2d-02dc-43c2-b3af-972db7a06e9f</VisitorRequestId> <VisitorTypeId>8473267d-3187-4fb5-9961-197351b5f4b9</VisitorTypeId> </VisitorViewModel> </ArrayOfVisitorViewModel>