Wrapper
This document defines the Wrapper resource.
Wrapper resources represent a some type of standard wrapper around a Message resource. For example a mass email will have HTML that typically adds a standard header and footer to the email message, whereas SMS will have standard from lines and unsubscribe text that will be added, etc… Wrappers have fields to describe them such as HTML headers and footers. Wrappers can be linked by Messages to show which wrapper the message is using.
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 Wrapper resource is osdi:wrapper
for a single Wrapper resource or osdi:wrappers
for a collection of Wrapper resources.
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. |
Control Headers
An “osdi:control” JSON object may contain common OSDI control headers which can be used on an OSDI POST, PUT, PATCH, Helper or other function calls to modify server behavior. Read More
Name | Type | Description |
---|---|---|
return_response | boolean | Defaults to true, if specified as false, the operation does not need to return the resource representation in the response |
Wrapper Fields
A list of fields specific to the Wrapper resource.
Name | Type | Description |
---|---|---|
origin_system | string | A human readable identifier of the system where this wrapper was created. (ex: “OSDI System”) |
name | string | The name of the wrapper. Intended for administrative display rather than a public title, though may be shown to a user. |
header | string | The header content of the wrapper. May contain HTML. |
footer | string | The footer content of the wrapper. May contain HTML. |
administrative_url | string | A URL string pointing to the wrapper’s administrative page on the web. |
wrapper_type | enum | The type of wrapper. One of “email” or “sms”. |
default | boolean | Whether this wrapper is the default wrapper for messages or not. |
Links
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 | Wrapper* | A self-referential link to the wrapper. |
creator | Person* | A link to a single Person resource representing the creator of the wrapper. |
taggings | Taggings[]* | A link to the collection of Tagging resources for this wrapper. |
modified_by | Person* | A link to a Person resource representing the last editor of this wrapper. |
Related Resources
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 Wrapper resources (GET)
Wrapper resources are sometimes presented as collections of wrappers. For example, calling the wrappers endpoint will return a collection of all the wrappers stored in the system’s database associated with your api key.
Request
GET https://osdi-sample-system.org/api/v1/wrappers/
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/wrappers?page=2"
},
"osdi:wrappers": [
{
"href": "https://osdi-sample-system.org/api/v1/wrappers/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
},
{
"href": "https://osdi-sample-system.org/api/v1/wrappers/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/wrappers"
}
},
"_embedded": {
"osdi:wrappers": [
{
"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": "GOTV email wrapper",
"header": "<p>It's time to go vote!</p>",
"footer": "<p>Sent by the campaign to elect Jane Doe.</p>",
"administrative_url": "http://osdi-sample-system.org/wrappers/gotv/manage",
"wrapper_type": "email",
"default": true,
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/wrappers/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
},
"osdi:creator": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
},
"osdi:taggings": {
"href": "https://osdi-sample-system.org/api/v1/wrappers/1efc3644-af25-4253-90b8-a0baf12dbd1e/taggings"
},
"osdi:modified_by": {
"href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
}
}
},
{
"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",
"name": "GOTV SMS wrapper",
"administrative_url": "http://osdi-sample-system.org/wrappers/gotv/manage",
"wrapper_type": "sms",
"default": true,
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/wrappers/1efc3644-af25-4253-90b8-a0baf12dbd1e"
},
"osdi:creator": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
},
"osdi:taggings": {
"href": "https://osdi-sample-system.org/api/v1/wrappers/1efc3644-af25-4253-90b8-a0baf12dbd1e/taggings"
},
"osdi:modified_by": {
"href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
}
}
},
//(truncated for brevity)
]
}
}
Scenario: Scenario: Retrieving an individual Wrapper resource (GET)
Calling an individual Wrapper resource will return the resource directly, along with all associated fields and appropriate links to additional information about the wrapper.
Request
GET https://osdi-sample-system.org/api/v1/wrappers/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": "GOTV email wrapper",
"header": "<p>It's time to go vote!</p>",
"footer": "<p>Sent by the campaign to elect Jane Doe.</p>",
"administrative_url": "http://osdi-sample-system.org/wrappers/gotv/manage",
"wrapper_type": "email",
"default": true,
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/wrappers/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
},
"osdi:creator": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
},
"osdi:taggings": {
"href": "https://osdi-sample-system.org/api/v1/wrappers/1efc3644-af25-4253-90b8-a0baf12dbd1e/taggings"
},
"osdi:modified_by": {
"href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
}
}
}
Scenario: Creating a new Wrapper (POST)
Posting to the wrappers collection endpoint will allow you to create a new wrapper. Optionally adding a link to a Person resource will set the creator. The response is the new wrapper 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/wrappers/
Header:
OSDI-API-Token:[your api key here]
{
"identifiers": [
"foreign_system:1"
],
"origin_system": "OSDI Sample System",
"name": "GOTV email wrapper",
"header": "<p>It's time to go vote!</p>",
"footer": "<p>Sent by the campaign to elect Jane Doe.</p>",
"wrapper_type": "email",
"default": true
}
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": "GOTV email wrapper",
"header": "<p>It's time to go vote!</p>",
"footer": "<p>Sent by the campaign to elect Jane Doe.</p>",
"administrative_url": "http://osdi-sample-system.org/wrappers/gotv/manage",
"wrapper_type": "email",
"default": true,
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/wrappers/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
},
"osdi:creator": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
},
"osdi:taggings": {
"href": "https://osdi-sample-system.org/api/v1/wrappers/1efc3644-af25-4253-90b8-a0baf12dbd1e/taggings"
},
"osdi:modified_by": {
"href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
}
}
}
Scenario: Modifying a wrapper (PUT)
You can update a wrapper by calling a PUT operation on that wrapper’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/wrappers/d91b4b2e-ae0e-4cd3-9ed7-de9uemdse
Header:
OSDI-API-Token:[your api key here]
{
"name": "GOTV wrapper version 2"
}
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": "GOTV wrapper version 2",
"header": "<p>It's time to go vote!</p>",
"footer": "<p>Sent by the campaign to elect Jane Doe.</p>",
"administrative_url": "http://osdi-sample-system.org/wrappers/gotv/manage",
"wrapper_type": "email",
"default": true,
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/wrappers/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
},
"osdi:creator": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
},
"osdi:taggings": {
"href": "https://osdi-sample-system.org/api/v1/wrappers/1efc3644-af25-4253-90b8-a0baf12dbd1e/taggings"
},
"osdi:modified_by": {
"href": "https://osdi-sample-system.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
}
}
}
Scenario: Deleting a wrapper (DELETE)
You may delete a wrapper by calling the DELETE command on the wrapper’s endpoint.
Request
DELETE https://osdi-sample-system.org/api/v1/wrappers/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 wrapper was successfully deleted."
}