Attendance
This document defines the Attendance resource.
Attendances are a type of action that a user may take by RSVPing to attend an event or buying tickets to a ticketed event. Attendances have fields to describe them such as when the attendance was created and typically are linked to the person who made the attendance.
Attendances for ticketed events will look different from non-ticketed events, including fields for the tickets bought and who received those tickets (which can be different from the person who bought the tickets and created the attendance).
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 Attendance resource is osdi:attendance for a single Attendance resource or osdi:attendances for a collection of Attendance 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 |
Attendance Fields
A list of fields specific to the Attendance resource.
| Name | Type | Description |
|---|---|---|
| origin_system | string | A human readable identifier of the system where this attendance was created. (ex: “OSDI System”) |
| action_date | string | The date and time the attendance was made by the person. |
| status | flexenum | The attendee’s response status. One of “declined”, “tentative”, “accepted”, “cancelled”, or “needs action”. Note: OSDI vendors may implement varying or client-configured statuses; users should check with the vendor for available attendance status values. |
| attended | boolean | For event RSVPs, represents whether the person actually attended the event or not. For ticketed events, field should be absent, as it’s superseded by the attended field in the ticket object. |
| comment | string | An optional comment from the attendee. |
| referrer_data | Referrer Data* | An object hash representing referrer and sourcing information about this attendance. |
| tickets | Tickets[] | If this event is a ticketed event, an array of object hashes representing each ticket purchased as part of this attendance. (ex: One $5 general admission ticket for Sam and two $50 VIP tickets for Sally and Saul.) |
Related Objects
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.
Referrer Data
| Name | Type | Description |
|---|---|---|
| referrer_data.source | string | The source code that was used when this attendance was created. Typically used to track individual links, such as a post on social media or a link in a specific email. (ex: “facebook-101016-mainpage”) |
| referrer_data.referrer | string | The code or ID representing a person or group that referred this attendance. Typically used to track which person referred the person who made this attendance. (ex: “jane-doe”) |
| referrer_data.website | string | The top level domain of the website where the person clicked from to then subsequently make this attendance. (ex: “facebook.com”) |
| referrer_data.url | string | The specific URL where the person clicked from to then subsequently make this attendance. (ex: “https://facebook.com/posts/12345”) |
Tickets
| Name | Type | Description |
|---|---|---|
| ticket.title | string | The name of the ticket type that was purchased. (ex: “General admission”) |
| ticket.description | string | A longer description of the ticket type. (ex: “Gets you access to the convention floor.”) |
| ticket.amount | float | The price paid for this ticket, in the specified currency. (ex: “10.50”) |
| ticket.currency | string | ISO 4217 designation of currency. (ex: “USD”, “JPY”) |
| attended | boolean | Represents whether the person actually attended the event or not. |
| ticket.person | Person* | An object hash representing the person who will use this ticket. |
Person
| Name | Type | Description |
|---|---|---|
| person | Person* | An inlined hash representation of a person who received this ticket, containing any valid fields for the Person resource. |
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 | Attendance* | A self-referential link to the attendance. |
| person | Person* | A link to a single Person resource representing the person who RSVPed for the event, or in the case of ticketed events, bought the tickets. |
| invited_by | Person* | A link to a Person resource representing the person that invited this attendee. This is expected to be used for guests. |
| event | Event* | A link to an Event resource representing the event on which this attendance was created. |
Helpers
Helpers faciliate combined creation operations (POST) that are commonly performed by users. Each resource may have one or more associated helpers, which perform different operations and have separate syntax. Some initial OSDI implementations may only support helpers, rather than full RESTful access.
The helpers that operate on this resource are described in the table below. Click on the helper to view its documentation and syntax.
| Name | Description |
|---|---|
| record_attendance_helper | Allows the creation of an attendance and a person at the same time. |
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 Attendance resources (GET)
Attendance resources are sometimes presented as collections of attendances. For example, calling the attendance endpoint on a particular event will return a collection of all the attendances made to that event.
Ticketed event attendances and non-ticketed event attendances look different. First, an example of non-ticketed event attendances:
Request
GET https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances
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/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances?page=2"
},
"osdi:submissions": [
{
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
},
{
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/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/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances"
}
},
"_embedded": {
"osdi:attendances": [
{
"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",
"action_date": "2014-03-18T11:02:15Z",
"status": "confirmed",
"attended": true,
"comment": "Looking forward to it!",
"referrer_data": {
"source": "facebook-101016-mainpage",
"referrer": "jane-doe",
"website": "facebook.com",
"url": "https://facebook.com/posts/12345"
},
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
},
"osdi:event": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29"
},
"osdi:person": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
},
"osdi:invited_by": {
"href": "https://osdi-sample-system.org/api/v1/person/8a625981-67a4-4457-8b55-2e30b267b2c2"
}
}
},
{
"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",
"action_date": "2014-03-12T01:45:34Z",
"status": "tentative",
"attended": false,
"referrer_data": {
"source": "email-101116-subjecttest1"
},
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/1efc3644-af25-4253-90b8-a0baf12dbd1e"
},
"osdi:event": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29"
},
"osdi:person": {
"href": "https://osdi-sample-system.org/api/v1/people/adb951cb-51f9-420e-b7e6-de953195ec86"
}
}
},
//(truncated for brevity)
]
}
}
Next, an example of ticketed event attendances:
Request
GET https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances
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/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances?page=2"
},
"osdi:submissions": [
{
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
},
{
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/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/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances"
}
},
"_embedded": {
"osdi:attendances": [
{
"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",
"action_date": "2014-03-18T11:02:15Z",
"status": "confirmed",
"comment": "Looking forward to it!",
"referrer_data": {
"source": "twitter-101016",
"website": "twitter.com"
},
"tickets": [
{
"title": "General Admission",
"description": "Gets you into the event and all activities.",
"amount": 5,
"currency": "USD",
"attended": true,
"person": {
"family_name": "Edwin",
"given_name": "Labadie",
"email_addresses": [
{
"address":"test-3@example.com",
"primary": true,
"address_type": "Personal"
}
]
}
},
{
"title": "VIP",
"description": "Meet and greet before the event, and front-row seats.",
"amount": 500,
"currency": "USD",
"attended": false,
"person": {
"family_name": "Jane",
"given_name": "Doe",
"email_addresses": [
{
"address":"jdoe@example.com",
"primary": true,
"address_type": "Personal"
}
]
}
}
],
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
},
"osdi:event": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29"
},
"osdi:person": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
},
"osdi:invited_by": {
"href": "https://osdi-sample-system.org/api/v1/person/8a625981-67a4-4457-8b55-2e30b267b2c2"
}
}
},
{
"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",
"action_date": "2014-03-12T01:45:34Z",
"status": "tentative",
"referrer_data": {
"source": "email-101216-final"
},
"tickets": [
{
"title": "General Admission",
"description": "Gets you into the event and all activities.",
"amount": 5,
"currency": "USD",
"attended": true,
"person": {
"family_name": "Sam",
"given_name": "Smith",
"email_addresses": [
{
"address":"smitty@example.com",
"primary": true,
"address_type": "Personal"
}
]
}
}
],
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/1efc3644-af25-4253-90b8-a0baf12dbd1e"
},
"osdi:event": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29"
},
"osdi:person": {
"href": "https://osdi-sample-system.org/api/v1/people/adb951cb-51f9-420e-b7e6-de953195ec86"
}
}
},
//(truncated for brevity)
]
}
}
Scenario: Scenario: Retrieving an individual Attendance resource (GET)
Calling an individual Attendance resource will return the resource directly, along with all associated fields and appropriate links to additional information about the attendance.
Ticketed event attendances and non-ticketed event attendances look different. First, an example of a non-ticketed event attendace:
Request
GET https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3
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",
"action_date": "2014-03-18T11:02:15Z",
"status": "confirmed",
"attended": true,
"comment": "Looking forward to it!",
"referrer_data": {
"source": "facebook-101016-mainpage",
"referrer": "jane-doe",
"website": "facebook.com",
"url": "https://facebook.com/posts/12345"
},
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
},
"osdi:event": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29"
},
"osdi:person": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
},
"osdi:invited_by": {
"href": "https://osdi-sample-system.org/api/v1/person/8a625981-67a4-4457-8b55-2e30b267b2c2"
}
}
}
Next, an example of a ticketed event attendance:
Request
GET https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3
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",
"action_date": "2014-03-18T11:02:15Z",
"status": "confirmed",
"comment": "Looking forward to it!",
"referrer_data": {
"source": "facebook-101016-mainpage",
"referrer": "jane-doe",
"website": "facebook.com",
"url": "https://facebook.com/posts/12345"
},
"tickets": [
{
"title": "General Admission",
"description": "Gets you into the event and all activities.",
"amount": 5,
"currency": "USD",
"attended": true,
"person": {
"family_name": "Edwin",
"given_name": "Labadie",
"email_addresses": [
{
"address":"test-3@example.com",
"primary": true,
"address_type": "Personal"
}
]
}
},
{
"title": "VIP",
"description": "Meet and greet before the event, and front-row seats.",
"amount": 500,
"currency": "USD",
"attended": false,
"person": {
"family_name": "Jane",
"given_name": "Doe",
"email_addresses": [
{
"address":"jdoe@example.com",
"primary": true,
"address_type": "Personal"
}
]
}
}
],
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3"
},
"osdi:event": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29"
},
"osdi:person": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
},
"osdi:invited_by": {
"href": "https://osdi-sample-system.org/api/v1/person/8a625981-67a4-4457-8b55-2e30b267b2c2"
}
}
}
Scenario: Creating a new attendance (POST)
Posting to the attendances collection endpoint and including a link to an existing Person resource will allow you to create a new attendance associated with that event and person. The response is the new attendance 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.
For information on how to create a person along with an attendance, see the Record Attendance Helper documentation.
Ticketed event attendances and non-ticketed event attendances look different. First, an example of POSTing a non-ticketed event attendace:
Request
POST https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/
Header:
OSDI-API-Token:[your api key here]
{
"identifiers": [
"foreign_system:1"
],
"origin_system": "OpenSupporter",
"action_date": "2014-03-18T11:02:15Z",
"referrer_data": {
"source": "api"
},
"_links" : {
"osdi:person" : {
"href" : "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
}
}
}
Response
200 OK
Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate
{
"identifiers": [
"osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-de9uemdse",
"foreign_system:1"
],
"created_date": "2014-03-20T21:04:31Z",
"modified_date": "2014-03-20T21:04:31Z",
"action_date": "2014-03-18T11:02:15Z",
"referrer_data": {
"source": "api"
},
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-de9uemdse"
},
"osdi:event": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29"
},
"osdi:person": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
}
}
}
Next, an example of POSTing a ticketed event attendance:
Request
POST https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/
Header:
OSDI-API-Token:[your api key here]
{
"identifiers": [
"foreign_system:1"
],
"origin_system": "OpenSupporter",
"action_date": "2014-03-18T11:02:15Z",
"referrer_data": {
"source": "api"
},
"tickets": [
{
"title": "General Admission",
"description": "Gets you into the event and all activities.",
"amount": 5,
"currency": "USD",
"attended": true,
"person": {
"family_name": "Edwin",
"given_name": "Labadie",
"email_addresses": [
{
"address":"test-3@example.com",
"primary": true,
"address_type": "Personal"
}
]
}
},
{
"title": "VIP",
"description": "Meet and greet before the event, and front-row seats.",
"amount": 500,
"currency": "USD",
"attended": false,
"person": {
"family_name": "Jane",
"given_name": "Doe",
"email_addresses": [
{
"address":"jdoe@example.com",
"primary": true,
"address_type": "Personal"
}
]
}
}
],
"_links" : {
"osdi:person" : {
"href" : "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
}
}
}
Response
200 OK
Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate
{
"identifiers": [
"osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-de9uemdse",
"foreign_system:1"
],
"created_date": "2014-03-20T21:04:31Z",
"modified_date": "2014-03-20T21:04:31Z",
"action_date": "2014-03-18T11:02:15Z",
"referrer_data": {
"source": "api"
},
"tickets": [
{
"title": "General Admission",
"description": "Gets you into the event and all activities.",
"amount": 5,
"currency": "USD",
"attended": true,
"person": {
"family_name": "Edwin",
"given_name": "Labadie",
"email_addresses": [
{
"address":"test-3@example.com",
"primary": true,
"address_type": "Personal"
}
]
}
},
{
"title": "VIP",
"description": "Meet and greet before the event, and front-row seats.",
"amount": 500,
"currency": "USD",
"attended": false,
"person": {
"family_name": "Jane",
"given_name": "Doe",
"email_addresses": [
{
"address":"jdoe@example.com",
"primary": true,
"address_type": "Personal"
}
]
}
}
],
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-de9uemdse"
},
"osdi:event": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29"
},
"osdi:person": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
}
}
}
Scenario: Modifying an attendance (PUT)
You can update an attendance by calling a PUT operation on that attendance’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/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-de9uemdse/
Header:
OSDI-API-Token:[your api key here]
{
"status": "declined"
}
Response
200 OK
Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate
{
"identifiers": [
"osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-de9uemdse",
"foreign_system:1"
],
"created_date": "2014-03-20T21:04:31Z",
"modified_date": "2014-03-20T22:04:31Z",
"action_date": "2014-03-17T11:02:15Z",
"status": "declined",
"referrer_data": {
"source": "facebook-101016-mainpage",
"referrer": "jane-doe",
"website": "facebook.com",
"url": "https://facebook.com/posts/12345"
},
"_links": {
"self": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-de9uemdse"
},
"osdi:event": {
"href": "https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29"
},
"osdi:person": {
"href": "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
}
}
}
Scenario: Deleting an attendance (DELETE)
You may delete an attendance by calling the DELETE command on the attendance’s endpoint.
Request
DELETE https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances/d91b4b2e-ae0e-4cd3-9ed7-de9uemdse
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 attendance was successfully deleted."
}