Back to top

Reservation Engine

The R-Engine API is a RESTful API. This means that the API is designed to allow you to get, create, update, & delete objects with the HTTP verbs GET, POST, PUT, PATCH, & DELETE.

Response Type (JSON)

The R-Engine API responses are exclusively in JSON format. This means that you should always set the Content-Type header to application/json to ensure that your requests are properly accepted and processed by the API.

Authentication (Basic)

R-Engine’s REST API is protected by the same restrictions which are provided via R-Engine standard web interface. This means that if you do not log in, you will not have any access to R-Engine Information. Furthermore, if you log in and do not have permission to view something in R-Engine, you will not be able to view it using the R-Engine REST API either. Because we are using R-Engine backend authentication credentials we should define them at the API call. Credentials should be encoded with Base64. The header is formatted like so.

Example Authentication

Authorization: Basic -u $USERNAME:$PASSWORD

Versioning

The R-Engine API is constantly being worked on to add features, make improvements, and fix bugs. This means that you should expect changes to be introduced and documented. Whenever we make a significant change to an endpoint, we will increase the version number used in the path of the resource being requested. However, there are some changes or additions that are considered backwards-compatible and your applications should be flexible enough to handle them.

These include: Adding new endpoints to the API Adding new attributes to the response of an existing endpoint.Changing the order of attributes of responses (JSON by definition is an object of unordered key/value pairs) Because we aren’t versioning the API in the URI we need to define an Accept header to request a specific version.

For the first version (v1) the header is formatted like so.

Accept: application/vnd.rengine.v1+json

For the current version (v2) header is formatted like so.

Accept: application/vnd.rengine.v2+json

Getting Started

How to start

In order to start using R-Engine API you just need to:

  • Sign in using your R-Engine Ultimate administrator account. If you don’ t have R-Engine Ultimate account please sign up or watch our introduction video learn more,

  • Create a new api user account,

  • Ready to go!

Make your first API call

Once you have created your app, you will be given a a username and a password. These will be used to authenticate your application when calling the API.

Try executing the following command to see the R-Engine services available in your account, just replace $USERNAME & $PASSWORD with your application’s credentials.

curl -v -H "Accept: application/vnd.rengine.v2+json" -u $USERNAME:$PASSWORD https://app.rese.io/api/services

Filtering

All GET Request endpoints can be filtered by multiple keys as query parameters as listed below.

/api/services/?filter[$RESPONSE_KEY]=$VALUE

Multiple filters are implemented using “&”. In many cases instead of ‘=’ you can replace it with specific operators that will be inticated a each end point. A sapmle call will look like so.

/api/services/?filter[$RESPONSE_KEY][$OPERATOR]$VALUE

Sorting

All GET Request endpoints can be sorted by a key adding a sorting query parameter as listed below (ASCEDING SORTING).

/api/services/?sort=$RESPONSE_KEY

It sorts only with one key and if it has a minus prefix it sorts descending as listed below (DECEDING SORTING).

/api/services/?sort=-$RESPONSE_KEY

Services

The services resource The Services endpoint returns information about the R-Engine Services (vehicles, equipments, yachts) offered from the companies associated to authenticated user. The response includes the display name and other details and groups of info about each service, and lists the services in the proper display order as they are stored initial at the database. You can re-sort the results by add sorting filter at your request as show here.

This endpoint does not reflect real-time availability of the services without “Availability filters”. You can use the the same endpoint to determine real-time availability by using “Availability filters” as show below.

In some cases, the list of service returned may contain double or more services with duplicate names. This is due to multi-company results. You can get unique results if your filter them by company.

Resource End Points

Method Endpoint Description
GET /api/services/ List all services
GET /api/services/{service_id}{service_id},… Get details about specific service(s)

List Services

List Services
GET/api/services

Example URI

GET https://app.rese.io/api/services
URI Parameters
HideShow
filter[extra_filters][companyid]
integer (optional) Example: 14

The companyid of the company you want services from

filter[extra_filters][brand]
integer (optional) Example: 10

The brand of the brand you want services from.

filter[extra_filters][alias]
String (optional) Example: vw-polo

The alias of a specific service.

filter[extra_filters][title]
String (optional) Example: Volkswagen Polo

The title of a specific service.

filter[extra_filters][category_id]
integer (optional) Example: 10

The category_id of a specific group of services.

filter[extra_filters][radius]
String (optional) Example: R-100

value = -1 (default) unstricted results sorted by closest.
value = 1 restrinct results to search zone.
value = R-100 restrict resuts to 100kms from start_coordinates point.

Response  200
HideShow
Body
{
  "data": [
    {
      "id": 32161,
      "alias": "MATIZ",
      "title": "MATIZ",
      "text_flag": "",
      "description": "some description",
      "includes": "",
      "excludes": "",
      "pax": 1,
      "min_pax": 1,
      "type": "daily",
      "media": [
        "https://secure.reservationengine.net/rest/assets/bizz/1435697883-matiz.jpg"
      ],
      "company": {
        "id": 14,
        "name": "bizz",
        "url": "Bizz.com",
        "alias": "bizz",
        "email": "info@reservationengine.net",
        "phone": "1234567890",
        "social": [
          {
            "social": "facebook.com",
            "alias": "johndoe"
          }
        ],
        "vat_reg_num": "``",
        "country": "FRA",
        "address": "P.O. Box 566",
        "city": "Paris",
        "reservation_email": "example@biz.com",
        "currency": "$",
        "media": [
          "https://secure.reservationengine.net/rest/assets/bizz/1471249140-xitelogo.jpg"
        ]
      },
      "group": {
        "id": 1339,
        "name": "7 passenger",
        "description": "Explorer/Pathfinder"
      },
      "total_availability": false,
      "available_spots": false,
      "maxmin": "null",
      "total_days": "null",
      "total_price": "false",
      "offers_applied": false,
      "availabilities_and_rates": [],
      "extras": [
        {
          "id": 2593,
          "name": "baby seat",
          "description": "Baby seat description",
          "media": "``",
          "params": {
            "rangeMax": 2,
            "rangeMin": 1,
            "price": 5,
            "fixedPrice": 3,
            "parent": "null (null,nullable)"
          }
        }
      ],
      "attributes": [
        {
          "id": 2522,
          "name": "Passengers",
          "description": "some description",
          "value": 22
        }
      ],
      "providers": []
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "id of the specific resource."
          },
          "alias": {
            "type": "string",
            "description": "the alias of the specific resource. Short name of the service."
          },
          "title": {
            "type": "string",
            "description": "The title of the specific resource. Full name of the service."
          },
          "text_flag": {
            "type": [
              "string",
              "null"
            ],
            "description": "A text flag."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "A more detailed description of the service."
          },
          "includes": {
            "type": [
              "string",
              "null"
            ]
          },
          "excludes": {
            "type": [
              "string",
              "null"
            ]
          },
          "pax": {
            "type": [
              "number",
              "null"
            ]
          },
          "min_pax": {
            "type": [
              "number",
              "null"
            ]
          },
          "type": {
            "type": "string",
            "description": "Type of availability"
          },
          "media": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "The fullpath of the images related to the specific service (e.g.the photo of a car)."
          },
          "company": {
            "type": "object",
            "properties": {
              "id": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "The id of the specific company."
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The name of the specific company."
              },
              "url": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The full url of the specific company."
              },
              "alias": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The name shotcode of the specific company."
              },
              "email": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The contact email of the specific company."
              },
              "phone": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The contact phone of the specific company."
              },
              "social": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "social": {
                      "type": "string",
                      "description": "social platform"
                    },
                    "alias": {
                      "type": "string",
                      "description": "alias of the specific resource in the platform specified"
                    }
                  },
                  "required": [
                    "social",
                    "alias"
                  ]
                },
                "description": "The basic social url of the specific company."
              },
              "vat_reg_num": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The vat registration number of the specific company"
              },
              "country": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The international ISO 3166 (A2 or A3) code of country of the specific company."
              },
              "address": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The full address of the specific company."
              },
              "city": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The city of the specific company."
              },
              "reservation_email": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The email that will be send all the bookings confirmations of the specific company. This can be empty in case company doesn’t need notificaitons."
              },
              "currency": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The symbol of currency of the specific company."
              },
              "media": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                },
                "description": "The fullpath of the images related to the specific company (e.g.the logo of the company)."
              }
            },
            "description": "The basic company details of the specific service. Company is the provider of the specific service."
          },
          "group": {
            "type": "object",
            "properties": {
              "id": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "The id of the specific category."
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The name of the specific category."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "A more detailed description of the specific category."
              }
            },
            "description": "The basic group details of the specific service. Group is a category of the services. Many services can be at the same group."
          },
          "total_availability": {
            "type": "boolean",
            "description": "Indicates where there is availability for all requested dates. Without availability filters will be always false."
          },
          "available_spots": {
            "type": "boolean",
            "description": "Indicates where there are availability spots."
          },
          "maxmin": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_days": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_price": {
            "type": "string"
          },
          "offers_applied": {
            "type": "boolean"
          },
          "availabilities_and_rates": {
            "type": "array",
            "description": "Always empty when no availability filters specified."
          },
          "extras": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "The id of the specific ‘n’ extra."
                },
                "name": {
                  "type": "string",
                  "description": "(string,nullable) - The name of the specific ‘n’ extra."
                },
                "description": {
                  "type": "string",
                  "description": "(string,nullable) - A more detailed description of the specific ‘n’ extra."
                },
                "media": {
                  "type": "string",
                  "description": "(string,nullable) - A full path of preview image of the specific ‘n’ extra."
                },
                "params": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "rangeMax": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the end value of a valid values range of the specific ‘n’ extra (e.g. “1” in a range [0,1] means the true value, “10” in a range [0,10] means that 10 of that extra can be added to the booking)"
                    },
                    "rangeMin": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the start value of a valid values range of the specific ‘n’ extra (e.g. “0” in a range [0,1] means the false value, “0” in a range [0,10] means the first value of a a selectable range)"
                    },
                    "price": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the daily price of the specific ‘n’ extra."
                    },
                    "fixedPrice": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the total price of the specific ‘n’ extra. In case this field is not empty, it overrides the daily price."
                    },
                    "parent": {
                      "type": "string",
                      "description": "Indicates the id of another extra in case there is a grouping of them."
                    }
                  },
                  "description": "Details about the pricing rules of the specific ‘n’ extra."
                }
              },
              "required": [
                "id"
              ]
            },
            "description": "The extras that are assigned to the specific service. Extras are the features that a user can add to his booking (e.g booster, gps, ski facilities, insurance e.t.c)."
          },
          "attributes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "the id of the specific 'n' attribute."
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The name of the specific ‘n’ attribute."
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "A more detailed description of the specific ‘n’ attribute."
                },
                "value": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "description": "The value of the specific ‘n’ attribute."
                }
              },
              "required": [
                "id"
              ]
            },
            "description": "The attributes that are assigned to the specific service. Attributes are the features that cannot be selected at the booking process (e.g. the color of the vehicle, cc, engine e.t.c)."
          },
          "providers": {
            "type": [
              "array",
              "null"
            ],
            "description": "Array of providers"
          }
        },
        "required": [
          "id",
          "alias",
          "title",
          "type",
          "company",
          "group",
          "total_availability",
          "available_spots",
          "total_price",
          "offers_applied",
          "availabilities_and_rates",
          "extras",
          "attributes"
        ]
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Get Service Availability

