API-förändringar mellan versioner

v2.0

Följande förändringar har skett mellan version 2.0 och version 1.1.

Exception-schemat har förändrats till följande struktur:

Schema

Typ

 

Schema

Typ

 

Problem

 

 

instance

String (url)

Sträng innehållande sökväg till det objekt som bearbetades när felet inträffade (ej obligatorisk)

type

String (url)

Sträng innehållande sökväg till beskrivning av felet (ej obligatorisk)

parameters

Map<String, Object>

Parametrar i requesten (ej obligatorisk)

title

String

Beskrivning av felet

detail

String

Detaljinformation kring felet

status

StatusType

Objekt som beskriver felet

StatusType

 

 

statusCode

Integer

Numerisk http-kod för felet

reasonPhrase

String

Textuell beskrivning av felet

v1.1

Följande förändringar har skett mellan version 1.0 och version 1.1.

 

Resurs GET /settings/{id} har förändrats enligt nedan:

Attribut

Åtgärd

Typ

Notering

Attribut

Åtgärd

Typ

Notering

FeedbackSetting.filters

Tillägg

List<FeedbackFilter>

Lista innehållande eventuella filter som ska appliceras för återkopplingskanalerna i posten

 

Resurs GET /settings har förändrats enligt nedan:

Attribut

Åtgärd

Typ

Notering

Attribut

Åtgärd

Typ

Notering

Request.header

Tillägg

String, String

Header-parameter för möjlighet att matcha returnerade poster utifrån filter. Namn-konvention för filter-parametrar är x-filter-[filternamn], tex x-filter-categories. Det går att applicera en eller flera filter genom att lägga till önskat antal headers enligt:

-H ‘x-filter-[filternamn]: värde’ -H ‘x-filter-[filternamn]: värde’

Ifall filter-parametrar återfinns i anropet så kommer tjänsten ta hänsyn till dessa när matchningsprocenten beräknas för respektive post. Se Filter-matchning vid sökning för ytterligare beskrivning kring användning av filter-parametrar.

WeightedFeedbackSetting.filters

Tillägg

List<FeedbackFilter>

Lista innehållande eventuella filter som ska appliceras för återkopplingskanalerna i posten

WeightedFeedbackSetting.matchPercent

Tillägg

int

Procentuell match av post utifrån de parametrar som skickats med i anropet

 

Resurs PATCH /settings/{id} har förändrats enligt nedan:

Attribut

Åtgärd

Typ

Notering

Attribut

Åtgärd

Typ

Notering

UpdateFeedbackSettingRequest.filters

Tillägg

List<RequestedFeedbackFilter>

Lista innehållande filter som ska appliceras för återkopplingskanalerna i posten. Listan är inte obligatorisk.

 

Resurs POST /settings har förändrats enligt nedan:

Attribut

Åtgärd

Typ

Notering

Attribut

Åtgärd

Typ

Notering

CreateFeedbackSettingRequest.filters

Tillägg

List<RequestedFeedbackFilter>

Lista innehållande filter som ska appliceras för återkopplingskanalerna i posten. Listan är inte obligatorisk.

v1.0

Första version av API:et