ResponseStatus

Create ResponseStatus

Creates a new ResponseStatus

SecurityapiKeyAuth
Request
header Parameters
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Request Body schema:
required
response_Status
required
string [ 1 .. 32 ] characters
description
string or null <= 256 characters
Responses
200

Success

401

Unauthorized

post/response-statuses
Request samples
{
  • "response_Status": "string",
  • "description": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ResponseStatus

Lists all ResponseStatus

SecurityapiKeyAuth
Request
query Parameters
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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/response-statuses
Request samples 
Response samples 
No sample
Get ResponseStatus
Gets ResponseStatus


SecurityapiKeyAuth 
Request 
path Parameters
Response_Status
required
string
Response Status


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/response-statuses/{Response_Status}
Request samples 
Response samples 
No sample
Update ResponseStatus
Updates a specific ResponseStatus.


SecurityapiKeyAuth 
Request 
path Parameters
Response_Status
required
string
Response Status


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
response_Status
required
string  [ 1 .. 32 ] characters 
 
description
string or null  <= 256 characters 
 
Responses 
200
Success


401
Unauthorized


put/response-statuses/{Response_Status}
Request samples 
{
  • "response_Status": "string",
  • "description": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ResponseStatus
Deletes an ResponseStatus


SecurityapiKeyAuth 
Request 
path Parameters
Response_Status
required
string
Response Status


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/response-statuses/{Response_Status}
Request samples 
Create or Update Batch ResponseStatus
Create or Update multiple ResponseStatus at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth 
Request 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
 Array 
response_Status
required
string  [ 1 .. 32 ] characters 
 
description
string or null  <= 256 characters 
 
Responses 
207
Success


401
Unauthorized


put/response-statuses-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}