Central Archives Roleplay API 1.0

Endpoints

GET /api/rp/v1/characters/profile/{world}/{name}

Return a character profile by character name and world name

Input parameters

Parameter	In	Type	Nullable	Description
`name`	path	string	No	Character name
`sessionToken`	query	string	No
`world`	path	string	No	Character world

Response 200 OK

Character found

application/json

{
    "appearance": "A statuesque stunner with amber-colored luminous orbs.",
    "background": "Born in Ishgard in a downtrodden peasant family...",
    "occupation": "Red mage",
    "race": "Elezen",
    "nationality": "Nationality",
    "age": "Middle-aged",
    "birthplace": "Ishgard",
    "residence": "Revenant's Toll",
    "title": "Lady",
    "nickname": "Inkie",
    "motto": "Tomorrow is another day.",
    "loves": "Her paramour, Lambert",
    "hates": "Hot chocolate",
    "friends": "Margaux",
    "relatives": "Mother: Arluelle, father: Silgryn",
    "enemies": "Elisande",
    "motivation": "Helping the helpless",
    "currently": "Tired, restless.",
    "oocInfo": "My Discord is: Example#1234",
    "pronouns": "She/her"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "appearance": {
            "type": "string",
            "description": "Character appearance (converted from HTML to plain text)",
            "example": "A statuesque stunner with amber-colored luminous orbs."
        },
        "background": {
            "type": "string",
            "description": "Character background (converted from HTML to plain text)",
            "example": "Born in Ishgard in a downtrodden peasant family..."
        },
        "occupation": {
            "type": "string",
            "description": "Character occupation",
            "example": "Red mage"
        },
        "race": {
            "type": "string",
            "description": "Character race",
            "example": "Elezen"
        },
        "nationality": {
            "type": "string",
            "description": "Character nationality",
            "example": "Nationality"
        },
        "age": {
            "type": "string",
            "description": "Character age",
            "example": "Middle-aged"
        },
        "birthplace": {
            "type": "string",
            "description": "Where the character was born",
            "example": "Ishgard"
        },
        "residence": {
            "type": "string",
            "description": "Where the character lives now",
            "example": "Revenant's Toll"
        },
        "title": {
            "type": "string",
            "description": "Character title, if any",
            "example": "Lady"
        },
        "nickname": {
            "type": "string",
            "description": "Character nickname, if any",
            "example": "Inkie"
        },
        "motto": {
            "type": "string",
            "description": "A quote or phrase describing the character",
            "example": "Tomorrow is another day."
        },
        "loves": {
            "type": "string",
            "description": "Whom or what the character loves",
            "example": "Her paramour, Lambert"
        },
        "hates": {
            "type": "string",
            "description": "Whom or what the character hates",
            "example": "Hot chocolate"
        },
        "friends": {
            "type": "string",
            "description": "The character's friends",
            "example": "Margaux"
        },
        "relatives": {
            "type": "string",
            "description": "The character's relatives",
            "example": "Mother: Arluelle, father: Silgryn"
        },
        "enemies": {
            "type": "string",
            "description": "The character's rivals or enemies",
            "example": "Elisande"
        },
        "motivation": {
            "type": "string",
            "description": "The character's motivation",
            "example": "Helping the helpless"
        },
        "currently": {
            "type": "string",
            "description": "What the character is doing right now during RP",
            "example": "Tired, restless."
        },
        "oocInfo": {
            "type": "string",
            "description": "OOC information about the character or player",
            "example": "My Discord is: Example#1234"
        },
        "pronouns": {
            "type": "string",
            "description": "The character's third-person pronouns",
            "example": "She/her"
        }
    },
    "required": [
        "appearance",
        "background",
        "occupation",
        "race",
        "nationality",
        "age",
        "birthplace",
        "residence",
        "title",
        "nickname",
        "motto",
        "loves",
        "hates",
        "friends",
        "relatives",
        "enemies",
        "motivation",
        "currently",
        "oocInfo",
        "pronouns"
    ]
}

Response 404 Not Found

Character not found

PATCH /api/rp/v1/characters/profile/{world}/{name}

