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

Name	Description	Type	Additional 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": "0a55e288-6fe8-4344-b8bd-3674ebbb53c5",
  "GuestPersonId": "279edc31-b26f-4ec0-bbdd-06852c6e427b",
  "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": "b973a0da-503d-40c6-9846-482af93fa487",
  "HostPersonId": "26d30d61-002f-48cf-8f08-a23ef2e742c4",
  "FacilityId": "bf172553-21f4-4e3e-a59c-95d426f2fa69",
  "ACSystemId": "eef2529a-b711-4b86-85ed-ce959a349cb3",
  "Floors": [
    {
      "FloorId": "39fcecb6-bf81-467b-881c-9c083a2db264",
      "Name": "sample string 2",
      "PhysicalSequence": 3,
      "Deleted": true
    },
    {
      "FloorId": "39fcecb6-bf81-467b-881c-9c083a2db264",
      "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>eef2529a-b711-4b86-85ed-ce959a349cb3</ACSystemId>
  <Deleted>true</Deleted>
  <FacilityId>bf172553-21f4-4e3e-a59c-95d426f2fa69</FacilityId>
  <Floors>
    <FloorsViewModel>
      <Deleted>true</Deleted>
      <FloorId>39fcecb6-bf81-467b-881c-9c083a2db264</FloorId>
      <Name>sample string 2</Name>
      <PhysicalSequence>3</PhysicalSequence>
    </FloorsViewModel>
    <FloorsViewModel>
      <Deleted>true</Deleted>
      <FloorId>39fcecb6-bf81-467b-881c-9c083a2db264</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>279edc31-b26f-4ec0-bbdd-06852c6e427b</GuestPersonId>
  <GuestPhone>sample string 4</GuestPhone>
  <HostPersonId>26d30d61-002f-48cf-8f08-a23ef2e742c4</HostPersonId>
  <Message>sample string 8</Message>
  <RequestedAccessLevelId>1</RequestedAccessLevelId>
  <VisitationPattern>sample string 7</VisitationPattern>
  <VisitorRequestId>0a55e288-6fe8-4344-b8bd-3674ebbb53c5</VisitorRequestId>
  <VisitorTypeId>b973a0da-503d-40c6-9846-482af93fa487</VisitorTypeId>
</AddUpdateVisitorRequestViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddUpdateVisitorRequestResult

Name	Description	Type	Additional 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": "fad13f10-662e-4820-a8c8-eee43f584560",
  "VisitorRequestInstances": [
    {
      "VisitorRequestInstanceId": "892d309b-139f-4b3a-9dda-fa4867093359",
      "VisitorRequestId": "60d0da76-e698-4a31-bf6c-5d983ce349a0",
      "DateExpected": "2024-04-23T18:30:50.8123347+00:00",
      "DateTimeArrived": "2024-04-23T18:30:50.8123347+00:00",
      "AssignedAccessLevelId": 1,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MiddleInitial": "sample string 6",
      "GuestCompany": "sample string 7",
      "HostPersonId": "9c87ad87-e26a-4418-876a-8294b8cb5a73",
      "Message": "sample string 9",
      "sVisitorTypeId": "dedb1a54-65b1-4f4e-8be9-5ae811f5b265",
      "GroupHashTag": "sample string 11",
      "VisitorStatus": 0,
      "Deleted": true,
      "Card": {
        "PersonCardId": "b9bcaefa-04b3-416c-9d69-64cf5544bc05",
        "CardName": "sample string 2",
        "CardId": "4452a4fa-050a-40f8-a8ff-0ed862d1c747",
        "CardType": 4,
        "CardACSystemId": "9e09f214-7e03-4895-9684-63d319ab4b32",
        "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": "2024-04-23T18:30:50.8123347+00:00",
        "DateInserted": "2024-04-23T18:30:50.8123347+00:00",
        "DateUpdated": "2024-04-23T18:30:50.8123347+00:00",
        "CardActivationStartDateTime": "2024-04-23T18:30:50.8123347+00:00",
        "CardDeactivationStartDateTime": "2024-04-23T18:30:50.8123347+00:00",
        "CardUserFlags": 1,
        "EncryptedMobileCredentials": [
          {
            "MobileKeySetId": "4048a68f-ec8c-49a6-aaf5-1fe71bc9ced3",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          },
          {
            "MobileKeySetId": "4048a68f-ec8c-49a6-aaf5-1fe71bc9ced3",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          }
        ],
        "CredentialType": 1
      }
    },
    {
      "VisitorRequestInstanceId": "892d309b-139f-4b3a-9dda-fa4867093359",
      "VisitorRequestId": "60d0da76-e698-4a31-bf6c-5d983ce349a0",
      "DateExpected": "2024-04-23T18:30:50.8123347+00:00",
      "DateTimeArrived": "2024-04-23T18:30:50.8123347+00:00",
      "AssignedAccessLevelId": 1,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MiddleInitial": "sample string 6",
      "GuestCompany": "sample string 7",
      "HostPersonId": "9c87ad87-e26a-4418-876a-8294b8cb5a73",
      "Message": "sample string 9",
      "sVisitorTypeId": "dedb1a54-65b1-4f4e-8be9-5ae811f5b265",
      "GroupHashTag": "sample string 11",
      "VisitorStatus": 0,
      "Deleted": true,
      "Card": {
        "PersonCardId": "b9bcaefa-04b3-416c-9d69-64cf5544bc05",
        "CardName": "sample string 2",
        "CardId": "4452a4fa-050a-40f8-a8ff-0ed862d1c747",
        "CardType": 4,
        "CardACSystemId": "9e09f214-7e03-4895-9684-63d319ab4b32",
        "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": "2024-04-23T18:30:50.8123347+00:00",
        "DateInserted": "2024-04-23T18:30:50.8123347+00:00",
        "DateUpdated": "2024-04-23T18:30:50.8123347+00:00",
        "CardActivationStartDateTime": "2024-04-23T18:30:50.8123347+00:00",
        "CardDeactivationStartDateTime": "2024-04-23T18:30:50.8123347+00:00",
        "CardUserFlags": 1,
        "EncryptedMobileCredentials": [
          {
            "MobileKeySetId": "4048a68f-ec8c-49a6-aaf5-1fe71bc9ced3",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          },
          {
            "MobileKeySetId": "4048a68f-ec8c-49a6-aaf5-1fe71bc9ced3",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          }
        ],
        "CredentialType": 1
      }
    }
  ],
  "Value": "be0ab16e-5c80-4d27-a9b9-27bd350d5242",
  "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>be0ab16e-5c80-4d27-a9b9-27bd350d5242</Value>
  <GuestPersonId>fad13f10-662e-4820-a8c8-eee43f584560</GuestPersonId>
  <VisitorRequestInstances>
    <VisitorRequestInstanceViewModel>
      <AssignedAccessLevelId>1</AssignedAccessLevelId>
      <Card>
        <CardACSystemId>9e09f214-7e03-4895-9684-63d319ab4b32</CardACSystemId>
        <CardACSystemName>sample string 6</CardACSystemName>
        <CardActivationStartDateTime>2024-04-23T18:30:50.8123347+00:00</CardActivationStartDateTime>
        <CardDeactivationStartDateTime>2024-04-23T18:30:50.8123347+00:00</CardDeactivationStartDateTime>
        <CardId>4452a4fa-050a-40f8-a8ff-0ed862d1c747</CardId>
        <CardName>sample string 2</CardName>
        <CardSerialNumber>1</CardSerialNumber>
        <CardType>4</CardType>
        <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
        <CredentialType>Proximity</CredentialType>
        <DateInserted>2024-04-23T18:30:50.8123347+00:00</DateInserted>
        <DateUpdated>2024-04-23T18:30:50.8123347+00:00</DateUpdated>
        <EncryptedMobileCredentials>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>4048a68f-ec8c-49a6-aaf5-1fe71bc9ced3</MobileKeySetId>
          </EncryptedCredentialData>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>4048a68f-ec8c-49a6-aaf5-1fe71bc9ced3</MobileKeySetId>
          </EncryptedCredentialData>
        </EncryptedMobileCredentials>
        <ExternalCardNumber>sample string 8</ExternalCardNumber>
        <FacilityCode>9</FacilityCode>
        <HidInvitationCode>sample string 13</HidInvitationCode>
        <InternalCardNumber>7</InternalCardNumber>
        <InvitationRedeemedDateTime>2024-04-23T18:30:50.8123347+00:00</InvitationRedeemedDateTime>
        <IssueCode>10</IssueCode>
        <PIN>sample string 11</PIN>
        <PersonCardId>b9bcaefa-04b3-416c-9d69-64cf5544bc05</PersonCardId>
      </Card>
      <DateExpected>2024-04-23T18:30:50.8123347+00:00</DateExpected>
      <DateTimeArrived>2024-04-23T18:30:50.8123347+00:00</DateTimeArrived>
      <Deleted>true</Deleted>
      <FirstName>sample string 4</FirstName>
      <GroupHashTag>sample string 11</GroupHashTag>
      <GuestCompany>sample string 7</GuestCompany>
      <HostPersonId>9c87ad87-e26a-4418-876a-8294b8cb5a73</HostPersonId>
      <LastName>sample string 5</LastName>
      <Message>sample string 9</Message>
      <MiddleInitial>sample string 6</MiddleInitial>
      <VisitorRequestId>60d0da76-e698-4a31-bf6c-5d983ce349a0</VisitorRequestId>
      <VisitorRequestInstanceId>892d309b-139f-4b3a-9dda-fa4867093359</VisitorRequestInstanceId>
      <VisitorStatus>NotCheckedIn</VisitorStatus>
      <sVisitorTypeId>dedb1a54-65b1-4f4e-8be9-5ae811f5b265</sVisitorTypeId>
    </VisitorRequestInstanceViewModel>
    <VisitorRequestInstanceViewModel>
      <AssignedAccessLevelId>1</AssignedAccessLevelId>
      <Card>
        <CardACSystemId>9e09f214-7e03-4895-9684-63d319ab4b32</CardACSystemId>
        <CardACSystemName>sample string 6</CardACSystemName>
        <CardActivationStartDateTime>2024-04-23T18:30:50.8123347+00:00</CardActivationStartDateTime>
        <CardDeactivationStartDateTime>2024-04-23T18:30:50.8123347+00:00</CardDeactivationStartDateTime>
        <CardId>4452a4fa-050a-40f8-a8ff-0ed862d1c747</CardId>
        <CardName>sample string 2</CardName>
        <CardSerialNumber>1</CardSerialNumber>
        <CardType>4</CardType>
        <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
        <CredentialType>Proximity</CredentialType>
        <DateInserted>2024-04-23T18:30:50.8123347+00:00</DateInserted>
        <DateUpdated>2024-04-23T18:30:50.8123347+00:00</DateUpdated>
        <EncryptedMobileCredentials>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>4048a68f-ec8c-49a6-aaf5-1fe71bc9ced3</MobileKeySetId>
          </EncryptedCredentialData>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>4048a68f-ec8c-49a6-aaf5-1fe71bc9ced3</MobileKeySetId>
          </EncryptedCredentialData>
        </EncryptedMobileCredentials>
        <ExternalCardNumber>sample string 8</ExternalCardNumber>
        <FacilityCode>9</FacilityCode>
        <HidInvitationCode>sample string 13</HidInvitationCode>
        <InternalCardNumber>7</InternalCardNumber>
        <InvitationRedeemedDateTime>2024-04-23T18:30:50.8123347+00:00</InvitationRedeemedDateTime>
        <IssueCode>10</IssueCode>
        <PIN>sample string 11</PIN>
        <PersonCardId>b9bcaefa-04b3-416c-9d69-64cf5544bc05</PersonCardId>
      </Card>
      <DateExpected>2024-04-23T18:30:50.8123347+00:00</DateExpected>
      <DateTimeArrived>2024-04-23T18:30:50.8123347+00:00</DateTimeArrived>
      <Deleted>true</Deleted>
      <FirstName>sample string 4</FirstName>
      <GroupHashTag>sample string 11</GroupHashTag>
      <GuestCompany>sample string 7</GuestCompany>
      <HostPersonId>9c87ad87-e26a-4418-876a-8294b8cb5a73</HostPersonId>
      <LastName>sample string 5</LastName>
      <Message>sample string 9</Message>
      <MiddleInitial>sample string 6</MiddleInitial>
      <VisitorRequestId>60d0da76-e698-4a31-bf6c-5d983ce349a0</VisitorRequestId>
      <VisitorRequestInstanceId>892d309b-139f-4b3a-9dda-fa4867093359</VisitorRequestInstanceId>
      <VisitorStatus>NotCheckedIn</VisitorStatus>
      <sVisitorTypeId>dedb1a54-65b1-4f4e-8be9-5ae811f5b265</sVisitorTypeId>
    </VisitorRequestInstanceViewModel>
  </VisitorRequestInstances>
</AddUpdateVisitorRequestResult>