API Documentation (1.0)

Download OpenAPI specification:Download

Comments

Create comment

path Parameters
poop_id
number
Example: 1
header Parameters
Accept
any
Example: application/json
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
{
  • "comment": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "comment": {
    }
}

Get comments

path Parameters
poop_id
number
Example: 2
header Parameters
Accept
any
Example: application/json

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "comments": [
    ]
}

Delete comment

path Parameters
poop_id
number
Example: 3
id
number
Example: 4
header Parameters
Accept
any
Example: application/json
Content-Type
any
Example: application/x-www-form-urlencoded

Responses

Response samples

Content type
application/json; charset=utf-8
{ }

Feed

Get feed

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "poops": [
    ],
  • "user": {
    }
}

Followers

Get Followers

path Parameters
user_id
number
Example: 8

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "users": [ ]
}

Followings

Get followings

path Parameters
user_id
number
Example: 10

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "users": [
    ]
}

Create following

header Parameters
Content-Type
any
Example: application/json
Request Body schema: any
Schema not provided

Responses

Request samples

Content type
any
{
  "user": {
    "id": 15
  }
}

Response samples

Content type
application/json; charset=utf-8
{ }

Delete following

header Parameters
Content-Type
any
Example: application/json
Request Body schema: any
Schema not provided

Responses

Request samples

Content type
any
{
  "user": {
    "id": 19
  }
}

Response samples

Content type
application/json; charset=utf-8
{ }

Leagues

Get leagues

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "leagues": [
    ]
}

Create league

header Parameters
Content-Type
any
Example: application/json
Request Body schema: any
Schema not provided

Responses

Request samples

Content type
any
{
  "league": {
    "name": "Jefferson",
    "is_public": true,
    "join_code": "5055e431a9"
  }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 5,
  • "name": "Jefferson",
  • "is_public": true,
  • "join_code": "vecbovyof5820",
  • "user_id": 22,
  • "active_from": null,
  • "active_to": null,
  • "created_at": "2021-05-24T16:10:57.753Z",
  • "updated_at": "2021-05-24T16:10:57.753Z",
  • "league_participants_count": 1,
  • "score_type": "poop_count",
  • "league_comments_count": 0,
  • "chat_enabled": true
}

Joinable leagues

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "leagues": [
    ]
}

Update league

path Parameters
id
number
Example: 8
header Parameters
Content-Type
any
Example: application/json
Request Body schema: any
Schema not provided

Responses

Request samples

Content type
any
{
  "league": {
    "is_public": false
  }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "user_id": 26,
  • "id": 8,
  • "is_public": false,
  • "name": "Johana",
  • "score_type": "poop_count",
  • "join_code": "cdb2511a65",
  • "active_from": null,
  • "active_to": null,
  • "created_at": "2021-05-24T16:10:57.845Z",
  • "updated_at": "2021-05-24T16:10:57.845Z",
  • "league_participants_count": 1,
  • "league_comments_count": 0,
  • "chat_enabled": true
}

Delete league

path Parameters
id
number
Example: 10
header Parameters
Content-Type
any
Example: application/x-www-form-urlencoded

Responses

Join public league

path Parameters
league_id
number
Example: 13
header Parameters
Content-Type
any
Example: application/json
Request Body schema: any
Schema not provided

Responses

Request samples

Content type
any
{}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 13,
  • "name": "Karlyn",
  • "is_public": true,
  • "join_code": "3a6db4ed40",
  • "user_id": 31,
  • "active_from": null,
  • "active_to": null,
  • "created_at": "2021-05-24T16:10:57.933Z",
  • "updated_at": "2021-05-24T16:10:57.933Z",
  • "league_participants_count": 2,
  • "score_type": "poop_count",
  • "league_comments_count": 0,
  • "chat_enabled": true
}

Leave leagues

path Parameters
league_id
number
Example: 14
header Parameters
Content-Type
any
Example: application/x-www-form-urlencoded

Responses

Response samples

Content type
application/json; charset=utf-8
{ }

Join private league by code

header Parameters
Content-Type
any
Example: application/json
Request Body schema: any
Schema not provided

Responses

Request samples

Content type
any
{
  "join_code": "015edc73be"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 17,
  • "name": "Ronny",
  • "is_public": true,
  • "join_code": "015edc73be",
  • "user_id": 35,
  • "active_from": null,
  • "active_to": null,
  • "created_at": "2021-05-24T16:10:58.022Z",
  • "updated_at": "2021-05-24T16:10:58.022Z",
  • "league_participants_count": 2,
  • "score_type": "poop_count",
  • "league_comments_count": 0,
  • "chat_enabled": true
}

Me

Get poops

header Parameters
Accept
any
Example: application/json

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "poops": [
    ],
  • "user": {
    }
}

Poops

Create poop

header Parameters
Accept
any
Example: application/json
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
{
  • "poop": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "poop": {
    }
}

Like poop

header Parameters
Accept
any
Example: application/json
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
{
  • "id": 11
}

Response samples

Content type
application/json; charset=utf-8
{ }

Unlike poop

header Parameters
Accept
any
Example: application/json
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
{
  • "id": 12
}

Response samples

Content type
application/json; charset=utf-8
{ }

Get poops

header Parameters
Accept
any
Example: application/json

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "poops": [
    ],
  • "user": {
    }
}

Update poop

path Parameters
id
number
Example: 14
header Parameters
Accept
any
Example: application/json
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
{
  • "poop": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "poop": {
    }
}

Delete poop

path Parameters
id
number
Example: 15
header Parameters
Accept
any
Example: application/json
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json; charset=utf-8
{ }

Devices

Create device

header Parameters
Content-Type
any
Example: application/x-www-form-urlencoded

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "device": {
    }
}

Users

Create user

header Parameters
Content-Type
any
Example: application/json
Request Body schema: any
Schema not provided

Responses

Request samples

Content type
any
{
  "user": {
    "username": "pooper52",
    "email": "[email protected]",
    "password": "123123",
    "password_confirmation": "123123"
  }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "user": {
    }
}

Update user

path Parameters
id
number
Example: 55
header Parameters
Content-Type
any
Example: application/json
Request Body schema: any
Schema not provided

Responses

Request samples

Content type
any
{
  "user": {
    "show_poops_world": true
  }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "user": {
    }
}

Get users

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "user": {
    }
}

Get user

path Parameters
id
number
Example: 59

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "user": {
    }
}

Get stats

path Parameters
user_id
number
Example: 60

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "account_days": 10,
  • "poops": {
    }
}

Get badges

path Parameters
user_id
number
Example: 62

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "badges": [
    ]
}

World

Get world poops

header Parameters
Accept
any
Example: application/json

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "user": {
    },
  • "poops": [
    ]
}