Update a character profile by character name and world name

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearer`	header	string	N/A	No	Access token obtained from OAuth
`name`	path	string		No	Character name
`world`	path	string		No	Character world

Request body

application/json

{
    "occupation": "Red mage",
    "nationality": "Ishgardian",
    "age": "Middle-aged",
    "birthplace": "Ishgard",
    "residence": "Revenant's Toll",
    "title": "Lady",
    "nickname": "Inkie",
    "motto": "Tomorrow is another day.",
    "loves": "Her paramour, Lambert",
    "hates": "Hot chocolate",
    "friends": "Margaux",
    "relatives": "Mother: Arluelle, father: Silgryn",
    "enemies": "Elisande",
    "motivation": "Helping the helpless",
    "currently": "Tired, restless.",
    "oocInfo": "My Discord is: Example#1234",
    "pronouns": "She/her"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "occupation": {
            "type": "string",
            "description": "Character occupation",
            "example": "Red mage"
        },
        "nationality": {
            "type": "string",
            "description": "Character nationality",
            "example": "Ishgardian"
        },
        "age": {
            "type": "string",
            "description": "Character age",
            "example": "Middle-aged"
        },
        "birthplace": {
            "type": "string",
            "description": "Where the character was born",
            "example": "Ishgard"
        },
        "residence": {
            "type": "string",
            "description": "Where the character lives now",
            "example": "Revenant's Toll"
        },
        "title": {
            "type": "string",
            "description": "Character title, if any",
            "example": "Lady"
        },
        "nickname": {
            "type": "string",
            "description": "Character nickname, if any",
            "example": "Inkie"
        },
        "motto": {
            "type": "string",
            "description": "A quote or phrase describing the character",
            "example": "Tomorrow is another day."
        },
        "loves": {
            "type": "string",
            "description": "Whom or what the character loves",
            "example": "Her paramour, Lambert"
        },
        "hates": {
            "type": "string",
            "description": "Whom or what the character hates",
            "example": "Hot chocolate"
        },
        "friends": {
            "type": "string",
            "description": "The character's friends",
            "example": "Margaux"
        },
        "relatives": {
            "type": "string",
            "description": "The character's relatives",
            "example": "Mother: Arluelle, father: Silgryn"
        },
        "enemies": {
            "type": "string",
            "description": "The character's rivals or enemies",
            "example": "Elisande"
        },
        "motivation": {
            "type": "string",
            "description": "The character's motivation",
            "example": "Helping the helpless"
        },
        "currently": {
            "type": "string",
            "description": "What the character is doing right now during RP",
            "example": "Tired, restless."
        },
        "oocInfo": {
            "type": "string",
            "description": "OOC information about the character or player",
            "example": "My Discord is: Example#1234"
        },
        "pronouns": {
            "type": "string",
            "description": "The character's third-person pronouns",
            "example": "She/her"
        }
    }
}

Response 204 No Content

Character updated

Response 400 Bad Request

Invalid character data

Response 403 Forbidden

This is not your character

Response 404 Not Found

Character not found

Schemas

RppCharacterProfileDto

Name	Type	Description
`age`	string	Character age
`appearance`	string	Character appearance (converted from HTML to plain text)
`background`	string	Character background (converted from HTML to plain text)
`birthplace`	string	Where the character was born
`currently`	string	What the character is doing right now during RP
`enemies`	string	The character's rivals or enemies
`friends`	string	The character's friends
`hates`	string	Whom or what the character hates
`loves`	string	Whom or what the character loves
`motivation`	string	The character's motivation
`motto`	string	A quote or phrase describing the character
`nationality`	string	Character nationality
`nickname`	string	Character nickname, if any
`occupation`	string	Character occupation
`oocInfo`	string	OOC information about the character or player
`pronouns`	string	The character's third-person pronouns
`race`	string	Character race
`relatives`	string	The character's relatives
`residence`	string	Where the character lives now
`title`	string	Character title, if any

RppCharacterProfileSaveDto

Name	Type	Description
`age`	string	Character age
`birthplace`	string	Where the character was born
`currently`	string	What the character is doing right now during RP
`enemies`	string	The character's rivals or enemies
`friends`	string	The character's friends
`hates`	string	Whom or what the character hates
`loves`	string	Whom or what the character loves
`motivation`	string	The character's motivation
`motto`	string	A quote or phrase describing the character
`nationality`	string	Character nationality
`nickname`	string	Character nickname, if any
`occupation`	string	Character occupation
`oocInfo`	string	OOC information about the character or player
`pronouns`	string	The character's third-person pronouns
`relatives`	string	The character's relatives
`residence`	string	Where the character lives now
`title`	string	Character title, if any

Security schemes

Name	Type	Scheme	Description
bearer	oauth2	Bearer	Access token obtained from OAuth