RequestQuestion

Create RequestQuestion

Creates a new RequestQuestion

SecurityapiKeyAuth
Request
path Parameters
Request_Key
required
integer <int32>

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

Request Body schema:
required
request_Key
required
integer <int32>

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

requestQuestionConfig_Key
required
integer <int32>

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

answerDate
string or null <date-time>

Gets or sets the date when the answer was provided.

answerMulti
string or null

Gets or sets the multi-choice answer provided by the user.

answerNumeric
number or null <double>

Gets or sets the numeric answer provided by the user.

answerRadio
string or null

Gets or sets the radio button answer provided by the user.

answerText
string or null <= 512 characters

Gets or sets the text answer provided by the user. This field has a maximum length of 512 characters.

answerYesNo
string or null <= 1 characters

Gets or sets the yes/no answer provided by the user. This field has a maximum length of 1 character.

question_Date
string or null <date-time>

Gets or sets the date when the question was asked.

Responses
200

Success

401

Unauthorized

post/requests/{Request_Key}/questions
Request samples
{
  • "request_Key": 0,
  • "requestQuestionConfig_Key": 0,
  • "answerDate": "2019-08-24T14:15:22Z",
  • "answerMulti": "string",
  • "answerNumeric": 0.1,
  • "answerRadio": "string",
  • "answerText": "string",
  • "answerYesNo": "s",
  • "question_Date": "2019-08-24T14:15:22Z"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List RequestQuestion

Lists all RequestQuestion for the given Request_Key

SecurityapiKeyAuth
Request
path Parameters
Request_Key
required
integer <int32>

Request Key

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/requests/{Request_Key}/questions
Request samples 
Response samples 
No sample
Get RequestQuestion
Gets RequestQuestion


SecurityapiKeyAuth 
Request 
path Parameters
Request_Key
required
integer <int32> 
Request Key


 
RequestQuestionConfig_Key
required
integer <int32> 
RequestQuestionConfig 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/requests/{Request_Key}/questions/{RequestQuestionConfig_Key}
Request samples 
Response samples 
No sample
Update RequestQuestion
Updates a specific RequestQuestion.


SecurityapiKeyAuth 
Request 
path Parameters
Request_Key
required
integer <int32> 
Request Key


 
RequestQuestionConfig_Key
required
integer <int32> 
RequestQuestionConfig 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
request_Key
required
integer <int32> 
Gets or sets the unique identifier for the request associated with this question.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
requestQuestionConfig_Key
required
integer <int32> 
Gets or sets the unique identifier for the question configuration.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
answerDate
string or null <date-time> 
Gets or sets the date when the answer was provided.


 
answerMulti
string or null
Gets or sets the multi-choice answer provided by the user.


 
answerNumeric
number or null <double> 
Gets or sets the numeric answer provided by the user.


 
answerRadio
string or null
Gets or sets the radio button answer provided by the user.


 
answerText
string or null  <= 512 characters 
Gets or sets the text answer provided by the user.
This field has a maximum length of 512 characters.


 
answerYesNo
string or null  <= 1 characters 
Gets or sets the yes/no answer provided by the user.
This field has a maximum length of 1 character.


 
question_Date
string or null <date-time> 
Gets or sets the date when the question was asked.


 
Responses 
200
Success


401
Unauthorized


put/requests/{Request_Key}/questions/{RequestQuestionConfig_Key}
Request samples 
{
  • "request_Key": 0,
  • "requestQuestionConfig_Key": 0,
  • "answerDate": "2019-08-24T14:15:22Z",
  • "answerMulti": "string",
  • "answerNumeric": 0.1,
  • "answerRadio": "string",
  • "answerText": "string",
  • "answerYesNo": "s",
  • "question_Date": "2019-08-24T14:15:22Z"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete RequestQuestion
Deletes an RequestQuestion


SecurityapiKeyAuth 
Request 
path Parameters
Request_Key
required
integer <int32> 
Request Key


 
RequestQuestionConfig_Key
required
integer <int32> 
RequestQuestionConfig 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/requests/{Request_Key}/questions/{RequestQuestionConfig_Key}
Request samples 
Create or Update Batch RequestQuestion
Create or Update multiple RequestQuestion at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth 
Request 
path Parameters
Request_Key
required
integer <int32> 
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


 
Request Body schema: 
required
 Array 
request_Key
required
integer <int32> 
Gets or sets the unique identifier for the request associated with this question.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
requestQuestionConfig_Key
required
integer <int32> 
Gets or sets the unique identifier for the question configuration.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
answerDate
string or null <date-time> 
Gets or sets the date when the answer was provided.


 
answerMulti
string or null
Gets or sets the multi-choice answer provided by the user.


 
answerNumeric
number or null <double> 
Gets or sets the numeric answer provided by the user.


 
answerRadio
string or null
Gets or sets the radio button answer provided by the user.


 
answerText
string or null  <= 512 characters 
Gets or sets the text answer provided by the user.
This field has a maximum length of 512 characters.


 
answerYesNo
string or null  <= 1 characters 
Gets or sets the yes/no answer provided by the user.
This field has a maximum length of 1 character.


 
question_Date
string or null <date-time> 
Gets or sets the date when the question was asked.


 
Responses 
207
Success


401
Unauthorized


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