Author

Examples

The following are generalized examples. Actual authors will vary based on configurations. Continue to the Fields section for information on each field.

{  
    "id":"0006f2fa-fa8a-51e6-8241-86979a2edb21",  
    "type":"author",  
    "client":"example-client",  
    "creationTime":"2016-08-30T01:31:11.760Z",  
    "lastModificationTime":"2016-08-30T15:45:10.486Z",  
    "legacyId":"78942450",  
    "submissionId":"qekz0odjlk8utw7y4n4ht8qtm",  
    "submissionTime":"2016-08-30T01:31:06.000Z",  
    "displayCode":"1234-en_au",  
    "authorBadgeEnabled":true,  
    "badges":[  
      {  
        "id":"staff",  
        "contentType":"REVIEWER",  
        "badgeType":"AffiliationBadge"  
      },  
      {  
        "id":"top1000Contributor",  
        "contentType":"REVIEWER",  
        "badgeType":"TopContributorBadge"  
      }  
    ],  
    "anonymous":false,  
    "authorRank":"NONE",  
    "externalId":"iqu8rjmy9zswwljev8opgm9yj",  
    "language":"en",  
    "displayName":"ugclover45",  
    "displayLocale":"en_AU",  
    "status": "APPROVED"  
  }

Relationships

Review

Refer to the Review Reference to learn how to join authors and reviews.

Comment

Refer to the Comment Reference to learn how to join authors and comments.

Question

Refer to the Question Reference to learn how to join authors and questions.

Answers

Refer to the Answer Reference to learn how to join authors and answers.

Fields

Anonymous

"anonymous":true

Anonymous authors are created when content is submitted to Bazaarvoice without an identifier. Anonymous authors will not have a display name.

Author badge enabled

"authorBadgeEnabled":true,

Indicates if the author is eligible for contributor level badges.

📘

Native Authors Only

This field will not be present on syndicated authors.

Author rank

"authorRank":"NONE"

Authors can be assigned a rank to identify them as having special skills, for example "EXPERT". This field is customizable; Other values are possible. Refer to the Badges tutorial in the Conversations API for more information.

📘

Native Authors Only

This field will not be present on syndicated authors.

Badges

"badges":[  
  {  
    "id":"staff",  
    "contentType":"REVIEWER",  
    "badgeType":"AffiliationBadge"  
  },  
  {  
    "id":"top1000Contributor",  
    "contentType":"REVIEWER",  
    "badgeType":"TopContributorBadge"  
  }  
],

A list of badges assigned to the Author. Refer to the Badges tutorial in the Conversations API information about badges, including recommended UI treatment.

📘

Native Authors Only

This field will not be present on syndicated authors.

Client

"client":"example-client"

The client from where this content originates. The source client.

📘

If this value is not your client name, then this content has been syndicated to you from the client identified.

Creation time

"creationTime":"2016-08-30T01:31:11.760Z"

When the content was created in the Bazaarvoice system.

Display code

"displayCode":"1234-en_au"

The display code associated with this author. Refer to the Configuration reference for more information.

📘

Native Authors Only

This field will not be present on syndicated authors.

Display locale

"displayLocale":"en_AU"

The locale associated with this author.

Display name

"displayName":"ugclover45",

The content authors public persona. This field will not be available on anonymous authors.

External ID

"externalId":"iqu8rjmy9zswwljev8opgm9yj"

The identifier for the content provided by content owner. This value is created by Bazaarvoice when an author is submitted anonymously.

ID

"id":"0006f2fa-fa8a-51e6-8241-86979a2edb21"

Universally unique value identifying item. This ID is generated by Bazaarvoice.

Last modification time

"lastModificationTime":"2016-08-30T15:45:10.486Z"

When this content was most recently modified.

Legacy ID

"legacyId":"78942450"

This identifier is used in the Bazaarvoice portal (AKA: Workbench) and standard export feeds. It is not guaranteed to be unique across clients.

Language

"language":"en"

The language associated with the author.

Status

"status":"APPROVED"

The moderation status of the author. Common values include:

• APPROVED

  The author has been moderated and is safe for public display.

• NONE

  The author is not eligible for moderation and should not be considered safe for public display.

• REJECTED

  The author has been moderated and is not safe for public display.

• SUBMITTED

  The author has not been moderated yet and should not be considered safe for public display.

🚧

Author records that are not approved are not safe for public display and therefore will only include a subset of information.

It is possible for content to be approved while the corresponding author is not. In this event we recommend you continue to display the content without the author information.

Submission ID

"submissionId":"qekz0odjlk8utw7y4n4ht8qtm"

The unique identifier assigned to content when it was submitted. This ID exists only on native content generated on your site. It does not exist on syndicated content or on native content generated through a manual import.

Submission time

"submissionTime":"2016-08-30T01:31:06.000Z"

When the content was submitted.

Type

"type":"author"

The content type.