Get Member Fields - PurposeOpen/Platform GitHub Wiki

GET /api/:locale/movements/:movement_id/action_pages/:id/member_fields(.:format)

Retrieves the required or missing member's fields for the requested member (identified by her email)

Parameters
movement_id`Mandatory`	Movement Id for which we want to retrieve member fields
locale`Mandatory`	Requested Action Page localized version
id`Mandatory`	Requested Action Page Id
email`Mandatory`	Requested user ember email
callback`Mandatory`	Javascript function to callback after request completion

Response

Status Code

200 if Successful

Content

Field	Description
first_name	Member's first name. See Note below for possible values
last_name	Member's last name. See Note below for possible values
country	Member's country. See Note below for possible values
postcode	Member's ZIP/Postcode (Only if country requires it). See Note below for possible values
email	Member's email. See Note below for possible values
mobile_number	Member's mobile phone number. See Note below for possible values
home_number	Member's home phone number. See Note below for possible values
suburb	Member's city / suburb. See Note below for possible values
street_address	Member's street address. See Note below for possible values

#####Note: These fields can have any of the following values or not be present at all (if hidden on action page): required, optional or refresh.

Example Request

GET /api/en/movements/test-movement/action_pages/1234/member_fields.json Content-Type: application/x-www-form-urlencoded

callback=jQuery17102797016181781271_1364302780656&email=john.doe%40example.com

Example Response

200 (OK) Content-Type: application/json

jQuery17102797016181781271_1364302780656(
{"member_fields":
	{
		"first_name":"required",
		"last_name":"required",
		"country":"required",
		"postcode":"refresh",
		"mobile_number":"optional",
		"home_number":"optional",
		"suburb":"optional",
		"street_address":"optional",
		"email":"required"
	}
})

Remark: Depends on fields configured as required, optional, refresh or hidden (not retrieved).

back