Advocacy Campaign

This document defines the Advocacy Campaign resource.

Advocacy campaigns represent an advocacy action directed at targets such as elected officials that a user may participate in by contacting those officials in some way, such as via email or phone. Advocacy campaigns have fields to describe them such as names, titles, summaries, descriptions, and targeting information, and when activists participate in an advocacy campaign, Outreach resources are created representing the individual outreach an activist made to a target as part of that advocacy campaign.

Sections

Endpoints and URL structures

OSDI does not specify specific endpoints and link structures for compliant systems to use. Rather, because OSDI is a HAL+JSON API, endpoints and structures are defined in the links section of each returned resource, starting with the API Entry Point link.

HAL’s link structure lets an API consumer move through API levels, resources, and collections by parsing and following links. While most systems will not change the value of their links often and obey RESTful design principles, the value of each link when that resource is retrieved is the only canonical value, and it can change at any time.

The link relation label for an Advocacy Campaign resource is osdi:advocacy_campaign for a single Advocacy Campaign resource or osdi:advocacy_campaigns for a collection of Advocacy Campaign resources.

Back to top…

Fields

The field names for this resource, with standard names, punctuation and capitalization, and values where appropriate.

Note: As with the entire OSDI specification, the specific fields a compliant system implements will vary between each system, as will the fields each system requires when creating or updating resources, which fields are writeable, and the operations you are allowed to perform on each resource.

Common Fields

A set of common fields that appear on all resources is included first, for reference.

Name Type Description
identifiers strings[] A unique string array of identifiers in the format [system name]:[id]. See the general concepts document for more information about identifiers.
created_date datetime A read-only property representing the date and time the resource was created on the local system.
modified_date datetime A read-only property representing the date and time the resource was last modified on the local system.

Back to top…

Advocacy Campaign Fields

A list of fields specific to the Advocacy Campaign resource.

Name Type Description
origin_system string A human readable identifier of the system where this advocacy campaign was created. (ex: “OSDI System”)
name string The name of the advocacy campaign. Intended for administrative display rather than a public title, though may be shown to a user.
title string The title of the advocacy campaign. Intended for public display rather than administrative purposes.
description string A description of the advocacy campaign, usually displayed publicly. May contain text and/or HTML.
summary string A text-only single paragraph summarizing the advocacy campaign. Shown on listing pages that have more than titles, but not enough room for full description.
targets string A human readable description of the target universe for this advocacy campaign. (ex: “U.S. Congress”)
browser_url string A URL string pointing to the publicly available advocacy campaign page on the web.
featured_image_url string A URL string pointing to a publicly available featured image file for this advocacy campaign on the web.
total_outreaches integer A read-only computed property representing the current count of the total number of outreaches on the advocacy campaign.
type flexunum The type of advocacy campaign, specifying how users perform outreaches to targets. One of “email”, “in-person”, “phone”, “postal mail”, or another type as needed.
share_url string A URL string pointing to the page that will be shared when this content is shared.
total_shares integer A computed property representing the current count of the total number of times the content has been shared by activists.
share_options ShareOptions[] An array of share options objects representing the default language and attributes used when an activist shares this content via various mediums. More than one share_options object is allowed. Depending on server implementations, these could represent different share language variations to test or rotate.

Back to top…

These JSON hashes included in the table above are broken out into their own tables for readability, rather than independent resources with their own endpoints.

Share Options

Name Type Description
facebook_share Facebook Share An object hash representing the default language and attributes used when an activist shares on Facebook.
twitter_share Twitter Share An object hash representing the default language and attributes used when an activist shares on Twitter.
email_share Email Share An object hash representing the default language and attributes used when an activist shares via email.

Facebook Share

Name Type Description
facebook_share.title string The title of the post created when an activist shares content on Facebook.
facebook_share.description string The description of the post created when an activist shares content on Facebook.
facebook_share.image string The URL of an image that goes with post created when an activist shares content on Facebook.
facebook_share.total_shares integer A computed property representing the current count of the total number of times the content has been shared on Facebook.

