Get Movement - PurposeOpen/Platform GitHub Wiki

GET /api/:locale/movements/:movement_id(.:format) Returns movement and homepage info

Parameters
movement_id
Mandatory
Required Movement Identifier
locale
Mandatory
Movement content 's locale

Response

Status Code

200 If Successful
404 If Not Found

Content

Field Description
languages Collection of supported languages. See Language
recommended_languages_to_display Collection of suggested languages to display on site. See Language
banner_text Homepage's Counter Text
featured_contents Carousel and FeaturedActions collections. See Featured Content
banner_image Logo image URL
join_headline Headline text
join_message Join text
follow_links Social accounts. See Social Accounts
header_navbar Header navigation content.
Note: Contains unescaped HTML
footer_navbar Footer navigation content.
Note: Contains unescaped HTML

Example Request

GET /api/en/movements/movement.json

Example Response

200 (OK)
Content-Type: application/json

{"languages":[
        {"iso_code":"en","name":"English","native_name":"English","is_default":true},
        {"iso_code":"es","name":"Spanish","native_name":"Espa\u00f1ol","is_default":false}
    ],
 "recommended_languages_to_display":[
        {"iso_code":"en","name":"English","native_name":"English","is_default":true},
        {"iso_code":"es","name":"Spanish","native_name":"Espa\u00f1ol","is_default":false}
    ],
 "banner_text":"<span class='member_count'>131,233</span> HAVE JOINED THE MOVEMENT",
 "featured_contents":{
    "Carousel":[
        {"button_text":"SIGN",
         "created_at":"2012-06-01T20:04:02Z",
         "date":"",
         "description":"description of carousel item",
         "featured_content_collection_id":21,
         "id":461,
         "image":"https://s3.amazonaws.com/bucket/image.jpg",
         "language_id":1,
         "position":0,
         "title":"carousel item title",
         "updated_at":"2012-12-12T20:12:14Z",
         "url":"http://www.movement.org/en/actions/action_name"
        }
    ],
    "FeaturedActions":[
        {"button_text":"Sign >",
         "created_at":"2012-06-01T20:04:02Z",
         "date":"",
         "description":"featured content item description",
         "featured_content_collection_id":31,
         "id":501,
         "image":"<img src=\"https://s3.amazonaws.com/bucket/image.jpeg\" /><figcaption>caption</figcaption>",
         "language_id":1,
         "position":0,
         "title":"<span>\"title\" -</span><br/><span>title line 2</span>",
         "updated_at":"2012-09-21T22:27:28Z",
         "url":"/actions/action_name"
        }
    ]
 },
 "banner_image":"//platform.s3.amazonaws.com/image.png",
 "join_headline":"HEADLINE",
 "join_message":"Will you join the movement?",
 "follow_links":{
     "facebook":"https://www.facebook.com/page",
     "flickr":"",
     "orkut":"",
     "tumblr":"http://name.tumblr.com/",
     "twitter":"https://twitter.com/#!/account",
     "youtube":"https://www.youtube.com/user/username"
 },
 "footer_navbar":"footer html"
}

back

⚠️ **GitHub.com Fallback** ⚠️