Meet Meeples API Documentation

A social network for board game geeks.

UserGroupMembership

POST /groups/:group_id/group_memberships

Endpoint

POST /groups/:group_id/group_memberships

Parameters

Name Description
group[group_id] required The unique id of the group to which the game_night belongs.

Request

Route

POST /groups/3834/group_memberships

Headers

Content-Type: application/x-www-form-urlencoded

Body

group[group_id]=3834

Response

Simulated Response

Status

204

Headers

UserGameNightAttendance

POST /game_nights/:game_night_id/game_night_attendances

Endpoint

POST /game_nights/:game_night_id/game_night_attendances

Parameters

Name Description
game_night[game_night_id] required The unique id of the game_night.

Request

Route

POST /game_nights/3885/game_night_attendances

Headers

Content-Type: application/x-www-form-urlencoded

Body

game_night[game_night_id]=3885

Response

Simulated Response

Status

204

Headers

Profile

GET /profiles

Endpoint

GET /profiles

Request

Route

GET /profiles

Headers

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "data": [
    {
      "id": "9323",
      "type": "users",
      "attributes": {
        "first_name": "Fay",
        "last_name": "Oberbrunner",
        "email": "caesar@jacobson.biz",
        "city": "Lake Lesleyshire",
        "state": "New Hampshire",
        "country": "Lesotho"
      }
    }
  ]
}

GET /profiles/:id

Endpoint

GET /profiles/:id

Parameters

Name Description
id required The unique ID of the user.

Request

Route

GET /profiles/9324

Headers

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "data": {
    "id": "9324",
    "type": "users",
    "attributes": {
      "first_name": "Fay",
      "last_name": "Oberbrunner",
      "email": "caesar@jacobson.biz",
      "city": "Lake Lesleyshire",
      "state": "New Hampshire",
      "country": "Lesotho"
    }
  }
}

Group

GET /groups/

Endpoint

GET /groups/

Request

Route

GET /groups/

Headers

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "data": [
    {
      "id": "3835",
      "type": "groups",
      "attributes": {
        "name": "Minnesota wolves",
        "city": "North Kallie",
        "state": "Georgia",
        "country": "Malta",
        "facebook": "http://facebook.com/antonette",
        "twitter": "http://twitter.com/darrell"
      }
    },
    {
      "id": "3836",
      "type": "groups",
      "attributes": {
        "name": "Minnesota wolves",
        "city": "North Kallie",
        "state": "Georgia",
        "country": "Malta",
        "facebook": "http://facebook.com/antonette",
        "twitter": "http://twitter.com/darrell"
      }
    },
    {
      "id": "3837",
      "type": "groups",
      "attributes": {
        "name": "Minnesota wolves",
        "city": "North Kallie",
        "state": "Georgia",
        "country": "Malta",
        "facebook": "http://facebook.com/antonette",
        "twitter": "http://twitter.com/darrell"
      }
    }
  ]
}

POST /groups

Endpoint

POST /groups

Parameters

Name Description
group[name] required The name of the group.
group[city] required The city where the group is located.
group[state] required The state where the group is located.
group[country] required The country where the group is located.
group[facebook] required The facebook address for the group.
group[twitter] required The twitter address for the group.

Request

Route

POST /groups

Headers

Content-Type: application/x-www-form-urlencoded

Body

group[name]=Waaggh&group[city]=Washington&group[state]=DC&group[country]=USA&group[facebook]=facebook.com%2Fwaaaggh&group[twitter]=%40waaggh

Response

Simulated Response

Status

201

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "data": {
    "id": "3838",
    "type": "groups",
    "attributes": {
      "name": "Waaggh",
      "city": "Washington",
      "state": "DC",
      "country": "USA",
      "facebook": "facebook.com/waaaggh",
      "twitter": "@waaggh"
    }
  }
}

GET /groups/:id

Endpoint

GET /groups/:id

Parameters

Name Description
id required The id of the group.

Request

Route

GET /groups/3839

Headers

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "data": {
    "id": "3839",
    "type": "groups",
    "attributes": {
      "name": "Minnesota wolves",
      "city": "North Kallie",
      "state": "Georgia",
      "country": "Malta",
      "facebook": "http://facebook.com/antonette",
      "twitter": "http://twitter.com/darrell"
    }
  }
}

PATCH /groups/:id

Endpoint

PATCH /groups/:id

Parameters

Name Description
group[name] required The name of the group.
group[city] required The city where the group is located.
group[state] required The state where the group is located.
group[country] required The country where the group is located.
group[facebook] required The facebook address for the group.
group[twitter] required The twitter address for the group.
id required The id of the group.

Request

Route

PATCH /groups/3840

Headers

Content-Type: application/x-www-form-urlencoded

Body

group[name]=Zombicide+Tuesdays&group[city]=Washington&group[state]=DC&group[country]=USA&group[facebook]=facebook.com%2Fzombie&group[twitter]=%40zombie

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "data": {
    "id": "3840",
    "type": "groups",
    "attributes": {
      "name": "Zombicide Tuesdays",
      "city": "Washington",
      "state": "DC",
      "country": "USA",
      "facebook": "facebook.com/zombie",
      "twitter": "@zombie"
    }
  }
}

DELETE /groups/:id

Endpoint

DELETE /groups/:id

Parameters

Name Description
id required The id of the group.

Request

Route

DELETE /groups/3841

Headers

Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Headers

