Junction definition delete

Service version: v1
Last edit: 2024.04.09

Purpose

Junction definition delete is a REST API endpoint that deletes a requested junction.

Request data

You can delete a Junction by sending a DELETE request.

  • Constants and parameters enclosed in curly brackets must be replaced with their values.
  • Please see the following Request parameters section with the required and optional parameter tables for their values. The generic request format is as follows.

HTTPS method: DELETE

delete
URL request example
https://api.tomtom.com/junction-analytics/junctions/1/{junctionId}/definition?key={Your_API_Key}

Request parameters

The following table shows the request parameters.

  • Required parameters must be used or the call will fail.
  • Optional parameters may be used.
Required parametersDescription

junctionId
string

The unique junction ID that must be used in the request path.

key
string

An API Key valid for the requested service. Value: Your valid API Key.

Example request

The following is an example curl request:

curl command example
$ curl '/junction-analytics/junctions/1/{junctionId}/definition?key={Your_API_Key}' -i -X DELETE

Response data

This response returns confirmation of deletion.

Example response

The following is an example response in JSON format:

Response body - JSON
1{
2 "modificationType": "Deleted",
3 "junctionId": "65268ff77cd5d952a185b9b5"
4}

Response fields

The following section describes all of the fields that can appear in a response.

modificationType (string) A string that describes the modification type. In this case it has the value Deleted.

junctionId (string) The unique ID of the deleted junction.

Errors

An error response is generated if there is an error in the supplied parameters, or any other internal problem. The error response is generated in the requested format.

Error response codes

The following table gives the HTTP error response codes.

CodeDescription
401

Unauthorized

403

Forbidden

404

Not Found Junction of id 5fd8da2b84510126b9d18b0d is not found.

Error response field

FieldDescription

errorMessage
string

Problem description.

Example error response

Response error - JSON
1{
2 "errorMessage": "Junction of id 5fd9b98a88a13608d7b5d92c not found"
3}