POST api/v1/VisitorRequests

Adds a single Visitor Request to the system. Returns Success/Error code plus primary key of Visitor Request added.

Request Information

URI Parameters

None.

Body Parameters

AddUpdateVisitorRequestViewModel
NameDescriptionTypeAdditional information
VisitorRequestId

Conditional: Represents the PK of an existing Visitor Request in BluSKY if calling an Update method. Not used for Add methods

 globally unique identifier

None.
GuestPersonId

Conditional: Represents the PK of an existing Visitor Request Guest in BluSKY if calling an Update method. Not used for Add methods

 globally unique identifier

None.
GuestFirstName

Required: Represents the Guest's first/given name. Max Length = 60

 string

Max length: 60
GuestLastName

Required: Represents the Guest's last name / surname. Max Length = 60

 string

Max length: 60
GuestEmail

Optional: Represents the email address of the Guest

 string

None.
GuestPhone

Optional: Represents the phone number of the Guest

 string

None.
GuestCompanyName

Optional: Represents the name of the occupancy or vendor instance that the Guest belongs to

 string

None.
GroupHashTag

Optional: Represents the group name that the Guest may belong to (if provided)

 string

None.
VisitationPattern

Required: Represents the visitation pattern that has been requested for the Guest

 string

None.
Message

Optional: Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives

 string

None.
VisitorTypeId

Required: Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives. Retrieve possible values from /Visitor/GetAllVisitorTypes

 globally unique identifier

None.
HostPersonId

Required: Represents the PK of an existing Visitor Request Host in BluSKY. Used for both Add and Update

 globally unique identifier

None.
FacilityId

Required: Represents the PK of the facility that the Guest is expected at. Retrieve possible values from /Facility/GetAllFacilities

 globally unique identifier

None.
ACSystemId

Required: Represents the PK of the Access Control System that the Host is located in. Retrieve possible values from /ACSystem/GetAllSystems

 globally unique identifier

None.
Floors

Optional: Represents the list of floors that the Guest will be allowed to visit if Access Levels are not being used.

 Collection of FloorsViewModel

None.
RequestedAccessLevelId

Optional: Represents an Access Level assignments requested by the Requestor for the Visitor. Retrieve possible values from /AccessLevel/GetAllAccessLevels

 integer

None.
Deleted

Required: Represents whether the Visitor Request is deleted or not. Should be false for Add methods.

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "VisitorRequestId": "c20fb8fe-7762-4442-b001-fa27eb9df37b",
  "GuestPersonId": "c67becf3-53a2-4dc8-903a-613422c4db2f",
  "GuestFirstName": "sample string 1",
  "GuestLastName": "sample string 2",
  "GuestEmail": "sample string 3",
  "GuestPhone": "sample string 4",
  "GuestCompanyName": "sample string 5",
  "GroupHashTag": "sample string 6",
  "VisitationPattern": "sample string 7",
  "Message": "sample string 8",
  "VisitorTypeId": "9c4a17ce-6fa0-48bc-915c-16b4789ddf6d",
  "HostPersonId": "c65bb2cd-2588-4569-a433-69768686bdde",
  "FacilityId": "f5bd4228-5804-4c2a-892e-a417e7cbaedf",
  "ACSystemId": "2dc29fa8-854d-4711-9f46-1d2d02c50de3",
  "Floors": [
    {
      "FloorId": "20997fd6-0149-49c5-991e-51794c251a7d",
      "Name": "sample string 2",
      "PhysicalSequence": 3,
      "Deleted": true
    },
    {
      "FloorId": "20997fd6-0149-49c5-991e-51794c251a7d",
      "Name": "sample string 2",
      "PhysicalSequence": 3,
      "Deleted": true
    }
  ],
  "RequestedAccessLevelId": 1,
  "Deleted": true
}

application/xml, text/xml

