> For the complete documentation index, see [llms.txt](https://docs.globalalerting.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.globalalerting.com/web-api/itineraries-journeys.md).

# Itineraries Journeys

## GET /V2/{tenantVarCode}/itineraries/{itineraryId}/journeys

> Returns a list of journeys for the itinerary

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Itineraries - Journeys"}],"paths":{"/V2/{tenantVarCode}/itineraries/{itineraryId}/journeys":{"get":{"tags":["Itineraries - Journeys"],"summary":"Returns a list of journeys for the itinerary","operationId":"GetJourneys","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"itineraryId","in":"path","description":"Itinerary Id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"}}}}}}}}},"components":{"schemas":{"InsightsJourney":{"required":["DestinationAddress","DestinationLatitude","DestinationLongitude","JourneyType","Name","OriginAddress","OriginLatitude","OriginLongitude"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the journey","format":"int32"},"JourneyType":{"$ref":"#/components/schemas/InsightsJourneyType"},"Name":{"minLength":1,"type":"string","description":"Name"},"Description":{"type":"string","description":"Description","nullable":true},"OriginAddress":{"minLength":1,"type":"string","description":"Origin address"},"OriginLatitude":{"type":"number","description":"Origin latitude","format":"double"},"OriginLongitude":{"type":"number","description":"Origin longitude","format":"double"},"OriginCountryName":{"type":"string","description":"Origin country name","nullable":true},"OriginCountryCode":{"type":"string","description":"Origin two letter country code","nullable":true},"DepartureTimeZoneId":{"type":"string","description":"Departure time zone id","nullable":true},"DepartureTimeLocal":{"type":"string","description":"Departure local time (required if departure time UTC not specified)","format":"date-time","nullable":true},"DepartureTime":{"type":"string","description":"Departure time UTC (required if departure local time not specified)","format":"date-time","nullable":true},"DestinationAddress":{"minLength":1,"type":"string","description":"Destination address"},"DestinationLatitude":{"type":"number","description":"Destination latitude","format":"double"},"DestinationLongitude":{"type":"number","description":"Destination longitude","format":"double"},"DestinationCountryName":{"type":"string","description":"Destination country name","nullable":true},"DestinationCountryCode":{"type":"string","description":"Destination two letter country code","nullable":true},"ArrivalTimeZoneId":{"type":"string","description":"Arrival time zone id","nullable":true},"ArrivalTimeLocal":{"type":"string","description":"Arrival local time (required if arrival time UTC not specified)","format":"date-time","nullable":true},"ArrivalTime":{"type":"string","description":"Arrival time UTC (required if arrival local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"InsightsJourneyType":{"enum":["Walk","Drive","Transit","Cycle","Ship"],"type":"string"}}}}
```

## POST /V2/{tenantVarCode}/itineraries/{itineraryId}/journeys

> Creates a new journey

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Itineraries - Journeys"}],"paths":{"/V2/{tenantVarCode}/itineraries/{itineraryId}/journeys":{"post":{"tags":["Itineraries - Journeys"],"summary":"Creates a new journey","operationId":"PostJourney","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"itineraryId","in":"path","description":"Itinerary Id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Journey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"text/plain":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"text/json":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/*+xml":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}}}},"responses":{"200":{"description":"OK"}}}}},"components":{"schemas":{"InsightsJourney":{"required":["DestinationAddress","DestinationLatitude","DestinationLongitude","JourneyType","Name","OriginAddress","OriginLatitude","OriginLongitude"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the journey","format":"int32"},"JourneyType":{"$ref":"#/components/schemas/InsightsJourneyType"},"Name":{"minLength":1,"type":"string","description":"Name"},"Description":{"type":"string","description":"Description","nullable":true},"OriginAddress":{"minLength":1,"type":"string","description":"Origin address"},"OriginLatitude":{"type":"number","description":"Origin latitude","format":"double"},"OriginLongitude":{"type":"number","description":"Origin longitude","format":"double"},"OriginCountryName":{"type":"string","description":"Origin country name","nullable":true},"OriginCountryCode":{"type":"string","description":"Origin two letter country code","nullable":true},"DepartureTimeZoneId":{"type":"string","description":"Departure time zone id","nullable":true},"DepartureTimeLocal":{"type":"string","description":"Departure local time (required if departure time UTC not specified)","format":"date-time","nullable":true},"DepartureTime":{"type":"string","description":"Departure time UTC (required if departure local time not specified)","format":"date-time","nullable":true},"DestinationAddress":{"minLength":1,"type":"string","description":"Destination address"},"DestinationLatitude":{"type":"number","description":"Destination latitude","format":"double"},"DestinationLongitude":{"type":"number","description":"Destination longitude","format":"double"},"DestinationCountryName":{"type":"string","description":"Destination country name","nullable":true},"DestinationCountryCode":{"type":"string","description":"Destination two letter country code","nullable":true},"ArrivalTimeZoneId":{"type":"string","description":"Arrival time zone id","nullable":true},"ArrivalTimeLocal":{"type":"string","description":"Arrival local time (required if arrival time UTC not specified)","format":"date-time","nullable":true},"ArrivalTime":{"type":"string","description":"Arrival time UTC (required if arrival local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"InsightsJourneyType":{"enum":["Walk","Drive","Transit","Cycle","Ship"],"type":"string"}}}}
```

## GET /V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId}

> Returns a specific journey

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Itineraries - Journeys"}],"paths":{"/V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId}":{"get":{"tags":["Itineraries - Journeys"],"summary":"Returns a specific journey","operationId":"GetJourney","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"itineraryId","in":"path","description":"Itinerary Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"journeyId","in":"path","description":"Journey Id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"text/plain":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"text/json":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}}}}}}}},"components":{"schemas":{"InsightsJourney":{"required":["DestinationAddress","DestinationLatitude","DestinationLongitude","JourneyType","Name","OriginAddress","OriginLatitude","OriginLongitude"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the journey","format":"int32"},"JourneyType":{"$ref":"#/components/schemas/InsightsJourneyType"},"Name":{"minLength":1,"type":"string","description":"Name"},"Description":{"type":"string","description":"Description","nullable":true},"OriginAddress":{"minLength":1,"type":"string","description":"Origin address"},"OriginLatitude":{"type":"number","description":"Origin latitude","format":"double"},"OriginLongitude":{"type":"number","description":"Origin longitude","format":"double"},"OriginCountryName":{"type":"string","description":"Origin country name","nullable":true},"OriginCountryCode":{"type":"string","description":"Origin two letter country code","nullable":true},"DepartureTimeZoneId":{"type":"string","description":"Departure time zone id","nullable":true},"DepartureTimeLocal":{"type":"string","description":"Departure local time (required if departure time UTC not specified)","format":"date-time","nullable":true},"DepartureTime":{"type":"string","description":"Departure time UTC (required if departure local time not specified)","format":"date-time","nullable":true},"DestinationAddress":{"minLength":1,"type":"string","description":"Destination address"},"DestinationLatitude":{"type":"number","description":"Destination latitude","format":"double"},"DestinationLongitude":{"type":"number","description":"Destination longitude","format":"double"},"DestinationCountryName":{"type":"string","description":"Destination country name","nullable":true},"DestinationCountryCode":{"type":"string","description":"Destination two letter country code","nullable":true},"ArrivalTimeZoneId":{"type":"string","description":"Arrival time zone id","nullable":true},"ArrivalTimeLocal":{"type":"string","description":"Arrival local time (required if arrival time UTC not specified)","format":"date-time","nullable":true},"ArrivalTime":{"type":"string","description":"Arrival time UTC (required if arrival local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"InsightsJourneyType":{"enum":["Walk","Drive","Transit","Cycle","Ship"],"type":"string"}}}}
```

## PUT /V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId}

> Updates an existing journey

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Itineraries - Journeys"}],"paths":{"/V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId}":{"put":{"tags":["Itineraries - Journeys"],"summary":"Updates an existing journey","operationId":"PutJourney","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"itineraryId","in":"path","description":"Itinerary Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"journeyId","in":"path","description":"Journey Id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Journey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"text/plain":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"text/json":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}},"application/*+xml":{"schema":{"$ref":"#/components/schemas/InsightsJourney"}}}},"responses":{"200":{"description":"OK"}}}}},"components":{"schemas":{"InsightsJourney":{"required":["DestinationAddress","DestinationLatitude","DestinationLongitude","JourneyType","Name","OriginAddress","OriginLatitude","OriginLongitude"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the journey","format":"int32"},"JourneyType":{"$ref":"#/components/schemas/InsightsJourneyType"},"Name":{"minLength":1,"type":"string","description":"Name"},"Description":{"type":"string","description":"Description","nullable":true},"OriginAddress":{"minLength":1,"type":"string","description":"Origin address"},"OriginLatitude":{"type":"number","description":"Origin latitude","format":"double"},"OriginLongitude":{"type":"number","description":"Origin longitude","format":"double"},"OriginCountryName":{"type":"string","description":"Origin country name","nullable":true},"OriginCountryCode":{"type":"string","description":"Origin two letter country code","nullable":true},"DepartureTimeZoneId":{"type":"string","description":"Departure time zone id","nullable":true},"DepartureTimeLocal":{"type":"string","description":"Departure local time (required if departure time UTC not specified)","format":"date-time","nullable":true},"DepartureTime":{"type":"string","description":"Departure time UTC (required if departure local time not specified)","format":"date-time","nullable":true},"DestinationAddress":{"minLength":1,"type":"string","description":"Destination address"},"DestinationLatitude":{"type":"number","description":"Destination latitude","format":"double"},"DestinationLongitude":{"type":"number","description":"Destination longitude","format":"double"},"DestinationCountryName":{"type":"string","description":"Destination country name","nullable":true},"DestinationCountryCode":{"type":"string","description":"Destination two letter country code","nullable":true},"ArrivalTimeZoneId":{"type":"string","description":"Arrival time zone id","nullable":true},"ArrivalTimeLocal":{"type":"string","description":"Arrival local time (required if arrival time UTC not specified)","format":"date-time","nullable":true},"ArrivalTime":{"type":"string","description":"Arrival time UTC (required if arrival local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"InsightsJourneyType":{"enum":["Walk","Drive","Transit","Cycle","Ship"],"type":"string"}}}}
```

## DELETE /V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId}

> Deletes a specific journey

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Itineraries - Journeys"}],"paths":{"/V2/{tenantVarCode}/itineraries/{itineraryId}/journeys/{journeyId}":{"delete":{"tags":["Itineraries - Journeys"],"summary":"Deletes a specific journey","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"itineraryId","in":"path","description":"Itinerary Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"journeyId","in":"path","description":"Journey Id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"}}}}}}
```