Här samlar vi gemensamma namn och format på vanligt förekommande parametrar och objekt i våra API:er. Detta gör vi för att få en enhetlig design på våra API:er och för att underlätta för klienterna.
Gemensamma fält
Namn | Datatyp | Format (exempel) | Regex | Beskrivning |
|---|---|---|---|---|
personalNumber | String | 199001010101 | ^(19|20)[0-9]{10}$ | Personnummer |
personId | String | 15aee472-46ab-4f03-9605-68bd64ebc73f | ^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$ | Unik identifierare för en person (GUID) |
caseId | String | - | - | Ärende-id |
customerNumber | String | - | - | Kundnummer |
mobileNumber | String | 0701234567 | ^07[02369]\d{7}$ | Mobilnummer |
emailAddress | String | test.testsson@test.se | ^((([!#$%&'*+\-/=?^_`{|}~\w])|([!#$%&'*+\-/=?^_`{|}~\w][!#$%&'*+\-/=?^_`{|}~\.\w]{0,}[!#$%&'*+\-/=?^_`{|}~\w]))[@]\w+([-.]\w+)*\.\w+([-.]\w+)*)$ | E-postadress |
organizationNumber | String | 5591621234 | - | Organisationsnummer |
organizationId | String | 15aee472-46ab-4f03-9605-68bd64ebc73f | ^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$ | Unik identifierare för en organisation (GUID) |
Gemensamma objekt
Här samlar vi gemensamma objekt som vi kan återanvända i våra API:er.
Attachment
Bilagor, filer, dokument.
“category” är en kategorisering av bilagan och innehållet i detta fält kan skilja från API till API.
"attachment": {
"category": "ANSOKNINGSHANDLING",
"name": "Namn på dokumentet",
"extension": "PDF",
"mimeType": "application/pdf",
"note": "En anteckning",
"file": "base64"
}
Address
Adress till privatperson eller organisation. Det är inte obligatoriskt att använda alla fält. Välj de som är relevanta för den specifika applikationen.
Beskrivning inom parentes.
"address": {
"street": "Kometvägen", (Gatunamn)
"houseNumber" : "1", (Husnummer)
"appartmentNumber": "LGH 1001", (Lägenhetsnummer)
"postalCode": "812 34", (Postnummer)
"city": "SUNDSVALL", (Stad)
"country": "Sverige", (Land)
"careOf": "Test Testsson", (c/o)
"attention": "Test Testsson", (Namn på den person inom en organisation som brev ska tillställas)
"propertyDesignation": "SUNDSVALL NORRMALM 1:1", (Fastighetsbeteckning)
"emigrated": false,
"addressType": "POPULATION_REGISTRATION_ADDRESS", (Folkbokföringsadress, särskild adress eller utländsk adress)
"addressCategories": [
"POSTAL_ADDRESS", "INVOICE_ADDRESS", "VISITING_ADDRESS" (Postadress, fakturaadress eller besöksadress)
]
}
Olika typer av adresser (addressType):
POPULATION_REGISTRATION_ADDRESS("Folkbokföringsadress"),SEPARATE_ADDRESS("Särskild adress"),FOREIGN_ADDRESS("Utländsk adress")
Olika kategorier av adresser (addressCategory):
POSTAL_ADDRESS("Postadress"),INVOICE_ADDRESS("Fakturaadress"),VISITING_ADDRESS("Besöksadress")