Sample: 
<AddUpdateVisitorRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <ACSystemId>2dc29fa8-854d-4711-9f46-1d2d02c50de3</ACSystemId>
  <Deleted>true</Deleted>
  <FacilityId>f5bd4228-5804-4c2a-892e-a417e7cbaedf</FacilityId>
  <Floors>
    <FloorsViewModel>
      <Deleted>true</Deleted>
      <FloorId>20997fd6-0149-49c5-991e-51794c251a7d</FloorId>
      <Name>sample string 2</Name>
      <PhysicalSequence>3</PhysicalSequence>
    </FloorsViewModel>
    <FloorsViewModel>
      <Deleted>true</Deleted>
      <FloorId>20997fd6-0149-49c5-991e-51794c251a7d</FloorId>
      <Name>sample string 2</Name>
      <PhysicalSequence>3</PhysicalSequence>
    </FloorsViewModel>
  </Floors>
  <GroupHashTag>sample string 6</GroupHashTag>
  <GuestCompanyName>sample string 5</GuestCompanyName>
  <GuestEmail>sample string 3</GuestEmail>
  <GuestFirstName>sample string 1</GuestFirstName>
  <GuestLastName>sample string 2</GuestLastName>
  <GuestPersonId>c67becf3-53a2-4dc8-903a-613422c4db2f</GuestPersonId>
  <GuestPhone>sample string 4</GuestPhone>
  <HostPersonId>c65bb2cd-2588-4569-a433-69768686bdde</HostPersonId>
  <Message>sample string 8</Message>
  <RequestedAccessLevelId>1</RequestedAccessLevelId>
  <VisitationPattern>sample string 7</VisitationPattern>
  <VisitorRequestId>c20fb8fe-7762-4442-b001-fa27eb9df37b</VisitorRequestId>
  <VisitorTypeId>9c4a17ce-6fa0-48bc-915c-16b4789ddf6d</VisitorTypeId>
</AddUpdateVisitorRequestViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddUpdateVisitorRequestResult
NameDescriptionTypeAdditional information
GuestPersonId

Represents a person ID of a visitor

 globally unique identifier

None.
VisitorRequestInstances

Contains all existing future visitor request instances for a given request

 Collection of VisitorRequestInstanceViewModel

None.
Value

Represents the PK value that was created as a result of an add

 globally unique identifier

None.
ResultCode

Represents the result code

 integer

None.
Description

Represents a description of the result code

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "GuestPersonId": "b20e442a-91e0-46b8-ac25-06532eb0f3a1",
  "VisitorRequestInstances": [
    {
      "VisitorRequestInstanceId": "373e8c2a-f272-4d62-8822-fbac193b6f27",
      "VisitorRequestId": "f552965a-0ae1-4c52-9d19-da5a6a0d24f0",
      "DateExpected": "2025-12-21T14:26:01.9276917+00:00",
      "DateTimeArrived": "2025-12-21T14:26:01.9276917+00:00",
      "AssignedAccessLevelId": 1,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MiddleInitial": "sample string 6",
      "GuestCompany": "sample string 7",
      "HostPersonId": "56917ae1-ff58-41cf-a9f0-8f68b149c798",
      "Message": "sample string 9",
      "sVisitorTypeId": "86d1b95e-0ba6-4782-b55d-5e0c40e84371",
      "GroupHashTag": "sample string 11",
      "VisitorStatus": 0,
      "Deleted": true,
      "Card": {
        "PersonCardId": "86270f36-4a21-4d8e-86cf-f44faa28c352",
        "CardName": "sample string 2",
        "CardId": "544b69b3-a3b7-4840-969a-8a187fc4ee82",
        "CardType": 4,
        "CardACSystemId": "3fe22956-6fe3-4bc4-a81a-8718f34cf40a",
        "CardACSystemName": "sample string 6",
        "InternalCardNumber": 7,
        "ExternalCardNumber": "sample string 8",
        "CardSerialNumber": 1,
        "FacilityCode": 9,
        "IssueCode": 10,
        "PIN": "sample string 11",
        "Deleted": true,
        "HidInvitationCode": "sample string 13",
        "InvitationRedeemedDateTime": "2025-12-21T14:26:01.9276917+00:00",
        "DateInserted": "2025-12-21T14:26:01.9276917+00:00",
        "DateUpdated": "2025-12-21T14:26:01.9276917+00:00",
        "CardActivationStartDateTime": "2025-12-21T14:26:01.9276917+00:00",
        "CardDeactivationStartDateTime": "2025-12-21T14:26:01.9276917+00:00",
        "CardUserFlags": 1,
        "EncryptedMobileCredentials": [
          {
            "MobileKeySetId": "8eb2b43a-a9c2-40c6-9cf2-0b55c4be0b97",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          },
          {
            "MobileKeySetId": "8eb2b43a-a9c2-40c6-9cf2-0b55c4be0b97",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          }
        ],
        "CredentialType": 1
      }
    },
    {
      "VisitorRequestInstanceId": "373e8c2a-f272-4d62-8822-fbac193b6f27",
      "VisitorRequestId": "f552965a-0ae1-4c52-9d19-da5a6a0d24f0",
      "DateExpected": "2025-12-21T14:26:01.9276917+00:00",
      "DateTimeArrived": "2025-12-21T14:26:01.9276917+00:00",
      "AssignedAccessLevelId": 1,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MiddleInitial": "sample string 6",
      "GuestCompany": "sample string 7",
      "HostPersonId": "56917ae1-ff58-41cf-a9f0-8f68b149c798",
      "Message": "sample string 9",
      "sVisitorTypeId": "86d1b95e-0ba6-4782-b55d-5e0c40e84371",
      "GroupHashTag": "sample string 11",
      "VisitorStatus": 0,
      "Deleted": true,
      "Card": {
        "PersonCardId": "86270f36-4a21-4d8e-86cf-f44faa28c352",
        "CardName": "sample string 2",
        "CardId": "544b69b3-a3b7-4840-969a-8a187fc4ee82",
        "CardType": 4,
        "CardACSystemId": "3fe22956-6fe3-4bc4-a81a-8718f34cf40a",
        "CardACSystemName": "sample string 6",
        "InternalCardNumber": 7,
        "ExternalCardNumber": "sample string 8",
        "CardSerialNumber": 1,
        "FacilityCode": 9,
        "IssueCode": 10,
        "PIN": "sample string 11",
        "Deleted": true,
        "HidInvitationCode": "sample string 13",
        "InvitationRedeemedDateTime": "2025-12-21T14:26:01.9276917+00:00",
        "DateInserted": "2025-12-21T14:26:01.9276917+00:00",
        "DateUpdated": "2025-12-21T14:26:01.9276917+00:00",
        "CardActivationStartDateTime": "2025-12-21T14:26:01.9276917+00:00",
        "CardDeactivationStartDateTime": "2025-12-21T14:26:01.9276917+00:00",
        "CardUserFlags": 1,
        "EncryptedMobileCredentials": [
          {
            "MobileKeySetId": "8eb2b43a-a9c2-40c6-9cf2-0b55c4be0b97",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          },
          {
            "MobileKeySetId": "8eb2b43a-a9c2-40c6-9cf2-0b55c4be0b97",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          }
        ],
        "CredentialType": 1
      }
    }
  ],
  "Value": "b0f08c08-4534-401e-a2bb-599745514bbb",
  "ResultCode": 3,
  "Description": "sample string 4"
}

