ROM Patches

Endpoint	Description
GET /v1/roms/patches	Gets a list of ROM patches
GET /v1/roms/patches/:patch_id	Gets a ROM patch
DELETE /v1/roms/patches/:patch_id	Deletes a ROM patch

---

GET /v1/roms/patches

Gets a list of ROM patches

Request Parameters

Location	Name	Type	Required?	Description
query	checksum	bool		Append checksum patch. Default: true. (Only applies to "application/patch" requests)
header	Accept	string		Format to return. Must be "application/json" or "application/patch".

Example Request

Header:

GET /v1/roms/patches
Host: api.pkmnapi.com
Authorization: Bearer <access_token>
Accept: application/json

Body:

None

Response Parameters

Name	Type	Description
data	array
data[].id	string	Patch ID.
data[].type	string	Type of resource. Must be "rom_patches".
data[].attributes	object
data[].attributes.description	string	Patch description.
data[].links	object
data[].links.self	string	Link to individual patch 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
ETag: w/"abcdef0123456789abcdef0123456789"

Body:

{
    "data": [
        {
            "id": "1337",
            "type": "rom_patches",
            "attributes": {
                "description": "Change X to Y"
            },
            "links": {
                "self": "https://api.pkmnapi.com/v1/roms/patches/1337"
            }
        },
        ...
    ],
    "links": {
        "self": "https://api.pkmnapi.com/v1/roms/patches"
    }
}

---

GET /v1/roms/patches/:patch_id

Gets a ROM patch

Request Parameters

Location	Name	Type	Required?	Description
url	:patch_id	string	✔️	Patch ID.

Example Request

Header:

GET /v1/roms/patches/1337
Host: api.pkmnapi.com
Authorization: Bearer <access_token>

Body:

None

Response Parameters

Name	Type	Description
data	array
data.id	string	Patch ID. (identical to :patch_id)
data.type	string	Type of resource. Must be "rom_patches".
data.attributes	object
data.attributes.description	string	Patch description.
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
ETag: w/"abcdef0123456789abcdef0123456789"

Body:

{
    "data": {
        "id": "1337",
        "type": "rom_patches",
        "attributes": {
            "description": "Change X to Y"
        },
        "links": {
            "self": "https://api.pkmnapi.com/v1/roms/patches/1337"
        }
    },
    "links": {
        "self": "https://api.pkmnapi.com/v1/roms/patches/1337"
    }
}

---

DELETE /v1/roms/patches/:patch_id

Deletes a ROM patch

Request Parameters

Location	Name	Type	Required?	Description
url	:patch_id	string	✔️	Patch ID.
header	If-Match	string	✔️	ETag of resource.

Example Request

Header:

DELETE /v1/roms/patches/1337
Host: api.pkmnapi.com
Authorization: Bearer <access_token>
If-Match: w/"abcdef0123456789abcdef0123456789"

Body:

None

Response Parameters

None

Example Response

Headers:

HTTP/1.1 204 No Content
Content-Type: application/json
Server: pkmnapi/0.1.0

Body:

None