Response

Create Response

Creates a new Response

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_Key
required
integer <int32>

Gets or sets the unique identifier for the response.
Note: This field is marked as NOT NULL in the database and therefore required by the API.

request_Key
integer or null <int32>

Gets or sets the unique identifier for the request associated with this response.

response_Date
string or null <date-time>

Gets or sets the date and time when the response was created.

response_Description
string or null <= 512 characters

Gets or sets the description of the response.
This field has a maximum length of 512 characters.

response_Status
string or null <= 32 characters

Gets or sets the status of the response.
This field has a maximum length of 32 characters.

response_Type
string or null <= 32 characters

Gets or sets the type of the response.
This field has a maximum length of 32 characters.

Responses
200

Success

401

Unauthorized

post/responses
Request samples
{
  • "response_Key": 0,
  • "request_Key": 0,
  • "response_Date": "2019-08-24T14:15:22Z",
  • "response_Description": "string",
  • "response_Status": "string",
  • "response_Type": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Response

Lists all Response with optional filtering by Request Key

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

requestKey
integer <int32>

Optional filter by Request Key

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


SecurityapiKeyAuth 
Request 
path Parameters
Response_Key
required
integer <int32> 
Response Key


 
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/responses/{Response_Key}
Request samples 
Response samples 
No sample
Update Response
Updates a specific Response.


SecurityapiKeyAuth 
Request 
path Parameters
Response_Key
required
integer <int32> 
Response Key


 
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_Key
required
integer <int32> 
Gets or sets the unique identifier for the response.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
request_Key
integer or null <int32> 
Gets or sets the unique identifier for the request associated with this response.


 
response_Date
string or null <date-time> 
Gets or sets the date and time when the response was created.


 
response_Description
string or null  <= 512 characters 
Gets or sets the description of the response.
This field has a maximum length of 512 characters.


 
response_Status
string or null  <= 32 characters 
Gets or sets the status of the response.
This field has a maximum length of 32 characters.


 
response_Type
string or null  <= 32 characters 
Gets or sets the type of the response.
This field has a maximum length of 32 characters.


 
Responses 
200
Success


401
Unauthorized


put/responses/{Response_Key}
Request samples 
{
  • "response_Key": 0,
  • "request_Key": 0,
  • "response_Date": "2019-08-24T14:15:22Z",
  • "response_Description": "string",
  • "response_Status": "string",
  • "response_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Response
Deletes an Response


SecurityapiKeyAuth 
Request 
path Parameters
Response_Key
required
integer <int32> 
Response Key


 
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/responses/{Response_Key}
Request samples 
Create or Update Batch Response
Create or Update multiple Response 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_Key
required
integer <int32> 
Gets or sets the unique identifier for the response.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
request_Key
integer or null <int32> 
Gets or sets the unique identifier for the request associated with this response.


 
response_Date
string or null <date-time> 
Gets or sets the date and time when the response was created.


 
response_Description
string or null  <= 512 characters 
Gets or sets the description of the response.
This field has a maximum length of 512 characters.


 
response_Status
string or null  <= 32 characters 
Gets or sets the status of the response.
This field has a maximum length of 32 characters.


 
response_Type
string or null  <= 32 characters 
Gets or sets the type of the response.
This field has a maximum length of 32 characters.


 
Responses 
207
Success


401
Unauthorized


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