Action Page Preview - PurposeOpen/Platform GitHub Wiki

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

Gets the preview of the Action Page with the requested ID

Parameters
movement_id `Mandatory`	Movement Id for which we want to request the Action Page Preview
locale `Mandatory`	Requested Action Page localized version
id `Mandatory`	Requested Action Page Id Preview

Response

Status Code

200 If Successful
404 If Not Found

Content

Field	Description
id	Action page identifier
name	Action page name
type	Action page type
is_join_page	Flag that mark an action page as a join oage
member_count	Action page member count
facebook_title	Action page title to display on Facebook
facebook_description	Action page description to display on Facebook
facebook_image_url	Action page image url to display on Facebook
actions_taken_count	Users action taken count
shares	User shares count
*Headers Content Modules Field's* i.e.: alternate_key, content, created_at, etc.	See Content Module
*Main Content Modules Field's* i.e.: alternate_key, content, created_at, etc.	See Content Module
*SideBar Content Modules Field's* i.e.: alternate_key, content, created_at, etc.	See Content Module
*Footer Content Modules Field's* i.e.: alternate_key, content, created_at, etc.	See Content Module

Example Request

GET /api/en/movements/test-movement/action_pages/909/preview.json

Example Response

200 (OK)
Content-Type: application/json

{
    "facebook_title": "This is the Facebook title",
    "facebook_description": "This is the Facebook description",
    "facebook_image_url": "//platform.s3.amazonaws.com/action_page_image.jpeg",
    "actions_taken_count": 1,
    "shares": null,
    "footer_content_modules": [],
    "first_name": "required",
    "last_name": "refresh",
    "country": "required",
    "postcode": "required",
    "mobile_number": "optional",
    "home_number": "optional",
    "suburb": "optional",
    "street_address": "optional",
    "email": "required",
    "id": 909,
    "name": "Page Title",
    "type": "ActionPage",
    "header_content_modules": [{
        "alternate_key": null,
        "content": "Header content",
        "created_at": "2013-01-01T00:00:00Z",
        "id": 101,
        "language_id": 1,
        "live_content_module_id": null,
        "options": {},
        "public_activity_stream_template": null,
        "title": null,
        "updated_at": "2013-01-01T00:00:00Z",
        "type": "HtmlModule"
    }],
    "main_content_modules": [{
        "alternate_key": null,
        "content": "<img alt=\"\" src=\"//platform.s3.amazonaws.com/action_page_image.jpeg\">",
        "created_at": "2013-01-01T00:00:00Z",
        "id": 102,
        "language_id": 1,
        "live_content_module_id": null,
        "options": {},
        "public_activity_stream_template": null,
        "title": null,
        "updated_at": "2013-01-01T00:00:00Z",
        "type": "HtmlModule"
    }],
    "sidebar_content_modules": [{
        "alternate_key": null,
        "content": "Sidebar content",
        "created_at": "2013-01-01T00:00:00Z",
        "id": 103,
        "language_id": 1,
        "live_content_module_id": null,
        "options": {
            "button_text": "Join",
            "comments_enabled": "1",
            "active": "true",
            "petition_statement": "Petition statement text.",
            "disabled_title": "",
            "disabled_content": "",
            "signatures_goal": 1000,
            "thermometer_threshold": 1,
            "comment_label": "Comment label",
            "comment_text": "Comment text placeholder"
        },
        "public_activity_stream_template": "{NAME|A member}, {COUNTRY|}<br/>[{HEADER}]",
        "title": "TO : Everyone",
        "updated_at": "2013-01-01T00:00:00Z",
        "type": "PetitionModule",
        "signatures": 1
    }],
    "is_join_page": false,
    "member_count": "15,000"
}

back