GameNight

PATCH /game_nights/:id

Endpoint

PATCH /game_nights/:id

Parameters

Name Description
game_night[name] The name of the game_night.
game_night[time] required The time of the game_night.
game_night[location_name] required The location of the game_night.
game_night[location_address] The address of the game_night.
id required The id of the game_night.

Request

Route

PATCH /game_nights/3886

Headers

Content-Type: application/x-www-form-urlencoded

Body

game_night[name]=New+Name&game_night[time]=2015-09-12+22%3A49%3A27+%2B0530&game_night[location_name]=Library&game_night[location_address]=999+main+st.+Silver+Spring%2C+MD+20910

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "data": {
    "id": "3886",
    "type": "game_nights",
    "attributes": {
      "name": "New Name",
      "time": "2015-09-12T17:19:27.000Z",
      "location_name": "Library",
      "location_address": "999 main st. Silver Spring, MD 20910"
    }
  }
}

POST /game_nights

Endpoint

POST /game_nights

Parameters

Name Description
game_night[name] The name of the game_night.
game_night[time] required The time of the game_night.
game_night[location_name] required The location of the game_night.
game_night[location_address] The address of the game_night.

Request

Route

POST /game_nights

Headers

Content-Type: application/x-www-form-urlencoded

Body

game_night[name]=Waaggh&game_night[time]=2015-09-12+22%3A49%3A27+%2B0530&game_night[location_name]=Library&game_night[location_address]=999+main+st.+Silver+Spring%2C+MD+20910

Response

Simulated Response

Status

201

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "data": {
    "id": "3887",
    "type": "game_nights",
    "attributes": {
      "name": "Waaggh",
      "time": "2015-09-12T17:19:27.000Z",
      "location_name": "Library",
      "location_address": "999 main st. Silver Spring, MD 20910"
    }
  }
}

GET /game_nights/:id

Endpoint

GET /game_nights/:id

Parameters

Name Description
id required The id of the game_night.

Request

Route

GET /game_nights/3888

Headers

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "data": {
    "id": "3888",
    "type": "game_nights",
    "attributes": {
      "name": "Washington fishes",
      "time": "2016-02-17T00:00:00.000Z",
      "location_name": "Cummerata, Feest and Schmitt",
      "location_address": "Joanny Ridge"
    }
  }
}

DELETE /game_nights/:id

Endpoint

DELETE /game_nights/:id

Parameters

Name Description
id required The id of the game_night.

Request

Route

DELETE /game_nights/3889

Headers

Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Headers

GET /game_nights/

Endpoint

GET /game_nights/

Request

Route

GET /game_nights/

Headers

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "data": [
    {
      "id": "3890",
      "type": "game_nights",
      "attributes": {
        "name": "Washington fishes",
        "time": "2016-02-18T00:00:00.000Z",
        "location_name": "Cummerata, Feest and Schmitt",
        "location_address": "Joanny Ridge"
      }
    },
    {
      "id": "3891",
      "type": "game_nights",
      "attributes": {
        "name": "Washington fishes",
        "time": "2016-02-22T00:00:00.000Z",
        "location_name": "Cummerata, Feest and Schmitt",
        "location_address": "Joanny Ridge"
      }
    },
    {
      "id": "3892",
      "type": "game_nights",
      "attributes": {
        "name": "Washington fishes",
        "time": "2016-02-21T00:00:00.000Z",
        "location_name": "Cummerata, Feest and Schmitt",
        "location_address": "Joanny Ridge"
      }
    }
  ]
}

User

POST /user

Endpoint

POST /user

Parameters

Name Description
user[first_name] required The first name of the user.
user[email] required The email of the user.
user[last_name] required The last name of the user.
user[password] required The password of the user.
user[city] required The city of the user.
user[state] required The state of the user.
user[country] required The country of the user.

Request

Route

POST /user

Headers

Content-Type: application/x-www-form-urlencoded

Body

user[first_name]=Nate&user[email]=admin%40test.com&user[last_name]=Pauzenga&user[password]=helloworld&user[city]=Annapolis&user[state]=MD&user[country]=USA

Response

Simulated Response

Status

201

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "jwt": {
    "payload": {
      "sub": 9335
    },
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NTU3NjI2OTgsImF1ZCI6bnVsbCwic3ViIjo5MzM1fQ.7s-kfylRFch_UdyGPlscKLTKEF5Av5QV_fj1KZ4g3V0"
  }
}

PATCH /user

Endpoint

PATCH /user

Parameters

Name Description
user[first_name] required The first name of the user.
user[email] required The email of the user.
user[last_name] required The last name of the user.
user[password] required The password of the user.
user[city] required The city of the user.
user[state] required The state of the user.
user[country] required The country of the user.

Request

Route

PATCH /user

Headers

Content-Type: application/x-www-form-urlencoded

Body

user[first_name]=John+Doe&user[email]=admin%40test.com&user[last_name]=Pauzenga&user[password]=helloworld&user[city]=Annapolis&user[state]=MD&user[country]=USA

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "data": {
    "id": "9336",
    "type": "users",
    "attributes": {
      "first_name": "John Doe",
      "last_name": "Pauzenga",
      "email": "admin@test.com",
      "city": "Annapolis",
      "state": "MD",
      "country": "USA"
    }
  }
}

DELETE /user

Endpoint

DELETE /user

Request

Route

DELETE /user

Headers

Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Headers