API-530

WIP för ny resurs i caseStatus för att returnera statusar på ärenden på nationellt format. Den nationella specen är på svenska, därav är även API:et på svenska.

Request / Response

Förslag på request:
Kräver att vi letar reda på alla caseInstanceId’s för en person / organisation

{
	"anropandeSystem": "något system",
	"huvudman": "165565491460",
	"externAnvandare": "197001011234"
}

Alternativt förslag på request med en utökning av api:et med något sorts flexibelt sätt att skicka in data:

{
	"anropandeSystem": "något system",
	"externAnvandare": "197001011234",
	"flexField": [
		{
			"caseInstanceId": "caseInstanceId-1"	
		},
		{
			"caseInstanceId": "caseInstanceId-2"
		}
	]
}

Antar att vi fortfarande vill veta vem det är som initierar anropet, därav externAnvandare-parametern

Förslag på response

{
	"metadata": 
	{
		"huvudman": "165565491460",
		"externAnvandare": "197001011234",
		"hamtatDatum": "2021-09-29T13:05:00+01:00"
	},
    "kundhandelser": [
        {
        	"kundhandelseId": "caseInstanceId-1",
            "handelserubrik": "Text som kortfattat beskriver händelsen.",
            "handelsebeskrivning": "En ännu längre text som beskriver ärendet med fler detaljer.",
            "kundhandelsekategori": "Åtgärd krävs",
            "registreradTidpunkt": "2021-09-25T12:05:20+01:00"
        },
        {
        	"kundhandelseId": "caseInstanceId-2",
            "handelserubrik": "Text som kortfattat beskriver händelsen.",
            "handelsebeskrivning": "En ännu längre text som beskriver ärendet med fler detaljer.",
            "kundhandelsekategori": "Föreläggande",
            "registreradTidpunkt": "2021-09-24T11:01:10+01:00"
        }
    ]
}

Förklaring

request

parameter	typ	förklaring
anropandeSystem	String	Namn på anropande system
externAnvandare	String	Den externa användare som utför förfrågan, kan vara personnummer eller organisationsnummer.
huvudman	String	Person eller organisation som det skall hämtas uppgifter om.

response → metadata

parameter	typ	förklaring	Extra-info / kommentar
huvudman	String	Person eller organisation som det skall hämtas uppgifter om.
externAnvandare	String	Den externa användare som utför förfrågan, kan vara personnummer eller organisationsnummer.
hamtatDatum	DateTime	Datum när kundhändelserna hämtades, kanske inte oerhört nödvändig men är med i specen.	ISO8601: “YYYY-MM-DDThh:mm:ssTZD” / “2021-09-29T13:05:00+01:00”

response → kundhandelser

parameter	typ	förklaring	Extra-info / kommentar
handelserubrik	String	Kortfattad beskrivning för ärendet
handelsebeskrivning	String	Ännu längre beskrivande text för ärendet	Behövs denna?
kundhandelseId	String	caseInstanceId för ärendet
kundhandelsekategori	String	Typ av händelse för ärendet	Möjliga värden: Mottagningskvittens, Beslut, Föreläggande, Kompletteringsbegäran, Upplysning, Kallelse, Påminnelse, Förfrågan, Svar, Åtgärd krävs
registreradTidpunkt	DateTime	Startdatum för ärendet	Kan tas från klasen `EnvironmentalCase` i caseManagement? Saknar tidpunkt där.