API docs by Redocly

CharactersWiki

Download OpenAPI specification:Download

CharactersWiki allows authors and fans to manage detailed character profiles, including relationships, allegiances, quotes, weapons, origins, locations, and securely uploaded images, serving as a comprehensive tool for storytelling and creative projects.

Origins

getOrigins

Get all origins.

query Parameters
query
string [ 1 .. 30 ] characters
pageNumber
required
integer <int32> >= 1
perPage
required
integer <int32> [ 1 .. 50 ]
sortDirection
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "maximumPage": 0,
  • "origins": [
    ],
  • "_links": {
    }
}

createOrigin

Create a new origin.

Request Body schema: application/json
required
name
required
string [ 1 .. 100 ] characters
importantPlacesIds
Array of integers <int32> [ items <int32 > ]
description
string [ 0 .. 500 ] characters
charactersIds
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "importantPlacesIds": [
    ],
  • "description": "string",
  • "charactersIds": [
    ]
}

Response samples

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

getPlaces

Get all places.

query Parameters
query
string [ 1 .. 30 ] characters
pageNumber
required
integer <int32> >= 1
perPage
required
integer <int32> [ 1 .. 50 ]
sortDirection
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "maximumPage": 0,
  • "places": [
    ],
  • "_links": {
    }
}

createPlace

Create a new place.

Request Body schema: application/json
required
name
required
string [ 1 .. 100 ] characters
type
required
string [ 1 .. 100 ] characters
originId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "originId": 0
}

Response samples

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

getOrigin

Get details of a specific origin.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": 0,
  • "characters": [
    ],
  • "importantPlaces": [
    ],
  • "description": "string",
  • "_links": {
    }
}

deleteOrigin

Delete a specific origin.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

updateOrigin

Update a specific origin.

path Parameters
id
required
integer <int32>
Request Body schema: application/json
required
name
string [ 0 .. 100 ] characters
importantPlacesIds
Array of integers <int32> [ items <int32 > ]
description
string [ 0 .. 500 ] characters
charactersIds
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "importantPlacesIds": [
    ],
  • "description": "string",
  • "charactersIds": [
    ]
}

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

getPlace

Get details of a specific place.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": 0,
  • "type": "string",
  • "origin": {
    },
  • "_links": {
    }
}

deletePlace

Delete a specific place.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

updatePlace

Update a specific place.

path Parameters
id
required
integer <int32>
Request Body schema: application/json
required
name
string [ 0 .. 100 ] characters
type
string [ 0 .. 100 ] characters
originId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "originId": 0
}

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

Characters

getCharacters

Get all characters.

query Parameters
query
string [ 1 .. 30 ] characters
pageNumber
required
integer <int32> >= 1
perPage
required
integer <int32> [ 1 .. 50 ]
sortDirection
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "maximumPage": 0,
  • "characters": [
    ],
  • "_links": {
    }
}

createCharacter

Create a new character.

Request Body schema: application/json
required
originId
integer <int32>
allegiancesIds
Array of integers <int32> [ items <int32 > ]
familyIds
Array of integers <int32> [ items <int32 > ]
childrenIds
Array of integers <int32> [ items <int32 > ]
loveInterestsIds
Array of integers <int32> [ items <int32 > ]
alliesIds
Array of integers <int32> [ items <int32 > ]
enemiesIds
Array of integers <int32> [ items <int32 > ]
weaponsIds
Array of integers <int32> [ items <int32 > ]
quotesIds
Array of integers <int32> [ items <int32 > ]
title
string [ 0 .. 100 ] characters
firstname
required
string [ 1 .. 100 ] characters
lastname
string [ 0 .. 100 ] characters
nickname
string [ 0 .. 100 ] characters
age
integer <int32>
species
required
string [ 1 .. 50 ] characters
status
required
string [ 1 .. 30 ] characters
hair
required
string [ 1 .. 30 ] characters
eyes
required
string [ 1 .. 30 ] characters
skin
required
string [ 1 .. 30 ] characters
gender
required
string [ 1 .. 50 ] characters
biography
string [ 0 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "originId": 0,
  • "allegiancesIds": [
    ],
  • "familyIds": [
    ],
  • "childrenIds": [
    ],
  • "loveInterestsIds": [
    ],
  • "alliesIds": [
    ],
  • "enemiesIds": [
    ],
  • "weaponsIds": [
    ],
  • "quotesIds": [
    ],
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "nickname": "string",
  • "age": 0,
  • "species": "string",
  • "status": "string",
  • "hair": "string",
  • "eyes": "string",
  • "skin": "string",
  • "gender": "string",
  • "biography": "string"
}

Response samples

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

getImageOfCharacter

Get the image of a specific character.

path Parameters
id
required
integer <int32>
query Parameters
quality
required
string
Enum: "Full" "Preview"

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

createImageForCharacter

Create an image for a specific character.

path Parameters
id
required
integer <int32>
Request Body schema: application/json
image
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "image": "string"
}

Response samples

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

deleteImageOfCharacter

Delete the image of a specific character.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

getWeapons

Get all weapons.

