API Response

En response skickas som ett svar av servern på request-meddelandet klienten skickade.

Response Headers

Följande responsheaders KAN (ARP.01) inkluderas i svaret:

HeaderVärde
Access-Control-Allow-OriginTillåten webbadressen som får åtkomst till tjänsten.
Obs! Använd aldrig URL-adresser med wildcard(*) såvida inte REST-resursen verkligen är offentlig
Access-Control-Allow-MethodsTillåtna metoderna som får åtkomst.
Access-Control-Allow-HeadersTillåtna HTTP header som får åtkomst.
Content-Type

Exempelvis:

  • application/json 
  • application/xml  
  • multipart/form-data  
  • text/html 
Cache-ControlInformerar cachemekanismerna.
DateDatum och tid då meddelandet skickades, i format definierat i RFC 3339
ExpiresDatum och tid efter vilket svaret anses vara inaktuellt, i format definierat i RFC 3339
ETagAnvänds för att identifiera den specifika versionen av en resurs. Klienten bör inkludera detta i alla uppdateringsförfrågningar för att säkerställa att den är oförändrad.

HTTP Response koder

I följande tabell definieras svar som är vanligt förekommande som BÖR (ARP.02) stödjas av ditt API när det är tillämpbart enligt RFC 7231.

KodOrsakPOSTGETPUTDELETEPATCH
200OK XX  
201CreatedX    
202AcceptedX XXX
204No content  XXX
400Bad RequestXXXXX
401UnauthorizedXXXXX
403ForbiddenXXXXX
404Not FoundXXXXX
405Not AllowedXXXXX
408Request TimeoutXXXXX
415Unsupported Media TypeXXX X
422Unprocessable EntityX X X
500Internal Service ErrorXXXXX
501Method Not implementedX XXX
502Bad GatewayXXXXX
503Service UnavailableXXXXX
504Gateway TimeoutXXXXX

Statuskoderna är tillämpliga för HTTP requests på både samlingar (collections) och enskilda resurser (resources{id}). Statuskoderna och dess definitioner finns definierade i RFC 2616

HTTP Response koder - beskrivningar

KodStatusNär ska man använda den?
200OKBegäran har behandlats. Används av GET- och PUT-metoden.
201CreatedResursen skapades med hjälp av POST-metoden. Svarets HTTP header “Location” BÖR (ARP.03) returneras för att ange var den nyskapade resursen är tillgänglig.
202AcceptedAnvänds för asynkron bearbetning för att indikera att servern har accepterat begäran men resultatet är inte tillgängligt ännu. Svarets HTTP header “Location” BÖR (ARP.04) returneras för att ange var den skapade resursen kommer att vara tillgänglig. Används av metoderna POST, PUT, DELETE eller PACTH.
204No contentServern behandlade framgångsrikt begäran och returnerar inget innehåll. Används av metoderna PUT, DELETE och PATCH.
400Bad RequestServern kan inte behandla förfrågan (såsom felaktig formningssyntax, storlek för stor, ogiltig eller vilseledande förfrågan, ogiltiga värden i begäran).
401UnauthorisedBegäran kunde inte autentiseras.
403ForbiddenBegäran autentiserades men har inte behörighet att komma åt resursen.
404Not foundResursen hittades inte.
405Not AllowedMetoden implementeras inte för den här resursen. Svaret kan innehålla en Allow i headern som innehåller en lista över giltiga metoder för resursen.
408Request TimeoutFörfrågan avbröts innan svaret mottogs.
415Unsupported Media TypeDenna statuskod anger att servern vägrar att acceptera begäran eftersom innehållstypen som anges i begäran inte stöds av servern.
422Unprocessable EntityDenna statuskod indikerar att servern tog emot begäran men att den inte uppfyllde kraven i backend. Ett exempel är att ett obligatoriskt fält inte tillhandahölls i payload.
500Internal Server errorEtt internt serverfel. Response body kan innehålla felmeddelanden.
501Not ImplementedDet indikerar att förfrågningsmetoden inte stöds av servern och inte kan hanteras för någon resurs. Till exempel stöder servern GET, POST, PUT, DELETE och PATCH men inte OPTIONS-metoden.
502UnauthorisedBad gateway.
503ForbiddenServicen är inte tillgänglig.
504Not foundGateway timeout.