For the complete documentation index, see llms.txt. This page is also available as Markdown.

Itineraries Journeys

Returns a list of journeys for the itinerary

get
Path parameters
tenantVarCodestringRequired

Tenant Var Code

itineraryIdinteger · int32Required

Itinerary Id

Responses
200

OK

Idinteger · int32Optional

A unique identifier of the journey

JourneyTypestring · enumRequiredPossible values:
Namestring · min: 1Required

Name

Descriptionstring · nullableOptional

Description

OriginAddressstring · min: 1Required

Origin address

OriginLatitudenumber · doubleRequired

Origin latitude

OriginLongitudenumber · doubleRequired

Origin longitude

OriginCountryNamestring · nullableOptional

Origin country name

OriginCountryCodestring · nullableOptional

Origin two letter country code

DepartureTimeZoneIdstring · nullableOptional

Departure time zone id

DepartureTimeLocalstring · date-time · nullableOptional

Departure local time (required if departure time UTC not specified)

DepartureTimestring · date-time · nullableOptional

Departure time UTC (required if departure local time not specified)

DestinationAddressstring · min: 1Required

Destination address

DestinationLatitudenumber · doubleRequired

Destination latitude

DestinationLongitudenumber · doubleRequired

Destination longitude

DestinationCountryNamestring · nullableOptional

Destination country name

DestinationCountryCodestring · nullableOptional

Destination two letter country code

ArrivalTimeZoneIdstring · nullableOptional

Arrival time zone id

ArrivalTimeLocalstring · date-time · nullableOptional

Arrival local time (required if arrival time UTC not specified)

ArrivalTimestring · date-time · nullableOptional

Arrival time UTC (required if arrival local time not specified)

get/V2/{tenantVarCode}/itineraries/{itineraryId}/journeys
GET /V2/{tenantVarCode}/itineraries/{itineraryId}/journeys HTTP/1.1
Accept: */*
200

OK

[
  {
    "Id": 1,
    "JourneyType": "Walk",
    "Name": "text",
    "Description": "text",
    "OriginAddress": "text",
    "OriginLatitude": 1,
    "OriginLongitude": 1,
    "OriginCountryName": "text",
    "OriginCountryCode": "text",
    "DepartureTimeZoneId": "text",
    "DepartureTimeLocal": "2026-01-01T00:00:00.000Z",
    "DepartureTime": "2026-01-01T00:00:00.000Z",
    "DestinationAddress": "text",
    "DestinationLatitude": 1,
    "DestinationLongitude": 1,
    "DestinationCountryName": "text",
    "DestinationCountryCode": "text",
    "ArrivalTimeZoneId": "text",
    "ArrivalTimeLocal": "2026-01-01T00:00:00.000Z",
    "ArrivalTime": "2026-01-01T00:00:00.000Z"
  }
]

Creates a new journey

post
Path parameters
tenantVarCodestringRequired

Tenant Var Code

itineraryIdinteger · int32Required

Itinerary Id

Body
Idinteger · int32Optional

A unique identifier of the journey

JourneyTypestring · enumRequiredPossible values:
Namestring · min: 1Required

Name

Descriptionstring · nullableOptional

Description

OriginAddressstring · min: 1Required

Origin address

OriginLatitudenumber · doubleRequired

Origin latitude

OriginLongitudenumber · doubleRequired

Origin longitude

OriginCountryNamestring · nullableOptional

Origin country name

OriginCountryCodestring · nullableOptional

Origin two letter country code

DepartureTimeZoneIdstring · nullableOptional

Departure time zone id

DepartureTimeLocalstring · date-time · nullableOptional

Departure local time (required if departure time UTC not specified)

DepartureTimestring · date-time · nullableOptional

Departure time UTC (required if departure local time not specified)

DestinationAddressstring · min: 1Required

Destination address

DestinationLatitudenumber · doubleRequired

Destination latitude

DestinationLongitudenumber · doubleRequired

Destination longitude

DestinationCountryNamestring · nullableOptional

Destination country name

DestinationCountryCodestring · nullableOptional

Destination two letter country code

ArrivalTimeZoneIdstring · nullableOptional

Arrival time zone id

ArrivalTimeLocalstring · date-time · nullableOptional

Arrival local time (required if arrival time UTC not specified)

ArrivalTimestring · date-time · nullableOptional

Arrival time UTC (required if arrival local time not specified)

Responses
200

OK

No content

post/V2/{tenantVarCode}/itineraries/{itineraryId}/journeys
POST /V2/{tenantVarCode}/itineraries/{itineraryId}/journeys HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 555

{
  "Id": 1,
  "JourneyType": "Walk",
  "Name": "text",
  "Description": "text",
  "OriginAddress": "text",
  "OriginLatitude": 1,
  "OriginLongitude": 1,
  "OriginCountryName": "text",
  "OriginCountryCode": "text",
  "DepartureTimeZoneId": "text",
  "DepartureTimeLocal": "2026-01-01T00:00:00.000Z",
  "DepartureTime": "2026-01-01T00:00:00.000Z",
  "DestinationAddress": "text",
  "DestinationLatitude": 1,
  "DestinationLongitude": 1,
  "DestinationCountryName": "text",
  "DestinationCountryCode": "text",
  "ArrivalTimeZoneId": "text",
  "ArrivalTimeLocal": "2026-01-01T00:00:00.000Z",
  "ArrivalTime": "2026-01-01T00:00:00.000Z"
}
200

OK

No content

Returns a specific journey

get
Path parameters
tenantVarCodestringRequired

Tenant Var Code

itineraryIdinteger · int32Required

Itinerary Id

journeyIdinteger · int32Required

Journey Id

Responses
200

OK

Idinteger · int32Optional

A unique identifier of the journey

JourneyTypestring · enumRequiredPossible values:
Namestring · min: 1Required

Name

Descriptionstring · nullableOptional

Description

OriginAddressstring · min: 1Required

Origin address

OriginLatitudenumber · doubleRequired

Origin latitude

OriginLongitudenumber · doubleRequired

Origin longitude

OriginCountryNamestring · nullableOptional

Origin country name

OriginCountryCodestring · nullableOptional

Origin two letter country code

DepartureTimeZoneIdstring · nullableOptional

Departure time zone id

DepartureTimeLocalstring · date-time · nullableOptional

Departure local time (required if departure time UTC not specified)

DepartureTimestring · date-time · nullableOptional

Departure time UTC (required if departure local time not specified)

DestinationAddressstring · min: 1Required

Destination address

DestinationLatitudenumber · doubleRequired

Destination latitude

DestinationLongitudenumber · doubleRequired

Destination longitude

DestinationCountryNamestring · nullableOptional

Destination country name

DestinationCountryCodestring · nullableOptional

Destination two letter country code

ArrivalTimeZoneIdstring · nullableOptional

Arrival time zone id

ArrivalTimeLocalstring · date-time · nullableOptional

Arrival local time (required if arrival time UTC not specified)

ArrivalTimestring · date-time · nullableOptional

Arrival time UTC (required if arrival local time not specified)

get/V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId}
GET /V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId} HTTP/1.1
Accept: */*
200

