weellgo-api (2.1.0)

Download OpenAPI specification:Download

LinkSwiss ICT Solutions Sagl: tech@linkswiss.com

Introduction

Flow to insert/update a new Trip on Weellgo

GET /trip/{platformID}_{tourOperatorID}_{tourOperatorTripID}

If result return "Error TripID do not exist"

PUT /trip -> Body Trip Model
GET /file-manager/{tripID}

PUT Trip files with pre-signed urls returned from call GET /file-manager/{tripID}

Authentication

weellgo_api_key

Security scheme type:	API Key
Header parameter name:	Authorization

push

Push Notification to the travellers

Send Push Notification

Send Push Notification to each traveller that has download the trip in the App

Authorizations:

weellgo_api_key

Request Body schema: application/json

Push Notification object that need to be sent

tripID required	string Trip ID
title required	string The Title of the push notification message.
message required	string The content of the message you want to send.
link	string Link must start with http:// or https://

Responses

200

Push Notification Sent!

post /push

https://api.weellgo.com/{basePath}/push

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"tripID": "string",
"title": "string",
"message": "string",
"link": "string"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

[

{
- "messageId": "string"
}

]

trip

Manage Trip

Get Trip Details

Get specific Trip by TripID

Authorizations:

weellgo_api_key

path Parameters

tripid

required

string

Weellgo Platform TripID

Responses

200

200 response

get /trip/{tripid}

https://api.weellgo.com/{basePath}/trip/{tripid}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"tripID": "string",
"tripName": "string",
"tourOperatorID": "string",
"tourOperatorTripID": "string",
"quoteUUID": "string",
"previewUUID": "string",
"desc": "string",
"dateStart": "string",
"dateEnd": "string",
"locale": "string",
"status": "CONFIRMED",
"generalContacts":
[
- 0
],
"featuredImage": 0,
"agency":
{
- "id": 0,
- "title": "string",
- "desc": "string",
- "image": 0,
- "contacts":
  [
  - 0
  ]
},
"itinerary":
[
- {
  - "stepID": "string",
  - "type": "START",
  - "cityID": "string",
  - "cityCode": "string",
  - "cityName": "string",
  - "cityDesc": "string",
  - "dateStart": "string",
  - "dateEnd": "string",
  - "autoGuide": true,
  - "map":
    {
    "lat": 0,
    "lng": 0,
    "zoom": 0,
    "minZoom": 0,
    "maxZoom": 0
    },
  - "images":
    [
    0
    ],
  - "services":
    [
    0
    ],
  - "contacts":
    [
    0
    ],
  - "documents":
    [
    0
    ],
  - "references":
    [
    {
    "id": 0,
    "title": "string",
    "type": "string",
    "languageId": "string",
    "url": "string",
    "supplier": "string",
    "enabled": true
    }
    ]
  }
],
"images":
[
- {
  - "id": 0,
  - "type": "CITY",
  - "isFeatured": true,
  - "url": "string",
  - "source": "WEELLGODRIVE",
  - "updatedAt": "string"
  }
],
"documents":
[
- {
  - "id": 0,
  - "type": "VOUCHER",
  - "title": "string",
  - "desc": "string",
  - "url": "string",
  - "source": "WEELLGODRIVE",
  - "updatedAt": "string"
  }
],
"contacts":
[
- {
  - "id": 0,
  - "type": "AGENCY",
  - "title": "string",
  - "desc": "string",
  - "phones":
    [
    {
    "title": "string",
    "phone": "string",
    "type": "WHATSAPP"
    }
    ],
  - "emails":
    [
    {
    "title": "string",
    "email": "user@example.com"
    }
    ],
  - "address": "string",
  - "website": "string"
  }
],
"services":
[
- {
  - "id": 0,
  - "type": "FLIGHT",
  - "title": "string",
  - "desc": "string",
  - "images":
    [
    0
    ],
  - "documents":
    [
    0
    ],
  - "serviceData":
    {
    "PNR": "string",
    "supplier": "string",
    "steps":
    [
    {
    "airplaneType": "string",
    "aptFrom": "string",
    "aptFromTerminal": "string",
    "aptFromText": "string",
    "aptTo": "string",
    "aptToTerminal": "string",
    "aptToText": "string",
    "arrivalDate": "string",
    "arrivalTime": "string",
    "carrier": "string",
    "carrierText": "string",
    "class": "string",
    "departureDate": "string",
    "departureTime": "string",
    "duration": "string",
    "number": "string",
    "status": "string"
    }
    ]
    },
  - "servicePaxList":
    [
    0
    ],
  - "markers":
    [
    {
    "lat": 0,
    "lng": 0,
    "title": "string"
    }
    ],
  - "contacts":
    [
    0
    ],
  - "date": "string",
  - "status": "CONFIRMED",
  - "price":
    {
    "label": "string",
    "amount": 0,
    "currency": "EUR"
    },
  - "parentID": 0
  }
],
"paxList":
[
- {
  - "id": 0,
  - "lastname": "string",
  - "firstname": "string",
  - "type": "ADULT",
  - "birthday": "string",
  - "isMainPax": true,
  - "email": "user@example.com",
  - "phone": "string"
  }
],
"mobiles":
[
- {
  - "id": "string",
  - "token": "string",
  - "os": "string",
  - "identityId": "string"
  }
],
"prices":
[
- {
  - "label": "string",
  - "amount": 0,
  - "currency": "EUR"
  }
],
"updatedAt": "string",
"createdAt": "string"

}

