Application API Profile questions GET

#/questions [GET]

Retrieve Question & Label/Value pairs in sections for a profile - protected.

Returns the long-form profile sections with questions and labels/values localized.

Parameters

None.

Response Messages

200 OK - success

The response is a questions array of sections.

{
  "questions" : [

Each section has a localized label, an internal name, an array of fields, and an optional localized comment describing the section in more detail. The name is provided so that clients may choose to style sections differently, based on the name of the section.

    { "label" : "...",
      "name" : "...",
      "comment" : "...",
      "fields" : [

Each field has a localized label, a legacy field name and a modern field_name (the latter is to be used when POSTing registration or profile data back to the server; the former is provided for backward compatibility with older code), a required flag indicating whether this is a mandatory field, and a values array. A field may optionally have a notes boolean entry which indicates whether the named field also accepts an associated notes field, with _notes appended to the name. This is an optional text field where members can add explanatory comments along with the selected value (usually for fields that are ratings, on a 1..5 scale).

        { "label" : "Family Roots",
          "name" : "FamilyRoots", // legacy name
          "field_name" : "family_roots", // modern name
          "required" : false,
          "values" : [

The values array is either empty ([]) indicating this is a free text field which can contain member-supplied information, or it is an array of localized label / actual value pairs that can be used in a select drop-down or set of radio buttons.

            { "label" : "Afghan",
              "value" : "AF" },
            { "label" : "...", "value" : "..." },
            ...
          ] },
        { "label" : "...", "name" : "...", "values" : [] },
        ...
      ] },
    { "label" : "...", "fields" : [ ... ] },
    ...
  ]
}