Skip to content
Veronika edited this page Dec 17, 2018 · 42 revisions

Getting Started with Hookers API

Protocol : http

Test host : localhost

Port : 8081

General requests :

Client requests :

Employee requests :

Every response contains next core parameters:

Name Value Sample
action string that indicates what kind of request was done "mixesList"
result string that indicates if result of request execution was success or not "ok"
reqId string with unique request identifier "1540760755020"
data object that includes the results of request execution see sample of response data in any request description, for example restaurantsList

Response with query error:

{
"status": 400,
"statusText": "Bad Request",
"errors": [
    {
        "field": [
            "restaurantId"
        ],
        "location": "query",
        "messages": [
            "\"restaurantId\" is required"
        ],
        "types": [
            "any.required"
        ]
    }
]
}