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": "612d142c-1ba0-43ed-ba05-6a0631a66450",
  "GuestPersonId": "478aee92-0218-4890-aea7-1bb44e995a19",
  "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": "a8fc51c1-725d-4619-854f-f1f3662f9aca",
  "HostPersonId": "2a5675b1-abe3-469c-88c0-516746b42d23",
  "FacilityId": "bf3361b9-0a58-474d-b2d5-deed17e15327",
  "ACSystemId": "41909e7b-d41b-4c8b-a0dc-febfcde6f1c3",
  "Floors": [
    {
      "FloorId": "80dbc93a-d7a9-4b59-8a63-35fc55bcad47",
      "Name": "sample string 2",
      "PhysicalSequence": 3,
      "Deleted": true
    },
    {
      "FloorId": "80dbc93a-d7a9-4b59-8a63-35fc55bcad47",
      "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>41909e7b-d41b-4c8b-a0dc-febfcde6f1c3</ACSystemId>
  <Deleted>true</Deleted>
  <FacilityId>bf3361b9-0a58-474d-b2d5-deed17e15327</FacilityId>
  <Floors>
    <FloorsViewModel>
      <Deleted>true</Deleted>
      <FloorId>80dbc93a-d7a9-4b59-8a63-35fc55bcad47</FloorId>
      <Name>sample string 2</Name>
      <PhysicalSequence>3</PhysicalSequence>
    </FloorsViewModel>
    <FloorsViewModel>
      <Deleted>true</Deleted>
      <FloorId>80dbc93a-d7a9-4b59-8a63-35fc55bcad47</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>478aee92-0218-4890-aea7-1bb44e995a19</GuestPersonId>
  <GuestPhone>sample string 4</GuestPhone>
  <HostPersonId>2a5675b1-abe3-469c-88c0-516746b42d23</HostPersonId>
  <Message>sample string 8</Message>
  <RequestedAccessLevelId>1</RequestedAccessLevelId>
  <VisitationPattern>sample string 7</VisitationPattern>
  <VisitorRequestId>612d142c-1ba0-43ed-ba05-6a0631a66450</VisitorRequestId>
  <VisitorTypeId>a8fc51c1-725d-4619-854f-f1f3662f9aca</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": "99a68a5b-1a14-470f-b612-1c8908430733",
  "VisitorRequestInstances": [
    {
      "VisitorRequestInstanceId": "caad1ff1-4adf-476f-84b0-7d1813c0cf21",
      "VisitorRequestId": "8a09b446-6dbe-4d92-bcff-366ac0c06576",
      "DateExpected": "2025-05-09T17:10:22.5848241+00:00",
      "DateTimeArrived": "2025-05-09T17:10:22.5848241+00:00",
      "AssignedAccessLevelId": 1,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MiddleInitial": "sample string 6",
      "GuestCompany": "sample string 7",
      "HostPersonId": "1447f82e-0f3e-401a-8dc0-3a5e11275c95",
      "Message": "sample string 9",
      "sVisitorTypeId": "c12a88f3-451a-42ed-8a97-a7e9a794fb12",
      "GroupHashTag": "sample string 11",
      "VisitorStatus": 0,
      "Deleted": true,
      "Card": {
        "PersonCardId": "bdc5a154-afcc-40e1-b72c-d23865597069",
        "CardName": "sample string 2",
        "CardId": "263754a3-56c5-43b6-bab1-30ccea4d7986",
        "CardType": 4,
        "CardACSystemId": "c0a88b89-f705-4eb0-9a8f-4b314af7de23",
        "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-05-09T17:10:22.5848241+00:00",
        "DateInserted": "2025-05-09T17:10:22.5848241+00:00",
        "DateUpdated": "2025-05-09T17:10:22.5848241+00:00",
        "CardActivationStartDateTime": "2025-05-09T17:10:22.5848241+00:00",
        "CardDeactivationStartDateTime": "2025-05-09T17:10:22.5848241+00:00",
        "CardUserFlags": 1,
        "EncryptedMobileCredentials": [
          {
            "MobileKeySetId": "0559cc2f-5257-40f8-ae2c-92629b6e271e",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          },
          {
            "MobileKeySetId": "0559cc2f-5257-40f8-ae2c-92629b6e271e",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          }
        ],
        "CredentialType": 1
      }
    },
    {
      "VisitorRequestInstanceId": "caad1ff1-4adf-476f-84b0-7d1813c0cf21",
      "VisitorRequestId": "8a09b446-6dbe-4d92-bcff-366ac0c06576",
      "DateExpected": "2025-05-09T17:10:22.5848241+00:00",
      "DateTimeArrived": "2025-05-09T17:10:22.5848241+00:00",
      "AssignedAccessLevelId": 1,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MiddleInitial": "sample string 6",
      "GuestCompany": "sample string 7",
      "HostPersonId": "1447f82e-0f3e-401a-8dc0-3a5e11275c95",
      "Message": "sample string 9",
      "sVisitorTypeId": "c12a88f3-451a-42ed-8a97-a7e9a794fb12",
      "GroupHashTag": "sample string 11",
      "VisitorStatus": 0,
      "Deleted": true,
      "Card": {
        "PersonCardId": "bdc5a154-afcc-40e1-b72c-d23865597069",
        "CardName": "sample string 2",
        "CardId": "263754a3-56c5-43b6-bab1-30ccea4d7986",
        "CardType": 4,
        "CardACSystemId": "c0a88b89-f705-4eb0-9a8f-4b314af7de23",
        "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-05-09T17:10:22.5848241+00:00",
        "DateInserted": "2025-05-09T17:10:22.5848241+00:00",
        "DateUpdated": "2025-05-09T17:10:22.5848241+00:00",
        "CardActivationStartDateTime": "2025-05-09T17:10:22.5848241+00:00",
        "CardDeactivationStartDateTime": "2025-05-09T17:10:22.5848241+00:00",
        "CardUserFlags": 1,
        "EncryptedMobileCredentials": [
          {
            "MobileKeySetId": "0559cc2f-5257-40f8-ae2c-92629b6e271e",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          },
          {
            "MobileKeySetId": "0559cc2f-5257-40f8-ae2c-92629b6e271e",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          }
        ],
        "CredentialType": 1
      }
    }
  ],
  "Value": "4be6c65e-5a62-4366-a878-90c387042c22",
  "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>4be6c65e-5a62-4366-a878-90c387042c22</Value>
  <GuestPersonId>99a68a5b-1a14-470f-b612-1c8908430733</GuestPersonId>
  <VisitorRequestInstances>
    <VisitorRequestInstanceViewModel>
      <AssignedAccessLevelId>1</AssignedAccessLevelId>
      <Card>
        <CardACSystemId>c0a88b89-f705-4eb0-9a8f-4b314af7de23</CardACSystemId>
        <CardACSystemName>sample string 6</CardACSystemName>
        <CardActivationStartDateTime>2025-05-09T17:10:22.5848241+00:00</CardActivationStartDateTime>
        <CardDeactivationStartDateTime>2025-05-09T17:10:22.5848241+00:00</CardDeactivationStartDateTime>
        <CardId>263754a3-56c5-43b6-bab1-30ccea4d7986</CardId>
        <CardName>sample string 2</CardName>
        <CardSerialNumber>1</CardSerialNumber>
        <CardType>4</CardType>
        <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
        <CredentialType>Proximity</CredentialType>
        <DateInserted>2025-05-09T17:10:22.5848241+00:00</DateInserted>
        <DateUpdated>2025-05-09T17:10:22.5848241+00:00</DateUpdated>
        <EncryptedMobileCredentials>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>0559cc2f-5257-40f8-ae2c-92629b6e271e</MobileKeySetId>
          </EncryptedCredentialData>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>0559cc2f-5257-40f8-ae2c-92629b6e271e</MobileKeySetId>
          </EncryptedCredentialData>
        </EncryptedMobileCredentials>
        <ExternalCardNumber>sample string 8</ExternalCardNumber>
        <FacilityCode>9</FacilityCode>
        <HidInvitationCode>sample string 13</HidInvitationCode>
        <InternalCardNumber>7</InternalCardNumber>
        <InvitationRedeemedDateTime>2025-05-09T17:10:22.5848241+00:00</InvitationRedeemedDateTime>
        <IssueCode>10</IssueCode>
        <PIN>sample string 11</PIN>
        <PersonCardId>bdc5a154-afcc-40e1-b72c-d23865597069</PersonCardId>
      </Card>
      <DateExpected>2025-05-09T17:10:22.5848241+00:00</DateExpected>
      <DateTimeArrived>2025-05-09T17:10:22.5848241+00:00</DateTimeArrived>
      <Deleted>true</Deleted>
      <FirstName>sample string 4</FirstName>
      <GroupHashTag>sample string 11</GroupHashTag>
      <GuestCompany>sample string 7</GuestCompany>
      <HostPersonId>1447f82e-0f3e-401a-8dc0-3a5e11275c95</HostPersonId>
      <LastName>sample string 5</LastName>
      <Message>sample string 9</Message>
      <MiddleInitial>sample string 6</MiddleInitial>
      <VisitorRequestId>8a09b446-6dbe-4d92-bcff-366ac0c06576</VisitorRequestId>
      <VisitorRequestInstanceId>caad1ff1-4adf-476f-84b0-7d1813c0cf21</VisitorRequestInstanceId>
      <VisitorStatus>NotCheckedIn</VisitorStatus>
      <sVisitorTypeId>c12a88f3-451a-42ed-8a97-a7e9a794fb12</sVisitorTypeId>
    </VisitorRequestInstanceViewModel>
    <VisitorRequestInstanceViewModel>
      <AssignedAccessLevelId>1</AssignedAccessLevelId>
      <Card>
        <CardACSystemId>c0a88b89-f705-4eb0-9a8f-4b314af7de23</CardACSystemId>
        <CardACSystemName>sample string 6</CardACSystemName>
        <CardActivationStartDateTime>2025-05-09T17:10:22.5848241+00:00</CardActivationStartDateTime>
        <CardDeactivationStartDateTime>2025-05-09T17:10:22.5848241+00:00</CardDeactivationStartDateTime>
        <CardId>263754a3-56c5-43b6-bab1-30ccea4d7986</CardId>
        <CardName>sample string 2</CardName>
        <CardSerialNumber>1</CardSerialNumber>
        <CardType>4</CardType>
        <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
        <CredentialType>Proximity</CredentialType>
        <DateInserted>2025-05-09T17:10:22.5848241+00:00</DateInserted>
        <DateUpdated>2025-05-09T17:10:22.5848241+00:00</DateUpdated>
        <EncryptedMobileCredentials>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>0559cc2f-5257-40f8-ae2c-92629b6e271e</MobileKeySetId>
          </EncryptedCredentialData>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>0559cc2f-5257-40f8-ae2c-92629b6e271e</MobileKeySetId>
          </EncryptedCredentialData>
        </EncryptedMobileCredentials>
        <ExternalCardNumber>sample string 8</ExternalCardNumber>
        <FacilityCode>9</FacilityCode>
        <HidInvitationCode>sample string 13</HidInvitationCode>
        <InternalCardNumber>7</InternalCardNumber>
        <InvitationRedeemedDateTime>2025-05-09T17:10:22.5848241+00:00</InvitationRedeemedDateTime>
        <IssueCode>10</IssueCode>
        <PIN>sample string 11</PIN>
        <PersonCardId>bdc5a154-afcc-40e1-b72c-d23865597069</PersonCardId>
      </Card>
      <DateExpected>2025-05-09T17:10:22.5848241+00:00</DateExpected>
      <DateTimeArrived>2025-05-09T17:10:22.5848241+00:00</DateTimeArrived>
      <Deleted>true</Deleted>
      <FirstName>sample string 4</FirstName>
      <GroupHashTag>sample string 11</GroupHashTag>
      <GuestCompany>sample string 7</GuestCompany>
      <HostPersonId>1447f82e-0f3e-401a-8dc0-3a5e11275c95</HostPersonId>
      <LastName>sample string 5</LastName>
      <Message>sample string 9</Message>
      <MiddleInitial>sample string 6</MiddleInitial>
      <VisitorRequestId>8a09b446-6dbe-4d92-bcff-366ac0c06576</VisitorRequestId>
      <VisitorRequestInstanceId>caad1ff1-4adf-476f-84b0-7d1813c0cf21</VisitorRequestInstanceId>
      <VisitorStatus>NotCheckedIn</VisitorStatus>
      <sVisitorTypeId>c12a88f3-451a-42ed-8a97-a7e9a794fb12</sVisitorTypeId>
    </VisitorRequestInstanceViewModel>
  </VisitorRequestInstances>
</AddUpdateVisitorRequestResult>