Get Service Availability
GET/api/services

Example URI

GET https://app.rese.io/api/services
URI Parameters
HideShow
filter[extra_filters][companyid]
integer (optional) Example: 14

The companyid of the company you want services from

filter[extra_filters][brand]
integer (optional) Example: 10

The brand of the brand you want services from.

filter[extra_filters][alias]
String (optional) Example: vw-polo

The alias of a specific service.

filter[extra_filters][title]
String (optional) Example: Volkswagen Polo

The title of a specific service.

filter[extra_filters][category_id]
integer (optional) Example: 10

The category_id of a specific group of services.

filter[extra_filters][radius]
String (optional) Example: R-100

value = -1 (default) unstricted results sorted by closest.
value = 1 restrinct results to search zone.
value = R-100 restrict resuts to 100kms from start_coordinates point.

filter[availability][start_coordinates]
String (required) Example: (31.65464,27.99954)

The starting coordinates use the form (lat,lon).

filter[availability][end_coordinates]
String (required) Example: (31.65464,27.99954)

The ending coordinates use the form (lat,lon).

filter[availability][start_date]
String (required) Example: 2018-08-30

The starting date uses the form Y-m-d.

filter[availability][end_date]
String (required) Example: 2018-08-30

The ending date uses the form Y-m-d.

filter[availability][start_time]
String (required) Example: 08:00

The starting date uses the form H:i

filter[availability][end_time]
String (required) Example: 08:00

The ending date uses the form H:i

filter[availability][coupon]
String (optional) Example: XMASPARTY

A coupon code that should be enabled as a dynamic policy at the backend

Response  200
HideShow
Body
{
  "data": [
    {
      "id": 32161,
      "alias": "MATIZ",
      "title": "MATIZ",
      "text_flag": "",
      "description": "some description",
      "includes": "",
      "excludes": "",
      "pax": 1,
      "min_pax": 1,
      "type": "daily",
      "media": [
        "https://secure.reservationengine.net/rest/assets/bizz/1435697883-matiz.jpg"
      ],
      "company": {
        "id": 14,
        "name": "bizz",
        "url": "Bizz.com",
        "alias": "bizz",
        "email": "info@reservationengine.net",
        "phone": "1234567890",
        "social": [
          {
            "social": "facebook.com",
            "alias": "johndoe"
          }
        ],
        "vat_reg_num": "``",
        "country": "FRA",
        "address": "P.O. Box 566",
        "city": "Paris",
        "reservation_email": "example@biz.com",
        "currency": "$",
        "media": [
          "https://secure.reservationengine.net/rest/assets/bizz/1471249140-xitelogo.jpg"
        ]
      },
      "group": {
        "id": 1339,
        "name": "7 passenger",
        "description": "Explorer/Pathfinder"
      },
      "total_availability": true,
      "available_spots": true,
      "maxmin": {
        "max": 157,
        "min": 157
      },
      "total_days": 2,
      "total_price": {
        "4587": 314
      },
      "units": {
        "4587": "per day"
      },
      "offers_applied": false,
      "availabilities_and_rates": {
        "2018-07-16": {
          "rates": {
            "4587": {
              "date": "2018-07-16",
              "weekdayname": "MON",
              "day": 16,
              "weekday": 0,
              "resources": 18,
              "availability": 18,
              "rate": "155",
              "spots": {
                "value": "155",
                "multiple_values": {
                  "extra_adult_value": "",
                  "child_value": "",
                  "infant_value": "",
                  "extra_child_value": "",
                  "extra_infant_value": ""
                },
                "offers": false,
                "slots": false,
                "availability": 18
              },
              "day_available_spots": 18,
              "day_recources": 18
            }
          }
        }
      },
      "next_available_slot": "2018-08-06 13:00",
      "extras": [
        {
          "id": 2593,
          "name": "baby seat",
          "description": "Baby seat description",
          "media": "``",
          "params": {
            "rangeMax": 2,
            "rangeMin": 1,
            "price": 5,
            "fixedPrice": 3,
            "parent": "null (null,nullable)"
          }
        }
      ],
      "attributes": [
        {
          "id": 2522,
          "name": "Passengers",
          "description": "some description",
          "value": 22
        }
      ],
      "providers": []
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "id of the specific resource."
          },
          "alias": {
            "type": "string",
            "description": "the alias of the specific resource. Short name of the service."
          },
          "title": {
            "type": "string",
            "description": "The title of the specific resource. Full name of the service."
          },
          "text_flag": {
            "type": [
              "string",
              "null"
            ],
            "description": "A text flag."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "A more detailed description of the service."
          },
          "includes": {
            "type": [
              "string",
              "null"
            ]
          },
          "excludes": {
            "type": [
              "string",
              "null"
            ]
          },
          "pax": {
            "type": [
              "number",
              "null"
            ]
          },
          "min_pax": {
            "type": [
              "number",
              "null"
            ]
          },
          "type": {
            "type": "string",
            "description": "Type of availability"
          },
          "media": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "The fullpath of the images related to the specific service (e.g.the photo of a car)."
          },
          "company": {
            "type": "object",
            "properties": {
              "id": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "The id of the specific company."
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The name of the specific company."
              },
              "url": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The full url of the specific company."
              },
              "alias": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The name shotcode of the specific company."
              },
              "email": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The contact email of the specific company."
              },
              "phone": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The contact phone of the specific company."
              },
              "social": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "social": {
                      "type": "string",
                      "description": "social platform"
                    },
                    "alias": {
                      "type": "string",
                      "description": "alias of the specific resource in the platform specified"
                    }
                  },
                  "required": [
                    "social",
                    "alias"
                  ]
                },
                "description": "The basic social url of the specific company."
              },
              "vat_reg_num": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The vat registration number of the specific company"
              },
              "country": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The international ISO 3166 (A2 or A3) code of country of the specific company."
              },
              "address": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The full address of the specific company."
              },
              "city": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The city of the specific company."
              },
              "reservation_email": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The email that will be send all the bookings confirmations of the specific company. This can be empty in case company doesn’t need notificaitons."
              },
              "currency": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The symbol of currency of the specific company."
              },
              "media": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                },
                "description": "The fullpath of the images related to the specific company (e.g.the logo of the company)."
              }
            },
            "description": "The basic company details of the specific service. Company is the provider of the specific service."
          },
          "group": {
            "type": "object",
            "properties": {
              "id": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "The id of the specific category."
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The name of the specific category."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "A more detailed description of the specific category."
              }
            },
            "description": "The basic group details of the specific service. Group is a category of the services. Many services can be at the same group."
          },
          "total_availability": {
            "type": "boolean",
            "description": "Indicates where there is availability for all requested dates."
          },
          "available_spots": {
            "type": "boolean",
            "description": "Indicates where there are availability spots."
          },
          "maxmin": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "max": {
                "type": "number"
              },
              "min": {
                "type": "number"
              }
            },
            "required": [
              "max",
              "min"
            ]
          },
          "total_days": {
            "type": [
              "number",
              "null"
            ]
          },
          "total_price": {
            "type": "object",
            "properties": {
              "4587": {
                "type": "number"
              }
            },
            "required": [
              "4587"
            ]
          },
          "units": {
            "type": "object",
            "properties": {
              "4587": {
                "type": "string"
              }
            },
            "required": [
              "4587"
            ]
          },
          "offers_applied": {
            "type": "boolean"
          },
          "availabilities_and_rates": {
            "type": "object",
            "properties": {
              "2018-07-16": {
                "type": "object",
                "properties": {
                  "rates": {
                    "type": "object",
                    "properties": {
                      "4587": {
                        "type": "object",
                        "properties": {
                          "date": {
                            "type": "string"
                          },
                          "weekdayname": {
                            "type": "string"
                          },
                          "day": {
                            "type": "number"
                          },
                          "weekday": {
                            "type": "number"
                          },
                          "resources": {
                            "type": "number"
                          },
                          "availability": {
                            "type": "number"
                          },
                          "rate": {
                            "type": "string"
                          },
                          "spots": {
                            "type": "object",
                            "properties": {
                              "value": {
                                "type": "string"
                              },
                              "multiple_values": {
                                "type": "object",
                                "properties": {
                                  "extra_adult_value": {
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "child_value": {
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "infant_value": {
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "extra_child_value": {
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "extra_infant_value": {
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                }
                              },
                              "offers": {
                                "type": "boolean"
                              },
                              "slots": {
                                "type": "boolean"
                              },
                              "availability": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "value",
                              "multiple_values",
                              "offers",
                              "slots",
                              "availability"
                            ]
                          },
                          "day_available_spots": {
                            "type": "number"
                          },
                          "day_recources": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "date",
                          "weekdayname",
                          "day",
                          "weekday",
                          "resources",
                          "availability",
                          "rate",
                          "spots",
                          "day_available_spots",
                          "day_recources"
                        ]
                      }
                    },
                    "required": [
                      "4587"
                    ]
                  }
                },
                "required": [
                  "rates"
                ]
              }
            },
            "required": [
              "2018-07-16"
            ],
            "description": "Each object of the array describes each day of the booking availability. In case there is no availability, the array will be empty."
          },
          "next_available_slot": {
            "type": "string"
          },
          "extras": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "The id of the specific ‘n’ extra."
                },
                "name": {
                  "type": "string",
                  "description": "(string,nullable) - The name of the specific ‘n’ extra."
                },
                "description": {
                  "type": "string",
                  "description": "(string,nullable) - A more detailed description of the specific ‘n’ extra."
                },
                "media": {
                  "type": "string",
                  "description": "(string,nullable) - A full path of preview image of the specific ‘n’ extra."
                },
                "params": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "rangeMax": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the end value of a valid values range of the specific ‘n’ extra (e.g. “1” in a range [0,1] means the true value, “10” in a range [0,10] means that 10 of that extra can be added to the booking)"
                    },
                    "rangeMin": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the start value of a valid values range of the specific ‘n’ extra (e.g. “0” in a range [0,1] means the false value, “0” in a range [0,10] means the first value of a a selectable range)"
                    },
                    "price": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the daily price of the specific ‘n’ extra."
                    },
                    "fixedPrice": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the total price of the specific ‘n’ extra. In case this field is not empty, it overrides the daily price."
                    },
                    "parent": {
                      "type": "string",
                      "description": "Indicates the id of another extra in case there is a grouping of them."
                    }
                  },
                  "description": "Details about the pricing rules of the specific ‘n’ extra."
                }
              },
              "required": [
                "id"
              ]
            },
            "description": "The extras that are assigned to the specific service. Extras are the features that a user can add to his booking (e.g booster, gps, ski facilities, insurance e.t.c)."
          },
          "attributes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "the id of the specific 'n' attribute."
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The name of the specific ‘n’ attribute."
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "A more detailed description of the specific ‘n’ attribute."
                },
                "value": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "description": "The value of the specific ‘n’ attribute."
                }
              },
              "required": [
                "id"
              ]
            },
            "description": "The attributes that are assigned to the specific service. Attributes are the features that cannot be selected at the booking process (e.g. the color of the vehicle, cc, engine e.t.c)."
          },
          "providers": {
            "type": [
              "array",
              "null"
            ],
            "description": "Array of providers"
          }
        },
        "required": [
          "id",
          "alias",
          "title",
          "type",
          "company",
          "group",
          "total_availability",
          "available_spots",
          "total_price",
          "units",
          "offers_applied",
          "availabilities_and_rates",
          "next_available_slot",
          "extras",
          "attributes"
        ]
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Get Specific Service

