Getting a Question
Returns a question for a collect page.
Method Info
| Url | https://www.payitsquare.com/api/v1/collect-page/{CollectPageId}/question/{Id} |
|---|---|
| Verb | GET |
| Headers | X-PayItSquare-AppKey, X-PayItSquare-Token |
| {CollectPageId} | The id of the collect page. |
| {Id} | The id of the question. |
Input
| Property | Data Type | Validation Info |
|---|---|---|
| QuestionType | Int32 | This is the type of control to use for this question. Pay It Square supports the following question types: Text Box (1), Text Area (2), Drop Down (3), Checkbox (4), Number (5). and Short Text Box (6) |
| QuestionText | String | The text to use for the question |
| IsRequired | Boolean | When true, payers must enter a value to continue |
| SortOrder | Int32 | This determines the order that the question will display on the collect page. |
Output
| Property | Data Type | Other Info |
|---|---|---|
| Id | Guid | The id of the question. This will be needed for calls to update or delete the individual question. |
| QuestionType | Int32 | This is the type of control to use for this question. Pay It Square supports the following question types: Text Box (1), Text Area (2), Drop Down (3), Checkbox (4), Number (5). and Short Text Box (6) |
| QuestionText | String | The text to use for the question |
| IsRequired | Boolean | When true, payers must enter a value to continue |
| SortOrder | Int32 | This determines the order that the question will display on the collect page. |
Sample Get Output
{
"Id": "8ee90c52-ac87-4e12-aebf-a15c1e2d5d16",
"QuestionType": 1,
"QuestionText": "My Question",
"IsRequired": true,
"SortOrder": 3
}
Sample Input
{
"QuestionType": 1,
"QuestionText": "My Question",
"IsRequired": true,
"SortOrder": 3
}
Sample Success Response
{
"IsSuccess": true,
"Messages": []
}
Sample Error Response
{
"IsSuccess": false,
"Messages": [
"Error Message 1",
"Error Message 2"
]
}