Twitter Share

Name Type Description
twitter_share.message string The text of the post created when an activist shares content on Twitter. Some systems may use templating or appends to insert the share_url into the tweet automatically.
twitter_share.total_shares integer A computed property representing the current count of the total number of times the content has been shared on Twitter.

Email Share

Name Type Description
email_share.subject string The subject line of the email created when an activist shares content via email.
email_share.body string The body text of the email created when an activist shares content via email. Some systems may use templating or appends to insert the share_url into the email body automatically.
email_share.total_shares integer A computed property representing the current count of the total number of times content has been shared via email.

Back to top…

The links associated with this resource, available in the links section of the resource. Links that are part of the OSDI spec are typically prefixed with the osdi: namespace to aid in curie matching and readability.

Note: As with the entire OSDI specification, the specific links a compliant system supplies will vary between each system. In addition, systems may choose to embed a linked resource directly in the response in addition to linking to it in the links section, using the standard _embedded syntax described in the general overview documentation.

Name Type Description
self Advocacy Campaigns* A self-referential link to the advocacy campaign.
creator Person* A link to a single Person resource representing the creator of the advocacy campaign.
modified_by Person* A link to a Person resource representing the last editor of this advocacy campaign.
outreaches Outreaches[]* A link to the collection of Outreach resources for this advocacy campaign.
record_outreach_helper Record Outreach Helper* A link to the Record Outreach Helper resource endpoint for this advocacy campaign.

Back to top…

Back to top…

Scenarios

The scenarios below show some common Create, Read, Update, Delete (CRUD) operations that can be performed on this resource, as well as any resource-specific behaviors worth highlighting. The following examples are for informational purposes. The authoritative resource definitions are above in the Fields tables and should be followed in the event of a conflict with the examples.

Scenario: Retrieving a collection of Advocacy Campaign resources (GET)

Advocacy campaign resources are sometimes presented as collections of advocacy campaigns. For example, calling the advocacy campaigns endpoint will return a collection of all the advocacy campaigns stored in the system’s database associated with your api key.

Request

GET https://osdi-sample-system.org/api/v1/advocacy_campaigns/

