POST api/v2/VisitorRequestInstances/{VisitorRequestInstanceId}/Card

Adds a card to the Visitor Request Instance

Request Information

URI Parameters

Name	Description	Type	Additional information
VisitorRequestInstanceId		string	None.

Body Parameters

AddUpdateVisitorCardViewModel2

Name	Description	Type	Additional information
VisitorRequestInstanceId	The Id of the visitor request instance to look for	globally unique identifier	None.
Card	Visitor card data	VisitorCardViewModel2	None.
ReassignIfExists	If true and the card belongs to another visitor already, forces to re-assign the card to this one	boolean	None.
CheckIn	If true, also checks in current visitor	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "VisitorRequestInstanceId": "423f4671-8ab0-44d9-8797-8e19442c24d4",
  "Card": {
    "CardId": "3a505c5f-cafb-4119-a0d4-33da9886169f",
    "CardType": 1,
    "InternalCardNumber": 2,
    "ExternalCardNumber": "sample string 3",
    "CardSerialNumber": 1,
    "FacilityCode": 1,
    "IssueCode": 1,
    "PIN": "sample string 4",
    "CardActivationStartDateTime": "2024-05-05T20:18:35.5532598+00:00",
    "CardDeactivationStartDateTime": "2024-05-05T20:18:35.5532598+00:00",
    "CardUserFlags": 1
  },
  "ReassignIfExists": true,
  "CheckIn": true
}

application/xml, text/xml

Sample:

<AddUpdateVisitorCardViewModel2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <Card>
    <CardActivationStartDateTime>2024-05-05T20:18:35.5532598+00:00</CardActivationStartDateTime>
    <CardDeactivationStartDateTime>2024-05-05T20:18:35.5532598+00:00</CardDeactivationStartDateTime>
    <CardId>3a505c5f-cafb-4119-a0d4-33da9886169f</CardId>
    <CardSerialNumber>1</CardSerialNumber>
    <CardType>1</CardType>
    <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
    <ExternalCardNumber>sample string 3</ExternalCardNumber>
    <FacilityCode>1</FacilityCode>
    <InternalCardNumber>2</InternalCardNumber>
    <IssueCode>1</IssueCode>
    <PIN>sample string 4</PIN>
  </Card>
  <CheckIn>true</CheckIn>
  <ReassignIfExists>true</ReassignIfExists>
  <VisitorRequestInstanceId>423f4671-8ab0-44d9-8797-8e19442c24d4</VisitorRequestInstanceId>
</AddUpdateVisitorCardViewModel2>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultWithGuid

Name	Description	Type	Additional information
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:

{
  "Value": "8b7f793d-da9a-438e-ac13-ce0598b57e3d",
  "ResultCode": 2,
  "Description": "sample string 3"
}

application/xml, text/xml

Sample:

<ResultWithGuid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <Description>sample string 3</Description>
  <HttpStatusCode>Continue</HttpStatusCode>
  <ResultCode>2</ResultCode>
  <Value>8b7f793d-da9a-438e-ac13-ce0598b57e3d</Value>
</ResultWithGuid>