Заголовки HTTP, используемые этим API, были реализованы с использованием стандартов, предоставленных в спецификации HTTP 1.1 RFC2616
Request Headers
Accept : type/subtype
- Пример — Accept :
application/xml
- Примечания. По умолчанию используется,
application/xml
если он не передан, и когда пользователь отправляет application/*, результирующий подтип контента будет XML. Можно отправить несколько типов/подтипов, но в соответствии со спецификацией первое совпадение по степени специфичности будет использовано первым.
т.е. если пользователь отправляет: application/*, application/xml, / порядок будет следующим:application/xml
application/*
*/*
- Допустимые значения -
application/xml
,application/json
,application/xsd
,application/help
- Если через заголовок Accept передано недопустимое значение, ответ приведет к ошибке 415 Unsupported Media Type .
Accept-Charset : charset
- Пример — Accept-Charset: utf-8
- Примечания. Accept-Charset не будет использоваться и по умолчанию всегда будет использоваться utf-8.
Accept-Encoding : encoding
- Пример — Accept-Encoding: deflate
- Примечания. Если ничего не отправлено, API по умолчанию не использует сжатие.
- Допустимые значения — deflate, Compress, gzip.
- Если через заголовок Accept-Encoding передано недопустимое значение, ответ приведет к ошибке 406 «Не приемлемо».
Authorization : credentials
- Пример — Authorization: OAuth realm=http://developer.fellowshipone.com/docs/v1
- Примечания. Здесь будут храниться учетные данные OAuth.
Date : HTTP-date
- Пример – Date: четверг, 29 января 2009 г., 15:28:25 по Гринвичу.
- Примечания — необязательные, чаще всего передаются с PUT и POST.
Response Headers
Allow : method
- Пример — Allow: GET, PUT
- Примечания. Поле заголовка Allow ДОЛЖНО присутствовать в ответе 405 (метод не разрешен).
- Возвращаемые значения — GET, PUT, POST, DELETE
Content-Encoding : content-coding
- Пример — Content-Encoding : gzip
- Примечания. Это сообщит клиенту, какой тип сжатия использовался для ресурса.
- Возвращаемые значения — дефляция, сжатие, gzip
Content-Length : DIGIT
- Пример — Content-Length : 1254
- Примечания - Отправляются обратно с каждым запросом. Возможно, будет доступно через запросы HEAD
Content-Location : absoluteURI | relativeURI
- Пример - Content-Location : developer.fellowshipone.com/docs/v1/People/22114944
- Примечания. Отправляются обратно с каждым запросом GET.
Content-Type : media-type
- Пример - Content-Type : application/xml, utf-8
- Примечания. Подробно описывается тип содержимого, возвращаемого клиенту.
Date : HTTP-date
- Пример - Date: Thu, 29 Jan 2009 15:28:25 GMT
- Примечания. Будет возвращен с каждым ответом, возможно, за исключением ответов, возвращающих коды состояния 500.
Location : absoluteURI
- Пример - Location: developer.fellowshipone.com/docs/v1/People/22114944
- Примечания. Применяется только к моделям 201 и 301.
WWW-Authenticate : challenge
- Пример - WWW-Authenticate : OAuth realm: developer.fellowshipone.com/docs/v1
- Примечания. URI будет меняться в зависимости от среды и версии.