query Parameters
query
string [ 1 .. 30 ] characters
pageNumber
required
integer <int32> >= 1
perPage
required
integer <int32> [ 1 .. 50 ]
sortDirection
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "maximumPage": 0,
  • "weapons": [
    ],
  • "_links": {
    }
}

createWeapon

Create a new weapon.

Request Body schema: application/json
required
name
required
string [ 1 .. 300 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

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

getQuotes

Get all quotes.

query Parameters
query
string [ 1 .. 30 ] characters
pageNumber
required
integer <int32> >= 1
perPage
required
integer <int32> [ 1 .. 50 ]
sortDirection
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "maximumPage": 0,
  • "quotes": [
    ],
  • "_links": {
    }
}

createQuote

Create a new quote.

Request Body schema: application/json
required
Array of objects (CreateQuoteLine)
charactersIds
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "quoteLines": [
    ],
  • "charactersIds": [
    ]
}

Response samples

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

getAllegiances

Get all allegiances.

query Parameters
query
string [ 1 .. 30 ] characters
pageNumber
required
integer <int32> >= 1
perPage
required
integer <int32> [ 1 .. 50 ]
sortDirection
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "maximumPage": 0,
  • "allegiances": [
    ],
  • "_links": {
    }
}

createAllegiance

Create a new allegiance.

Request Body schema: application/json
required
name
required
string [ 1 .. 300 ] characters
note
string [ 0 .. 300 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "note": "string"
}

Response samples

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

getCharacter

Get details of a specific character.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "family": [
    ],
  • "children": [
    ],
  • "age": 0,
  • "firstname": "string",
  • "species": "string",
  • "hair": "string",
  • "eyes": "string",
  • "skin": "string",
  • "gender": "string",
  • "lastname": "string",
  • "nickname": "string",
  • "biography": "string",
  • "allegiances": [
    ],
  • "weapons": [
    ],
  • "quotes": [
    ],
  • "status": "string",
  • "allies": [
    ],
  • "enemies": [
    ],
  • "loveInterests": [
    ],
  • "origin": {
    },
  • "_links": {
    }
}

deleteCharacter

Delete a specific character.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

updateCharacter

Update a specific character.

path Parameters
id
required
integer <int32>
Request Body schema: application/json
required
originId
integer <int32>
allegiancesIds
Array of integers <int32> [ items <int32 > ]
familyIds
Array of integers <int32> [ items <int32 > ]
childrenIds
Array of integers <int32> [ items <int32 > ]
loveInterestsIds
Array of integers <int32> [ items <int32 > ]
alliesIds
Array of integers <int32> [ items <int32 > ]
enemiesIds
Array of integers <int32> [ items <int32 > ]
weaponsIds
Array of integers <int32> [ items <int32 > ]
quotesIds
Array of integers <int32> [ items <int32 > ]
title
string [ 0 .. 100 ] characters
firstname
string [ 0 .. 100 ] characters
lastname
string [ 0 .. 100 ] characters
nickname
string [ 0 .. 100 ] characters
age
integer <int32>
species
string [ 0 .. 50 ] characters
status
string [ 0 .. 30 ] characters
hair
string [ 0 .. 30 ] characters
eyes
string [ 0 .. 30 ] characters
skin
string [ 0 .. 30 ] characters
gender
string [ 0 .. 50 ] characters
biography
string [ 0 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "originId": 0,
  • "allegiancesIds": [
    ],
  • "familyIds": [
    ],
  • "childrenIds": [
    ],
  • "loveInterestsIds": [
    ],
  • "alliesIds": [
    ],
  • "enemiesIds": [
    ],
  • "weaponsIds": [
    ],
  • "quotesIds": [
    ],
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "nickname": "string",
  • "age": 0,
  • "species": "string",
  • "status": "string",
  • "hair": "string",
  • "eyes": "string",
  • "skin": "string",
  • "gender": "string",
  • "biography": "string"
}

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

getWeapon

Get details of a specific weapon.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": 0,
  • "characters": [
    ],
  • "_links": {
    }
}

deleteWeapon

Delete a specific weapon.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

updateWeapon

Update a specific weapon.

path Parameters
id
required
integer <int32>
Request Body schema: application/json
required
name
string [ 1 .. 300 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

getQuote

Get details of a specific quote.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "quoteLines": [
    ],
  • "characters": [
    ],
  • "_links": {
    }
}

deleteQuote

Delete a specific quote.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

updateQuote

Update a specific quote.

path Parameters
id
required
integer <int32>
Request Body schema: application/json
required
Array of objects (CreateQuoteLine)
charactersIds
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "quoteLines": [
    ],
  • "charactersIds": [
    ]
}

Response samples

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

getAllegiance

Get details of a specific allegiance.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": 0,
  • "characters": [
    ],
  • "note": "string",
  • "_links": {
    }
}

deleteAllegiance

Delete a specific allegiance.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

updateAllegiance

Update a specific allegiance.

path Parameters
id
required
integer <int32>
Request Body schema: application/json
required
name
string [ 0 .. 300 ] characters
note
string [ 0 .. 300 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "messages": [
    ]
}