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": "9f0b7e3c-9019-453d-ab1d-8ab3926fa413",
"Card": {
"CardId": "c692c3ac-9670-4603-9985-5edfb781f9c8",
"CardType": 1,
"InternalCardNumber": 2,
"ExternalCardNumber": "sample string 3",
"CardSerialNumber": 1,
"FacilityCode": 1,
"IssueCode": 1,
"PIN": "sample string 4",
"CardActivationStartDateTime": "2025-10-16T09:18:55.2715224+00:00",
"CardDeactivationStartDateTime": "2025-10-16T09:18:55.2715224+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>2025-10-16T09:18:55.2715224+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2025-10-16T09:18:55.2715224+00:00</CardDeactivationStartDateTime>
<CardId>c692c3ac-9670-4603-9985-5edfb781f9c8</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>9f0b7e3c-9019-453d-ab1d-8ab3926fa413</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": "f10243e3-620e-43a2-854f-f58a0e082ad0",
"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>f10243e3-620e-43a2-854f-f58a0e082ad0</Value> </ResultWithGuid>