You are on page 1of 3

4/13/2016

FellowshipOneRESTfulAPIHttpHeaders

FellowshipOneRESTAPI
APIIndex|Authentication|HTTPStatusCodes|HTTPHeaders|SingleSignOnClientImplementation
|SingleSignOnHostImplementation

HTTPHeaders
TheHTTPHeadersusedbythisAPIwereimplementedusingthestandardsprovidedfromtheHTTP1.1
specificationRFC2616

RequestHeaders
Accept:type/subtype
ExampleAccept:application/xml
NotesDefaultstoapplication/xmlifoneisnotpassedin,andwhenausersendsapplication/*
theresultingcontentsubtypewillbeXML.Multipletypes/subtypescanbesentinbutasperthe
specificationthefirstmatchindegreeofspecificitywillbethefirstused.
i.e.ifusersendsin:application/,application/xml,*/theorderwouldbeasfollows:
1.application/xml
2.application/*
3.*/*
Acceptablevaluesapplication/xml,application/json,application/xsd,application/help
IfaninvalidvalueispassedinviaAcceptheadertheresponsewillresultina415Unsupported
MediaType
AcceptCharset:charset
ExampleAcceptCharset:utf8
NotesAcceptCharsetwillnotbeusedandwillalwaysdefaulttoutf8
AcceptEncoding:encoding
ExampleAcceptEncoding:deflate
NotesIfnoneissentinthentheAPIwilldefaulttonocompression.
Acceptablevaluesdeflate,compress,gzip
IfaninvalidvalueispassedinviaAcceptEncodingheadertheresponsewillresultina406Not
acceptable
Authorization:credentials
ExampleAuthorization:OAuthrealm=https://demo.staging.fellowshiponeapi.com/v1
NotesThisiswheretheOAuthcredentialswillgo
Date:HTTPdate
https://demo.staging.fellowshiponeapi.com/v1/Util/HttpHeaders.help

1/3

4/13/2016

FellowshipOneRESTfulAPIHttpHeaders

ExampleDate:Thu,29Jan200915:28:25GMT
NotesOptional,mostcommonlypassedinwithPUTsandPOSTs

ResponseHeaders
Allow:method
ExampleAllow:GET,PUT
NotesAnAllowheaderfieldMUSTbepresentina405(MethodNotAllowed)response.
ReturnvaluesGET,PUT,POST,DELETE
ContentEncoding:contentcoding
ExampleContentEncoding:gzip
NotesThiswilltelltheclientwhattypeofcompressionwasusedontheresource
Returnvaluesdeflate,compress,gzip
ContentLength:DIGIT
ExampleContentLength:1254
NotesSentbackwitheachrequest.WillpossiblybeavailableviaHEADrequests
ContentLocation:absoluteURI|relativeURI
ExampleContentLocation:https://demo.staging.fellowshiponeapi.com/v1/People/22114944
NotesSentbackwitheachGETrequest
ContentType:mediatype
ExampleContentType:application/xml,utf8
NotesDetailsthetypeofcontentbeingreturnedtotheclient
Date:HTTPdate
ExampleDate:Thu,29Jan200915:28:25GMT
NotesWillbereturnedwitheveryresponse,possiblyexcludingresponsesreturningstatuscodes
of500
Location:absoluteURI
ExampleLocation:https://demo.staging.fellowshiponeapi.com/v1/People/22114944
NotesAppliesto201and301only
WWWAuthenticate:challenge
ExampleWWWAuthenticate:OAuthrealm:https://demo.staging.fellowshiponeapi.com/v1
NotesTheURIwillchangeperenvironment,perversion
https://demo.staging.fellowshiponeapi.com/v1/Util/HttpHeaders.help

2/3

4/13/2016

FellowshipOneRESTfulAPIHttpHeaders

FellowshipOneRESTAPICopyright2016

https://demo.staging.fellowshiponeapi.com/v1/Util/HttpHeaders.help

3/3