Add Trip

Add new Trip to Weellgo

Authorizations:

weellgo_api_key

Request Body schema: application/json

tripID	string Weellgo Platform TripID, autogenerated by Weellgo
tripName required	string Trip Name/Title
tourOperatorID required	string You need to fill it with the your tourOperatorID provided by Weellgo by Linkswiss
tourOperatorTripID required	string Your Trip Reference Number
quoteUUID	string Quote ID, autogenerated by Weellgo
previewUUID	string Preview ID, autogenerated by Weellgo
desc	string Trip Description
dateStart required	string <yyyy-MM-dd> (Date)
dateEnd required	string <yyyy-MM-dd> (Date)
locale required	string Trip Language, ISO 3166-1 Alpha-2 (i.e. en, us, de, it, ...)
status required	string Enum: "CONFIRMED" "PENDING" "CANCELED" "QUOTE" Trip Status
generalContacts	Array of integers <int64> (Id) Array of the Trip Contacts ids added as General Contacts
featuredImage	integer <int64> (Id)
agency required	object (Agency)
itinerary required	Array of objects (Step) Trip Steps Collection
images	Array of objects (Image) Trip Images Collection
documents	Array of objects (Document) Trip Documents Collection
contacts required	Array of objects (Contact) Trip Contacts Collection
services required	Array of objects (Service) Trip Services Collection
paxList required	Array of objects (Pax) Pax Collection
mobiles	Array of objects (MobileTuple) Trip Mobiles Collection (devices that have already downloaded the Trip)
prices	Array of objects (Price) Trip Prices details
updatedAt	string <yyyy-MM-dd HH:mm:ss> (DateTime)
createdAt	string <yyyy-MM-dd HH:mm:ss> (DateTime)

Responses

200

200 response

post /trip

