ICWE REST API v0.6 Reference Manual
This is the ICWE REST API documentation, which gives detailed endpoint descriptions for accessing REST resources.
Endpoints and Methods (HTTP BASIC AUTH PROTECTED)
Participant Methods
GET Participants by event
http://api.icwe-secretariat.com/participants/:event_code
This method allows you to retrieve a list of all valid participants by event.
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
Example:
event_code: "OEB-14" registration_id: "6423" payment_status: "100" title: "" first_name: "Max" surname: "Mustermann" institution: "ICWE" country: "" email: "example@example.de" delegate_status: "Attend" session_code_reference: "M3" form_of_address: "Mr" position: "Training Manager" department: "Business Management" city: "Berlin" website: "http://www.icwe.net"
Valid means:
- JSON field "payment_status" != 0
- JSON field "email" != LEER
GET Number of participants by event
http://api.icwe-secretariat.com/participantsCount/:event_code
This method allows you to retrieve the number of all valid participants by event.
| Parameter | Example alue | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
Example:
count: "91"
GET single Participant by event and registration id
http://api.icwe-secretariat.com/participantsCount/:event_code/:registration_id
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
| registration_id | 6423 | Number | — |
Example:
event_code: "OEB-14" registration_id: "6423" payment_status: "100" title: "" first_name: "Max" surname: "Mustermann" institution: "ICWE" country: "" email: "example@example.de" delegate_status: "Attend" session_code_reference: "M3" form_of_address: "Mr" position: "Training Manager" department: "Business Management" city: "Berlin" website: "http://www.icwe.net"
Speaker Methods
GET speakers by event
http://api.icwe-secretariat.com/speakers/:event_code
This method allows you to retrieve a list of all valid speakers by event.
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
Valid means:
- JSON field "status" = accepted
- JSON field "session_code" != NULL
- JSON field "session_code" != LEER
- JSON field "session_title" != NULL
- JSON field "session_title" != LEER
- JSON field "surname" != T.B.C.
Notes:
- The JSON field "session_code_reference" links to the sessions in which the speaker takes part.
Example:
event_code: "OEB-14"
address_id: "9660"
_ids: "3583694"
degree: null
first_name: "Max"
surname: "Mustermann"
institution: "University of Helsinki"
position: "Manager"
country: "Germany"
country_iso: "GER"
website: "www.icwe.net"
email: "example@example.net"
session_code_reference:
{
session_code: "OPN35"
speaker_id: "11111"
state: "accepted"
theme: "OPN – Open Education, OER, MOOCs, Badges"
title_of_paper: "Global Higher Education and Blockbuster MOOCs"
speaker_type: "Speaker"
}
bio_degree: "Prof"
description: "
Eine wunderbare Heiterkeit hat meine ganze Seele eingenommen, gleich den süßen Frühlingsmorgen, die ich mit ganzem Herzen genieße.
" twitter: "@test" imageOrigURL: "http://www.icwe-secretariat.com/icwe_webprojects_cms/uploads/resize_0123456_surname.jpg"GET Number of speakers by event
http://api.icwe-secretariat.com/speakersCount/:event_code
This method allows you to retrieve the number of all valid speakers by event.
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
Example:
count: "91"
GET single speaker by event and address id
http://api.icwe-secretariat.com/speakers/:event_code/:address_id
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
| address_id | 29363 | Number | — |
Example:
event_code: "OEB-14"
address_id: "9660"
_ids: "3583694"
degree: null
first_name: "Max"
surname: "Mustermann"
institution: "University of Helsinki"
position: "Manager"
country: "Germany"
country_iso: "GER"
website: "www.icwe.net"
email: "example@example.net"
session_code_reference:
{
session_code: "OPN35"
speaker_id: "11111"
state: "accepted"
theme: "OPN – Open Education, OER, MOOCs, Badges"
title_of_paper: "Global Higher Education and Blockbuster MOOCs"
speaker_type: "Speaker"
}
bio_degree: "Prof"
description: "
Eine wunderbare Heiterkeit hat meine ganze Seele eingenommen, gleich den süßen Frühlingsmorgen, die ich mit ganzem Herzen genieße.
" twitter: "@test" imageOrigURL: "http://www.icwe-secretariat.com/icwe_webprojects_cms/uploads/resize_0123456_surname.jpg"Session Methods
GET sessions by event
http://api.icwe-secretariat.com/sessions/:event_code
This method allows you to retrieve a list of all valid sessions by event.
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
Valid means:
- JSON field "status" = accepted
- JSON field "session_code" != NULL
- JSON field "session_code" != LEER
- JSON field "session_title" != NULL
- JSON field "session_title" != LEER
- JSON field "surname" != T.B.C.
Notes:
- The JSON field "address_id_reference" links to the speakers address ids of the session in the order (asc) defined by the database field "SessionPosition".
Example:
event_code: "OEB-14" session_code: "A1" address_id_reference: "18912,141361,159138" chairperson_address_id_reference: "18912" speaker_address_id_reference: "141361,159138" title: "Sharing, Enabling, Connecting" session_type: "Pre-Conference Workshop" session_date: "2014-12-03" session_date_display: "Wednesday, December 3, 2014" time_display: "15:00 - 18:00" time_start: "15:00" time_end: "18:00" date_start: "2014-12-03 15:00:00" date_end: "2014-12-03 18:00:00" room: "Potsdam" description: "Eine wunderbare Heiterkeit hat meine ganze Seele eingenommen, gleich den süßen Frühlingsmorgen, die ich mit ganzem Herzen genieße." theme: "IMM – Immersive Learning, Engagement, Games" notice: "Eine wunderbare Heiterkeit hat meine ganze Seele eingenommen, gleich den süßen Frühlingsmorgen, die ich mit ganzem Herzen genieße."
GET Number of sessions by event
http://api.icwe-secretariat.com/sessionsCount/:event_code
This method allows you to retrieve the number of all valid sessions by event.
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
Example:
count: "91"
GET single session by event and session_code
http://api.icwe-secretariat.com/sessions/:event_code/:session_code
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
| session_code | A1 | String | — |
Example:
event_code: "OEB-14" session_code: "A1" address_id_reference: "18912,141361,159138" chairperson_address_id_reference: "18912" speaker_address_id_reference: "141361,159138" title: "Sharing, Enabling, Connecting" session_type: "Pre-Conference Workshop" session_date: "2014-12-03" session_date_display: "Wednesday, December 3, 2014" time_display: "15:00 - 18:00" time_start: "15:00" time_end: "18:00" date_start: "2014-12-03 15:00:00" date_end: "2014-12-03 18:00:00" room: "Potsdam" description: "Eine wunderbare Heiterkeit hat meine ganze Seele eingenommen, gleich den süßen Frühlingsmorgen, die ich mit ganzem Herzen genieße." theme: "IMM – Immersive Learning, Engagement, Games" notice: "Eine wunderbare Heiterkeit hat meine ganze Seele eingenommen, gleich den süßen Frühlingsmorgen, die ich mit ganzem Herzen genieße."
1) For the right syntax of the internal event codes of the ICWE please contact: info@icwe.net
The Online EDUCA has for example "OEB-14".
Endpoints and Methods (PUBLIC)
Exhibitor Methods
GET exhibitors by event
http://api.icwe-secretariat.com/public/exhibitors/:event_code
This method allows you to retrieve a list of all valid exhibitors by event.
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
Valid means:
- JSON field "show_online" = 1
Notes:
- Because this is a public endpoint, you can't add the global parameter ?ALL=true. So you can call only valid items.
Example:
event_code: "OEB-14" id: "106" show_online: "1" institution: "Canvas" stand_name: "Canvas" stand: "35A" contact_person: "Max Musterman" first_name: "Martha " surname: "Musterfrau" street: "Street 5" zip: "N1C 4AG" city: "London" country: "GBR" phone: "+44 20 305911111" fax: "+44 20 3051111" email: "example@example.com" website: "www.icwe.net." description: "Eine wunderbare Heiterkeit hat meine ganze Seele eingenommen, gleich den süßen Frühlingsmorgen, die ich mit ganzem Herzen genieße." modified: "2014-09-19 12:19:55" category_kind: "Software Provider" category_sector: "Further Education Higher Education Primary Education Secondary Education" category_service: "Cloud Based Learning Collaborative Working and Learning Content Management (LMS, LCMS) Learning Platforms Open Educational Resources (OER) and MOOCs Video for Learning, Webcasts and Lecture Capture"
GET Number of exhibitors by event
http://api.icwe-secretariat.com/public/exhibitorsCount/:event_code
This method allows you to retrieve the number of all valid exhibitors by event.
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
Notes:
- Because this is a public endpoint, you can't add the global parameter ?ALL=true. So you can call only valid items.
Example:
count: "91"
GET single exhibitor by event and id
http://api.icwe-secretariat.com/public/exhibitors/:event_code/:id
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
| id | 106 | Number | — |
Notes:
- Because this is a public endpoint, you can't add the global parameter ?ALL=true. So you can call only valid items.
Example:
event_code: "OEB-14" id: "106" show_online: "1" institution: "Canvas" stand_name: "Canvas" stand: "35A" contact_person: "Max Musterman" first_name: "Martha " surname: "Musterfrau" street: "Street 5" zip: "N1C 4AG" city: "London" country: "GBR" phone: "+44 20 30566777791912" fax: "+44 20 30665977771912" email: "example@example.com" website: "www.icwe.net." description: "Eine wunderbare Heiterkeit hat meine ganze Seele eingenommen, gleich den süßen Frühlingsmorgen, die ich mit ganzem Herzen genieße." modified: "2014-09-19 12:19:55" category_kind: "Software Provider" category_sector: "Further Education Higher Education Primary Education Secondary Education" category_service: "Cloud Based Learning Collaborative Working and Learning Content Management (LMS, LCMS) Learning Platforms Open Educational Resources (OER) and MOOCs Video for Learning, Webcasts and Lecture Capture"
Bio Methods
GET bios by event
http://api.icwe-secretariat.com/public/bios/:event_code
This method allows you to retrieve a list of all valid bios by event.
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
Valid means:
- The bio owner has a participant_type entry in the conference_participant table.
Notes:
- Because this is a public endpoint, you can't add the global parameter ?ALL=true. So you can call only valid items.
Example:
TBA
GET Number of bios by event
http://api.icwe-secretariat.com/public/biosCount/:event_code
This method allows you to retrieve the number of all valid bios by event.
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
Notes:
- Because this is a public endpoint, you can't add the global parameter ?ALL=true. So you can call only valid items.
Example:
count: "91"
GET single bio by event and address id
http://api.icwe-secretariat.com/public/bios/:event_code/:address_id
| Parameter | Example value | Type | Description |
|---|---|---|---|
| event_code | "OEB-14" | String | see 1) |
| address_id | 106 | Number | — |
Notes:
- Because this is a public endpoint, you can't add the global parameter ?ALL=true. So you can call only valid items.
Example:
TBA
1) For the right syntax of the internal event codes of the ICWE please contact: info@icwe.net
The Online EDUCA has for example "OEB-14".
Pagination and filtering parameters
The following request parameters are valid for some GET methods, and the endpoint documentation indicates if the method supports common request parameters.
Conforming endpoints might not support all of these parameters!
| Name | Type | Default | Description |
|---|---|---|---|
| LIMIT | Number | 0 |
Maximum number of entries to return. |
| OFFSET | Number | 0 |
Index of first item to return. |
| MODIFIED_SINCE | String |
Response filter delivering only datasets where the modified timestamp in the database is newer then the parameters value. Format: 'YYYY-MM-DD-hh-mm-ss', e.g. '2014-09-12-15-45-25' |
|
| DISPLAY | String | full |
Response type:
|
| ALL | Bool | false |
Response type:
Delivers all database rows ignoring the "valid" criteria. |
Special parameters for the speakers method
| Name | Type | Default | Description |
|---|---|---|---|
| speaker_type | String | Response type:
|
|
| session_code | String | Response type:
|
Special parameters for the bios method
| Name | Type | Default | Description |
|---|---|---|---|
| bio_type | String | Response type:
|
HTTP status codes
TODO