{"action":"created","comment":{"url":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/comments/27124614","id":27124614,"diff_hunk":"@@ -0,0 +1,496 @@\n+---\r\n+layout: default\r\n+title: Outreach\r\n+---\r\n+\r\n+# Outreach\r\n+\r\n+This document defines the Outreach resource. \r\n+\r\n+Outreachs are a type of action that a user may take by participating in an [advocacy campaign](advocacy_campaigns.html). Outreaches have fields to describe them such as when the outreach was created, who the user contacted as the target of their advocacy, and the content of the message a user sent to that target, and typically are linked to the person who made the outreach.\r\n+\r\n+\r\n+### Sections\r\n+\r\n+* [Endpoints and URL structures](#endpoints-and-url-structures)\r\n+* [Fields](#fields)\r\n+    * [Common Fields](#common-fields)\r\n+    * [Outreach Fields](#outreach-fields)  \r\n+    * [Related Objects](#related-objects)\r\n+    * [Links](#links)\r\n+* [Helpers](#helpers)\r\n+* [Related Resources](#related-resources)\r\n+* [Scenarios](#scenarios)\r\n+    * [Scenario: Retrieving a collection of Outreach resources (GET)](#scenario-retrieving-a-collection-of-outreach-resources-get)\r\n+    * [Scenario: Retrieving an individual Outreach resource (GET)](#scenario-scenario-retrieving-an-individual-outreach-resource-get)\r\n+    * [Scenario: Creating a new outreach (POST)](#scenario-creating-a-new-outreach-post)\r\n+    * [Scenario: Modifying an outreach (PUT)](#scenario-modifying-an-outreach-put)\r\n+    * [Scenario: Deleting an outreach (DELETE)](#scenario-deleting-an-outreach-delete)\r\n+\r\n+\r\n+{% include endpoints_and_url_structures.md %}\r\n+\r\n+The link relation label for a Outreach resource is ```osdi:outreach``` for a single Outreach resource or ```osdi:outreaches``` for a collection of Outreach resources.\r\n+\r\n+_[Back to top...](#)_\r\n+\r\n+\r\n+## Fields\r\n+\r\n+{% include fields_intro.md %}\r\n+\r\n+{% include global_fields.md %}\r\n+\r\n+_[Back to top...](#)_\r\n+\r\n+\r\n+### Outreach Fields\r\n+\r\n+A list of fields specific to the Outreach resource.\r\n+\r\n+| Name          | Type      | Description\r\n+|-----------    |-----------|-----------|--------------\r\n+|origin_system\t\t|string     |A human readable identifier of the system where this outreach was created. (ex: \"OSDI System\")\r\n+|action_date\t\t|string\t\t|The date and time the outreach was made by the person.\r\n+|type\t\t\t\t|flexunum\t|The type of outreach, specifying how the user performed the outreach to targets. One of \"email\", \"in-person\", \"phone\", \"postal mail\", or another type as needed.\r\n+|duration\t\t|integer\t\t|The duration in seconds of the outreach, if applicable. (ex: duration will only be present on phone outreach types)\r\n+|subject\t\t|string\t\t|The subject of the outreach, if applicable. (ex: subject will only be present on email outreach types)\r\n+|message\t\t|string\t\t|The message of the outreach, if applicable. (ex: message will only be present on email or postal mail outreach types)\r\n+|targets\t\t\t|[Target[]](#target)    |An array of target object hashes representing the targets of the outreach.\r\n+\r\n+_[Back to top...](#)_\r\n+\r\n+\r\n+### Related Objects\r\n+\r\n+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.\r\n+\r\n+#### Target\r\n+\r\n+|Name          \t|Type      |Description\r\n+|-----------    |-----------|--------------\r\n+|target.title\t|string    |The title of the target. (ex: \"Senator\")\r\n+|target.given_name\t|string    |The first or given name of the target. (ex: \"John\")\r\n+|target.family_name\t|string    |The last or family name of the target. (ex: \"Smith\")\r\n+|target.ocdid\t|string    |The Open Civic Data Division ID for this target's political geography, if applicable. See [here](http://docs.opencivicdata.org/en/latest/proposals/0002.html) for more documentation. (ex: \"ocd-division/country:us/state:ny/cd:18\", which corresponds to New York's 18th Congressional District)\r","path":"outreaches.md","position":75,"original_position":75,"commit_id":"9063b0378f1c190be9790a99d37bbb259e74d482","original_commit_id":"9063b0378f1c190be9790a99d37bbb259e74d482","user":{"login":"shaisachs","id":910582,"avatar_url":"https://avatars.githubusercontent.com/u/910582?v=3","gravatar_id":"","url":"https://api.github.com/users/shaisachs","html_url":"https://github.com/shaisachs","followers_url":"https://api.github.com/users/shaisachs/followers","following_url":"https://api.github.com/users/shaisachs/following{/other_user}","gists_url":"https://api.github.com/users/shaisachs/gists{/gist_id}","starred_url":"https://api.github.com/users/shaisachs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shaisachs/subscriptions","organizations_url":"https://api.github.com/users/shaisachs/orgs","repos_url":"https://api.github.com/users/shaisachs/repos","events_url":"https://api.github.com/users/shaisachs/events{/privacy}","received_events_url":"https://api.github.com/users/shaisachs/received_events","type":"User","site_admin":false},"body":"While I see the value of using OCDID for cases where it's applicable, I think there are a lot of cases where it's not applicable, and for which a standard is unlikely to ever become available.  For example, I'm thinking of corporate advocacy campaigns, whereby an advocacy group may want to target people like Walmart's VP of HR, or something like that.  For that reason I'd suggest adding fields like organization, position, and email address, if OCDID is not applicable.","created_at":"2015-03-25T14:24:38Z","updated_at":"2015-03-25T14:24:38Z","html_url":"https://github.com/opensupporter/osdi-docs/pull/201#discussion_r27124614","pull_request_url":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/201","_links":{"self":{"href":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/comments/27124614"},"html":{"href":"https://github.com/opensupporter/osdi-docs/pull/201#discussion_r27124614"},"pull_request":{"href":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/201"}}},"pull_request":{"url":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/201","id":30948286,"html_url":"https://github.com/opensupporter/osdi-docs/pull/201","diff_url":"https://github.com/opensupporter/osdi-docs/pull/201.diff","patch_url":"https://github.com/opensupporter/osdi-docs/pull/201.patch","issue_url":"https://api.github.com/repos/opensupporter/osdi-docs/issues/201","number":201,"state":"open","locked":false,"title":"Advocacy proposal","user":{"login":"j-ro","id":1058998,"avatar_url":"https://avatars.githubusercontent.com/u/1058998?v=3","gravatar_id":"","url":"https://api.github.com/users/j-ro","html_url":"https://github.com/j-ro","followers_url":"https://api.github.com/users/j-ro/followers","following_url":"https://api.github.com/users/j-ro/following{/other_user}","gists_url":"https://api.github.com/users/j-ro/gists{/gist_id}","starred_url":"https://api.github.com/users/j-ro/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/j-ro/subscriptions","organizations_url":"https://api.github.com/users/j-ro/orgs","repos_url":"https://api.github.com/users/j-ro/repos","events_url":"https://api.github.com/users/j-ro/events{/privacy}","received_events_url":"https://api.github.com/users/j-ro/received_events","type":"User","site_admin":false},"body":"Here's my first draft of an advocacy proposal, including the Advocacy Campaign resource representing the umbrella campaign object, the Outreach resource representing each individual outreach made to advocacy targets by people, and the Record Outreach Helper to help POST an outreach and a person at the same time.\r\n\r\nA few notes and points for discussion:\r\n\r\n* I don't love the names that I've chosen here, Advocacy Campaign and Outreach. Outreach especially is awkward -- the plural is \"Outreaches\" -- though I guess not more awkward than Taggings. Anyway, if folks have thoughts on other names, happy to hear them.\r\n* I've put a type field on the Advocacy Campaign resource as a kind of hint to the type of Outreaches you can expect for this campaign (ie: phone, or email, or in-person). This means that Advocacy Campaigns then can only contain one type of Outreach. I'm not sure I've seen a system that can handle more than one type in a single campaign, but maybe I'm wrong there. Type could easily be removed and just be present on individual Outreaches.\r\n* Targets are not their own resources. I can see them becoming such in the future, but for now it seemed like overkill.\r\n* I'm using OCDID as an identifier for targets. I know it's not a standard everyone uses, but it is in fact a standard, and I'm not sure there's really another one to use instead. Of course, like everything, it's optional, so if you don't use it, just don't have the field, but it seems useful for matching and analysis, especially because targets are not their own resources.\r\n\r\nAll other comments welcome!","created_at":"2015-03-11T14:33:30Z","updated_at":"2015-03-25T14:24:38Z","closed_at":null,"merged_at":null,"merge_commit_sha":"3a6961cf3b40dcd352d5aea96a01ad8fe18c0224","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/201/commits","review_comments_url":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/201/comments","review_comment_url":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/opensupporter/osdi-docs/issues/201/comments","statuses_url":"https://api.github.com/repos/opensupporter/osdi-docs/statuses/9063b0378f1c190be9790a99d37bbb259e74d482","head":{"label":"opensupporter:feature/advocacy","ref":"feature/advocacy","sha":"9063b0378f1c190be9790a99d37bbb259e74d482","user":{"login":"opensupporter","id":6803043,"avatar_url":"https://avatars.githubusercontent.com/u/6803043?v=3","gravatar_id":"","url":"https://api.github.com/users/opensupporter","html_url":"https://github.com/opensupporter","followers_url":"https://api.github.com/users/opensupporter/followers","following_url":"https://api.github.com/users/opensupporter/following{/other_user}","gists_url":"https://api.github.com/users/opensupporter/gists{/gist_id}","starred_url":"https://api.github.com/users/opensupporter/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/opensupporter/subscriptions","organizations_url":"https://api.github.com/users/opensupporter/orgs","repos_url":"https://api.github.com/users/opensupporter/repos","events_url":"https://api.github.com/users/opensupporter/events{/privacy}","received_events_url":"https://api.github.com/users/opensupporter/received_events","type":"Organization","site_admin":false},"repo":{"id":9832302,"name":"osdi-docs","full_name":"opensupporter/osdi-docs","owner":{"login":"opensupporter","id":6803043,"avatar_url":"https://avatars.githubusercontent.com/u/6803043?v=3","gravatar_id":"","url":"https://api.github.com/users/opensupporter","html_url":"https://github.com/opensupporter","followers_url":"https://api.github.com/users/opensupporter/followers","following_url":"https://api.github.com/users/opensupporter/following{/other_user}","gists_url":"https://api.github.com/users/opensupporter/gists{/gist_id}","starred_url":"https://api.github.com/users/opensupporter/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/opensupporter/subscriptions","organizations_url":"https://api.github.com/users/opensupporter/orgs","repos_url":"https://api.github.com/users/opensupporter/repos","events_url":"https://api.github.com/users/opensupporter/events{/privacy}","received_events_url":"https://api.github.com/users/opensupporter/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/opensupporter/osdi-docs","description":"OSDI Specification","fork":false,"url":"https://api.github.com/repos/opensupporter/osdi-docs","forks_url":"https://api.github.com/repos/opensupporter/osdi-docs/forks","keys_url":"https://api.github.com/repos/opensupporter/osdi-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/opensupporter/osdi-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/opensupporter/osdi-docs/teams","hooks_url":"https://api.github.com/repos/opensupporter/osdi-docs/hooks","issue_events_url":"https://api.github.com/repos/opensupporter/osdi-docs/issues/events{/number}","events_url":"https://api.github.com/repos/opensupporter/osdi-docs/events","assignees_url":"https://api.github.com/repos/opensupporter/osdi-docs/assignees{/user}","branches_url":"https://api.github.com/repos/opensupporter/osdi-docs/branches{/branch}","tags_url":"https://api.github.com/repos/opensupporter/osdi-docs/tags","blobs_url":"https://api.github.com/repos/opensupporter/osdi-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/opensupporter/osdi-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/opensupporter/osdi-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/opensupporter/osdi-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/opensupporter/osdi-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/opensupporter/osdi-docs/languages","stargazers_url":"https://api.github.com/repos/opensupporter/osdi-docs/stargazers","contributors_url":"https://api.github.com/repos/opensupporter/osdi-docs/contributors","subscribers_url":"https://api.github.com/repos/opensupporter/osdi-docs/subscribers","subscription_url":"https://api.github.com/repos/opensupporter/osdi-docs/subscription","commits_url":"https://api.github.com/repos/opensupporter/osdi-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/opensupporter/osdi-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/opensupporter/osdi-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/opensupporter/osdi-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/opensupporter/osdi-docs/contents/{+path}","compare_url":"https://api.github.com/repos/opensupporter/osdi-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/opensupporter/osdi-docs/merges","archive_url":"https://api.github.com/repos/opensupporter/osdi-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/opensupporter/osdi-docs/downloads","issues_url":"https://api.github.com/repos/opensupporter/osdi-docs/issues{/number}","pulls_url":"https://api.github.com/repos/opensupporter/osdi-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/opensupporter/osdi-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/opensupporter/osdi-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/opensupporter/osdi-docs/labels{/name}","releases_url":"https://api.github.com/repos/opensupporter/osdi-docs/releases{/id}","created_at":"2013-05-03T08:51:24Z","updated_at":"2015-03-10T02:54:56Z","pushed_at":"2015-03-23T13:34:52Z","git_url":"git://github.com/opensupporter/osdi-docs.git","ssh_url":"git@github.com:opensupporter/osdi-docs.git","clone_url":"https://github.com/opensupporter/osdi-docs.git","svn_url":"https://github.com/opensupporter/osdi-docs","homepage":"opensupporter.org","size":4319,"stargazers_count":45,"watchers_count":45,"language":"HTML","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":23,"mirror_url":null,"open_issues_count":45,"forks":23,"open_issues":45,"watchers":45,"default_branch":"gh-pages"}},"base":{"label":"opensupporter:gh-pages","ref":"gh-pages","sha":"880083390f1afc440b937d5a675236db4fa330a8","user":{"login":"opensupporter","id":6803043,"avatar_url":"https://avatars.githubusercontent.com/u/6803043?v=3","gravatar_id":"","url":"https://api.github.com/users/opensupporter","html_url":"https://github.com/opensupporter","followers_url":"https://api.github.com/users/opensupporter/followers","following_url":"https://api.github.com/users/opensupporter/following{/other_user}","gists_url":"https://api.github.com/users/opensupporter/gists{/gist_id}","starred_url":"https://api.github.com/users/opensupporter/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/opensupporter/subscriptions","organizations_url":"https://api.github.com/users/opensupporter/orgs","repos_url":"https://api.github.com/users/opensupporter/repos","events_url":"https://api.github.com/users/opensupporter/events{/privacy}","received_events_url":"https://api.github.com/users/opensupporter/received_events","type":"Organization","site_admin":false},"repo":{"id":9832302,"name":"osdi-docs","full_name":"opensupporter/osdi-docs","owner":{"login":"opensupporter","id":6803043,"avatar_url":"https://avatars.githubusercontent.com/u/6803043?v=3","gravatar_id":"","url":"https://api.github.com/users/opensupporter","html_url":"https://github.com/opensupporter","followers_url":"https://api.github.com/users/opensupporter/followers","following_url":"https://api.github.com/users/opensupporter/following{/other_user}","gists_url":"https://api.github.com/users/opensupporter/gists{/gist_id}","starred_url":"https://api.github.com/users/opensupporter/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/opensupporter/subscriptions","organizations_url":"https://api.github.com/users/opensupporter/orgs","repos_url":"https://api.github.com/users/opensupporter/repos","events_url":"https://api.github.com/users/opensupporter/events{/privacy}","received_events_url":"https://api.github.com/users/opensupporter/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/opensupporter/osdi-docs","description":"OSDI Specification","fork":false,"url":"https://api.github.com/repos/opensupporter/osdi-docs","forks_url":"https://api.github.com/repos/opensupporter/osdi-docs/forks","keys_url":"https://api.github.com/repos/opensupporter/osdi-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/opensupporter/osdi-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/opensupporter/osdi-docs/teams","hooks_url":"https://api.github.com/repos/opensupporter/osdi-docs/hooks","issue_events_url":"https://api.github.com/repos/opensupporter/osdi-docs/issues/events{/number}","events_url":"https://api.github.com/repos/opensupporter/osdi-docs/events","assignees_url":"https://api.github.com/repos/opensupporter/osdi-docs/assignees{/user}","branches_url":"https://api.github.com/repos/opensupporter/osdi-docs/branches{/branch}","tags_url":"https://api.github.com/repos/opensupporter/osdi-docs/tags","blobs_url":"https://api.github.com/repos/opensupporter/osdi-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/opensupporter/osdi-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/opensupporter/osdi-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/opensupporter/osdi-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/opensupporter/osdi-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/opensupporter/osdi-docs/languages","stargazers_url":"https://api.github.com/repos/opensupporter/osdi-docs/stargazers","contributors_url":"https://api.github.com/repos/opensupporter/osdi-docs/contributors","subscribers_url":"https://api.github.com/repos/opensupporter/osdi-docs/subscribers","subscription_url":"https://api.github.com/repos/opensupporter/osdi-docs/subscription","commits_url":"https://api.github.com/repos/opensupporter/osdi-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/opensupporter/osdi-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/opensupporter/osdi-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/opensupporter/osdi-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/opensupporter/osdi-docs/contents/{+path}","compare_url":"https://api.github.com/repos/opensupporter/osdi-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/opensupporter/osdi-docs/merges","archive_url":"https://api.github.com/repos/opensupporter/osdi-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/opensupporter/osdi-docs/downloads","issues_url":"https://api.github.com/repos/opensupporter/osdi-docs/issues{/number}","pulls_url":"https://api.github.com/repos/opensupporter/osdi-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/opensupporter/osdi-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/opensupporter/osdi-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/opensupporter/osdi-docs/labels{/name}","releases_url":"https://api.github.com/repos/opensupporter/osdi-docs/releases{/id}","created_at":"2013-05-03T08:51:24Z","updated_at":"2015-03-10T02:54:56Z","pushed_at":"2015-03-23T13:34:52Z","git_url":"git://github.com/opensupporter/osdi-docs.git","ssh_url":"git@github.com:opensupporter/osdi-docs.git","clone_url":"https://github.com/opensupporter/osdi-docs.git","svn_url":"https://github.com/opensupporter/osdi-docs","homepage":"opensupporter.org","size":4319,"stargazers_count":45,"watchers_count":45,"language":"HTML","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":23,"mirror_url":null,"open_issues_count":45,"forks":23,"open_issues":45,"watchers":45,"default_branch":"gh-pages"}},"_links":{"self":{"href":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/201"},"html":{"href":"https://github.com/opensupporter/osdi-docs/pull/201"},"issue":{"href":"https://api.github.com/repos/opensupporter/osdi-docs/issues/201"},"comments":{"href":"https://api.github.com/repos/opensupporter/osdi-docs/issues/201/comments"},"review_comments":{"href":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/201/comments"},"review_comment":{"href":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/opensupporter/osdi-docs/pulls/201/commits"},"statuses":{"href":"https://api.github.com/repos/opensupporter/osdi-docs/statuses/9063b0378f1c190be9790a99d37bbb259e74d482"}}}}