API

Differences between revisions 4 and 6 (spanning 2 versions)
⇤ ← Revision 4 as of 2010-07-02 14:43:02 →
Size: 6766
Editor: 24
Comment:
← Revision 6 as of 2011-11-12 01:57:36 → ⇥
Size: 8624
Editor: ip72-196-101-83
Comment: project moved from LoCoDirectory to LoCoTeamPortal
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## page was renamed from LoCoDirectory/API
Line 80: Line 81:
=== Team Meetings ===

'''URL:''' http://loco.ubuntu.com/services/meeting/

Returns a collections of Team IRC Meeting objects. An individual meeting can be referenced by appending the meeting id to the end of the url.

'''Examples:'''
 * http://loco.ubuntu.com/services/meeting/1/ - The first Team IRC Meeting registered in the !LoCo Directory
 * http://loco.ubuntu.com/services/meeting/?date_begin__gte=2010-06-21 - List meetings starting on or after June 21st, 2010.
 * http://loco.ubuntu.com/services/meeting/?teams=13 - List meetings for the [[FloridaTeam | Florida LoCo Team]].
 * http://loco.ubuntu.com/services/meeting/?chair__user=32 - List all team meetings being chaired by a specific user.
 * http://loco.ubuntu.com/services/meeting/?agenda__owner__user=32 - List of team meetings where a specific user has an agenda item

=== Agenda Items ===

'''URL:''' http://loco.ubuntu.com/services/agenda/

Returns a collections of Agenda Item objects. An individual agenda item can be referenced by appending the item id to the end of the url.

'''Examples:'''
 * http://loco.ubuntu.com/services/agenda/1/ - The first agenda item in the !LoCo Directory
 * http://loco.ubuntu.com/services/agenda/?team_event=2 - List of agenda items for a specific Team Event.
 * http://loco.ubuntu.com/services/agenda/?meeting=1 - List of agenda items for a specific meeting
 * http://loco.ubuntu.com/services/agenda/?owner__user=32 - List of agenda items for a specific user
 * http://loco.ubuntu.com/services/agenda/?owner__user=32&meeting=1 - List of agenda items for a specific user for a specific meeting.
 * http://loco.ubuntu.com/services/agenda/?owner__user=32&meeting__date_begin__gte=2010-06-21 - List of agenda items for a specific user for meetings starting on or after June 21st, 2010.

Starting in version 0.2.11, the Ubuntu LoCo Directory provides a collection of Restful/JSON APIs for accessing the data it provides.

Contents

  1. Available Services
    1. Teams
    2. Global Events
    3. Team Events
    4. Venues
    5. Comments
    6. Attendees
    7. Team Meetings
    8. Agenda Items
    9. Users
    10. Groups
    11. Admins
    12. Countries
    13. Continents

Available Services

All services support GET requests only, there is no write-support available at this time. Service URLs return Collections of objects if no id is given, or an individual Entity if the entity's id is appended to the end of the url. When using a Collection path, a query string may be used to filter the results using fieldname=value.

Teams

URL: http://loco.ubuntu.com/services/teams/

Returns a collections of LoCo Team objects. An individual team can be referenced by appending the team id to the end of the url.

Examples:

Global Events

URL: http://loco.ubuntu.com/services/global/

Returns a collections of Global Event objects. An individual event can be referenced by appending the event id to the end of the url.

Examples:

Team Events

URL: http://loco.ubuntu.com/services/events/

Returns a collections of Team Event objects. An individual event can be referenced by appending the event id to the end of the url.

Examples:

Venues

URL: http://loco.ubuntu.com/services/venues/

Returns a collections of Event Venue objects. An individual venue can be referenced by appending the venue id to the end of the url.

Examples:

Comments

URL: http://loco.ubuntu.com/services/comments/

Returns a collections of user Comment objects. An individual comment can be referenced by appending the comment id to the end of the url.

Examples:

Attendees

URL: http://loco.ubuntu.com/services/attendees/

Returns a collections of registration Attendee objects. An individual attendee can be referenced by appending the attendee id to the end of the url.

Examples:

Team Meetings

URL: http://loco.ubuntu.com/services/meeting/

Returns a collections of Team IRC Meeting objects. An individual meeting can be referenced by appending the meeting id to the end of the url.

Examples:

Agenda Items

URL: http://loco.ubuntu.com/services/agenda/

Returns a collections of Agenda Item objects. An individual agenda item can be referenced by appending the item id to the end of the url.

Examples:

Users

URL: http://loco.ubuntu.com/services/users/

Returns a collections of User objects, these contain only Launchpad user name and team membership information. An individual user can be referenced by appending the user id to the end of the url.

Examples:

Groups

URL: http://loco.ubuntu.com/services/groups/

Returns a collections of Group objects, these contain only Launchpad team name. An individual group can be referenced by appending the group id to the end of the url.

Examples:

Admins

URL: http://loco.ubuntu.com/services/admins/

Returns a collections of Admin objects, these contain only Launchpad username of a Team admin. An individual admin can be referenced by appending the admin id to the end of the url.

Examples:

Countries

URL: http://loco.ubuntu.com/services/countries/

Returns a collections of Country objects, these relate to the country or countries a LoCo Team is from. An individual country can be referenced by appending the country id to the end of the url.

Examples:

Continents

URL: http://loco.ubuntu.com/services/continents/

Returns a collections of Continent objects, these relate to the continent or continents a Country is on. An individual continent can be referenced by appending the continent id to the end of the url.

Examples:

LoCoTeamPortal/API (last edited 2011-11-12 01:57:36 by ip72-196-101-83)