Trainer Parties

Endpoint	Description
GET /v1/trainers/parties	Gets a list of trainer parties
GET /v1/trainers/parties/:trainer_id	Gets a trainer's parties
POST /v1/trainers/parties/:trainer_id	Updates a trainer's parties

GET /v1/trainers/parties

Gets a list of trainer parties

Request Parameters

None

Example Request

Header:

GET /v1/trainers/parties
Host: api.pkmnapi.com
Authorization: Bearer <access_token>

Body:

None

Response Parameters

Name	Type	Description
`data`	array
`data[]`	object
`data[].id`	string	Trainer ID. (identical to `:trainer_id`)
`data[].type`	string	Type of resource. Must be "trainer_parties".
`data[].attributes`	object
`data[].attributes.parties`	array	List of trainer parties.
`data[].attributes.parties[].party`	array	List of Pokémon in party.
`data[].attributes.parties[].party[].level`	number	Level of Pokémon.
`data[].attributes.parties[].party[].pokemon`	object	Pokémon.
`data[].attributes.parties[].party[].pokemon.id`	string	Pokédex ID.
`data[].attributes.parties[].party[].pokemon.type`	string	Type of resource. Must be "pokemon_names".
`data[].attributes.parties[].party[].pokemon.attributes`	object
`data[].attributes.parties[].party[].pokemon.attributes.name`	string	Pokémon name.
`data[].attributes.parties[].party[].pokemon.links`	object
`data[].attributes.parties[].party[].pokemon.links.self`	string	Link to Pokémon resource.
`data[].links`	object
`data[].links.self`	string	Link to current resource.
`links`	object
`links.self`	string	Link to list resource.

Example Response

Headers:

HTTP/1.1 200 OK
Content-Type: application/json
Server: pkmnapi/0.1.0

Body:

{
    "data": [
        {
            "id": "34",
            "type": "trainer_parties",
            "attributes": {
                "parties": [
                    {
                        "party": [
                            {
                                "level": 12,
                                "pokemon": {
                                    "id": "74",
                                    "type": "pokemon_names",
                                    "attributes": {
                                        "name": "GEODUDE"
                                    },
                                    "links": {
                                        "self": "https://api.pkmnapi.com/v1/pokemon/names/74"
                                    }
                                }
                            },
                            {
                                "level": 14,
                                "pokemon": {
                                    "id": "95",
                                    "type": "pokemon_names",
                                    "attributes": {
                                        "name": "ONIX"
                                    },
                                    "links": {
                                        "self": "https://api.pkmnapi.com/v1/pokemon/names/95"
                                    }
                                }
                            }
                        ]
                    }
                ]
            },
            "links": {
                "self": "https://api.pkmnapi.com/v1/trainers/parties/34"
            }
        },
        ...
    ],
    "links": {
        "self": "https://api.pkmnapi.com/v1/trainers/parties"
    }
}

GET /v1/trainers/parties/:trainer_id

Gets a trainer's parties

Request Parameters

Location	Name	Type	Required?	Description
url	`:trainer_id`	string	✔️	Trainer ID.

Example Request

Header:

GET /v1/trainers/parties/34
Host: api.pkmnapi.com
Authorization: Bearer <access_token>

Body:

None

Response Parameters

Name	Type	Description
`data`	object
`data.id`	string	Trainer ID. (identical to `:trainer_id`)
`data.type`	string	Type of resource. Must be "trainer_parties".
`data.attributes`	object
`data.attributes.parties`	array	List of trainer parties.
`data.attributes.parties[].party`	array	List of Pokémon in party.
`data.attributes.parties[].party[].level`	number	Level of Pokémon.
`data.attributes.parties[].party[].pokemon`	object	Pokémon.
`data.attributes.parties[].party[].pokemon.id`	string	Pokédex ID.
`data.attributes.parties[].party[].pokemon.type`	string	Type of resource. Must be "pokemon_names".
`data.attributes.parties[].party[].pokemon.attributes`	object
`data.attributes.parties[].party[].pokemon.attributes.name`	string	Pokémon name.
`data.attributes.parties[].party[].pokemon.links`	object
`data.attributes.parties[].party[].pokemon.links.self`	string	Link to Pokémon resource.
`data.links`	object
`data.links.self`	string	Link to current resource.
`links`	object
`links.self`	string	Link to current resource.

Example Response

Headers:

HTTP/1.1 200 OK
Content-Type: application/json
Server: pkmnapi/0.1.0

Body:

{
    "data": {
        "id": "34",
        "type": "trainer_parties",
        "attributes": {
            "parties": [
                {
                    "party": [
                        {
                            "level": 12,
                            "pokemon": {
                                "id": "74",
                                "type": "pokemon_names",
                                "attributes": {
                                    "name": "GEODUDE"
                                },
                                "links": {
                                    "self": "https://api.pkmnapi.com/v1/pokemon/names/74"
                                }
                            }
                        },
                        {
                            "level": 14,
                            "pokemon": {
                                "id": "95",
                                "type": "pokemon_names",
                                "attributes": {
                                    "name": "ONIX"
                                },
                                "links": {
                                    "self": "https://api.pkmnapi.com/v1/pokemon/names/95"
                                }
                            }
                        }
                    ]
                }
            ]
        },
        "links": {
            "self": "https://api.pkmnapi.com/v1/trainers/parties/34"
        }
    },
    "links": {
        "self": "https://api.pkmnapi.com/v1/trainers/parties/34"
    }
}

POST /v1/trainers/parties/:trainer_id

Updates a trainer's parties

Request Parameters

Location	Name	Type	Required?	Description
url	`:trainer_id`	string	✔️	Trainer ID.
header	`X-Patch-Description`	string		Description of change.
body	`data`	object	✔️
body	`data.type`	string	✔️	Type of data. Must be "trainer_parties".
body	`data.attributes`	object	✔️
body	`data.attributes.parties`	array	✔️	List of trainer parties.
body	`data.attributes.parties[].party`	array	✔️	List of Pokémon in party.
body	`data.attributes.parties[].party[].level`	number	✔️	Level of Pokémon.
body	`data.attributes.parties[].party[].pokemon`	object	✔️	Pokémon.
body	`data.attributes.parties[].party[].pokemon.id`	string	✔️	Pokédex ID.

Example Request

Header:

POST /v1/trainers/parties/34
Host: api.pkmnapi.com
Authorization: Bearer <access_token>
Content-Type: application/json
X-Patch-Description: Update BROCK's party to all GEODUDE

Body:

{
    "data": {
        "type": "trainer_parties",
        "attributes": {
            "parties": [
                {
                    "party": [
                        {
                            "level": 5,
                            "pokemon": {
                                "id": "74"
                            }
                        },
                        {
                            "level": 5,
                            "pokemon": {
                                "id": "74"
                            }
                        },
                        {
                            "level": 5,
                            "pokemon": {
                                "id": "74"
                            }
                        },
                        {
                            "level": 5,
                            "pokemon": {
                                "id": "74"
                            }
                        }
                    ]
                }
            ]
        }
    }
}

Response Parameters

None

Example Response

Headers:

HTTP/1.1 202 Accepted
Content-Type: application/json
Server: pkmnapi/0.1.0

Body:

{}