Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0104ec7a2049892052081b46dc0d145070c37902
api-guidelines/message/message-formats.md
apidesigner 0104ec7a20 Updates message/error-reporting.md 
Auto commit by GitBook Editor
2017-02-03 10:20:56 +00:00

1.1 KiB
Raw Blame History

Message Formats

Response Message Format

All response messages MUST support an application/vnd.siren+json (Siren) based format.

The Siren format MUST NOT be used directly, instead it MUST be used as the base format for every application or domain-specific format to convey specific semantics. E.g. application/vnd.example.siren+json

Error Response Format

Siren-based format MUST be used to communicate a problem (error). This format SHOULD be application or domain-specific accordingly to non-error response format.

Request Message Format

Data body request messages MUST support a application/json (JSON) based format.

The JSON format MUST NOT be used directly, instead it MUST be used as the base format for every application or domain-specific format to convey specific semantics. E.g. application/vnd.example+json.

Data body request messages SHOULD also support the application/x-www-form-urlencoded (URL Encoded) format.