Skip to content

Create IDCardRequest

Request

Creates a new IDCardRequest

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
idCardRequest_Keyinteger, (int32)required

Key value of the ID Card request Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

as_Of_Datestring or null, (date-time)

Date the ID card will be effective

cancellation_Reasonstring or null, <= 256 characters

Reason indicating why the ID Card Request was cancelled

card_Record_Statusstring or null, <= 3 characters

Status of the card

division_IDstring or null, <= 20 characters

Division ID of the subscriber enrollment for the ID card

entry_Datestring, (date-time)

Date record was first added to the system

entry_Userstring or null, <= 20 characters

User that first added the record to the system

group_IDstring or null, <= 20 characters

Group ID of the subscriber enrollment for the ID card

issuance_Typestring or null, <= 3 characters

Issuance type of the ID card

member_Seqstring or null, <= 2 characters

Member Sequence of the family member for the ID card

renewalbooleanrequired

Flag indicating the ID card request was for a renewal Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

request_Datestring or null, (date-time)

Date the ID card was requested

request_Quantityinteger or null, (int32)

Quantity of ID cards requested

request_Statusstring or null, <= 16 characters

Status of the ID card request

request_Typestring or null, <= 16 characters

Identifier for the ID card request type or source

subscriber_IDstring or null, <= 9 characters

Subscriber ID of the subscriber for the ID card

update_Datestring, (date-time)

Date the record was last updated in the system

update_Userstring or null, <= 20 characters

User that last updated the record in the system

physical_Card_Requestedboolean
curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/id-card-requests \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "idCardRequest_Key": 0,
    "as_Of_Date": "2019-08-24T14:15:22Z",
    "cancellation_Reason": "string",
    "card_Record_Status": "str",
    "division_ID": "string",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "group_ID": "string",
    "issuance_Type": "str",
    "member_Seq": "st",
    "renewal": true,
    "request_Date": "2019-08-24T14:15:22Z",
    "request_Quantity": 0,
    "request_Status": "string",
    "request_Type": "string",
    "subscriber_ID": "string",
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string",
    "physical_Card_Requested": true
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}