TEAM ORGA API documentation version v1

http://teamorga.com/api/v1

Introduction

The documentation describes the API-endpoints and JSON-formats which enable one to send request and receive responses from the TEAM ORGA API-endpoints.

Trigger an API requests on the command line via cURL like that:

$ curl -X POST http://teamorga.com/api/recurrences \
       -H 'Content-Type: application/json' \
       -H 'Accept: application/vnd.teamorga.v1+json' \
       -H 'Authorization: Token token="s1dHdF-AldFMqKcR7AQgjVNNZOVT5zY5"' \

Make sure to send allways in the header

  • the accepted media type of the response body Accept: application/vnd.teamorga.v1+json and
  • a valid token Authorization: Token token="s1dHdF-AldFMqKcR7AQgjVNNZOVT5zY5",

otherwise you will get an error!

Specifing the header media type for the request body Content-Type: application/json is only needed for POST-/ PUT-requests!

All actions will be executed in the context of the current_user and responses will be based on the specific current user rights!

AUTHENTICATION

Here the user manages token authentication of the API, e.g.

  • requests and creates a token or
  • destroys an existing token.

post

post

Create a new ApiKey.

Trigger the behaviour via cURL at the command line like that:

$ curl -X POST http://teamorga.com/api_keys \
       -H 'Content-Type: application/json' \
       -H 'Accept: application/vnd.teamorga.v1+json' \
       -d '{"user": {"email": "fritz@teamorga.com", "password": "foobar"}}' \

Create a new ApiKey.

Trigger the behaviour via cURL at the command line like that:

$ curl -X POST http://teamorga.com/api_keys \
       -H 'Content-Type: application/json' \
       -H 'Accept: application/vnd.teamorga.v1+json' \
       -d '{"user": {"email": "fritz@teamorga.com", "password": "foobar"}}' \

Headers

  • ContentType: (string )

    Media type of the request body.

    Example:

    Content-Type: application/json
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

Body

Type: application/json

Example:

{
  "user":
    {
      "email": "fritz@teamorga.com",
      "password": "foobar"
    }
}

HTTP status code 201

Created

Body

Type: application/json

Example:

{
  "id": 2,
  "birthday": "1983-04-17",
  "phone": "+49 150 123 45 67",
  "email": "Fritz@teamorga.com",
  "shirt_number": 10,
  "access_token": "X5V5_ha5stUrzi6pgjpP1Q",
  "access_until": "2015-08-20T00:00:00+02:00"
}

HTTP status code 401

Not authorized

delete

delete

Deletes the respective ApiKey.

Deletes the respective ApiKey.

Secured by Token Authentication

URI Parameters

  • id: required (string )

    Account identifier

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 204

No Content

HTTP status code 403

Forbidden

EVENTS

Collection of available recurrences in the respective context.

get

get

Get a list of recurrences.

Get a list of recurrences.

Secured by Token Authentication

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    "id": 233,
    "scheduled_to": "2015-10-24",
    "participation_id": 30,
    "participation": false,
    "participations": [
      {
        "id": 28,
        "status": true,
        "user_id": 3,
        "user_name": "Hans"
      },
      {
        "id": 30,
        "status": false,
        "user_id": 2,
        "user_name": "Fritz"
      }
    ],
    "event": {
      "id": 36,
      "category": "Spieltag",
      "remark": "",
      "place": "Thedenstr.",
      "latitude": 38.9426583,
      "longitude": -94.83177839999999,
      "base_time": "2000-01-01T15:06:00Z",
      "group": {
        "id": 1,
        "name": "First Team"
      }
    }
  },
  {...}
]

get

Entity representing a recurrence

get

Get the recurrence with recurrenceId = {recurrenceId}

Get the recurrence with recurrenceId = {recurrenceId}

Secured by Token Authentication

URI Parameters

  • recurrenceID: required (string )

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Body

Type: application/json

Example:

{
  "id": 233,
  "scheduled_to": "2015-10-24",
  "participation_id": 30,
  "participation": false,
  "participations": [
    {
      "id": 28,
      "status": true,
      "user_id": 3,
      "user_name": "Hans"
    },
    {
      "id": 30,
      "status": false,
      "user_id": 2,
      "user_name": "Fritz"
    }
  ],
  "event": {
    "id": 36,
    "category": "Spieltag",
    "remark": "",
    "place": "Thedenstr.",
    "latitude": 38.9426583,
    "longitude": -94.83177839999999,
    "base_time": "2000-01-01T15:06:00Z",
    "group": {
      "id": 1,
      "name": "First Team"
    }
  }
}

HTTP status code 404

Body