Get Specific Service
GET/api/services/{service_id}

Example URI

GET https://app.rese.io/api/services/32161
URI Parameters
HideShow
service_id
integer (optional) Example: 32161

The companyid of the company you want services from

Response  200
HideShow
Body
{
  "data": [
    {
      "id": 32161,
      "alias": "MATIZ",
      "title": "MATIZ",
      "text_flag": "",
      "description": "some description",
      "includes": "",
      "excludes": "",
      "pax": 1,
      "min_pax": 1,
      "type": "daily",
      "media": [
        "https://secure.reservationengine.net/rest/assets/bizz/1435697883-matiz.jpg"
      ],
      "company": {
        "id": 14,
        "name": "bizz",
        "url": "Bizz.com",
        "alias": "bizz",
        "email": "info@reservationengine.net",
        "phone": "1234567890",
        "social": [
          {
            "social": "facebook.com",
            "alias": "johndoe"
          }
        ],
        "vat_reg_num": "``",
        "country": "FRA",
        "address": "P.O. Box 566",
        "city": "Paris",
        "reservation_email": "example@biz.com",
        "currency": "$",
        "media": [
          "https://secure.reservationengine.net/rest/assets/bizz/1471249140-xitelogo.jpg"
        ]
      },
      "group": {
        "id": 1339,
        "name": "7 passenger",
        "description": "Explorer/Pathfinder"
      },
      "total_availability": false,
      "available_spots": false,
      "maxmin": "null",
      "total_days": "null",
      "total_price": "false",
      "offers_applied": false,
      "availabilities_and_rates": [],
      "extras": [
        {
          "id": 2593,
          "name": "baby seat",
          "description": "Baby seat description",
          "media": "``",
          "params": {
            "rangeMax": 2,
            "rangeMin": 1,
            "price": 5,
            "fixedPrice": 3,
            "parent": "null (null,nullable)"
          }
        }
      ],
      "attributes": [
        {
          "id": 2522,
          "name": "Passengers",
          "description": "some description",
          "value": 22
        }
      ],
      "providers": []
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "id of the specific resource."
          },
          "alias": {
            "type": "string",
            "description": "the alias of the specific resource. Short name of the service."
          },
          "title": {
            "type": "string",
            "description": "The title of the specific resource. Full name of the service."
          },
          "text_flag": {
            "type": [
              "string",
              "null"
            ],
            "description": "A text flag."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "A more detailed description of the service."
          },
          "includes": {
            "type": [
              "string",
              "null"
            ]
          },
          "excludes": {
            "type": [
              "string",
              "null"
            ]
          },
          "pax": {
            "type": [
              "number",
              "null"
            ]
          },
          "min_pax": {
            "type": [
              "number",
              "null"
            ]
          },
          "type": {
            "type": "string",
            "description": "Type of availability"
          },
          "media": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "The fullpath of the images related to the specific service (e.g.the photo of a car)."
          },
          "company": {
            "type": "object",
            "properties": {
              "id": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "The id of the specific company."
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The name of the specific company."
              },
              "url": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The full url of the specific company."
              },
              "alias": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The name shotcode of the specific company."
              },
              "email": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The contact email of the specific company."
              },
              "phone": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The contact phone of the specific company."
              },
              "social": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "social": {
                      "type": "string",
                      "description": "social platform"
                    },
                    "alias": {
                      "type": "string",
                      "description": "alias of the specific resource in the platform specified"
                    }
                  },
                  "required": [
                    "social",
                    "alias"
                  ]
                },
                "description": "The basic social url of the specific company."
              },
              "vat_reg_num": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The vat registration number of the specific company"
              },
              "country": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The international ISO 3166 (A2 or A3) code of country of the specific company."
              },
              "address": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The full address of the specific company."
              },
              "city": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The city of the specific company."
              },
              "reservation_email": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The email that will be send all the bookings confirmations of the specific company. This can be empty in case company doesn’t need notificaitons."
              },
              "currency": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The symbol of currency of the specific company."
              },
              "media": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                },
                "description": "The fullpath of the images related to the specific company (e.g.the logo of the company)."
              }
            },
            "description": "The basic company details of the specific service. Company is the provider of the specific service."
          },
          "group": {
            "type": "object",
            "properties": {
              "id": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "The id of the specific category."
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The name of the specific category."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "A more detailed description of the specific category."
              }
            },
            "description": "The basic group details of the specific service. Group is a category of the services. Many services can be at the same group."
          },
          "total_availability": {
            "type": "boolean",
            "description": "Indicates where there is availability for all requested dates. Without availability filters will be always false."
          },
          "available_spots": {
            "type": "boolean",
            "description": "Indicates where there are availability spots."
          },
          "maxmin": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_days": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_price": {
            "type": "string"
          },
          "offers_applied": {
            "type": "boolean"
          },
          "availabilities_and_rates": {
            "type": "array",
            "description": "Always empty when no availability filters specified."
          },
          "extras": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "The id of the specific ‘n’ extra."
                },
                "name": {
                  "type": "string",
                  "description": "(string,nullable) - The name of the specific ‘n’ extra."
                },
                "description": {
                  "type": "string",
                  "description": "(string,nullable) - A more detailed description of the specific ‘n’ extra."
                },
                "media": {
                  "type": "string",
                  "description": "(string,nullable) - A full path of preview image of the specific ‘n’ extra."
                },
                "params": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "rangeMax": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the end value of a valid values range of the specific ‘n’ extra (e.g. “1” in a range [0,1] means the true value, “10” in a range [0,10] means that 10 of that extra can be added to the booking)"
                    },
                    "rangeMin": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the start value of a valid values range of the specific ‘n’ extra (e.g. “0” in a range [0,1] means the false value, “0” in a range [0,10] means the first value of a a selectable range)"
                    },
                    "price": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the daily price of the specific ‘n’ extra."
                    },
                    "fixedPrice": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "Indicates the total price of the specific ‘n’ extra. In case this field is not empty, it overrides the daily price."
                    },
                    "parent": {
                      "type": "string",
                      "description": "Indicates the id of another extra in case there is a grouping of them."
                    }
                  },
                  "description": "Details about the pricing rules of the specific ‘n’ extra."
                }
              },
              "required": [
                "id"
              ]
            },
            "description": "The extras that are assigned to the specific service. Extras are the features that a user can add to his booking (e.g booster, gps, ski facilities, insurance e.t.c)."
          },
          "attributes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "the id of the specific 'n' attribute."
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The name of the specific ‘n’ attribute."
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "A more detailed description of the specific ‘n’ attribute."
                },
                "value": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "description": "The value of the specific ‘n’ attribute."
                }
              },
              "required": [
                "id"
              ]
            },
            "description": "The attributes that are assigned to the specific service. Attributes are the features that cannot be selected at the booking process (e.g. the color of the vehicle, cc, engine e.t.c)."
          },
          "providers": {
            "type": [
              "array",
              "null"
            ],
            "description": "Array of providers"
          }
        },
        "required": [
          "id",
          "alias",
          "title",
          "type",
          "company",
          "group",
          "total_availability",
          "available_spots",
          "total_price",
          "offers_applied",
          "availabilities_and_rates",
          "extras",
          "attributes"
        ]
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Orders

The Orders endpoints returns information about the R-Engine Orders (Bookings) that have been made by the authenticated user. The response includes the display name and other details and groups of info about each order, and lists the orders in the proper display order as they are stored initial at the database. You can re-sort the results by add sorting filter at your request as show here.

Method Endpoint Description
GET /api/orders/ Get logged in user related order(s)
GET /api/orders/{booking_id}{booking_id},… Get details about specific order(s)
POST /api/orders/ Check for availability and create a new order
PATCH /api/orders/{booking_id} Cancel the specific order and copy to a new one with the updated post info. This endpoint can be used for updating order info
DELETE /api/orders/{booking_id} Check and cancel an existing order.

Get all Orders

Get all Orders
GET/api/orders/

Example URI

GET https://app.rese.io/api/orders/
URI Parameters
HideShow
filter[booking_reference]
string (optional) Example: VBV7DH

Filter orders by booking reference.

filter[booking_status]
string (optional) Example: PAID

Filter orders by booking status.

Choices: ON_PROGRESS PAID NOT_PAID

filter[company_id]
integer (optional) Example: 14

The companyid of the specific company you want orders from.

filter[customer_id]
integer (optional) Example: 119

Filter orders by the id of a specific customer.

filter[service_id]
integer (optional) Example: 32161

Filter orders by the id of a specific service.

filter[start_coordinates]
string (optional) Example: (39.074208, 21.824312)

Filter orders by the coordinates of a specific starting point.

filter[start_location_name]
string (optional) Example: London

Filter orders by the name of a specific starting point.

filter[end_coordinates]
string (optional) Example: (39.074208, 21.824312)

Filter orders by the coordinates of a specific ending point.

filter[end_location_name]
string (optional) Example: London

Filter orders by the name of a specific ending point.

filter[status]
string (optional) Example: CANCELLED

Filter orders by the status of the order.

Choices: PRE_ASSIGNED ASSIGNED_NOT_CONFIRMED ASSIGNED_AND_AGREED CHECKED_OUT CHECKED_IN CHECKED_IN_EARLIER CANCELLED

filter[total_cost]
float (optional) Example: 20.00

Filter orders by checking the total cost of each order. Operators may be applied here.

filter[start_date]
string (optional) Example: 2018-08-30

Filter orders by checking the starting date of each order. Operators may be applied here.

filter[start_time]
string (optional) Example: 13:00

Filter orders by checking the starting time of each order. Operators may be applied here.

filter[end_date]
string (optional) Example: 2018-08-31

