API docs by Redocly

Documentation de l'api travelsApi (1.0.0)

Download OpenAPI specification:Download

Terms of Service

Documentation et contrat d'interface pour l'api travelsApi, l'api responsable de la géstion (création, publication, reservation ...) d'un voyage.

Trips

addTrip

création d'un circuit au tant qu'objet métier.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

id technique et unique généré automatiquement et qui identifie un circuit.

reference
string

référence du circuit.

establishmentId
required
string

id technique de l'établissemnt propriétaire du circuit.

Array of objects (pictures)

Liste de photos qui représentent le circuit.

title
required
string

titre du circuit.

smallDescription
string

Une description brève de l'annonce.

detailedDescription
string

Une description détaillée de l'annonce.

Array of objects (tripProgramDetails)

les détails du programme d'un circuit.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "establishmentId": "string",
  • "pictures": [
    ],
  • "title": "string",
  • "smallDescription": "string",
  • "detailedDescription": "string",
  • "tripProgramDetails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "establishmentId": "string",
  • "pictures": [
    ],
  • "title": "string",
  • "smallDescription": "string",
  • "detailedDescription": "string",
  • "tripProgramDetails": [
    ],
  • "links": [
    ]
}

deleteMultipleTrips

Suppression logique des trips.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
listIds
required
Array of strings

Liste des identifiants de trips.

Responses

Request samples

Content type
application/json
{
  • "listIds": [
    ]
}

Response samples

Content type
application/json
{ }

listTrip

Lister les circuits.

query Parameters
establishment-id
required
string

id technique de l'établissement propriétaire du bien.

currentPage
integer >= 1

le numéro de la page actuelle, si 1er appel ne pas envoyer cet attribut.

sizePage
integer >= 3

Nombre d'éléments par page.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": [
    ]
}

getTrip

récupération d'un circuit par son id.

path Parameters
trip-id
required
string

id technique du circuit.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "establishmentId": "string",
  • "pictures": [
    ],
  • "title": "string",
  • "smallDescription": "string",
  • "detailedDescription": "string",
  • "tripProgramDetails": [
    ],
  • "links": [
    ]
}

putTrip

modification d'un circuit.

path Parameters
trip-id
required
string

id technique du circuit.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

id technique et unique généré automatiquement et qui identifie un circuit.

reference
string

référence du circuit.

establishmentId
required
string

id technique de l'établissemnt propriétaire du circuit.

Array of objects (pictures)

Liste de photos qui représentent le circuit.

title
required
string

titre du circuit.

smallDescription
string

Une description brève de l'annonce.

detailedDescription
string

Une description détaillée de l'annonce.

Array of objects (tripProgramDetails)

les détails du programme d'un circuit.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "establishmentId": "string",
  • "pictures": [
    ],
  • "title": "string",
  • "smallDescription": "string",
  • "detailedDescription": "string",
  • "tripProgramDetails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "establishmentId": "string",
  • "pictures": [
    ],
  • "title": "string",
  • "smallDescription": "string",
  • "detailedDescription": "string",
  • "tripProgramDetails": [
    ],
  • "links": [
    ]
}

deleteTrip

suppression d'un circuit.

path Parameters
trip-id
required
string

id technique du circuit.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{ }

TripPublications

listPublications

Lister les publications.

query Parameters
destination
string

Une ville de destination.

start-date
string <date>

Date de début de séjour.

end-date
string <date>

Date de fin de séjour.

adultTravelers
integer

Le nombre de voyageurs (adules).

childTravelers
integer

Le nombre de voyageurs (enfant).

babiesTravelers
integer

Le nombre de voyageurs (bébé).

maxPrice
integer <int64>

Le prix maximum.

minPrice
integer <int64>

Le prix minimum.

currentPage
integer >= 0

le numéro de la page actuelle, si 1er appel ne pas envoyer cet attribut.

sizePage
integer >= 1

Nombre d'éléments par page.

establishmentIds
string
Example: establishmentIds=id1,id2,id3

Filtre par identifiants d(établissements (séparés par virgule)

publicationIds
string
Example: publicationIds=id1,id2,id3

Filtre par identifiants de publication (séparés par virgule)

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": [
    ]
}

archivePublications

archiver toutes les publications.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
tripIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tripIds": [
    ]
}

Response samples

Content type
application/json
true

getPublication

récupération d'une publication par son id.

path Parameters
publication-id
required
string

id technique de la publication.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "tripId": "string",
  • "status": "PUBLISHED",
  • "childsMaxAge": 0,
  • "babiesMaxAge": 0,
  • "tripDates": [
    ],
  • "trip": {
    },
  • "links": [
    ]
}

putPublication

modification d'une publication.

path Parameters
publication-id
required
string

id technique de la publication.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

id technique et unique généré automatiquement et qui identifie une publication d'un trip.

tripId
required
string

id technique du bien à publier.