Header:
OSDI-API-Token:[your api key here]

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "total_pages": 10,
    "per_page": 25,
    "page": 1,
    "total_records": 250,
    "_links": {
        "next": {
            "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns?page=2"
        },
        "osdi:advocacy_campaigns": [
            {
                "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
            },
            {
                "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/1efc3644-af25-4253-90b8-a0baf12dbd1e"
            },
            //(truncated for brevity)
        ],
        "curies": [
            {
                "name": "osdi",
                "href": "https://osdi-sample-system.org/docs/v1/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns"
        }
    },
    "_embedded": {
        "osdi:advocacy_campaigns": [
            {
                "identifiers": [
                    "osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3",
                    "foreign_system:1"
                ],
                "origin_system": "OSDI Sample System",
                "created_date": "2014-03-20T21:04:31Z",
                "modified_date": "2014-03-20T21:04:31Z",
                "name": "Civil Rights Bill 2015 Advocacy Campaign",
                "title": "Tell Congress to pass the 2015 Civil Rights bill",
                "description": "<p>Congress is prepared to pass a civil rights bill.</p><p>Email your member of Congress and tell them to vote yes!</p>",
                "summary": "Congress is prepared to pass a civil rights bill -- tell your member of Congress to vote yes.",
                "target_universe": "U.S. Congress",
                "browser_url": "http://osdi-sample-system.org/advocacy_campaigns/civil-rights-2015",
                "featured_image_url": "http://osdi-sample-system.org/images/civil-rights-image.jpg",
                "type": "email",
                "total_outreaches": 345,
                "share_url": "http://osdi-sample-system.org/advocacy_campaigns/my-campaign/",
                "total_shares": 345,
                "share_options": [
                    {
                        "facebook_share": {
                            "title": "Write your representative!",
                            "description": "Please write today.",
                            "image": "http://odsi-sample-system.org/images/advocacy-share-image.jpg",
                            "total_shares": 100
                        },
                        "twitter_share": {
                            "message": "Write your representative with @OSDI to get rid of the bad things! Click here: http://osdi-sample-system.org/advocacy_campaigns/my-campaign/",
                            "total_shares": 100
                        },
                        "email_share": {
                            "subject": "Write your representatives!",
                            "body": "Can you write your representatives to get rid of the bad things? Click here: http://osdi-sample-system.org/advocacy_campaigns/my-campaign/",
                            "total_shares": 145
                        }
                    }
                ],
                "_links": {
                    "self": {
                        "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
                    },
                    "osdi:outreaches": {
                        "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/outreaches"
                    },
                    "osdi:creator": {
                        "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
                    },
                    "osdi:modified_by": {
                        "href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
                    },
                    "osdi:record_outreach_helper": {
                        "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/record_outreach_helper"
                    }
                }
            },
            {
                "identifiers": [
                    "osdi_sample_system:1efc3644-af25-4253-90b8-a0baf12dbd1e"
                ],
                "origin_system": "OSDI Sample System",
                "created_date": "2014-03-20T20:44:13Z",
                "modified_date": "2014-03-20T20:44:13Z",
                "title": "Call Congress: Raise the minimum wage!",
                "description": "<p>We need $15/hour now!</p>",
                "target_universe": "U.S. Senate",
                "browser_url": "http://osdi-sample-system.org/advocacy_campaigns/raise-the-wage",
                "type": "phone"
                "total_outreaches": 10572,
                "_links": {
                    "self": {
                        "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/1efc3644-af25-4253-90b8-a0baf12dbd1e"
                    },
                    "osdi:outreaches": {
                        "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/1efc3644-af25-4253-90b8-a0baf12dbd1e/outreaches"
                    },
                    "osdi:creator": {
                        "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
                    },
                    "osdi:modified_by": {
                        "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
                    },
                    "osdi:record_outreach_helper": {
                        "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/1efc3644-af25-4253-90b8-a0baf12dbd1e/record_outreach_helper"
                    }
                }
            },
            //(truncated for brevity)
        ]
    }
}

Back to top…

Scenario: Scenario: Retrieving an individual Advocacy Campaign resource (GET)

Calling an individual Advocacy Campaign resource will return the resource directly, along with all associated fields and appropriate links to additional information about the advocacy campaign.

Request

GET https://osdi-sample-system.org/api/v1/advocacy_campaigns/d32fcdd6-7366-466d-a3b8-7e0d87c3cd8b

Header:
OSDI-API-Token:[your api key here]

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "identifiers": [
        "osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3",
        "foreign_system:1"
    ],
    "origin_system": "OSDI Sample System",
    "created_date": "2014-03-20T21:04:31Z",
    "modified_date": "2014-03-20T21:04:31Z",
    "name": "Civil Rights Bill 2015 Advocacy Campaign",
    "title": "Tell Congress to pass the 2015 Civil Rights bill",
    "description": "<p>Congress is prepared to pass a civil rights bill.</p><p>Email your member of Congress and tell them to vote yes!</p>",
    "summary": "Congress is prepared to pass a civil rights bill -- tell your member of Congress to vote yes.",
    "target_universe": "U.S. Congress",
    "browser_url": "http://osdi-sample-system.org/advocacy_campaigns/civil-rights-2015",
    "featured_image_url": "http://osdi-sample-system.org/images/civil-rights-image.jpg",
    "type": "email",
    "total_outreaches": 345,
    "share_url": "http://osdi-sample-system.org/advocacy_campaigns/my-campaign/",
    "total_shares": 345,
    "share_options": [
        {
            "facebook_share": {
                "title": "Write your representative!",
                "description": "Please write today.",
                "image": "http://odsi-sample-system.org/images/advocacy-share-image.jpg",
                "total_shares": 100
            },
            "twitter_share": {
                "message": "Write your representative with @OSDI to get rid of the bad things! Click here: http://osdi-sample-system.org/advocacy_campaigns/my-campaign/",
                "total_shares": 100
            },
            "email_share": {
                "subject": "Write your representatives!",
                "body": "Can you write your representatives to get rid of the bad things? Click here: http://osdi-sample-system.org/advocacy_campaigns/my-campaign/",
                "total_shares": 145
            }
        }
    ],
    "_links": {
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
        },
        "osdi:outreaches": {
            "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/outreaches"
        },
        "osdi:creator": {
            "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
        },
        "osdi:modified_by": {
            "href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:record_outreach_helper": {
            "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/record_outreach_helper"
        }
    }
}

