Response fields - PurposeOpen/Platform GitHub Wiki
| Field | Description |
|---|---|
| iso_code | Language's ISO code. i.e.: "en', "es" |
| name | Language's name in English. i.e.: "English", "Spanish" |
| native_name | Language's name in native language. i.e.: "English", "Español" |
| is_default | Boolean value indicating if language is default for movement |
| Field | Description |
|---|---|
| id | Featured content's internal ID |
| featured_content_collection_id | Featured content collection's internal ID |
| button_text | Button text |
| created_at | Featured content creation date |
| updated_at | Featured content last update date |
| description | Featured content description text. Note: Might contain unescaped HTML |
| image | Featured content associated image as an <img> tag |
| language_id | Featured content associated language's ID |
| position | Zero-based featured content disposition on the sequence |
| title | Featured content title text. Note: Might contain unescaped HTML |
| url | Absolute or relative URL associated with the featured content |
| date | deprecated |
| Field | Description |
|---|---|
| Movement's Facebook page URL | |
| flickr | Movement's Flickr page URL |
| orkut | Movement's Orkut page URL |
| tumblr | Movement's Tumblr page URL |
| Movement's Twitter page URL | |
| youtube | Movement's YouTube page URL |
| 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 |
| 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 |
| Field | Description |
|---|---|
| id | Member's internal ID |
| first_name | Member's first name |
| last_name | Member's last name |
| Member's email address | |
| country_iso | Member's country ISO code |
| postcode | Member's ZIP/Postcode |
| home_number | Member's home phone number |
| mobile_number | Member's mobile phone number |
| street_address | Member's street address |
| suburb | Member's suburb |
| Field | Description |
|---|---|
| id | Activity Id |
| html | Activity HTML content; it depends on User Activity Type:, i.e: {"if Activity Type = 'Subscribed' then retrieves Ask Module HTML content, else if Activity Type ='ActionTaken' then retrieves Content Module HTML content, else if Activity Type = 'EmailClicked' then returns "#{member_name} Member clicked a link in the #{email.name} email.", else if Activity Type = 'EmailViewed' then returns "#{member_name} Member opened the #{email.name} email." , else if Activity Type = 'Unsubscribed' then returns "#{member_name} Member unsuscribed from #{email.name}!"} |
| timestamp | Activity Creation Date |
| timestamp_in_words | Activity Creation Formatted Date |
| first_name | User first name |
| last_name | User last name |
| country_iso | User country iso |
| country | User country |
| Field | Description |
|---|---|
| alternate_key | Content Module alternate Identifier |
| content | Content Module HTML content |
| created_at | Content Module Creation Date |
| id | Content Module Identifier |
| language_id | Content Module Language Identifier |
| live_content_module_id | Content Module Live Identifier |
| options | Content Module Options Hash, i.e: {"button_text":"ACT NOW","petition_statement":"lorep ip sum...", "signatures_goal":999987,"thermometer_threshold":100,"comments_enabled":"1", "comment_label":"Comment:","comment_text":"This is the pre-populated comment text...","disabled_title":"foo", "disabled_content":"bar","active":"true"} |
| public_activity_stream_template | Template with place-holders to record the users activity events on current Module |
| title | Content Module Title |
| updated_at | Content Module Updated Date |
| type | Content Module Type, possible values are ('HtmlModule','PetitionModule','TellAFriendModule','JoinModule','AccordionModule', 'UnsubscribeModule','DonationModule','EmailTargetsModule','TaxDeductibleDonationModule', |
| Field | Description |
|---|---|
| action_sequence_id | Action page sequence identifier |
| alternate_key | Action page Alternate Identifier |
| content_page_collection_id | Related Collection id |
| created_at | Action page creation date |
| created_by | Action page User Name created by |
| crowdring_campaign_name | Campaign Name related to current action page |
| deleted_at | Action page deletion date |
| id | Action page identifier |
| live_page_id | Action page live identifier |
| movement_id | Movement identifier related to current action page |
| name | Action page Name |
| paginate_main_content | Flag to indicate if main action page content should be paginated or not |
| position | Action page position |
| required_user_details | See Member Required Fields |
| slug | Action Page slug |
| updated_at | Action page updated date |
| updated_by | User Name created by |
| views | Number of times viewed by users |
| Field | Description |
|---|---|
| Facebook shares count | |
| Twitter shares count | |
| Email to a Friend shares count |