Claim Queues

Create ClaimQueue

Creates a new ClaimQueue

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimQueue_Key
required
integer <int32>

Unique identifer for each claim queue entry. 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.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

queue_Date
string or null <date-time>

The date this queue was created.

queue_End
string or null <date-time>

This notes the end adjudication time of the last claim in this queue.

queue_Priority
integer or null <int32>

A priority identifying when a claim is picked up from the processor queue.

queue_Start
string or null <date-time>

This notes the time the first claim in this queue is picked up.

queue_Status
string or null <= 32 characters

The status of the queue: QUEUED - the claims are actively being worked, or COMPLETE - all claims have completed their processing.

queue_Type
string or null <= 32 characters

The type of queue being created: CHECK - adjudicate the claims or PROCESS - process the claims.

queue_User
string or null <= 20 characters

The user who created this queue.

update_Date
string <date-time>

Date when 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/claim-queues
Request samples
{
  • "claimQueue_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "queue_Date": "2019-08-24T14:15:22Z",
  • "queue_End": "2019-08-24T14:15:22Z",
  • "queue_Priority": 0,
  • "queue_Start": "2019-08-24T14:15:22Z",
  • "queue_Status": "string",
  • "queue_Type": "string",
  • "queue_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimQueue

Lists all ClaimQueue

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/claim-queues
Request samples 
Response samples 
No sample
Get ClaimQueue
Gets ClaimQueue


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimQueue_Key
required
integer <int32> 
ClaimQueue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-queues/{claimQueue_Key}
Request samples 
Response samples 
No sample
Update ClaimQueue
Updates a specific ClaimQueue.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimQueue_Key
required
integer <int32> 
ClaimQueue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
claimQueue_Key
required
integer <int32> 
Unique identifer for each claim queue entry.  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.


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


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


 
queue_Date
string or null <date-time> 
The date this queue was created.


 
queue_End
string or null <date-time> 
This notes the end adjudication time of the last claim in this queue.


 
queue_Priority
integer or null <int32> 
A priority identifying when a claim is picked up from the processor queue.


 
queue_Start
string or null <date-time> 
This notes the time the first claim in this queue is picked up.


 
queue_Status
string or null  <= 32 characters 
The status of the queue: QUEUED - the claims are actively being worked, or COMPLETE - all claims have completed their processing.


 
queue_Type
string or null  <= 32 characters 
The type of queue being created: CHECK - adjudicate the claims or PROCESS - process the claims.


 
queue_User
string or null  <= 20 characters 
The user who created this queue.


 
update_Date
string <date-time> 
Date when 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/claim-queues/{claimQueue_Key}
Request samples 
{
  • "claimQueue_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "queue_Date": "2019-08-24T14:15:22Z",
  • "queue_End": "2019-08-24T14:15:22Z",
  • "queue_Priority": 0,
  • "queue_Start": "2019-08-24T14:15:22Z",
  • "queue_Status": "string",
  • "queue_Type": "string",
  • "queue_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimQueue
Deletes an ClaimQueue


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimQueue_Key
required
integer <int32> 
ClaimQueue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-queues/{claimQueue_Key}
Request samples 
Create or Update Batch ClaimQueue
Create or Update multiple ClaimQueue 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 
claimQueue_Key
required
integer <int32> 
Unique identifer for each claim queue entry.  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.


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


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


 
queue_Date
string or null <date-time> 
The date this queue was created.


 
queue_End
string or null <date-time> 
This notes the end adjudication time of the last claim in this queue.


 
queue_Priority
integer or null <int32> 
A priority identifying when a claim is picked up from the processor queue.


 
queue_Start
string or null <date-time> 
This notes the time the first claim in this queue is picked up.


 
queue_Status
string or null  <= 32 characters 
The status of the queue: QUEUED - the claims are actively being worked, or COMPLETE - all claims have completed their processing.


 
queue_Type
string or null  <= 32 characters 
The type of queue being created: CHECK - adjudicate the claims or PROCESS - process the claims.


 
queue_User
string or null  <= 20 characters 
The user who created this queue.


 
update_Date
string <date-time> 
Date when 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/claim-queues-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}