Tours API documentation

/brands

/brands get

get

Retrieve all available brands

Secured by jwt

Use JWT (JSON Web Token) authentication with given token

Response

HTTP status code 200

Body

Type: application/json

Schema:

{
    "type": "object",
    "$schema": "http://jsonapi.org/schema",
    "title": "Brands",
    "description": "Brands collection",
    "properties": {
        "data": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "type": {
                        "type": "string",
                        "required": "true"
                    },
                    "id": {
                        "type": "string",
                        "required": "true"
                    },
                    "attributes": {
                        "type": "object",
                        "required": "true",
                        "properties": {
                            "title": {
                                "type": "string",
                                "required": "true"
                            }
                        }
                    },
                    "links": {
                        "type": "object",
                        "required": "true",
                        "properties": {
                            "self": {
                                "type": "string",
                                "required": "true"
                            }
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "data": [
        {
            "type": "brands",
            "id": "1",
            "attributes": {
                "title": "MarcoVasco"
            },
            "links": {
                "self": "http:\/\/tours.marcovasco.fr\/0\/brands\/1"
            }
        },
        {
            "type": "brands",
            "id": "2",
            "attributes": {
                "title": "Prestige"
            },
            "links": {
                "self": "http:\/\/tours.marcovasco.fr\/0\/brands\/2"
            }
        },
    ]
}

HTTP status code 204

/domains

/domains get

get

Retrieve all available domains

Secured by jwt

Use JWT (JSON Web Token) authentication with given token

Request
Response

Query Parameters

brand: (string)
Brand id

HTTP status code 200

Body

Type: application/json

Schema:

{
    "type": "object",
    "$schema": "http://jsonapi.org/schema",
    "title": "Domains",
    "description": "Domains collection",
    "properties": {
        "data": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "type": {
                        "type": "string",
                        "required": "true"
                    },
                    "id": {
                        "type": "string",
                        "required": "true"
                    },
                    "attributes": {
                        "type": "object",
                        "required": "true",
                        "properties": {
                            "title": {
                                "type": "string",
                                "required": "true"
                            }
                        }
                    },
                    "links": {
                        "type": "object",
                        "required": "true",
                        "properties": {
                            "self": {
                                "type": "string",
                                "required": "true"
                            }
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "data": [
        {
            "type": "domains",
            "id": "41",
            "attributes": {
                "title": "Afrique"
            },
            "links": {
                "self": "http:\/\/tours.marcovasco.fr\/0\/domains\/41"
            }
        },
        {
            "type": "domains",
            "id": "42",
            "attributes": {
                "title": "Afriquedusud"
            },
            "links": {
                "self": "http:\/\/tours.marcovasco.fr\/0\/domains\/42"
            }
        },
        {
            "type": "domains",
            "id": "25",
            "attributes": {
                "title": "Argentine"
            },
            "links": {
                "self": "http:\/\/tours.marcovasco.fr\/0\/domains\/25"
            }
        },
    ]
}

HTTP status code 204

/tours

/tours get

get

Retrieve all tours for a domain and a brand

Secured by jwt

Use JWT (JSON Web Token) authentication with given token

Request
Response

Query Parameters

domain: required (integer)
Domain id
brand: required (string)
Brand id

HTTP status code 200

Body

Type: application/json

Schema:

{
    "type": "object",
    "$schema": "http://jsonapi.org/schema",
    "title": "Tours",
    "description": "Tours collection",
    "properties": {
        "data": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "type": {
                        "type": "string",
                        "required": "true"
                    },
                    "id": {
                        "type": "string",
                        "required": "true"
                    },
                    "attributes": {
                        "type": "object",
                        "required": "true",
                        "properties": {
                            "title": {
                                "type": "string",
                                "required": "true"
                            }
                        }
                    },
                    "links": {
                        "type": "object",
                        "required": "true",
                        "properties": {
                            "self": {
                                "type": "string",
                                "required": "true"
                            }
                        }
                    },
                    "relationships": {
                        "type": "object",
                        "required": "true",
                        "properties": {
                            "brand": {
                                "type": "object",
                                "required": "true",
                                "properties": {
                                    "links": {
                                        "type": "object",
                                        "properties": {
                                            "self": {
                                                "type": "string",
                                                "required": "true"
                                            },
                                            "related": {
                                                "type": "string",
                                                "required": "true"
                                            }
                                        }
                                    },
                                    "data": {
                                        "type": "object",
                                        "required": "true",
                                        "properties": {
                                            "type": {
                                                "type": "string",
                                                "required": "true"
                                            },
                                            "id": {
                                                "type": "string",
                                                "required": "true"
                                            }
                                        }
                                    }
                                }
                            },
                            "domain": {
                                "type": "object",
                                "required": "true",
                                "properties": {
                                    "links": {
                                        "type": "object",
                                        "properties": {
                                            "self": {
                                                "type": "string",
                                                "required": "true"
                                            },
                                            "related": {
                                                "type": "string",
                                                "required": "true"
                                            }
                                        }
                                    },
                                    "data": {
                                        "type": "object",
                                        "required": "true",
                                        "properties": {
                                            "type": {
                                                "type": "string",
                                                "required": "true"
                                            },
                                            "id": {
                                                "type": "string",
                                                "required": "true"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "data": [
        {
            "type": "tours",
            "id": "6862",
            "attributes": {
                "title": "Découverte de l'Argentince"
            },
            "links": {
                "self": "http:\/\/tours.marcovasco.fr\/0\/tours\/6862?domainId=25&brand=1"
            },
            "relationships": {
                "domain": {
                    "links": {
                        "self": "http:\/\/tours.marcovasco.fr\/0\/tours\/6862?domainId=25&brand=1\/relationships\/domain",
                        "related": "http:\/\/tours.marcovasco.fr\/0\/tours\/6862?domainId=25&brand=1\/domain"
                    },
                    "data": {
                        "type": "domains",
                        "id": "25"
                    }
                },
                "brand": {
                    "links": {
                        "self": "http:\/\/tours.marcovasco.fr\/0\/tours\/6862?domainId=25&brand=1\/relationships\/brand",
                        "related": "http:\/\/tours.marcovasco.fr\/0\/tours\/6862?domainId=25&brand=1\/brand"
                    },
                    "data": {
                        "type": "brands",
                        "id": "1"
                    }
                }
            }
        },
    ],
    "included": [
        {
            "type": "domains",
            "id": "25",
            "attributes": {
                "title": "Argentine"
            },
            "links": {
                "self": "http:\/\/tours.marcovasco.fr\/0\/tours\/domains\/25"
            }
        },
        {
            "type": "brands",
            "id": "1",
            "attributes": {
                "title": "MarcoVasco"
            },
            "links": {
                "self": "http:\/\/tours.marcovasco.fr\/0\/tours\/brands\/1"
            }
        }
    ]
}

HTTP status code 204

/tours/{id} get

get

Retrieve tour information, domain and brand parameters are required

Secured by jwt

Use JWT (JSON Web Token) authentication with given token

Request
Response

URI Parameters

id: required (string)
User id

HTTP status code 200

Body

Type: application/json

Schema:

user

Example:

{
    "data": {
        "type": "tours",
        "id": "6862",
        "attributes": {
            "title": "Découverte de l'Argentince"
        },
        "links": {
            "self": "http:\/\/tours.marcovasco.fr\/0\/tours\/6862?domainId=25&brand=1"
        },
        "relationships": {
            "domain": {
                "links": {
                    "self": "http:\/\/tours.marcovasco.fr\/0\/tours\/6862?domainId=25&brand=1\/relationships\/domain",
                    "related": "http:\/\/tours.marcovasco.fr\/0\/tours\/6862?domainId=25&brand=1\/domain"
                },
                "data": {
                    "type": "domains",
                    "id": "25"
                }
            },
            "brand": {
                "links": {
                    "self": "http:\/\/tours.marcovasco.fr\/0\/tours\/6862?domainId=25&brand=1\/relationships\/brand",
                    "related": "http:\/\/tours.marcovasco.fr\/0\/tours\/6862?domainId=25&brand=1\/brand"
                },
                "data": {
                    "type": "brands",
                    "id": "1"
                }
            }
        }
    },
    "included": [
        {
            "type": "domains",
            "id": "25",
            "attributes": {
                "title": "Argentine"
            },
            "links": {
                "self": "http:\/\/tours.marcovasco.fr\/0\/tours\/domains\/25"
            }
        },
        {
            "type": "brands",
            "id": "1",
            "attributes": {
                "title": "MarcoVasco"
            },
            "links": {
                "self": "http:\/\/tours.marcovasco.fr\/0\/tours\/brands\/1"
            }
        }
    ]
}

Tours API documentation version 0

/brands

/brands get

get /brands

HTTP status code 200

Body

HTTP status code 204

/domains

/domains get

get /domains

Query Parameters

HTTP status code 200

Body

HTTP status code 204

/tours

/tours get

get /tours

Query Parameters

HTTP status code 200

Body

HTTP status code 204

/tours/{id} get

get /tours/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 204