Forfeiture Statuses

Create ForfeitureStatus

Creates a new ForfeitureStatus

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
forfeiture_Status
required
string [ 1 .. 32 ] characters

Name for the forfeiture status.

default_Status
required
boolean

Identifies that the forfeiture status will be assigned by default. Note: This field is marked as NOT NULL in the database and therefore required by the API.

description
string or null <= 256 characters

Description of the forfeiture status.

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

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/forfeiture-statuses
Request samples
{
  • "forfeiture_Status": "string",
  • "default_Status": true,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ForfeitureStatus

Lists all ForfeitureStatus

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/forfeiture-statuses
Request samples 
Response samples 
No sample
Get ForfeitureStatus
Gets ForfeitureStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
forfeitureStatus
required
string
Forfeiture Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/forfeiture-statuses/{forfeitureStatus}
Request samples 
Response samples 
No sample
Update ForfeitureStatus
Updates a specific ForfeitureStatus.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
forfeitureStatus
required
string
Forfeiture Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
forfeiture_Status
required
string  [ 1 .. 32 ] characters 
Name for the forfeiture status.


 
default_Status
required
boolean
Identifies that the forfeiture status will be assigned by default. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 256 characters 
Description of the forfeiture status.


 
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


 
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/forfeiture-statuses/{forfeitureStatus}
Request samples 
{
  • "forfeiture_Status": "string",
  • "default_Status": true,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ForfeitureStatus
Deletes an ForfeitureStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
forfeitureStatus
required
string
Forfeiture Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/forfeiture-statuses/{forfeitureStatus}
Request samples 
Create or Update Batch ForfeitureStatus
Create or Update multiple ForfeitureStatus 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 
forfeiture_Status
required
string  [ 1 .. 32 ] characters 
Name for the forfeiture status.


 
default_Status
required
boolean
Identifies that the forfeiture status will be assigned by default. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 256 characters 
Description of the forfeiture status.


 
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


 
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/forfeiture-statuses-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}