API Message

Datamodell för representation

Datamodellen för en representation BÖR (AME.01) beskrivas med JSON enligt senaste versionen, RFC 8259

Det BÖR (AME.02) förutsättas att alla request headers som standard använder  Accept med värde  application/json . Även andra datamodeller KAN (AME.03) användas, exempelvis XML.

Namnsättningskonvention för message

För fältnamn i request och response body BÖR (AME.04) camelCase eller snake_case notation användas. camelCase innebär att första ordet skrivs med gemener och samtliga andra efterföljande ord börjar med en versal. Inom ett API SKALL (AME.05) namnsättningen vara konsekvent, dvs blanda inte camelCase och snake_case.

Exempel

// dettaArCamelCase
{
 "individId" : "1234"
}

Fältnamn som representerar listor SKALL (AME.06) namnges i pluralform. 

Fältnamn BÖR (AME.07) använda tecken som är alfanumeriska.