| layout | title |
|---|---|
default |
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).
{% include endpoints_and_url_structures.md %}
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.
{% include fields_intro.md %}
{% include global_fields.md %}
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.)
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.
| 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") |
| 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. |
| Name | Type | Description |
|---|---|---|
| person | Person* | An inlined hash representation of a person who received this ticket, containing any valid fields for the Person resource. |
{% include links_intro.md %}
| 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.
{% include helpers_intro.md %}
| Name | Description |
|---|---|
| record_attendance_helper | Allows the creation of an attendance and a person at the same time. |
{% include scenarios_intro.md %}
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:
GET https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances
Header:
OSDI-API-Token:[your api key here]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:
GET https://osdi-sample-system.org/api/v1/events/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances
Header:
OSDI-API-Token:[your api key here]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":"[email protected]",
"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":"[email protected]",
"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":"[email protected]",
"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)
]
}
}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:
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]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:
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]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":"[email protected]",
"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":"[email protected]",
"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"
}
}
}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:
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"
}
}
}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:
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":"[email protected]",
"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":"[email protected]",
"primary": true,
"address_type": "Personal"
}
]
}
}
],
"_links" : {
"osdi:person" : {
"href" : "https://osdi-sample-system.org/api/v1/people/65345d7d-cd24-466a-a698-4a7686ef684f"
}
}
}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":"[email protected]",
"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":"[email protected]",
"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"
}
}
}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.
{% include array_warning.md %}
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"
}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"
}
}
}You may delete an attendance by calling the DELETE command on the attendance's endpoint.
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]200 OK
Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate
{
"notice": "This attendance was successfully deleted."
}