Back to top…

Scenario: Creating a new advocacy campaign (POST)

Posting to the advocacy campaign collection endpoint will allow you to create a new advocacy campaign. The response is the new advocacy campaign that was created. While each implementing system will require different fields, any optional fields not included in a post operation should not be set at all by the receiving system, or should be set to default values.

Request

POST https://osdi-sample-system.org/api/v1/advocacy_campaigns/

Header:
OSDI-API-Token:[your api key here]

{
    "identifiers": [
        "foreign_system:1"
    ],
    "name": "Civil Rights Bill 2015 Advocacy Campaign",
    "title": "Tell Congress to pass the 2015 Civil Rights bill",
    "origin_system": "OpenSupporter"
}

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "identifiers": [
        "osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3",
        "foreign_system:1"
    ],
    "origin_system": "OpenSupporter",
    "created_date": "2014-03-20T21:04:31Z",
    "modified_date": "2014-03-20T21:04:31Z",
    "name": "Civil Rights Bill 2015 Advocacy Campaign",
    "title": "Tell Congress to pass the 2015 Civil Rights bill",
    "total_outreaches": 0,
    "_links": {
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
        },
        "osdi:outreaches": {
            "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/outreaches"
        },
        "osdi:creator": {
            "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
        },
        "osdi:record_outreach_helper": {
            "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/record_outreach_helper"
        }
    }
}

Back to top…

Scenario: Modifying an advocacy campaign (PUT)

You can update an advocacy campaign by calling a PUT operation on that advocacy campaign’s endpoint. Your PUT should contain fields that you want to update. Missing fields will be ignored by the receiving system. Systems may also ignore PUT values, depending on whether fields you are trying to modify are read-only or not. You may set an attribute to nil by including the attribute using nil for value.

Note: Modifying members of an array separately is not supported. To change the contents of an array, first GET the current contents and then PUT back only those you wish to keep.

Request

PUT https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-de9uemdse

Header:
OSDI-API-Token:[your api key here]

{
    "name": "Civil Rights Bill 2015-2016 Advocacy Campaign"
}

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "identifiers": [
        "osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3",
        "foreign_system:1"
    ],
    "origin_system": "OpenSupporter",
    "created_date": "2014-03-20T21:04:31Z",
    "modified_date": "2014-03-20T22:04:31Z",
    "name": "Civil Rights Bill 2015-2016 Advocacy Campaign",
    "title": "Tell Congress to pass the 2015 Civil Rights bill",
    "total_signatures": 0,
    "_links": {
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
        },
        "osdi:outreaches": {
            "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/outreaches"
        },
        "osdi:creator": {
            "href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
        },
        "osdi:record_outreach_helper": {
            "href": "https://osdi-sample-system.org/api/v1/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/record_outreach_helper"
        }
    }
}

Back to top…

Scenario: Deleting an advocacy campaign (DELETE)

You may delete an advocacy campaign by calling the DELETE command on the advocacy campaign’s endpoint.

Request

DELETE https://osdi-sample-system.org/api/v1/advocacy_campaigns/d32fcdd6-7366-466d-a3b8-7e0d87c3cd8b

Header:
OSDI-API-Token:[your api key here]

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "notice": "This advocacy campaign was successfully deleted."
}

Back to top…