Getting a Question Option
Returns a question option for a quesiton on a collect page.
Method Info
| Url | https://www.payit2.com/api/v1/collect-page/{CollectPageId}/question/{QuestionId}/option/{Id} |
|---|---|
| Verb | GET |
| Headers | X-PayItSquare-AppKey, X-PayItSquare-Token |
| {CollectPageId} | The id of the collect page. |
| {QuestionId} | The id of the question. |
| {Id} | The id of the option. |
Input
| Property | Data Type | Validation Info |
|---|---|---|
| OptionText | String | The text for the option that the user will see. |
| SortOrder | Int32 | The order that the option will be displayed. |
Output
| Property | Data Type | Other Info |
|---|---|---|
| Id | Guid | The Id of the question option. |
| OptionText | String | The text for the option that the user will see. |
| SortOrder | Int32 | The order that the option will be displayed. |
Sample Get Output
{
"Id": "46aa0b1f-d25f-4c7b-9ea7-ea64032b65fd",
"OptionText": "My Option",
"SortOrder": 2
}
Sample Input
{
"OptionText": "My Option",
"SortOrder": 2
}
Sample Success Response
{
"IsSuccess": true,
"Messages": []
}
Sample Error Response
{
"IsSuccess": false,
"Messages": [
"Error Message 1",
"Error Message 2"
]
}