The Mavryx platform responds to every request in JSON format and always includes two basic fields: header and response.
Header
| Field Name | Type | Description |
|---|
| version | Mavryx/Types/Integer | Microservice API version |
| endpoint | Mavryx/Types/String | The responding endpoint (typically the one that was called). |
| referer | Mavryx/Types/String | Requester who called the endpoint. |
| raycast | Mavryx/Types/String | Request tracking identifier |
| request_id | Mavryx/Types/String | Request identifier |
| response_id | Mavryx/Types/String | Response identifier |
| status | Mavryx/Types/Integer | Response status (the response code may not comply with HTTP error codes). |
| message | Mavryx/Types/String | Response message |
Response
| Field Name | Type | Description |
|---|
| response_type | Const | It defines whether a single object, a list of objects, or a basic type has been returned. The possible values are: list, item, simple |
| type | Object Type or Simple Type | The type of the returned object |
| item | Object | If a single object is returned, this field contains information about it. |
| list | Mavryx/Types/Array | If a list of objects is returned, this field contains the list of objects. |
| value | | The value of the returned primitive type |
Example response
{
"header": {
"version": 20240101,
"endpoint": "/oauth2/user/me",
"referer": "https://swagger-dev.mavryx.software",
"raycast": "1b1453327a1f84c766e0208b4b3ad998",
"request_id": "f095ae90e2e201884ec0de8e6cb65614",
"response_id": "20b887831d578eb36852392bf68895d8",
"status": 200,
"message": "OK"
},
"response": {
"type": "item",
"item": {
"uuid": "c940b0ba-d81d-4739-9872-ca762b57ef69",
"type": "Mavryx/User",
"client_id": "john.doe@somwhere.com",
"account_uuid": "27eed955-4473-4319-ba2f-c7a49e40a978"
}
}
}
Was this article helpful to you?
No
Yes