status
string
Enum: "PUBLISHED" "ARCHIVED" "WAITTING_FOR_APPROVAL" "DRAFTS"

Le statut de l'annonce.

childsMaxAge
required
integer

l'age maximum pour profiter des traifs enfants.

babiesMaxAge
required
integer

l'age maximum pour profiter des traifs Bébées.

required
Array of objects (tripDate)

liste de dates proposées pour un circuit.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "tripId": "string",
  • "status": "PUBLISHED",
  • "childsMaxAge": 0,
  • "babiesMaxAge": 0,
  • "tripDates": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "tripId": "string",
  • "status": "PUBLISHED",
  • "childsMaxAge": 0,
  • "babiesMaxAge": 0,
  • "tripDates": [
    ],
  • "trip": {
    },
  • "links": [
    ]
}

deletePublication

suppression d'une publication.

path Parameters
publication-id
required
string

id technique de la publication.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{ }

publishPublication

publication d'une publication.

path Parameters
publication-id
required
string

id technique de la publication.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
true

TripPublicationsManagePlace

managePlaces

Géstion de nombre de place dans une publication.

path Parameters
publication-id
required
string

id technique de la publication.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
tripDateId
string

id technique de la date du circuit choisi au moment de la reservation.

adultPlacesCount
integer

le nombre de place pour adulte, (le nombre est positif si on souhaite remetrre à dispo des places, et negatif sinon).

childPlacesCount
integer

le nombre de place pour enfant, (le nombre est positif si on souhaite remetrre à dispo des places, et negatif sinon).

babiesPlacesCount
integer

le nombre de place pour bébé, (le nombre est positif si on souhaite remetrre à dispo des places, et negatif sinon).

Responses

Request samples

Content type
application/json
{
  • "tripDateId": "string",
  • "adultPlacesCount": 0,
  • "childPlacesCount": 0,
  • "babiesPlacesCount": 0
}

Response samples

Content type
application/json
{ }

TripPricing

getTripPricing

récupération le details de prix pour un voyage.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

id technique et unique généré automatiquement et qui identifie une reservation.

publicationId
required
string

id technique de la publication achetée.

required
Array of objects (client)

liste de clients qui vont effectuer le trip.

transactionId
string

id technique du client qui a effectuer la reservation.

tripDateId
required
string

id technique de la date du circuit choisi au moment de la reservation.

status
string
Enum: "CONFIRMED" "CREATED" "IN_PROGRESS" "CANCELED" "ARCHIVED" "PASSED"

Le statut de la réservation.

Array of objects (activitieInput)

la liste d'activités achetées pour un ciruit.

Array of objects (optionInput)

la liste d'options achetées pour un ciruit.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "status": "CONFIRMED",
  • "activitesPurchased": [
    ],
  • "optionsPurchased": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "travelPricingPerPerson": {
    },
  • "travelTotalPriceWithoutCharge": {
    },
  • "serviceFees": {
    },
  • "paimentFees": {
    },
  • "activitiesTotalPrice": {
    },
  • "optionsTotalPrice": {
    },
  • "travelTotalPrice": {
    }
}

TripReservations

addReservation

reservation d'un bien.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

id technique et unique généré automatiquement et qui identifie une reservation.

publicationId
required
string

id technique de la publication achetée.

required
Array of objects (client)

liste de clients qui vont effectuer le trip.

transactionId
string

id technique du client qui a effectuer la reservation.

tripDateId
required
string

id technique de la date du circuit choisi au moment de la reservation.

status
string
Enum: "CONFIRMED" "CREATED" "IN_PROGRESS" "CANCELED" "ARCHIVED" "PASSED"

Le statut de la réservation.

Array of objects (activitieInput)

la liste d'activités achetées pour un ciruit.

Array of objects (optionInput)

la liste d'options achetées pour un ciruit.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "status": "CONFIRMED",
  • "activitesPurchased": [
    ],
  • "optionsPurchased": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "status": "CONFIRMED",
  • "activitesPurchased": [
    ],
  • "optionsPurchased": [
    ],
  • "tripDate": {
    },
  • "pricingDetails": {
    },
  • "reservedPlaces": {
    },
  • "links": [
    ]
}

listreservations

Lister les reservations.

query Parameters
publication-id
string

id technique de la publication.

establishment-id
string

id technique de l'établissemnt propriétaire de la publication.

owner-id
string

id technique du client qui a effectué la reservation.

currentPage
integer >= 0

le numéro de la page actuelle, si 1er appel ne pas envoyer cet attribut.

sizePage
integer >= 1

Nombre d'éléments par page.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": [
    ]
}

getReservation

récupération d'une reservation par son id.

path Parameters
reservation-id
required
string

id technique de la reservation.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "status": "CONFIRMED",
  • "activitesPurchased": [
    ],
  • "optionsPurchased": [
    ],
  • "tripDate": {
    },
  • "pricingDetails": {
    },
  • "reservedPlaces": {
    },
  • "links": [
    ]
}

