Suffix

Create Suffix

Creates a new Suffix

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
suffix1
required
string [ 1 .. 16 ] characters

Suffix used with personal or entity names

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/suffixes
Request samples
{
  • "suffix1": "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 Suffix

Lists all Suffix

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/suffixes
Request samples 
Response samples 
No sample
Get Suffix
Gets Suffix


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
suffix1
required
string
Suffix1


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/suffixes/{suffix1}
Request samples 
Response samples 
No sample
Update Suffix
Updates a specific Suffix


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
suffix1
required
string
Suffix1


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
suffix1
required
string  [ 1 .. 16 ] characters 
Suffix used with personal or entity names


 
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/suffixes/{suffix1}
Request samples 
{
  • "suffix1": "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 Suffix
Deletes an Suffix


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
suffix1
required
string
Suffix1


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/suffixes/{suffix1}
Request samples 
Create or Update Batch Suffix
Create or Update multiple Suffix 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 
suffix1
required
string  [ 1 .. 16 ] characters 
Suffix used with personal or entity names


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