application/xml, text/xml

Sample: 
<AddUpdateVisitorRequestResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <Description>sample string 4</Description>
  <HttpStatusCode>Continue</HttpStatusCode>
  <ResultCode>3</ResultCode>
  <Value>b0f08c08-4534-401e-a2bb-599745514bbb</Value>
  <GuestPersonId>b20e442a-91e0-46b8-ac25-06532eb0f3a1</GuestPersonId>
  <VisitorRequestInstances>
    <VisitorRequestInstanceViewModel>
      <AssignedAccessLevelId>1</AssignedAccessLevelId>
      <Card>
        <CardACSystemId>3fe22956-6fe3-4bc4-a81a-8718f34cf40a</CardACSystemId>
        <CardACSystemName>sample string 6</CardACSystemName>
        <CardActivationStartDateTime>2025-12-21T14:26:01.9276917+00:00</CardActivationStartDateTime>
        <CardDeactivationStartDateTime>2025-12-21T14:26:01.9276917+00:00</CardDeactivationStartDateTime>
        <CardId>544b69b3-a3b7-4840-969a-8a187fc4ee82</CardId>
        <CardName>sample string 2</CardName>
        <CardSerialNumber>1</CardSerialNumber>
        <CardType>4</CardType>
        <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
        <CredentialType>Proximity</CredentialType>
        <DateInserted>2025-12-21T14:26:01.9276917+00:00</DateInserted>
        <DateUpdated>2025-12-21T14:26:01.9276917+00:00</DateUpdated>
        <EncryptedMobileCredentials>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>8eb2b43a-a9c2-40c6-9cf2-0b55c4be0b97</MobileKeySetId>
          </EncryptedCredentialData>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>8eb2b43a-a9c2-40c6-9cf2-0b55c4be0b97</MobileKeySetId>
          </EncryptedCredentialData>
        </EncryptedMobileCredentials>
        <ExternalCardNumber>sample string 8</ExternalCardNumber>
        <FacilityCode>9</FacilityCode>
        <HidInvitationCode>sample string 13</HidInvitationCode>
        <InternalCardNumber>7</InternalCardNumber>
        <InvitationRedeemedDateTime>2025-12-21T14:26:01.9276917+00:00</InvitationRedeemedDateTime>
        <IssueCode>10</IssueCode>
        <PIN>sample string 11</PIN>
        <PersonCardId>86270f36-4a21-4d8e-86cf-f44faa28c352</PersonCardId>
      </Card>
      <DateExpected>2025-12-21T14:26:01.9276917+00:00</DateExpected>
      <DateTimeArrived>2025-12-21T14:26:01.9276917+00:00</DateTimeArrived>
      <Deleted>true</Deleted>
      <FirstName>sample string 4</FirstName>
      <GroupHashTag>sample string 11</GroupHashTag>
      <GuestCompany>sample string 7</GuestCompany>
      <HostPersonId>56917ae1-ff58-41cf-a9f0-8f68b149c798</HostPersonId>
      <LastName>sample string 5</LastName>
      <Message>sample string 9</Message>
      <MiddleInitial>sample string 6</MiddleInitial>
      <VisitorRequestId>f552965a-0ae1-4c52-9d19-da5a6a0d24f0</VisitorRequestId>
      <VisitorRequestInstanceId>373e8c2a-f272-4d62-8822-fbac193b6f27</VisitorRequestInstanceId>
      <VisitorStatus>NotCheckedIn</VisitorStatus>
      <sVisitorTypeId>86d1b95e-0ba6-4782-b55d-5e0c40e84371</sVisitorTypeId>
    </VisitorRequestInstanceViewModel>
    <VisitorRequestInstanceViewModel>
      <AssignedAccessLevelId>1</AssignedAccessLevelId>
      <Card>
        <CardACSystemId>3fe22956-6fe3-4bc4-a81a-8718f34cf40a</CardACSystemId>
        <CardACSystemName>sample string 6</CardACSystemName>
        <CardActivationStartDateTime>2025-12-21T14:26:01.9276917+00:00</CardActivationStartDateTime>
        <CardDeactivationStartDateTime>2025-12-21T14:26:01.9276917+00:00</CardDeactivationStartDateTime>
        <CardId>544b69b3-a3b7-4840-969a-8a187fc4ee82</CardId>
        <CardName>sample string 2</CardName>
        <CardSerialNumber>1</CardSerialNumber>
        <CardType>4</CardType>
        <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
        <CredentialType>Proximity</CredentialType>
        <DateInserted>2025-12-21T14:26:01.9276917+00:00</DateInserted>
        <DateUpdated>2025-12-21T14:26:01.9276917+00:00</DateUpdated>
        <EncryptedMobileCredentials>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>8eb2b43a-a9c2-40c6-9cf2-0b55c4be0b97</MobileKeySetId>
          </EncryptedCredentialData>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>8eb2b43a-a9c2-40c6-9cf2-0b55c4be0b97</MobileKeySetId>
          </EncryptedCredentialData>
        </EncryptedMobileCredentials>
        <ExternalCardNumber>sample string 8</ExternalCardNumber>
        <FacilityCode>9</FacilityCode>
        <HidInvitationCode>sample string 13</HidInvitationCode>
        <InternalCardNumber>7</InternalCardNumber>
        <InvitationRedeemedDateTime>2025-12-21T14:26:01.9276917+00:00</InvitationRedeemedDateTime>
        <IssueCode>10</IssueCode>
        <PIN>sample string 11</PIN>
        <PersonCardId>86270f36-4a21-4d8e-86cf-f44faa28c352</PersonCardId>
      </Card>
      <DateExpected>2025-12-21T14:26:01.9276917+00:00</DateExpected>
      <DateTimeArrived>2025-12-21T14:26:01.9276917+00:00</DateTimeArrived>
      <Deleted>true</Deleted>
      <FirstName>sample string 4</FirstName>
      <GroupHashTag>sample string 11</GroupHashTag>
      <GuestCompany>sample string 7</GuestCompany>
      <HostPersonId>56917ae1-ff58-41cf-a9f0-8f68b149c798</HostPersonId>
      <LastName>sample string 5</LastName>
      <Message>sample string 9</Message>
      <MiddleInitial>sample string 6</MiddleInitial>
      <VisitorRequestId>f552965a-0ae1-4c52-9d19-da5a6a0d24f0</VisitorRequestId>
      <VisitorRequestInstanceId>373e8c2a-f272-4d62-8822-fbac193b6f27</VisitorRequestInstanceId>
      <VisitorStatus>NotCheckedIn</VisitorStatus>
      <sVisitorTypeId>86d1b95e-0ba6-4782-b55d-5e0c40e84371</sVisitorTypeId>
    </VisitorRequestInstanceViewModel>
  </VisitorRequestInstances>
</AddUpdateVisitorRequestResult>