/v1/community/get_board_about_post_candidates
#Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
boardId |
int |
No |
0 |
ATDiscussionBoards.ID. |
forumAlias |
string |
No |
"" |
Optional v2 forum alias fallback. |
searchFilter |
string |
No |
"" |
Search text for board posts by title, body, or author alias. |
postID |
int |
No |
0 |
Exact ATDiscussionPosts.ID to preview. |
pageSize |
int |
No |
8 |
Maximum candidates to return. |
minimumImageMediaCount |
int |
No |
2 |
Minimum attached image-media items required. |
Request example (cURL)
curl --get \
'https://ca.appointmenttrader.com/v1/community/get_board_about_post_candidates' \
--data-urlencode 'key={{API_KEY}}' \
--data-urlencode 'boardId={{boardId}}' \
--data-urlencode 'forumAlias={{forumAlias}}' \
--data-urlencode 'searchFilter={{searchFilter}}' \
--data-urlencode 'postID={{postID}}' \
--data-urlencode 'pageSize={{pageSize}}' \
--data-urlencode 'minimumImageMediaCount={{minimumImageMediaCount}}'
Returns
JSON Response fields
| Field | Type | Required | Description |
|---|---|---|---|
$ | community_get_board_about_post_candidates_Response |
Yes | |
$.oneOf[0] | |
Yes | |
$.oneOf[0].allOf[0] | object |
Yes | |
$.oneOf[0].allOf[0].RequestUserAlias | string |
Yes | |
$.oneOf[0].allOf[0].RequestPath | string | null |
Yes | |
$.oneOf[0].allOf[0].RequestStatus | = "Succeeded" |
Yes | |
$.oneOf[0].allOf[0].ResponseCode | integer |
Yes | |
$.oneOf[0].allOf[0].ResponseMessage | APIResponseMessage |
Yes | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0] | string | number | boolean | null |
Yes | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1] | array |
Yes | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][] | APIResponseMessage |
No | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2] | object |
Yes | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].* | APIResponseMessage |
No | |
$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias | string |
No | |
$.oneOf[0].allOf[1] | object |
Yes | |
$.oneOf[0].allOf[1].Payload | object |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates | array |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[] | object |
No | |
$.oneOf[0].allOf[1].Payload.Candidates[].id | integer |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].title | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].bodyPreview | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].url | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].createdDate | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author | AboutPostAuthor |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0] | object |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].id | integer |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].alias | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].avatarEmoji | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].profileUrl | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1] | object |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].id | null |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].alias | null |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].avatarEmoji | null |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].profileUrl | null |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].identityHidden | = true |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].identityHiddenUntil | integer |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].board | object |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].board.id | integer |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].board.name | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].board.slug | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].board.type | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].imageMediaCount | integer |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].media | array |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].media[] | object |
No | |
$.oneOf[0].allOf[1].Payload.Candidates[].media[].id | integer |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].media[].thumbUrl | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].media[].mediaUrl | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].media[].mediaType | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].media[].width | integer |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].media[].height | integer |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].media[].title | string |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].media[].isImage | boolean |
Yes | |
$.oneOf[0].allOf[1].Payload.Candidates[].media[].isEmbedded | boolean |
Yes | |
$.oneOf[0].allOf[1].Payload.Page | object |
Yes | |
$.oneOf[0].allOf[1].Payload.Page.pageSize | integer |
Yes | |
$.oneOf[0].allOf[1].Payload.Page.minimumImageMediaCount | integer |
Yes | |
$.oneOf[0].allOf[1].Payload.Page.boardId | integer |
Yes | |
$.oneOf[1] | object |
Yes | |
$.oneOf[1].RequestUserAlias | string |
Yes | |
$.oneOf[1].RequestPath | string | null |
Yes | |
$.oneOf[1].RequestStatus | = "Failed" |
Yes | |
$.oneOf[1].ResponseCode | integer |
Yes | |
$.oneOf[1].ResponseMessage | APIResponseMessage |
Yes | |
$.oneOf[1].ResponseMessage.oneOf[0] | string | number | boolean | null |
Yes | |
$.oneOf[1].ResponseMessage.oneOf[1] | array |
Yes | |
$.oneOf[1].ResponseMessage.oneOf[1][] | APIResponseMessage |
No | |
$.oneOf[1].ResponseMessage.oneOf[2] | object |
Yes | |
$.oneOf[1].ResponseMessage.oneOf[2].* | APIResponseMessage |
No | |
$.oneOf[1].RequestImpersonatedByUserAlias | string |
No |
Response example
{
"RequestStatus": "Succeeded",
"ResponseCode": 100,
"ResponseMessage": "Synthetic success example.",
"RequestPath": "/v1/community/get_board_about_post_candidates",
"RequestUserAlias": "example-user",
"Payload": {
"Candidates": [],
"Page": {
"pageSize": 0,
"minimumImageMediaCount": 0,
"boardId": 0
}
}
}