ABES/Objects

Bedienungsanleitungen, Dokumentationen, Lern-Videos

03 Verwendete Http-Request-Header

aoRestServer/ODATA für ABES/Objects - Hinweise für Frontend-Entwickler

Neben der eigentlichen Http-URL in Verbindung mit dem Http-Verb können im Http-Protokoll auch zusätzliche Http-Header im Request übergeben werden.
Von diesen Request-Headern wird in folgenden Zusammenhängen Gebrauch gemacht, teilweise ist die gleiche Anforderung auch über Query-Parameter möglich.
Weitere Details zu den Request-Headern finden sich in den offiziellen OData-ProtokollDefinitionen.

 

Client fordert Format an:

a) über Request-Header:

Accept: application/json,application/xml;odata.metadata=minimal

 

b) über Query-Parameter der URL:

…$format=application/json,application/xml;odata.metadata=minimal

 

Wenn beide Angaben vorhanden sind wird die Angabe aus den Query-Parametern benutzt.

 

Client fordert komprimierten Response an:

über Request-Header:

Accept-Encoding: gzip,deflate

 


Client authentifiziert sich:

a) über Request-Header:

Authorization: AbesObjects xxxxxx…

 

b) über Query-Parameter der URL:

…?$authorization=xxxxxx…

 

Wenn beide Angaben vorhanden sind wird die Angabe aus den Query-Parametern benutzt.

 

Client fordert Rückgabeumfang an: (für Create- oder Update-Anforderungen)

über Request-Header:

Prefer: return=minimal|representation

 

minimal: Http-Resultcode ist 204 “No Content” → leerer Body wird zurückgegeben
representation: Http-Resultcode ist 201 “Created” → JSON im Body

Default ist minimal