OK

{
  "Id": 1,
  "JourneyType": "Walk",
  "Name": "text",
  "Description": "text",
  "OriginAddress": "text",
  "OriginLatitude": 1,
  "OriginLongitude": 1,
  "OriginCountryName": "text",
  "OriginCountryCode": "text",
  "DepartureTimeZoneId": "text",
  "DepartureTimeLocal": "2026-01-01T00:00:00.000Z",
  "DepartureTime": "2026-01-01T00:00:00.000Z",
  "DestinationAddress": "text",
  "DestinationLatitude": 1,
  "DestinationLongitude": 1,
  "DestinationCountryName": "text",
  "DestinationCountryCode": "text",
  "ArrivalTimeZoneId": "text",
  "ArrivalTimeLocal": "2026-01-01T00:00:00.000Z",
  "ArrivalTime": "2026-01-01T00:00:00.000Z"
}

Updates an existing journey

put
Path parameters
tenantVarCodestringRequired

Tenant Var Code

itineraryIdinteger · int32Required

Itinerary Id

journeyIdinteger · int32Required

Journey Id

Body
Idinteger · int32Optional

A unique identifier of the journey

JourneyTypestring · enumRequiredPossible values:
Namestring · min: 1Required

Name

Descriptionstring · nullableOptional

Description

OriginAddressstring · min: 1Required

Origin address

OriginLatitudenumber · doubleRequired

Origin latitude

OriginLongitudenumber · doubleRequired

Origin longitude

OriginCountryNamestring · nullableOptional

Origin country name

OriginCountryCodestring · nullableOptional

Origin two letter country code

DepartureTimeZoneIdstring · nullableOptional

Departure time zone id

DepartureTimeLocalstring · date-time · nullableOptional

Departure local time (required if departure time UTC not specified)

DepartureTimestring · date-time · nullableOptional

Departure time UTC (required if departure local time not specified)

DestinationAddressstring · min: 1Required

Destination address

DestinationLatitudenumber · doubleRequired

Destination latitude

DestinationLongitudenumber · doubleRequired

Destination longitude

DestinationCountryNamestring · nullableOptional

Destination country name

DestinationCountryCodestring · nullableOptional

Destination two letter country code

ArrivalTimeZoneIdstring · nullableOptional

Arrival time zone id

ArrivalTimeLocalstring · date-time · nullableOptional

Arrival local time (required if arrival time UTC not specified)

ArrivalTimestring · date-time · nullableOptional

Arrival time UTC (required if arrival local time not specified)

Responses
200

OK

No content

put/V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId}
PUT /V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 555

{
  "Id": 1,
  "JourneyType": "Walk",
  "Name": "text",
  "Description": "text",
  "OriginAddress": "text",
  "OriginLatitude": 1,
  "OriginLongitude": 1,
  "OriginCountryName": "text",
  "OriginCountryCode": "text",
  "DepartureTimeZoneId": "text",
  "DepartureTimeLocal": "2026-01-01T00:00:00.000Z",
  "DepartureTime": "2026-01-01T00:00:00.000Z",
  "DestinationAddress": "text",
  "DestinationLatitude": 1,
  "DestinationLongitude": 1,
  "DestinationCountryName": "text",
  "DestinationCountryCode": "text",
  "ArrivalTimeZoneId": "text",
  "ArrivalTimeLocal": "2026-01-01T00:00:00.000Z",
  "ArrivalTime": "2026-01-01T00:00:00.000Z"
}
200

OK

No content

Deletes a specific journey

delete
Path parameters
tenantVarCodestringRequired

Tenant Var Code

itineraryIdinteger · int32Required

Itinerary Id

journeyIdinteger · int32Required

Journey Id

Responses
200

OK

No content

delete/V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId}
DELETE /V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId} HTTP/1.1
Accept: */*
200

OK

No content

Last updated