GET api/v1/VisitorRequests?VisitorRequestId={VisitorRequestId}
Returns a single VisitorRequestViewModel if the API token has rights to view it
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
VisitorRequestId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
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": "1eb2f178-cb4e-427d-ba90-0e244853422e", "GuestPersonId": "ffbe477b-6c3e-42ee-bc70-3f5ba9c8cae8", "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": "c67751c6-18fb-49b6-96bb-69b271d3daf3", "HostPersonId": "873e1f96-43d9-4e93-9526-128dbdfaf651", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "9ebcc600-0d37-4603-8208-0b0a15e65279", "FacilityName": "sample string 18", "ACSystemId": "e24f89a1-4741-4785-8f22-ef5af2f81fdc", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2025-06-01T01:17:09.5264807+00:00", "AccessLevelEndDate": "2025-06-01T01:17:09.5264807+00:00", "Deleted": true, "ACSystemId": "62aabbd1-428b-476e-adbe-33d940ce67b3", "CompanyId": "c6946741-0dc1-4dc5-9739-e1e0ef597f6f", "ApplyByDefault": true, "AccessLevelTypeId": "56a41813-95c0-4bb3-afef-2d189234bada", "FacilityId": "7166219c-fbf7-47f4-abbc-55fe834a56e9" }, "Deleted": true }
application/xml, text/xml
<VisitorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <ACSystemId>e24f89a1-4741-4785-8f22-ef5af2f81fdc</ACSystemId> <ACSystemName>sample string 19</ACSystemName> <Deleted>true</Deleted> <FacilityId>9ebcc600-0d37-4603-8208-0b0a15e65279</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>ffbe477b-6c3e-42ee-bc70-3f5ba9c8cae8</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>873e1f96-43d9-4e93-9526-128dbdfaf651</HostPersonId> <HostPhone>sample string 16</HostPhone> <Message>sample string 10</Message> <RequestedAccessLevel> <ACSystemId>62aabbd1-428b-476e-adbe-33d940ce67b3</ACSystemId> <AccessLevelEndDate>2025-06-01T01:17:09.5264807+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2025-06-01T01:17:09.5264807+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>c6946741-0dc1-4dc5-9739-e1e0ef597f6f</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </RequestedAccessLevel> <VisitationPattern>sample string 9</VisitationPattern> <VisitorRequestId>1eb2f178-cb4e-427d-ba90-0e244853422e</VisitorRequestId> <VisitorTypeId>c67751c6-18fb-49b6-96bb-69b271d3daf3</VisitorTypeId> </VisitorViewModel>