Application API Profile qanda GET

#/qanda [GET]

Retrieve Question & Answer sections of a member’s profile - protected.

Returns the long-form profile sections with questions and answers localized. Also returns the My Match criteria values for the member.

Parameters

• profileid (numeric) [REQUIRED] - the ID of the profile for which you want data; must be an accessible profile

Response Messages

403 Forbidden

If profileid is missing or invalid (including not accessible to the current member).

{ "fail" : "Invalid Argument" }

200 OK - success

The response contains a qanda array of sections and a criteria map of My Match criteria values.

{
  "qanda" : [

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, a localized value string, the original field_value (non-localized), and an optional note which may contain free-form text entered by members. As with the /questions API, a field may optionally have a notes boolean entry which indicates whether the named field also accepts an associated notes field. This may be present and true even when note is not present (indicating that this member did not provide any additional text with the field).

        { "label" : "Family Roots",
          "name" : "FamilyRoots", // legacy name
          "field_name" : "family_roots", // modern name
          "required" : true,
          "value" : "Afghan",
          "field_value" : "AF",
          "note" : "..." },
        { "label" : "...", "name" : "...", "value" : "..." },
        ...
      ] },
    { "label" : "...", "fields" : [ ... ] },
    ...      
  ],
  "criteria" : {

See GET /members/self/criteria for the format of this section.

  }
}

In addition, if you are retrieving the Question & Answer data for the current authenticated member, you may also get value_moderated and note_moderated fields, indicating changes submitted by the current member that are still awaiting approval by our Customer Service team.