NGngpvan

/stories/{storyId}

Changed on

Use this endpoint to retrieve the details of a specific Story.

Returns a standard Story object, if found.

If the specified Story does not exist, this endpoint will return an error with HTTP Status Code 404 Not Found.

get/stories/{storyId}

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/stories/{storyId}
  • Auth
    HTTP basic

Path parameters

storyIdinteger required

Required; unique identifier of the story to be retrieved

Response

200

storyIdinteger
titlestring
storyTextstring
vanIdinteger
campaignIdinteger

Example response

{
  "storyId": 123,
  "title": "Jane Eyre",
  "storyText": "There was no possibility of taking a walk that day.",
  "storyStatus": {
    "storyStatusId": 1,
    "statusName": "Submitted"
  },
  "vanId": 1000000000,
  "tags": [
    {
      "codeId": 123,
      "codeName": "Book"
    }
  ],
  "campaignId": 123456
}

Changes