Member ID Card Requests

Create IDCardRequest

Creates a new IDCardRequest

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
idCardRequest_Key
required
integer <int32>

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_Date
string or null <date-time>

Date the ID card will be effective

cancellation_Reason
string or null <= 256 characters

Reason indicating why the ID Card Request was cancelled

card_Record_Status
string or null <= 3 characters

Status of the card

division_ID
string or null <= 20 characters

Division ID of the subscriber enrollment for the ID card

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

group_ID
string or null <= 20 characters

Group ID of the subscriber enrollment for the ID card

issuance_Type
string or null <= 3 characters

Issuance type of the ID card

member_Seq
string or null <= 2 characters

Member Sequence of the family member for the ID card

renewal
required
boolean

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_Date
string or null <date-time>

Date the ID card was requested

request_Quantity
integer or null <int32>

Quantity of ID cards requested

request_Status
string or null <= 16 characters

Status of the ID card request

request_Type
string or null <= 16 characters

Identifier for the ID card request type or source

subscriber_ID
string or null <= 9 characters

Subscriber ID of the subscriber for the ID card

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/id-card-requests
Request samples
{
  • "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"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List IDCardRequest

Lists all IDCardRequest

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/id-card-requests
Request samples 
Response samples 
No sample
Get IDCardRequest
Gets IDCardRequest


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
iDCardRequestKey
required
integer <int32> 
IDCardRequest Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/id-card-requests/{iDCardRequestKey}
Request samples 
Response samples 
No sample
Update IDCardRequest
Updates a specific IDCardRequest.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
iDCardRequestKey
required
integer <int32> 
IDCardRequest Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
idCardRequest_Key
required
integer <int32> 
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_Date
string or null <date-time> 
Date the ID card will be effective


 
cancellation_Reason
string or null  <= 256 characters 
Reason indicating why the ID Card Request was cancelled


 
card_Record_Status
string or null  <= 3 characters 
Status of the card


 
division_ID
string or null  <= 20 characters 
Division ID of the subscriber enrollment for the ID card


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
group_ID
string or null  <= 20 characters 
Group ID of the subscriber enrollment for the ID card


 
issuance_Type
string or null  <= 3 characters 
Issuance type of the ID card


 
member_Seq
string or null  <= 2 characters 
Member Sequence of the family member for the ID card


 
renewal
required
boolean
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_Date
string or null <date-time> 
Date the ID card was requested


 
request_Quantity
integer or null <int32> 
Quantity of ID cards requested


 
request_Status
string or null  <= 16 characters 
Status of the ID card request


 
request_Type
string or null  <= 16 characters 
Identifier for the ID card request type or source


 
subscriber_ID
string or null  <= 9 characters 
Subscriber ID of the subscriber for the ID card


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/id-card-requests/{iDCardRequestKey}
Request samples 
{
  • "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"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete IDCardRequest
Deletes an IDCardRequest


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
iDCardRequestKey
required
integer <int32> 
IDCardRequest Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/id-card-requests/{iDCardRequestKey}
Request samples 
Create or Update Batch IDCardRequest
Create or Update multiple IDCardRequest at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
idCardRequest_Key
required
integer <int32> 
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_Date
string or null <date-time> 
Date the ID card will be effective


 
cancellation_Reason
string or null  <= 256 characters 
Reason indicating why the ID Card Request was cancelled


 
card_Record_Status
string or null  <= 3 characters 
Status of the card


 
division_ID
string or null  <= 20 characters 
Division ID of the subscriber enrollment for the ID card


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
group_ID
string or null  <= 20 characters 
Group ID of the subscriber enrollment for the ID card


 
issuance_Type
string or null  <= 3 characters 
Issuance type of the ID card


 
member_Seq
string or null  <= 2 characters 
Member Sequence of the family member for the ID card


 
renewal
required
boolean
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_Date
string or null <date-time> 
Date the ID card was requested


 
request_Quantity
integer or null <int32> 
Quantity of ID cards requested


 
request_Status
string or null  <= 16 characters 
Status of the ID card request


 
request_Type
string or null  <= 16 characters 
Identifier for the ID card request type or source


 
subscriber_ID
string or null  <= 9 characters 
Subscriber ID of the subscriber for the ID card


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/id-card-requests-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}