https://api.weellgo.com/{basePath}/trip

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"tripID": "string",
"tripName": "string",
"tourOperatorID": "string",
"tourOperatorTripID": "string",
"quoteUUID": "string",
"previewUUID": "string",
"desc": "string",
"dateStart": "string",
"dateEnd": "string",
"locale": "string",
"status": "CONFIRMED",
"generalContacts":
[
- 0
],
"featuredImage": 0,
"agency":
{
- "id": 0,
- "title": "string",
- "desc": "string",
- "image": 0,
- "contacts":
  [
  - 0
  ]
},
"itinerary":
[
- {
  - "stepID": "string",
  - "type": "START",
  - "cityID": "string",
  - "cityCode": "string",
  - "cityName": "string",
  - "cityDesc": "string",
  - "dateStart": "string",
  - "dateEnd": "string",
  - "autoGuide": true,
  - "map":
    {
    "lat": 0,
    "lng": 0,
    "zoom": 0,
    "minZoom": 0,
    "maxZoom": 0
    },
  - "images":
    [
    0
    ],
  - "services":
    [
    0
    ],
  - "contacts":
    [
    0
    ],
  - "documents":
    [
    0
    ],
  - "references":
    [
    {
    "id": 0,
    "title": "string",
    "type": "string",
    "languageId": "string",
    "url": "string",
    "supplier": "string",
    "enabled": true
    }
    ]
  }
],
"images":
[
- {
  - "id": 0,
  - "type": "CITY",
  - "isFeatured": true,
  - "url": "string",
  - "source": "WEELLGODRIVE",
  - "updatedAt": "string"
  }
],
"documents":
[
- {
  - "id": 0,
  - "type": "VOUCHER",
  - "title": "string",
  - "desc": "string",
  - "url": "string",
  - "source": "WEELLGODRIVE",
  - "updatedAt": "string"
  }
],
"contacts":
[
- {
  - "id": 0,
  - "type": "AGENCY",
  - "title": "string",
  - "desc": "string",
  - "phones":
    [
    {
    "title": "string",
    "phone": "string",
    "type": "WHATSAPP"
    }
    ],
  - "emails":
    [
    {
    "title": "string",
    "email": "user@example.com"
    }
    ],
  - "address": "string",
  - "website": "string"
  }
],
"services":
[
- {
  - "id": 0,
  - "type": "FLIGHT",
  - "title": "string",
  - "desc": "string",
  - "images":
    [
    0
    ],
  - "documents":
    [
    0
    ],
  - "serviceData":
    {
    "PNR": "string",
    "supplier": "string",
    "steps":
    [
    {
    "airplaneType": "string",
    "aptFrom": "string",
    "aptFromTerminal": "string",
    "aptFromText": "string",
    "aptTo": "string",
    "aptToTerminal": "string",
    "aptToText": "string",
    "arrivalDate": "string",
    "arrivalTime": "string",
    "carrier": "string",
    "carrierText": "string",
    "class": "string",
    "departureDate": "string",
    "departureTime": "string",
    "duration": "string",
    "number": "string",
    "status": "string"
    }
    ]
    },
  - "servicePaxList":
    [
    0
    ],
  - "markers":
    [
    {
    "lat": 0,
    "lng": 0,
    "title": "string"
    }
    ],
  - "contacts":
    [
    0
    ],
  - "date": "string",
  - "status": "CONFIRMED",
  - "price":
    {
    "label": "string",
    "amount": 0,
    "currency": "EUR"
    },
  - "parentID": 0
  }
],
"paxList":
[
- {
  - "id": 0,
  - "lastname": "string",
  - "firstname": "string",
  - "type": "ADULT",
  - "birthday": "string",
  - "isMainPax": true,
  - "email": "user@example.com",
  - "phone": "string"
  }
],
"mobiles":
[
- {
  - "id": "string",
  - "token": "string",
  - "os": "string",
  - "identityId": "string"
  }
],
"prices":
[
- {
  - "label": "string",
  - "amount": 0,
  - "currency": "EUR"
  }
],
"updatedAt": "string",
"createdAt": "string"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"tripID": "string",
"tripName": "string",
"tourOperatorID": "string",
"tourOperatorTripID": "string",
"quoteUUID": "string",
"previewUUID": "string",
"desc": "string",
"dateStart": "string",
"dateEnd": "string",
"locale": "string",
"status": "CONFIRMED",
"generalContacts":
[
- 0
],
"featuredImage": 0,
"agency":
{
- "id": 0,
- "title": "string",
- "desc": "string",
- "image": 0,
- "contacts":
  [
  - 0
  ]
},
"itinerary":
[
- {
  - "stepID": "string",
  - "type": "START",
  - "cityID": "string",
  - "cityCode": "string",
  - "cityName": "string",
  - "cityDesc": "string",
  - "dateStart": "string",
  - "dateEnd": "string",
  - "autoGuide": true,
  - "map":
    {
    "lat": 0,
    "lng": 0,
    "zoom": 0,
    "minZoom": 0,
    "maxZoom": 0
    },
  - "images":
    [
    0
    ],
  - "services":
    [
    0
    ],
  - "contacts":
    [
    0
    ],
  - "documents":
    [
    0
    ],
  - "references":
    [
    {
    "id": 0,
    "title": "string",
    "type": "string",
    "languageId": "string",
    "url": "string",
    "supplier": "string",
    "enabled": true
    }
    ]
  }
],
"images":
[
- {
  - "id": 0,
  - "type": "CITY",
  - "isFeatured": true,
  - "url": "string",
  - "source": "WEELLGODRIVE",
  - "updatedAt": "string"
  }
],
"documents":
[
- {
  - "id": 0,
  - "type": "VOUCHER",
  - "title": "string",
  - "desc": "string",
  - "url": "string",
  - "source": "WEELLGODRIVE",
  - "updatedAt": "string"
  }
],
"contacts":
[
- {
  - "id": 0,
  - "type": "AGENCY",
  - "title": "string",
  - "desc": "string",
  - "phones":
    [
    {
    "title": "string",
    "phone": "string",
    "type": "WHATSAPP"
    }
    ],
  - "emails":
    [
    {
    "title": "string",
    "email": "user@example.com"
    }
    ],
  - "address": "string",
  - "website": "string"
  }
],
"services":
[
- {
  - "id": 0,
  - "type": "FLIGHT",
  - "title": "string",
  - "desc": "string",
  - "images":
    [
    0
    ],
  - "documents":
    [
    0
    ],
  - "serviceData":
    {
    "PNR": "string",
    "supplier": "string",
    "steps":
    [
    {
    "airplaneType": "string",
    "aptFrom": "string",
    "aptFromTerminal": "string",
    "aptFromText": "string",
    "aptTo": "string",
    "aptToTerminal": "string",
    "aptToText": "string",
    "arrivalDate": "string",
    "arrivalTime": "string",
    "carrier": "string",
    "carrierText": "string",
    "class": "string",
    "departureDate": "string",
    "departureTime": "string",
    "duration": "string",
    "number": "string",
    "status": "string"
    }
    ]
    },
  - "servicePaxList":
    [
    0
    ],
  - "markers":
    [
    {
    "lat": 0,
    "lng": 0,
    "title": "string"
    }
    ],
  - "contacts":
    [
    0
    ],
  - "date": "string",
  - "status": "CONFIRMED",
  - "price":
    {
    "label": "string",
    "amount": 0,
    "currency": "EUR"
    },
  - "parentID": 0
  }
],
"paxList":
[
- {
  - "id": 0,
  - "lastname": "string",
  - "firstname": "string",
  - "type": "ADULT",
  - "birthday": "string",
  - "isMainPax": true,
  - "email": "user@example.com",
  - "phone": "string"
  }
],
"mobiles":
[
- {
  - "id": "string",
  - "token": "string",
  - "os": "string",
  - "identityId": "string"
  }
],
"prices":
[
- {
  - "label": "string",
  - "amount": 0,
  - "currency": "EUR"
  }
],
"updatedAt": "string",
"createdAt": "string"

}

file-manager

Get Files Signed Urls

Get Files Signed Urls for a specific Trip

Authorizations:

weellgo_api_key

path Parameters

tripid

required

string

Responses

200

200 response

get /file-manager/{tripid}

https://api.weellgo.com/{basePath}/file-manager/{tripid}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"tripID": "string",
"images":
[
- {
  - "id": "string",
  - "name": "string",
  - "putPresignedUrl": "string",
  - "getPresignedUrl": "string",
  - "expireAt": "string"
  }
],
"documents":
[
- {
  - "id": "string",
  - "name": "string",
  - "putPresignedUrl": "string",
  - "getPresignedUrl": "string",
  - "expireAt": "string"
  }
]

}