Author
This page describes the response Author resource. The Author resource is the writer of the review response.
Request
To access interactive tools and applications that will help you work with the Response API, refer to Tools.
The following code block shows a sample request.
GET https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/{responseGUID}/author?passkey={RESPONSE_API_PASSKEY} HTTP/1.1
Authorization: Bearer {ACCESS_TOKEN}
...
Ellipses (…) in above example indicate that your app may generate other headers.
Older applications may be using https://[stg.]api.bazaarvoice.com/contentmanagement as the base URL for the Response API, instead of https://[stg.]api.bazaarvoice.com/response. The contentmanagement URL has been deprecated. However, Bazaarvoice will continue to support applications that use the contentmanagement URL until further notice.
Parameters
Name | Description | Required |
---|---|---|
Path | ||
responseGuid | The ID for a given response. | Yes |
QueryString | ||
passkey | Response API passkey. | Yes |
Header | ||
Authorization | The Authorization value will consist of the string Bearer followed by the OAuth2 access token. Refer to OAuth2 Integration for more information. | Yes |
Response
Header
HTTP status 200 indicates success. Other header values are documented in the API Reference.
Body
A successful response will contain a JSON object in the body. The following demonstrates a typical successful creation of a client response:
{
"data": {
"type": "author",
"id": "1"
},
"links": {
"self": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/author",
"related": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/author"
}
}
The response syntax follows the JSON API specification, exposing data
, links
, and relationships
nodes.
Errors
To fix common Response API errors, refer to Troubleshooting.
Updated 8 months ago