Filter orders by checking the ending date of each order. Operators may be applied here.

filter[end_time]
string (optional) Example: 18:00

Filter orders by checking the ending time of each order. Operators may be applied here.

Response  200
HideShow
Body
{
  "data": [
    {
      "id": 1831,
      "reference": "4GELNA",
      "company_id": 475,
      "status": "PRE_ASSIGNED",
      "customer": {
        "id": 911,
        "fullname": "David Oregon",
        "email": "info@davidoregon.com"
      },
      "total_cost": 55,
      "orders": {
        "order": {
          "id": 6274,
          "reference": 627401,
          "service_id": "33273",
          "start": {
            "coordinates": "(39.074208, 21.824312)",
            "location_name": "Main Desk",
            "date": "2018-07-11",
            "time": "08:09"
          },
          "end": {
            "coordinates": "(39.074208, 21.824312)",
            "location_name": "Main Desk",
            "date": "2018-07-11",
            "time": "08:09"
          },
          "comment": "``",
          "status": "PRE_ASSIGNED",
          "total_cost": 55,
          "recource": {
            "number": "Peg-1",
            "type": "``",
            "color": "``"
          },
          "extras": [
            {
              "id": 2593,
              "name": "baby seat",
              "description": "Baby seat description",
              "media": "``",
              "params": {
                "rangeMax": 2,
                "rangeMin": 1,
                "price": 5,
                "fixedPrice": 3,
                "parent": "null (null,nullable)"
              }
            }
          ]
        }
      },
      "currency": "$",
      "payments": [
        {
          "id": 1810,
          "issue_date": "2018-07-05",
          "amount": 55,
          "comments": "Payment for Booking #4GELNA"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "The id of the specific resource"
          },
          "reference": {
            "type": "string",
            "description": "reference for the specific order"
          },
          "company_id": {
            "type": "number",
            "description": "The company id that this specific order is being assigned to."
          },
          "status": {
            "type": "string",
            "description": "The status of the specific order. Valid values for status are: “PRE_ASSIGNED”, “ASSIGNED_NOT_CONFIRMED”, “ASSIGNED_AND_AGREED”, “CHECKED_OUT”, “CHECKED_IN”, “CHECKED_IN_EARLIER”, “CANCELLED”."
          },
          "customer": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "id": {
                "type": "number",
                "description": "The customer id for this specific resource."
              },
              "fullname": {
                "type": "string",
                "description": "The customer fullname for this specific resource."
              },
              "email": {
                "type": "string",
                "description": "The customer email for this specific resource."
              }
            },
            "required": [
              "id",
              "fullname"
            ],
            "description": "The basic customer details of the specific order"
          },
          "total_cost": {
            "type": "number",
            "description": "The final total cost that this order was booked."
          },
          "orders": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "order": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "id for the specific order"
                  },
                  "reference": {
                    "type": "number",
                    "description": "reference for the specific order"
                  },
                  "service_id": {
                    "type": "string"
                  },
                  "start": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "coordinates": {
                        "type": "string",
                        "description": "The coordinates of the starting point of the specific order. The starting/ending coordinates use the form (lat,lon)."
                      },
                      "location_name": {
                        "type": "string",
                        "description": "The location name of the starting/ending point of the specific order."
                      },
                      "date": {
                        "type": "string",
                        "description": "The starting date of the specific order. The starting/ending date uses the form Y-m-d."
                      },
                      "time": {
                        "type": "string",
                        "description": "The starting time of the specific order. The starting/ending time uses the form H:i."
                      }
                    },
                    "description": "The basic starting location details of the specific order."
                  },
                  "end": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "coordinates": {
                        "type": "string",
                        "description": "The coordinates of the starting point of the specific order. The starting/ending coordinates use the form (lat,lon)."
                      },
                      "location_name": {
                        "type": "string",
                        "description": "The location name of the starting/ending point of the specific order."
                      },
                      "date": {
                        "type": "string",
                        "description": "The starting date of the specific order. The starting/ending date uses the form Y-m-d."
                      },
                      "time": {
                        "type": "string",
                        "description": "The starting time of the specific order. The starting/ending time uses the form H:i."
                      }
                    },
                    "description": "The basic ending location details of the specific order."
                  },
                  "comment": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The comments that user add to the specific order."
                  },
                  "status": {
                    "type": "string",
                    "description": "The status of the specific order. Valid values for status are: “PRE_ASSIGNED”, “ASSIGNED_NOT_CONFIRMED”, “ASSIGNED_AND_AGREED”, “CHECKED_OUT”, “CHECKED_IN”, “CHECKED_IN_EARLIER”, “CANCELLED”."
                  },
                  "total_cost": {
                    "type": "number",
                    "description": "The final total cost that this order was booked."
                  },
                  "recource": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "number": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "number for the specific recource"
                      },
                      "type": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "type for the specific recource"
                      },
                      "color": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "color for the specific recource"
                      }
                    }
                  },
                  "extras": {
                    "type": [
                      "array",
                      "null"
                    ],
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number",
                          "description": "The id of the specific ‘n’ extra."
                        },
                        "name": {
                          "type": "string",
                          "description": "(string,nullable) - The name of the specific ‘n’ extra."
                        },
                        "description": {
                          "type": "string",
                          "description": "(string,nullable) - A more detailed description of the specific ‘n’ extra."
                        },
                        "media": {
                          "type": "string",
                          "description": "(string,nullable) - A full path of preview image of the specific ‘n’ extra."
                        },
                        "params": {
                          "type": [
                            "object",
                            "null"
                          ],
                          "properties": {
                            "rangeMax": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "description": "Indicates the end value of a valid values range of the specific ‘n’ extra (e.g. “1” in a range [0,1] means the true value, “10” in a range [0,10] means that 10 of that extra can be added to the booking)"
                            },
                            "rangeMin": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "description": "Indicates the start value of a valid values range of the specific ‘n’ extra (e.g. “0” in a range [0,1] means the false value, “0” in a range [0,10] means the first value of a a selectable range)"
                            },
                            "price": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "description": "Indicates the daily price of the specific ‘n’ extra."
                            },
                            "fixedPrice": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "description": "Indicates the total price of the specific ‘n’ extra. In case this field is not empty, it overrides the daily price."
                            },
                            "parent": {
                              "type": "string",
                              "description": "Indicates the id of another extra in case there is a grouping of them."
                            }
                          },
                          "description": "Details about the pricing rules of the specific ‘n’ extra."
                        }
                      },
                      "required": [
                        "id"
                      ]
                    },
                    "description": "The extras that are selected by the user during the booking process. Extras are the features that a user can add to his booking (e.g booster, gps, ski facilities, insurance e.t.c). The cost is included at order.total_cost"
                  }
                },
                "required": [
                  "id",
                  "reference",
                  "status",
                  "total_cost"
                ],
                "description": "order object"
              }
            },
            "description": "Object that contains zero or more orders"
          },
          "currency": {
            "type": [
              "string",
              "null"
            ],
            "description": "currency"
          },
          "payments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "The id of ‘n’ payment assigned to the specific order."
                },
                "issue_date": {
                  "type": "string",
                  "description": "The issue date of ‘n’ payment assigned to the specific order. The date uses the form Y-m-d."
                },
                "amount": {
                  "type": "number",
                  "description": "The amount paid of ‘n’ payment assigned to the specific order."
                },
                "comments": {
                  "type": "string",
                  "description": "Comments about ‘n’ payment assigned to the specific order."
                }
              },
              "required": [
                "id",
                "issue_date",
                "amount"
              ]
            },
            "description": "Array of payments assigned to the specific order."
          }
        },
        "required": [
          "id",
          "reference",
          "company_id",
          "status",
          "total_cost",
          "payments"
        ]
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Get Specific Order

Get Specific Order
GET/api/orders/{booking_id}

Example URI

GET https://app.rese.io/api/orders/1831
URI Parameters
HideShow
booking_id
integer (optional) Example: 1831

you can specify more booking_id separated by comma ,