putReservation

modification d'une reservation.

path Parameters
reservation-id
required
string

id technique de la reservation.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

id technique et unique généré automatiquement et qui identifie une reservation.

publicationId
required
string

id technique de la publication achetée.

required
Array of objects (client)

liste de clients qui vont effectuer le trip.

transactionId
string

id technique du client qui a effectuer la reservation.

tripDateId
required
string

id technique de la date du circuit choisi au moment de la reservation.

status
string
Enum: "CONFIRMED" "CREATED" "IN_PROGRESS" "CANCELED" "ARCHIVED" "PASSED"

Le statut de la réservation.

Array of objects (activitieInput)

la liste d'activités achetées pour un ciruit.

Array of objects (optionInput)

la liste d'options achetées pour un ciruit.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "status": "CONFIRMED",
  • "activitesPurchased": [
    ],
  • "optionsPurchased": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "publicationId": "string",
  • "clients": [
    ],
  • "transactionId": "string",
  • "tripDateId": "string",
  • "status": "CONFIRMED",
  • "activitesPurchased": [
    ],
  • "optionsPurchased": [
    ],
  • "tripDate": {
    },
  • "pricingDetails": {
    },
  • "reservedPlaces": {
    },
  • "links": [
    ]
}

deleteReservation

suppression d'une reservation.

path Parameters
reservation-id
required
string

id technique de la reservation.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{ }

Opinions

addOpinion

ajout d'un opinion sur une annance.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

id technique et unique généré automatiquement et qui identifie un opinion.

tripPublicationId
required
string

id technique de la publication conerné par l'opinion, obligatoir pour (post).

globalMark
required
integer [ 1 .. 5 ]
Default: 1

note globale du client sur l'annonce.

complianceMark
required
integer [ 1 .. 5 ]
Default: 1

note de conformité du l'annonce donné par le client sur l'annonce.

qualityServiceMark
required
integer [ 1 .. 5 ]
Default: 1

note de qualité de service donné par le client sur l'annonce.

priceQualityMark
required
integer [ 1 .. 5 ]
Default: 1

note du rapport qualité prix donné par le client sur l'annonce.

comment
required
string [ 10 .. 200 ] characters

Le commentaire laisé par le client sur l'annonce.

createdDate
string <date-time>

Date de creation de l'opinion.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "tripPublicationId": "string",
  • "globalMark": 1,
  • "complianceMark": 1,
  • "qualityServiceMark": 1,
  • "priceQualityMark": 1,
  • "comment": "stringstri",
  • "createdDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "tripPublicationId": "string",
  • "globalMark": 1,
  • "complianceMark": 1,
  • "qualityServiceMark": 1,
  • "priceQualityMark": 1,
  • "comment": "stringstri",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

listOpinions

Lister les opinions.

query Parameters
publication-id
required
string

id technique de la publication.

currentPage
integer >= 1

le numéro de la page actuelle, si 1er appel ne pas envoyer cet attribut.

sizePage
integer >= 3

Nombre d'éléments par page.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": {
    }
}

getOpinion

récupération d'un opinion par son id.

path Parameters
opinion-id
string

id technique de l'avis.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "tripPublicationId": "string",
  • "globalMark": 1,
  • "complianceMark": 1,
  • "qualityServiceMark": 1,
  • "priceQualityMark": 1,
  • "comment": "stringstri",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

putOpinion

modification d'un opinion.

path Parameters
opinion-id
required
string

id technique de l'avis.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

id technique et unique généré automatiquement et qui identifie un opinion.

tripPublicationId
required
string

id technique de la publication conerné par l'opinion, obligatoir pour (post).

globalMark
required
integer [ 1 .. 5 ]
Default: 1

note globale du client sur l'annonce.

complianceMark
required
integer [ 1 .. 5 ]
Default: 1

note de conformité du l'annonce donné par le client sur l'annonce.

qualityServiceMark
required
integer [ 1 .. 5 ]
Default: 1

note de qualité de service donné par le client sur l'annonce.

priceQualityMark
required
integer [ 1 .. 5 ]
Default: 1

note du rapport qualité prix donné par le client sur l'annonce.

comment
required
string [ 10 .. 200 ] characters

Le commentaire laisé par le client sur l'annonce.

createdDate
string <date-time>

Date de creation de l'opinion.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "tripPublicationId": "string",
  • "globalMark": 1,
  • "complianceMark": 1,
  • "qualityServiceMark": 1,
  • "priceQualityMark": 1,
  • "comment": "stringstri",
  • "createdDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "tripPublicationId": "string",
  • "globalMark": 1,
  • "complianceMark": 1,
  • "qualityServiceMark": 1,
  • "priceQualityMark": 1,
  • "comment": "stringstri",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

deleteOpinion

suppression d'un opinion.

path Parameters
opinion-id
required
string

id technique de l'avis.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{ }