Type: application/json

Example:

{"message": "recurrence not found" }

post

post

Create a status for the recurrence participation.

Create a status for the recurrence participation.

Secured by Token Authentication

URI Parameters

  • recurrenceID: required (string )

Headers

  • Content-Type: (string )

    Media type of the request body.

    Example:

    Content-Type: application/json
  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

Body

Type: application/json

Example:

{
  "participation":
    {
      "status": "false" or "true"
    }
}

HTTP status code 201

Created

put

put

Toggle the status for the recurrence participation.

Toggle the status for the recurrence participation.

Secured by Token Authentication

URI Parameters

  • recurrenceID: required (string )
  • participationID: required (string )

Headers

  • Content-Type: (string )

    Media type of the request body.

    Example:

    Content-Type: application/json
  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Ok

Body

Type: application/json

Example:

{
  "participation":
    {
      "status": "false" or "true"
    }
}

get post

Collection of available comments in the respective context.

get

Get a list of comments.

post

Add a new comment.

Get a list of comments.

Secured by Token Authentication

URI Parameters

  • recurrenceID: required (string )

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

OK

Body

Type: application/json

Example:

[
  {
    id: 123,
    recurrence_id: 123,
    recurrence_name: "Training",
    recurrence_date: "2016-11-24",
    user_id: 123,
    user_name: "Hans-Peter Schmidt",
    body: "Lorem Ipsum dolor sit amet ...",
    created_at: "0000-00-00 00:00:00",
    updated_at: "0000-00-00 00:00:00"
  },
  {
    id: 123,
    recurrence_id: 123,
    recurrence_name: "Training",
    recurrence_date: "2016-11-24",
    user_id: 123,
    user_name: "Hans-Peter Schmidt",
    body: "Lorem Ipsum dolor sit amet ...",
    created_at: "0000-00-00 00:00:00",
    updated_at: "0000-00-00 00:00:00"
  }
]

Add a new comment.

Secured by Token Authentication

URI Parameters

  • recurrenceID: required (string )

Headers

  • Content-Type: (string )

    Media type of the request body.

    Example:

    Content-Type: application/json
  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

Body

Type: application/json

Example:

{
  "recurrence_id": 123,
  "body": "Lorem Ipsum dolor sit amet ..."
}

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "The comment has been properly entered" }

TEAMS

Collection of available groups in the respective context.

get

get

Get a list of groups.

Get a list of groups.

Secured by Token Authentication

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    id: 123,
    name: "First Team"
  },
  {
    id: 123,
    name: "Second Team"
  }
]

get

Entity representing a group

get

Get the group with groupId = {groupId}

Get the group with groupId = {groupId}

Secured by Token Authentication

URI Parameters

  • groupID: required (string )

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Body

Type: application/json

Example:

{
  id: 123,
  name: "Team Name"
}

HTTP status code 404

Body

Type: application/json

Example:

{"message": "group not found" }

get

Collection of available birthdays in the respective context.

get

Get a list of birthdays.

Get a list of birthdays.

Secured by Token Authentication

URI Parameters

  • groupID: required (string )

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    id: 123,
    name: "Hans-Peter Schmidt",
    birthday: "0000-00-00",
    phone: "+49-40-1234567",
    email: "hps@teamorga.com",
    shirt_number: 10,
    valid_until: "0000-00-00"
  },
  {
    id: 123,
    name: "Hans-Peter Schmidt",
    birthday: "0000-00-00",
    phone: "+49-40-1234567",
    email: "hps@teamorga.com",
    shirt_number: 10,
    valid_until: "0000-00-00"
  },
  {
    id: 123,
    name: "Hans-Peter Schmidt",
    birthday: "0000-00-00",
    phone: "+49-40-1234567",
    email: "hps@teamorga.com",
    shirt_number: 10,
    valid_until: "0000-00-00"
  }
]

get

Collection of available comments in the respective context.

get

Get a list of comments.

Get a list of comments.

Secured by Token Authentication

URI Parameters

  • groupID: required (string )

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    id: 123,
    recurrence_id: 123,
    recurrence_name: "Training",
    recurrence_date: "2016-11-24",
    user_id: 123,
    user_name: "Hans-Peter Schmidt",
    body: "Lorem Ipsum dolor sit amet ...",
    created_at: "0000-00-00 00:00:00",
    updated_at: "0000-00-00 00:00:00"
  },
  {
    id: 123,
    recurrence_id: 123,
    recurrence_name: "Training",
    recurrence_date: "2016-11-24",
    user_id: 123,
    user_name: "Hans-Peter Schmidt",
    body: "Lorem Ipsum dolor sit amet ...",
    created_at: "0000-00-00 00:00:00",
    updated_at: "0000-00-00 00:00:00"
  }
]