Response  200
HideShow
Body
{
  "data": [
    {
      "id": 1831,
      "reference": "4GELNA",
      "company_id": 475,
      "status": "PRE_ASSIGNED",
      "customer": {
        "id": 911,
        "fullname": "David Oregon",
        "email": "info@davidoregon.com"
      },
      "total_cost": 55,
      "orders": {
        "order": {
          "id": 6274,
          "reference": 627401,
          "service_id": "33273",
          "start": {
            "coordinates": "(39.074208, 21.824312)",
            "location_name": "Main Desk",
            "date": "2018-07-11",
            "time": "08:09"
          },
          "end": {
            "coordinates": "(39.074208, 21.824312)",
            "location_name": "Main Desk",
            "date": "2018-07-11",
            "time": "08:09"
          },
          "comment": "``",
          "status": "PRE_ASSIGNED",
          "total_cost": 55,
          "recource": {
            "number": "Peg-1",
            "type": "``",
            "color": "``"
          },
          "extras": [
            {
              "id": 2593,
              "name": "baby seat",
              "description": "Baby seat description",
              "media": "``",
              "params": {
                "rangeMax": 2,
                "rangeMin": 1,
                "price": 5,
                "fixedPrice": 3,
                "parent": "null (null,nullable)"
              }
            }
          ]
        }
      },
      "currency": "$",
      "payments": [
        {
          "id": 1810,
          "issue_date": "2018-07-05",
          "amount": 55,
          "comments": "Payment for Booking #4GELNA"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "The id of the specific resource"
          },
          "reference": {
            "type": "string",
            "description": "reference for the specific order"
          },
          "company_id": {
            "type": "number",
            "description": "The company id that this specific order is being assigned to."
          },
          "status": {
            "type": "string",
            "description": "The status of the specific order. Valid values for status are: “PRE_ASSIGNED”, “ASSIGNED_NOT_CONFIRMED”, “ASSIGNED_AND_AGREED”, “CHECKED_OUT”, “CHECKED_IN”, “CHECKED_IN_EARLIER”, “CANCELLED”."
          },
          "customer": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "id": {
                "type": "number",
                "description": "The customer id for this specific resource."
              },
              "fullname": {
                "type": "string",
                "description": "The customer fullname for this specific resource."
              },
              "email": {
                "type": "string",
                "description": "The customer email for this specific resource."
              }
            },
            "required": [
              "id",
              "fullname"
            ],
            "description": "The basic customer details of the specific order"
          },
          "total_cost": {
            "type": "number",
            "description": "The final total cost that this order was booked."
          },
          "orders": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "order": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "id for the specific order"
                  },
                  "reference": {
                    "type": "number",
                    "description": "reference for the specific order"
                  },
                  "service_id": {
                    "type": "string"
                  },
                  "start": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "coordinates": {
                        "type": "string",
                        "description": "The coordinates of the starting point of the specific order. The starting/ending coordinates use the form (lat,lon)."
                      },
                      "location_name": {
                        "type": "string",
                        "description": "The location name of the starting/ending point of the specific order."
                      },
                      "date": {
                        "type": "string",
                        "description": "The starting date of the specific order. The starting/ending date uses the form Y-m-d."
                      },
                      "time": {
                        "type": "string",
                        "description": "The starting time of the specific order. The starting/ending time uses the form H:i."
                      }
                    },
                    "description": "The basic starting location details of the specific order."
                  },
                  "end": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "coordinates": {
                        "type": "string",
                        "description": "The coordinates of the starting point of the specific order. The starting/ending coordinates use the form (lat,lon)."
                      },
                      "location_name": {
                        "type": "string",
                        "description": "The location name of the starting/ending point of the specific order."
                      },
                      "date": {
                        "type": "string",
                        "description": "The starting date of the specific order. The starting/ending date uses the form Y-m-d."
                      },
                      "time": {
                        "type": "string",
                        "description": "The starting time of the specific order. The starting/ending time uses the form H:i."
                      }
                    },
                    "description": "The basic ending location details of the specific order."
                  },
                  "comment": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The comments that user add to the specific order."
                  },
                  "status": {
                    "type": "string",
                    "description": "The status of the specific order. Valid values for status are: “PRE_ASSIGNED”, “ASSIGNED_NOT_CONFIRMED”, “ASSIGNED_AND_AGREED”, “CHECKED_OUT”, “CHECKED_IN”, “CHECKED_IN_EARLIER”, “CANCELLED”."
                  },
                  "total_cost": {
                    "type": "number",
                    "description": "The final total cost that this order was booked."
                  },
                  "recource": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "number": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "number for the specific recource"
                      },
                      "type": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "type for the specific recource"
                      },
                      "color": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "color for the specific recource"
                      }
                    }
                  },
                  "extras": {
                    "type": [
                      "array",
                      "null"
                    ],
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number",
                          "description": "The id of the specific ‘n’ extra."
                        },
                        "name": {
                          "type": "string",
                          "description": "(string,nullable) - The name of the specific ‘n’ extra."
                        },
                        "description": {
                          "type": "string",
                          "description": "(string,nullable) - A more detailed description of the specific ‘n’ extra."
                        },
                        "media": {
                          "type": "string",
                          "description": "(string,nullable) - A full path of preview image of the specific ‘n’ extra."
                        },
                        "params": {
                          "type": [
                            "object",
                            "null"
                          ],
                          "properties": {
                            "rangeMax": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "description": "Indicates the end value of a valid values range of the specific ‘n’ extra (e.g. “1” in a range [0,1] means the true value, “10” in a range [0,10] means that 10 of that extra can be added to the booking)"
                            },
                            "rangeMin": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "description": "Indicates the start value of a valid values range of the specific ‘n’ extra (e.g. “0” in a range [0,1] means the false value, “0” in a range [0,10] means the first value of a a selectable range)"
                            },
                            "price": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "description": "Indicates the daily price of the specific ‘n’ extra."
                            },
                            "fixedPrice": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "description": "Indicates the total price of the specific ‘n’ extra. In case this field is not empty, it overrides the daily price."
                            },
                            "parent": {
                              "type": "string",
                              "description": "Indicates the id of another extra in case there is a grouping of them."
                            }
                          },
                          "description": "Details about the pricing rules of the specific ‘n’ extra."
                        }
                      },
                      "required": [
                        "id"
                      ]
                    },
                    "description": "The extras that are selected by the user during the booking process. Extras are the features that a user can add to his booking (e.g booster, gps, ski facilities, insurance e.t.c). The cost is included at order.total_cost"
                  }
                },
                "required": [
                  "id",
                  "reference",
                  "status",
                  "total_cost"
                ],
                "description": "order object"
              }
            },
            "description": "Object that contains zero or more orders"
          },
          "currency": {
            "type": [
              "string",
              "null"
            ],
            "description": "currency"
          },
          "payments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "The id of ‘n’ payment assigned to the specific order."
                },
                "issue_date": {
                  "type": "string",
                  "description": "The issue date of ‘n’ payment assigned to the specific order. The date uses the form Y-m-d."
                },
                "amount": {
                  "type": "number",
                  "description": "The amount paid of ‘n’ payment assigned to the specific order."
                },
                "comments": {
                  "type": "string",
                  "description": "Comments about ‘n’ payment assigned to the specific order."
                }
              },
              "required": [
                "id",
                "issue_date",
                "amount"
              ]
            },
            "description": "Array of payments assigned to the specific order."
          }
        },
        "required": [
          "id",
          "reference",
          "company_id",
          "status",
          "total_cost",
          "payments"
        ]
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Create new Order

Create new Order
POST/api/orders

Error codes

HTTP status Code Description
500 Undefined index: distance Distance between starting coordinates and the desks’(user role) locations cannot be resolved.
400 No customer fullname was supplied! No mobile or email was supplied! There is no customer_id or customer fullname, email and mobile provided
400 No customer found! There is no customer with the customer_id that was provided.
400 There is no availability or rate set for this service for your selected criteria There is on availability at the specific dates and time that was provided. Please try other dates or services.

Example URI

