Back to endpoints

Get a person's extra questions answers for a program

GET api/V3/{language}/org/{orgIdentifier}/programs/{id}/extraQuestions/{personId}

Get all extra question answers for a person in a program.

Request Information

URI Parameters

PARAMETERS
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

Required
orgIdentifier (string)

Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'.

Required
id (integer)

Program id

Required
personId (integer)

Id of the person to get all extra question answers.

Required

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
ExtraQuestionId (integer)
Question (string)
Answer (string)
AnswerType (string)

Response Formats

CODE SAMPLE JSON
[
  {
    "ExtraQuestionId": 1,
    "Question": "Do you have any allergies?",
    "Answer": "Nuts, Dairy, Grains, Meat.",
    "AnswerType": null
  },
  {
    "ExtraQuestionId": 1,
    "Question": "Do you have any allergies?",
    "Answer": "Nuts, Dairy, Grains, Meat.",
    "AnswerType": null
  }
]