get

Collection of available recurrences in the respective context.

get

Get a list of recurrences.

Get a list of recurrences.

Secured by Token Authentication

URI Parameters

  • groupID: required (string )

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    "id": 233,
    "scheduled_to": "2015-10-24",
    "participation_id": 30,
    "participation": false,
    "participations": [
      {
        "id": 28,
        "status": true,
        "user_id": 3,
        "user_name": "Hans"
      },
      {
        "id": 30,
        "status": false,
        "user_id": 2,
        "user_name": "Fritz"
      }
    ],
    "event": {
      "id": 36,
      "category": "Spieltag",
      "remark": "",
      "place": "Thedenstr.",
      "latitude": 38.9426583,
      "longitude": -94.83177839999999,
      "base_time": "2000-01-01T15:06:00Z",
      "group": {
        "id": 1,
        "name": "First Team"
      }
    }
  },
  {...}
]

get

Collection of available users in the respective context.

get

Get a list of users.

Get a list of users.

Secured by Token Authentication

URI Parameters

  • groupID: required (string )

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    id: 123,
    name: "Hans-Peter Schmidt",
    birthday: "0000-00-00",
    phone: "+49-40-1234567",
    email: "hps@teamorga.com",
    shirt_number: 10,
    valid_until: "0000-00-00"
  },
  {
    id: 123,
    name: "Hans-Peter Schmidt",
    birthday: "0000-00-00",
    phone: "+49-40-1234567",
    email: "hps@teamorga.com",
    shirt_number: 10,
    valid_until: "0000-00-00"
  },
  {
    id: 123,
    name: "Hans-Peter Schmidt",
    birthday: "0000-00-00",
    phone: "+49-40-1234567",
    email: "hps@teamorga.com",
    shirt_number: 10,
    valid_until: "0000-00-00"
  }
]

Birthdays

Collection of available birthdays in the respective context.

get

get

Get a list of birthdays.

Get a list of birthdays.

Secured by Token Authentication

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    id: 123,
    name: "Hans-Peter Schmidt",
    birthday: "0000-00-00",
    phone: "+49-40-1234567",
    email: "hps@teamorga.com",
    shirt_number: 10,
    valid_until: "0000-00-00"
  },
  {
    id: 123,
    name: "Hans-Peter Schmidt",
    birthday: "0000-00-00",
    phone: "+49-40-1234567",
    email: "hps@teamorga.com",
    shirt_number: 10,
    valid_until: "0000-00-00"
  },
  {
    id: 123,
    name: "Hans-Peter Schmidt",
    birthday: "0000-00-00",
    phone: "+49-40-1234567",
    email: "hps@teamorga.com",
    shirt_number: 10,
    valid_until: "0000-00-00"
  }
]

Comments

Collection of available comments in the respective context.

get

get

Get a list of comments.

Get a list of comments.

Secured by Token Authentication

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    id: 123,
    recurrence_id: 123,
    recurrence_name: "Training",
    recurrence_date: "2016-11-24",
    user_id: 123,
    user_name: "Hans-Peter Schmidt",
    body: "Lorem Ipsum dolor sit amet ...",
    created_at: "0000-00-00 00:00:00",
    updated_at: "0000-00-00 00:00:00"
  },
  {
    id: 123,
    recurrence_id: 123,
    recurrence_name: "Training",
    recurrence_date: "2016-11-24",
    user_id: 123,
    user_name: "Hans-Peter Schmidt",
    body: "Lorem Ipsum dolor sit amet ...",
    created_at: "0000-00-00 00:00:00",
    updated_at: "0000-00-00 00:00:00"
  }
]

delete

delete
Secured by Token Authentication

URI Parameters

  • commentID: required (string )

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

Profile

get

Entity representing a user

get

Get the user with userId = {userId}

Get the user with userId = {userId}

Secured by Token Authentication

URI Parameters

  • userID: required (string )

Headers

  • Authorization: (string )

    Token authentication header.

    Example:

    Authorization: Token token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  • Accept: (string )

    Media type of the response body.

    Example:

    Accept: application/vnd.teamorga.v1+json

HTTP status code 200

Body

Type: application/json

Example:

{
  id: 123,
  name: "Hans-Peter Schmidt",
  birthday: "0000-00-00",
  phone: "+49-40-1234567",
  email: "hps@teamorga.com",
  shirt_number: 10,
  valid_until: "0000-00-00"
}

HTTP status code 404

Body

Type: application/json

Example:

{"message": "user not found" }