POST https://app.rese.io/api/orders
Request
HideShow
Body
{
  "start_coordinates": "(36.8915064, 27.2877228)",
  "start_location_name": "Kos town",
  "start_date": "2018-07-18",
  "start_time": "11:00",
  "end_coordinates": "(36.8915064, 27.2877228)",
  "end_location_name": "Kos town",
  "end_date": "2018-07-18",
  "end_time": "11:59",
  "service_id": 33357,
  "customer_id": 2111,
  "selected_slots": "11:00",
  "slot_start_time": "11:00",
  "slot_end_time": "11:59"
}
Schema
{
  "type": "object",
  "properties": {
    "start_coordinates": {
      "type": "string",
      "description": "The start location coordinates. The coordinates use the form (lat,lon)."
    },
    "start_location_name": {
      "type": "string",
      "description": "The start location name."
    },
    "start_date": {
      "type": "string",
      "description": "The start date for the specific order."
    },
    "start_time": {
      "type": "string",
      "description": "The start time for the specific order."
    },
    "end_coordinates": {
      "type": "string",
      "description": "The end location coordinates. The coordinates use the form (lat,lon)."
    },
    "end_location_name": {
      "type": "string",
      "description": "The end location name."
    },
    "end_date": {
      "type": "string",
      "description": "The end date for the specific order."
    },
    "end_time": {
      "type": "string",
      "description": "The end time for the specific order."
    },
    "service_id": {
      "type": "number",
      "description": "The id of the service that will be booked. The system checks for availability."
    },
    "customer_id": {
      "type": "number",
      "description": "The id of the customer that will be charged for the specific order."
    },
    "selected_slots": {
      "type": "string",
      "description": "Selected slots."
    },
    "slot_start_time": {
      "type": "string",
      "description": "Slot starting time."
    },
    "slot_end_time": {
      "type": "string",
      "description": "Slot ending time."
    }
  },
  "required": [
    "start_coordinates",
    "start_location_name",
    "start_date",
    "start_time",
    "end_coordinates",
    "end_location_name",
    "end_date",
    "end_time",
    "service_id",
    "customer_id",
    "selected_slots",
    "slot_start_time",
    "slot_end_time"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Body
{
  "data": {
    "id": 1831,
    "reference": "4GELNA",
    "company_id": 475,
    "status": "PRE_ASSIGNED",
    "customer": {
      "id": 911,
      "fullname": "David Oregon",
      "email": "info@davidoregon.com"
    },
    "total_cost": 55,
    "orders": {
      "order": {
        "id": 6274,
        "reference": 627401,
        "service_id": "33273",
        "start": {
          "coordinates": "(39.074208, 21.824312)",
          "location_name": "Main Desk",
          "date": "2018-07-11",
          "time": "08:09"
        },
        "end": {
          "coordinates": "(39.074208, 21.824312)",
          "location_name": "Main Desk",
          "date": "2018-07-11",
          "time": "08:09"
        },
        "comment": "``",
        "status": "PRE_ASSIGNED",
        "total_cost": 55,
        "recource": {
          "number": "Peg-1",
          "type": "``",
          "color": "``"
        },
        "extras": [
          {
            "id": 2593,
            "name": "baby seat",
            "description": "Baby seat description",
            "media": "``",
            "params": {
              "rangeMax": 2,
              "rangeMin": 1,
              "price": 5,
              "fixedPrice": 3,
              "parent": "null (null,nullable)"
            }
          }
        ]
      }
    },
    "currency": "$",
    "payments": [
      {
        "id": 1810,
        "issue_date": "2018-07-05",
        "amount": 55,
        "comments": "Payment for Booking #4GELNA"
      }
    ]
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The id of the specific resource"
        },
        "reference": {
          "type": "string",
          "description": "reference for the specific order"
        },
        "company_id": {
          "type": "number",
          "description": "The company id that this specific order is being assigned to."
        },
        "status": {
          "type": "string",
          "description": "The status of the specific order. Valid values for status are: “PRE_ASSIGNED”, “ASSIGNED_NOT_CONFIRMED”, “ASSIGNED_AND_AGREED”, “CHECKED_OUT”, “CHECKED_IN”, “CHECKED_IN_EARLIER”, “CANCELLED”."
        },
        "customer": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "id": {
              "type": "number",
              "description": "The customer id for this specific resource."
            },
            "fullname": {
              "type": "string",
              "description": "The customer fullname for this specific resource."
            },
            "email": {
              "type": "string",
              "description": "The customer email for this specific resource."
            }
          },
          "required": [
            "id",
            "fullname"
          ],
          "description": "The basic customer details of the specific order"
        },
        "total_cost": {
          "type": "number",
          "description": "The final total cost that this order was booked."
        },
        "orders": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "order": {
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "id": {
                  "type": "number",
                  "description": "id for the specific order"
                },
                "reference": {
                  "type": "number",
                  "description": "reference for the specific order"
                },
                "service_id": {
                  "type": "string"
                },
                "start": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "coordinates": {
                      "type": "string",
                      "description": "The coordinates of the starting point of the specific order. The starting/ending coordinates use the form (lat,lon)."
                    },
                    "location_name": {
                      "type": "string",
                      "description": "The location name of the starting/ending point of the specific order."
                    },
                    "date": {
                      "type": "string",
                      "description": "The starting date of the specific order. The starting/ending date uses the form Y-m-d."
                    },
                    "time": {
                      "type": "string",
                      "description": "The starting time of the specific order. The starting/ending time uses the form H:i."
                    }
                  },
                  "description": "The basic starting location details of the specific order."
                },
                "end": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "coordinates": {
                      "type": "string",
                      "description": "The coordinates of the starting point of the specific order. The starting/ending coordinates use the form (lat,lon)."
                    },
                    "location_name": {
                      "type": "string",
                      "description": "The location name of the starting/ending point of the specific order."
                    },
                    "date": {
                      "type": "string",
                      "description": "The starting date of the specific order. The starting/ending date uses the form Y-m-d."
                    },
                    "time": {
                      "type": "string",
                      "description": "The starting time of the specific order. The starting/ending time uses the form H:i."
                    }
                  },
                  "description": "The basic ending location details of the specific order."
                },
                "comment": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The comments that user add to the specific order."
                },
                "status": {
                  "type": "string",
                  "description": "The status of the specific order. Valid values for status are: “PRE_ASSIGNED”, “ASSIGNED_NOT_CONFIRMED”, “ASSIGNED_AND_AGREED”, “CHECKED_OUT”, “CHECKED_IN”, “CHECKED_IN_EARLIER”, “CANCELLED”."
                },
                "total_cost": {
                  "type": "number",
                  "description": "The final total cost that this order was booked."
                },
                "recource": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "number": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "number for the specific recource"
                    },
                    "type": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "type for the specific recource"
                    },
                    "color": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "color for the specific recource"
                    }
                  }
                },
                "extras": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "description": "The id of the specific ‘n’ extra."
                      },
                      "name": {
                        "type": "string",
                        "description": "(string,nullable) - The name of the specific ‘n’ extra."
                      },
                      "description": {
                        "type": "string",
                        "description": "(string,nullable) - A more detailed description of the specific ‘n’ extra."
                      },
                      "media": {
                        "type": "string",
                        "description": "(string,nullable) - A full path of preview image of the specific ‘n’ extra."
                      },
                      "params": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "rangeMax": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "description": "Indicates the end value of a valid values range of the specific ‘n’ extra (e.g. “1” in a range [0,1] means the true value, “10” in a range [0,10] means that 10 of that extra can be added to the booking)"
                          },
                          "rangeMin": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "description": "Indicates the start value of a valid values range of the specific ‘n’ extra (e.g. “0” in a range [0,1] means the false value, “0” in a range [0,10] means the first value of a a selectable range)"
                          },
                          "price": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "description": "Indicates the daily price of the specific ‘n’ extra."
                          },
                          "fixedPrice": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "description": "Indicates the total price of the specific ‘n’ extra. In case this field is not empty, it overrides the daily price."
                          },
                          "parent": {
                            "type": "string",
                            "description": "Indicates the id of another extra in case there is a grouping of them."
                          }
                        },
                        "description": "Details about the pricing rules of the specific ‘n’ extra."
                      }
                    },
                    "required": [
                      "id"
                    ]
                  },
                  "description": "The extras that are selected by the user during the booking process. Extras are the features that a user can add to his booking (e.g booster, gps, ski facilities, insurance e.t.c). The cost is included at order.total_cost"
                }
              },
              "required": [
                "id",
                "reference",
                "status",
                "total_cost"
              ],
              "description": "order object"
            }
          },
          "description": "Object that contains zero or more orders"
        },
        "currency": {
          "type": [
            "string",
            "null"
          ],
          "description": "currency"
        },
        "payments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The id of ‘n’ payment assigned to the specific order."
              },
              "issue_date": {
                "type": "string",
                "description": "The issue date of ‘n’ payment assigned to the specific order. The date uses the form Y-m-d."
              },
              "amount": {
                "type": "number",
                "description": "The amount paid of ‘n’ payment assigned to the specific order."
              },
              "comments": {
                "type": "string",
                "description": "Comments about ‘n’ payment assigned to the specific order."
              }
            },
            "required": [
              "id",
              "issue_date",
              "amount"
            ]
          },
          "description": "Array of payments assigned to the specific order."
        }
      },
      "required": [
        "id",
        "reference",
        "company_id",
        "status",
        "total_cost",
        "payments"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Update an Order

Update an Order
PATCH/api/orders/{booking_id}

Cancels the specific order and creates a new one based on POST parameters. If any manatory paramenter are not provided they will be copied from the canceled order

Error codes

HTTP status Code Description
400 This order can not be modified in its current state. If order status is “CANCELLED” cannot be tested.
400 This order can not be tested using the data you provided. You might have not provide order id, or your request parameters are not valid.

Example URI

PATCH https://app.rese.io/api/orders/1831
URI Parameters
HideShow
booking_id
integer (optional) Example: 1831

the id of the specific order

Request
HideShow
Body
{
  "id": 992
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "The id you want the order to change to."
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Body
{
  "data": {
    "op": "replace",
    "path": "/id",
    "value": "992"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "op": {
          "type": "string",
          "description": "One of JSON PATCH operations (add, remove, replace, move, copy, test), based on rfc6902."
        },
        "path": {
          "type": "string",
          "description": "A JSON Pointer value that references the location in the target document to move the value from based on rfc6901."
        },
        "value": {
          "type": "string",
          "description": "The value that was changed."
        }
      },
      "required": [
        "op",
        "path",
        "value"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Delete an Order

Delete an Order
DELETE/api/orders/{booking_id}

Check and cancel an existing order. The status of the specific order should be ‘PRE_ASSIGNED’, ‘NOT_PAID’ or ‘ASSIGNED_NOT_CONFIRMED’. In any other case response with a 400 Error.

Error codes

HTTP status Code Description
400 You must provide the order ID(s) If order status is CANCELLED cannot be tested.
400 No orders found to be canceled. The order ids you specified cannot be found, or cannot be canceled. Cancelation can be done only in order that their status is PRE_ASSIGNED, NOT_PAID or ASSIGNED_NOT_CONFIRMED and belong to the authenticated user.

Example URI

DELETE https://app.rese.io/api/orders/32161
URI Parameters
HideShow
booking_id
integer (optional) Example: 32161

the id of the specific order.

Response  200
HideShow
Body
{
  "data": {
    "op": "replace",
    "path": "/status",
    "value": "CANCELLED"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "op": {
          "type": "string",
          "description": "One of JSON PATCH operations (add, remove, replace, move, copy, test), based on rfc6902."
        },
        "path": {
          "type": "string",
          "description": "A JSON Pointer value that references the location in the target document to move the value from based on rfc6901."
        },
        "value": {
          "type": "string",
          "description": "The value that was replaced."
        }
      },
      "required": [
        "op",
        "path",
        "value"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Customers

The Customers endpoints returns information about the R-Engine Customers that have been made by the authenticated user. In case user is has a “companyadmin” role, then the results contain all the customers that belong at user company. The response includes the display name and other details and groups of info about each customer, and lists the customers in the proper display order as they are stored initial at the database. You can re-sort the results by add sorting filter at your request as show here.

Method Endpoint Description
GET /api/customers/ Get logged in user related customers. In case user is has a “companyadmin” role, then the results contain all the customers that belong at user company
GET /api/customers/{customer_id}{customer_id},… Get specific customers details
POST /api/customers/ Add a new customer
PATCH /api/customers/{customer_id} Update customer’s details.

List all Customers

List all Customers
GET/api/customers/

Example URI

GET https://app.rese.io/api/customers/
URI Parameters
HideShow
filter[fullname]
string (optional) Example: John Doe

The fullname of customer(s) you want details from.

filter[email]
string (optional) Example: jdoe@gmail.com

The email of customer(s) you want details from.

filter[mobile]
string (optional) Example: +4469960022

The mobile of customer(s) you want details from.

filter[Country]
string (optional) Example: UK

The country of customer(s) you want details from. ISO Country codes should be used.

filter[city]
string (optional) Example: London

The city of customer(s) you want details from.

filter[postal_code]
string (optional) Example: N1 7GU

The city of customer(s) you want details from.

filter[company_id]
integer (optional) Example: 14

The company id of customer(s) you want details from.

Response  200
HideShow
Body
{
  "data": {
    "id": 3332,
    "fullname": "John Doe",
    "email": "johnydoe@doe.com",
    "mobile": 1112223334,
    "country": "Greece",
    "city": "Athens",
    "address": "Patisiwn 11",
    "postal_code": 13211,
    "vat_number": "112233",
    "birthdate": "1985-02-11",
    "gender": "M",
    "title": "Mr",
    "social": [
      {
        "social": "facebook.com",
        "alias": "johndoe"
      }
    ],
    "comments": "some comments",
    "companyid": 475,
    "media": [
      "http://stage.reservationengine.net/assets/images/aueb-475/1531817042-pic2.png"
    ]
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The id of the specific resource"
        },
        "fullname": {
          "type": "string",
          "description": "The fullname (first name & last name) of the specific customer."
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "The email address for this specific resource."
        },
        "mobile": {
          "type": [
            "number",
            "null"
          ],
          "description": "The customer mobile number (is used for sms communication)."
        },
        "country": {
          "type": [
            "string",
            "null"
          ],
          "description": "The customer residence country for this specific resource."
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "The customer residence city for this specific resource."
        },
        "address": {
          "type": [
            "string",
            "null"
          ],
          "description": "The customer resident address for this specific resource."
        },
        "postal_code": {
          "type": [
            "number",
            "null"
          ],
          "description": "The residense postal code of the customer."
        },
        "vat_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "The VAT registration number for the specific customer."
        },
        "birthdate": {
          "type": [
            "string",
            "null"
          ],
          "description": "The birthdate of the customer. The date uses the form Y-m-d."
        },
        "gender": {
          "type": [
            "string",
            "null"
          ],
          "description": "The gender of the specific customer. Response values are: ‘m’, ‘M’, ‘f’, ‘F’."
        },
        "title": {
          "type": [
            "string",
            "null"
          ],
          "description": "The title of the specific customer. Accepted values are: ‘Miss’, ‘Ms’, ‘Mr’, ‘Sir’, ‘Mrs’, ‘Dr’."
        },
        "social": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {
              "social": {
                "type": "string",
                "description": "social platform"
              },
              "alias": {
                "type": "string",
                "description": "alias of the specific resource in the platform specified"
              }
            },
            "required": [
              "social",
              "alias"
            ]
          },
          "description": "The social media alias of the specific customer. Social media should be place in Json format."
        },
        "comments": {
          "type": [
            "string",
            "null"
          ],
          "description": "Some comments of the specific customer."
        },
        "companyid": {
          "type": "number",
          "description": "The company id that this specific customer is being assignet to."
        },
        "media": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "id",
        "fullname",
        "companyid"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Get a specific Customer

Get a specific Customer
GET/api/customers/{customer_id}

Example URI

GET https://app.rese.io/api/customers/3332
URI Parameters
HideShow
customer_id
integer (optional) Example: 3332

The id for the specific customer.

Response  200
HideShow
Body
{
  "data": {
    "id": 3332,
    "fullname": "John Doe",
    "email": "johnydoe@doe.com",
    "mobile": 1112223334,
    "country": "Greece",
    "city": "Athens",
    "address": "Patisiwn 11",
    "postal_code": 13211,
    "vat_number": "112233",
    "birthdate": "1985-02-11",
    "gender": "M",
    "title": "Mr",
    "social": [
      {
        "social": "facebook.com",
        "alias": "johndoe"
      }
    ],
    "comments": "some comments",
    "companyid": 475,
    "media": [
      "http://stage.reservationengine.net/assets/images/aueb-475/1531817042-pic2.png"
    ]
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The id of the specific resource"
        },
        "fullname": {
          "type": "string",
          "description": "The fullname (first name & last name) of the specific customer."
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "The email address for this specific resource."
        },
        "mobile": {
          "type": [
            "number",
            "null"
          ],
          "description": "The customer mobile number (is used for sms communication)."
        },
        "country": {
          "type": [
            "string",
            "null"
          ],
          "description": "The customer residence country for this specific resource."
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "The customer residence city for this specific resource."
        },
        "address": {
          "type": [
            "string",
            "null"
          ],
          "description": "The customer resident address for this specific resource."
        },
        "postal_code": {
          "type": [
            "number",
            "null"
          ],
          "description": "The residense postal code of the customer."
        },
        "vat_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "The VAT registration number for the specific customer."
        },
        "birthdate": {
          "type": [
            "string",
            "null"
          ],
          "description": "The birthdate of the customer. The date uses the form Y-m-d."
        },
        "gender": {
          "type": [
            "string",
            "null"
          ],
          "description": "The gender of the specific customer. Response values are: ‘m’, ‘M’, ‘f’, ‘F’."
        },
        "title": {
          "type": [
            "string",
            "null"
          ],
          "description": "The title of the specific customer. Accepted values are: ‘Miss’, ‘Ms’, ‘Mr’, ‘Sir’, ‘Mrs’, ‘Dr’."
        },
        "social": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {
              "social": {
                "type": "string",
                "description": "social platform"
              },
              "alias": {
                "type": "string",
                "description": "alias of the specific resource in the platform specified"
              }
            },
            "required": [
              "social",
              "alias"
            ]
          },
          "description": "The social media alias of the specific customer. Social media should be place in Json format."
        },
        "comments": {
          "type": [
            "string",
            "null"
          ],
          "description": "Some comments of the specific customer."
        },
        "companyid": {
          "type": "number",
          "description": "The company id that this specific customer is being assignet to."
        },
        "media": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "id",
        "fullname",
        "companyid"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Create a new Customer

Create a new Customer
POST/api/customers/

Error codes

HTTP status Code Description
400 A fullname and an email are mandatory data for a new customer Fullname and email are mandatory post parameters.
400 The email you supplied is malformed! Please check the customer’s email format.

Example URI

POST https://app.rese.io/api/customers/
Request
HideShow
Body
{
  "fullname": "John Doe",
  "email": "johnydoe@doe.com",
  "city": "Athens",
  "address": "Patisiwn 11",
  "postal_code": 13211,
  "country": "Greece",
  "mobile": 1112223334,
  "vat_number": "112233",
  "birthdate": "1985-02-11",
  "gender": "M",
  "title": "Mr",
  "social": "social=[{“social”:”facebook.com”, “alias”:”johndoe”}]",
  "comments": "some comments",
  "companyid": 475
}
Schema
{
  "type": "object",
  "properties": {
    "fullname": {
      "type": "string",
      "description": "The fullname of the specic customer. Fullname could be at ‘Firstname Lastname’ format."
    },
    "email": {
      "type": "string",
      "description": "The email address for this specific customer"
    },
    "city": {
      "type": [
        "string",
        "null"
      ],
      "description": "The customer residence city."
    },
    "address": {
      "type": [
        "string",
        "null"
      ],
      "description": "The residense address of the customer."
    },
    "postal_code": {
      "type": [
        "number",
        "null"
      ],
      "description": "The residense postal code of the customer."
    },
    "country": {
      "type": [
        "string",
        "null"
      ],
      "description": "The customer residence country for this specific resource."
    },
    "mobile": {
      "type": [
        "number",
        "null"
      ],
      "description": "The customer mobile number (is used for sms communication)."
    },
    "vat_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The VAT registration number for the specific customer."
    },
    "birthdate": {
      "type": [
        "string",
        "null"
      ],
      "description": "The birthdate of the customer. The date uses the form Y-m-d."
    },
    "gender": {
      "type": [
        "string",
        "null"
      ],
      "description": "The gender of the specific customer. Response values are: ‘m’, ‘M’, ‘f’, ‘F’."
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "description": "The title of the specific customer. Accepted values are: ‘Miss’, ‘Ms’, ‘Mr’, ‘Sir’, ‘Mrs’, ‘Dr’."
    },
    "social": {
      "type": [
        "string",
        "null"
      ],
      "description": "The social media aliases of the specific customer. Social media should be placed in JSON format."
    },
    "comments": {
      "type": [
        "string",
        "null"
      ],
      "description": "Some comments of the specific customer."
    },
    "companyid": {
      "type": [
        "number",
        "null"
      ],
      "description": "The company id that this specific customer is being assignet to."
    }
  },
  "required": [
    "fullname",
    "email"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Body
{
  "data": {
    "id": 3332,
    "fullname": "John Doe",
    "email": "johnydoe@doe.com",
    "mobile": 1112223334,
    "country": "Greece",
    "city": "Athens",
    "address": "Patisiwn 11",
    "postal_code": 13211,
    "vat_number": "112233",
    "birthdate": "1985-02-11",
    "gender": "M",
    "title": "Mr",
    "social": [
      {
        "social": "facebook.com",
        "alias": "johndoe"
      }
    ],
    "comments": "some comments",
    "companyid": 475,
    "media": [
      "http://stage.reservationengine.net/assets/images/aueb-475/1531817042-pic2.png"
    ]
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The id of the specific resource"
        },
        "fullname": {
          "type": "string",
          "description": "The fullname (first name & last name) of the specific customer."
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "The email address for this specific resource."
        },
        "mobile": {
          "type": [
            "number",
            "null"
          ],
          "description": "The customer mobile number (is used for sms communication)."
        },
        "country": {
          "type": [
            "string",
            "null"
          ],
          "description": "The customer residence country for this specific resource."
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "The customer residence city for this specific resource."
        },
        "address": {
          "type": [
            "string",
            "null"
          ],
          "description": "The customer resident address for this specific resource."
        },
        "postal_code": {
          "type": [
            "number",
            "null"
          ],
          "description": "The residense postal code of the customer."
        },
        "vat_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "The VAT registration number for the specific customer."
        },
        "birthdate": {
          "type": [
            "string",
            "null"
          ],
          "description": "The birthdate of the customer. The date uses the form Y-m-d."
        },
        "gender": {
          "type": [
            "string",
            "null"
          ],
          "description": "The gender of the specific customer. Response values are: ‘m’, ‘M’, ‘f’, ‘F’."
        },
        "title": {
          "type": [
            "string",
            "null"
          ],
          "description": "The title of the specific customer. Accepted values are: ‘Miss’, ‘Ms’, ‘Mr’, ‘Sir’, ‘Mrs’, ‘Dr’."
        },
        "social": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {
              "social": {
                "type": "string",
                "description": "social platform"
              },
              "alias": {
                "type": "string",
                "description": "alias of the specific resource in the platform specified"
              }
            },
            "required": [
              "social",
              "alias"
            ]
          },
          "description": "The social media alias of the specific customer. Social media should be place in Json format."
        },
        "comments": {
          "type": [
            "string",
            "null"
          ],
          "description": "Some comments of the specific customer."
        },
        "companyid": {
          "type": "number",
          "description": "The company id that this specific customer is being assignet to."
        },
        "media": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "id",
        "fullname",
        "companyid"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Update a Customer

Update a Customer
PATCH/api/customers/{customer_id}

Error codes

HTTP status Code Description
400 No customers could be found. The customer_id you provided is not in authenticated user customer list.
400 Please provide a customer_id! The endpoint doesn’t have a valid customer_id.

Example URI

PATCH https://app.rese.io/api/customers/32161
URI Parameters
HideShow
customer_id
integer (optional) Example: 32161

The id for the specific customer.

Request
HideShow
Body
{
  "fullname": "John Doe",
  "email": "johnydoe@doe.com",
  "city": "Athens",
  "address": "Patisiwn 11",
  "postal_code": 13211,
  "country": "Greece",
  "mobile": 1112223334,
  "vat_number": "112233",
  "birthdate": "1985-02-11",
  "gender": "M",
  "title": "Mr",
  "social": "social=[{“social”:”facebook.com”, “alias”:”johndoe”}]",
  "comments": "some comments",
  "companyid": 475
}
Schema
{
  "type": "object",
  "properties": {
    "fullname": {
      "type": [
        "string",
        "null"
      ],
      "description": "The fullname of the specic customer. Fullname could be at ‘Firstname Lastname’ format."
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "description": "The email address for this specific customer"
    },
    "city": {
      "type": [
        "string",
        "null"
      ],
      "description": "The customer residence city."
    },
    "address": {
      "type": [
        "string",
        "null"
      ],
      "description": "The residense address of the customer."
    },
    "postal_code": {
      "type": [
        "number",
        "null"
      ],
      "description": "The residense postal code of the customer."
    },
    "country": {
      "type": [
        "string",
        "null"
      ],
      "description": "The customer residence country for this specific resource."
    },
    "mobile": {
      "type": [
        "number",
        "null"
      ],
      "description": "The customer mobile number (is used for sms communication)."
    },
    "vat_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The VAT registration number for the specific customer."
    },
    "birthdate": {
      "type": [
        "string",
        "null"
      ],
      "description": "The birthdate of the customer. The date uses the form Y-m-d."
    },
    "gender": {
      "type": [
        "string",
        "null"
      ],
      "description": "The gender of the specific customer. Response values are: ‘m’, ‘M’, ‘f’, ‘F’."
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "description": "The title of the specific customer. Accepted values are: ‘Miss’, ‘Ms’, ‘Mr’, ‘Sir’, ‘Mrs’, ‘Dr’."
    },
    "social": {
      "type": [
        "string",
        "null"
      ],
      "description": "The social media aliases of the specific customer. Social media should be placed in JSON format."
    },
    "comments": {
      "type": [
        "string",
        "null"
      ],
      "description": "Some comments of the specific customer."
    },
    "companyid": {
      "type": [
        "number",
        "null"
      ],
      "description": "The company id that this specific customer is being assignet to."
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Body
{
  "data": {
    "op": "replace",
    "path": "/fullname",
    "value": "Jordan Johnson"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "op": {
          "type": "string",
          "description": "One of JSON PATCH operations (add, remove, replace, move, copy, test), based on rfc6902."
        },
        "path": {
          "type": "string",
          "description": "A JSON Pointer value that references the location in the target document to move the value from based on rfc6901."
        },
        "value": {
          "type": "string",
          "description": "The value that was changed."
        }
      },
      "required": [
        "op",
        "path",
        "value"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Payments

The payments has only one POST endpoint. You can always add new payments. If you like to discard a payment you have to add a new one with minus amount. You cannot delete or modify or get details for a payment. as show here.

Method Endpoint Description
POST /api/payments/ Add a new payment

Add a new Payment

Add a new Payment
POST/api/payments/

Error codes

HTTP status Code Description
400 You didn’t specify a correct booking ID. Payments are assigned to orders. You cannot pass a payment without defining a specific order. Please provide a valid booking_id as a POST parameter
400 This order does not have the NOT_PAID or CANCELLED status! The only accepted status for adding a payment through this end point are: NOT_PAID and CANCELLED

Example URI

POST https://app.rese.io/api/payments/
Request
HideShow
Body
{
  "order_id": 1231
}
Schema
{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "number",
      "description": "The order id of the specific payment. If order status is “NOT_PAID” the total amount of the order will be added to the specific payment. If order status is “CANCELLED” the minus amount will be added. Any other case will response a 400 error."
    }
  },
  "required": [
    "order_id"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Body
{
  "data": {
    "issue_date": "2016-09-14",
    "customer_id": 359,
    "series": "Cash",
    "transaction_num,": 15,
    "amount": 80,
    "currency": "$",
    "comments": "Payment for the Order #1015",
    "order_id": 1015
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "issue_date": {
          "type": "string",
          "description": "The issue date of the specific resource"
        },
        "customer_id": {
          "type": "number",
          "description": "The id of the customer of the specific payment."
        },
        "series": {
          "type": "string",
          "description": "The type of payment for this specific resource."
        },
        "transaction_num,": {
          "type": "number",
          "description": "The unique transaction id for this specific resource."
        },
        "amount": {
          "type": "number",
          "description": "The amount of this specific resource."
        },
        "currency": {
          "type": "string",
          "description": "The currency of this specific resource."
        },
        "comments": {
          "type": "string",
          "description": "The comment that will be added automaticaly for this specific payment."
        },
        "order_id": {
          "type": "number",
          "description": "The booking id that this payment is assigned to."
        }
      },
      "required": [
        "issue_date",
        "customer_id",
        "series",
        "transaction_num,",
        "amount",
        "currency",
        "comments",
        "order_id"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Companies

The Companies endpoints returns information about the R-Engine Companies that have been assigned with the authenticated user. The response includes the display name and other details and groups of info about each company, and lists the companies in the proper display order as they are stored initial at the database. You can re-sort the results by add sorting filter at your request as show here.

Method Endpoint Description
GET /api/companies Get logged in user related companies
GET /api/companies/{company_id},{company_id},… Get specific companies details

List all Companies

List all Companies
GET/api/companies/

Example URI

GET https://app.rese.io/api/companies/
URI Parameters
HideShow
filter[companyid]
number (optional) Example: 14

The companyid of the specific company you want.

filter[name]
string (optional) Example: bizz ltd

Filter companies by the name of a specific company.

filter[url]
string (optional) Example: bizz.com

Filter companies by the url of a specific company.

filter[email]
string (optional) Example: info@bizz.com

Filter companies by the email of a specific company.

filter[alias]
string (optional) Example: bizz

Filter companies by the alias of a specific company.

Response  200
HideShow
Body
{
  "data": {
    "id": 14,
    "name": "bizz",
    "url": "Bizz.com",
    "alias": "bizz",
    "email": "info@reservationengine.net",
    "phone": "1234567890",
    "social": [
      {
        "social": "facebook.com",
        "alias": "johndoe"
      }
    ],
    "vat_reg_num": "EL 078839923",
    "swift_code": "BCINSDD23",
    "currency": "$",
    "logo": "",
    "settings": {
      "working_hours": [
        {
          "day": 0,
          "start": "09:00",
          "end": "17:30"
        },
        {
          "day": 1,
          "start": "09:00",
          "end": "17:30"
        },
        {
          "day": 2,
          "start": "09:00",
          "end": "17:30"
        },
        {
          "day": 3,
          "start": "09:00",
          "end": "17:30"
        },
        {
          "day": 4,
          "start": "10:00",
          "end": "17:30"
        }
      ],
      "work_load": 160,
      "time_window": 1
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "number",
            "null"
          ],
          "description": "The id of the specific company."
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the specific company."
        },
        "url": {
          "type": [
            "string",
            "null"
          ],
          "description": "The full url of the specific company."
        },
        "alias": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name shotcode of the specific company."
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "The contact email of the specific company."
        },
        "phone": {
          "type": [
            "string",
            "null"
          ],
          "description": "The contact phone of the specific company."
        },
        "social": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {
              "social": {
                "type": "string",
                "description": "social platform"
              },
              "alias": {
                "type": "string",
                "description": "alias of the specific resource in the platform specified"
              }
            },
            "required": [
              "social",
              "alias"
            ]
          },
          "description": "The basic social url of the specific company."
        },
        "vat_reg_num": {
          "type": [
            "string",
            "null"
          ],
          "description": "The vat registraion number of the specific company"
        },
        "swift_code": {
          "type": "string",
          "description": "The swift bank code of this specific resource."
        },
        "currency": {
          "type": [
            "string",
            "null"
          ],
          "description": "The symbol of currency of the specific company."
        },
        "logo": {
          "type": [
            "string",
            "null"
          ],
          "description": "Link to the company's logo."
        },
        "settings": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "working_hours": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "day": {
                    "type": "number",
                    "description": "Day [0-6] starting from Monday."
                  },
                  "start": {
                    "type": "string",
                    "description": "Starting hour."
                  },
                  "end": {
                    "type": "string",
                    "description": "Ending hour."
                  }
                },
                "required": [
                  "day",
                  "start",
                  "end"
                ]
              },
              "description": "Company's working hours by day."
            },
            "work_load": {
              "type": "number",
              "description": "Company's workload."
            },
            "time_window": {
              "type": "number",
              "description": "Company's time window."
            }
          },
          "required": [
            "working_hours",
            "work_load"
          ],
          "description": "Company related settings."
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Get specific Company

Get specific Company
GET/api/companies/{company_id}

Error codes

HTTP status Code Description
400 No companies could be found. There is no valid company id provided.

Example URI

GET https://app.rese.io/api/companies/14
URI Parameters
HideShow
company_id
integer (optional) Example: 14

The id for the specific company.

Response  200
HideShow
Body
{
  "data": {
    "id": 14,
    "name": "bizz",
    "url": "Bizz.com",
    "alias": "bizz",
    "email": "info@reservationengine.net",
    "phone": "1234567890",
    "social": [
      {
        "social": "facebook.com",
        "alias": "johndoe"
      }
    ],
    "vat_reg_num": "EL 078839923",
    "swift_code": "BCINSDD23",
    "currency": "$",
    "logo": "",
    "settings": {
      "working_hours": [
        {
          "day": 0,
          "start": "09:00",
          "end": "17:30"
        },
        {
          "day": 1,
          "start": "09:00",
          "end": "17:30"
        },
        {
          "day": 2,
          "start": "09:00",
          "end": "17:30"
        },
        {
          "day": 3,
          "start": "09:00",
          "end": "17:30"
        },
        {
          "day": 4,
          "start": "10:00",
          "end": "17:30"
        }
      ],
      "work_load": 160,
      "time_window": 1
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "number",
            "null"
          ],
          "description": "The id of the specific company."
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the specific company."
        },
        "url": {
          "type": [
            "string",
            "null"
          ],
          "description": "The full url of the specific company."
        },
        "alias": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name shotcode of the specific company."
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "The contact email of the specific company."
        },
        "phone": {
          "type": [
            "string",
            "null"
          ],
          "description": "The contact phone of the specific company."
        },
        "social": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {
              "social": {
                "type": "string",
                "description": "social platform"
              },
              "alias": {
                "type": "string",
                "description": "alias of the specific resource in the platform specified"
              }
            },
            "required": [
              "social",
              "alias"
            ]
          },
          "description": "The basic social url of the specific company."
        },
        "vat_reg_num": {
          "type": [
            "string",
            "null"
          ],
          "description": "The vat registraion number of the specific company"
        },
        "swift_code": {
          "type": "string",
          "description": "The swift bank code of this specific resource."
        },
        "currency": {
          "type": [
            "string",
            "null"
          ],
          "description": "The symbol of currency of the specific company."
        },
        "logo": {
          "type": [
            "string",
            "null"
          ],
          "description": "Link to the company's logo."
        },
        "settings": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "working_hours": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "day": {
                    "type": "number",
                    "description": "Day [0-6] starting from Monday."
                  },
                  "start": {
                    "type": "string",
                    "description": "Starting hour."
                  },
                  "end": {
                    "type": "string",
                    "description": "Ending hour."
                  }
                },
                "required": [
                  "day",
                  "start",
                  "end"
                ]
              },
              "description": "Company's working hours by day."
            },
            "work_load": {
              "type": "number",
              "description": "Company's workload."
            },
            "time_window": {
              "type": "number",
              "description": "Company's time window."
            }
          },
          "required": [
            "working_hours",
            "work_load"
          ],
          "description": "Company related settings."
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Attributes

