GAganjoor
GanjoorRelatedPerson

split a person who is really two people with the same name (see PersonSplitViewModel); use DryRun = true first to see what would move (Auth policies: ganjoor:modify)

Changed on
post/api/people/split

Request

  • Base URL
    https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Request body

personIdinteger

the person to split

newNamestring nullable

name of the new person; empty = same name as the original

newDescriptionstring nullable

description of the new person (the description of the original is not copied, it describes the other one)

fromPoemIdinteger

first poem (inclusive) of the part that belongs to the new person

fromCoupletIndexinteger

first couplet (inclusive) of FromPoemId that belongs to the new person

toPoemIdinteger nullable

last poem (inclusive) of the part that belongs to the new person; null = up to the end of the book

toCoupletIndexinteger nullable

last couplet (inclusive) of ToPoemId; null = the whole poem

dryRunboolean

only report what would be moved, change nothing

Response

OK

newPersonIdinteger

id of the new person (0 for a dry run)

dryRunboolean

was this a dry run

reportstring nullable

what was (or would be) moved

Changes