The attributes endpoints returns information about the R-Engine attributes that have been assigned with the authenticated user services. The response includes the display name and other details and groups of info about each attribute, and lists the attributes in the proper display order as they are stored initial at the database. You can re-sort the results by add sorting filter at your request as show here.

GET /api/attributes Get logged in user related attributes
GET /api/attributes/{attribute_id},{attribute_id},… Get specific attribute details

List all Attributes

List all Attributes
GET/api/attributes/

Example URI

GET https://app.rese.io/api/attributes/
URI Parameters
HideShow
filter[name]
string (optional) Example: Passengers

Filter brands by the name of a specific recourse.

Response  200
HideShow
Body
{
  "data": {
    "id": 2522,
    "name": "Passengers",
    "description": "some description",
    "value": 22
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "the id of the specific 'n' attribute."
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the specific ‘n’ attribute."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "A more detailed description of the specific ‘n’ attribute."
        },
        "value": {
          "type": [
            "number",
            "null"
          ],
          "description": "The value of the specific ‘n’ attribute."
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Get a specific Attribute

Get a specific Attribute
GET/api/attributes/{attribute_id}

Error codes

HTTP status Code Description
400 No attributes could be found. There is no valid attribute id provided.

Example URI

GET https://app.rese.io/api/attributes/32161
URI Parameters
HideShow
attribute_id
integer (optional) Example: 32161

The id for the specific attribute.

Response  200
HideShow
Body
{
  "data": {
    "id": 2522,
    "name": "Passengers",
    "description": "some description",
    "value": 22
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "the id of the specific 'n' attribute."
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the specific ‘n’ attribute."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "A more detailed description of the specific ‘n’ attribute."
        },
        "value": {
          "type": [
            "number",
            "null"
          ],
          "description": "The value of the specific ‘n’ attribute."
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}