Config

Get all routing algorithms

get

Retrieves all routing algorithms with their role configurations

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

organizationIdintegerRequired

ID of the organization

Example: 1

activebooleanOptional

Filter by active status

Example: true

defaultbooleanOptional

Filter by default status

Example: true

Responses

200Success

application/json

Responseany[]

get

/api/routing/config

HTTPcURLJavaScriptPython

GET /api/routing/config?organizationId=1 HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[]

Create routing algorithm

post

Creates a new routing algorithm with role configurations

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

namestringRequired

Name of the routing algorithm

Example: Standard Routing Algorithm

descriptionstringOptional

Description of the routing algorithm

Example: Default algorithm for general purpose routing

distanceWeightnumberOptional

Weight given to distance in routing calculations

Default: 1Example: 0.7

considerRealTimeTrafficbooleanOptional

Whether to consider real-time traffic in routing

Example: true

maxTravelRadiusnumberOptional

Maximum travel radius in kilometers

Example: 50

defaultPrioritystringOptional

Default priority level for routing

Default: MEDIUMExample: MEDIUM

highPriorityWeightnumberOptional

Weight for high priority tasks

Default: 0.75Example: 0.7

mediumPriorityWeightnumberOptional

Weight for medium priority tasks

Default: 0.2Example: 0.2

lowPriorityWeightnumberOptional

Weight for low priority tasks

Default: 0.05Example: 0.1

considerServiceRegionsbooleanOptional

Whether to consider service regions in routing

Example: true

organizationIdintegerRequired

ID of the organization

Example: 1

defaultbooleanOptional

Whether the routing algorithm is default

Example: true

Responses

200Success

application/json

Responseany

post

/api/routing/config

HTTPcURLJavaScriptPython

POST /api/routing/config HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 356

{
  "name": "Standard Routing Algorithm",
  "description": "Default algorithm for general purpose routing",
  "distanceWeight": 0.7,
  "considerRealTimeTraffic": true,
  "maxTravelRadius": 50,
  "roleConfigs": [],
  "defaultPriority": "MEDIUM",
  "highPriorityWeight": 0.7,
  "mediumPriorityWeight": 0.2,
  "lowPriorityWeight": 0.1,
  "considerServiceRegions": true,
  "organizationId": 1,
  "default": true
}

200Success

No content

Get routing algorithm by ID

get

Retrieves a specific routing algorithm with its role configurations

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

Responseany

get

/api/routing/config/{id}

HTTPcURLJavaScriptPython

GET /api/routing/config/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

No content

Update routing algorithm

put

Updates an existing routing algorithm and its role configurations

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Body

application/json

namestringOptional

Name of the routing algorithm

Example: Updated Routing Algorithm

activebooleanOptional

Whether the routing algorithm is active

Example: true

descriptionstringOptional

Description of the routing algorithm

Example: Default algorithm for general purpose routing

distanceWeightnumberOptional

Weight given to distance in routing calculations

Default: 1Example: 0.7

considerRealTimeTrafficbooleanOptional

Whether to consider real-time traffic in routing

Example: true

maxTravelRadiusnumberOptional

Maximum travel radius in kilometers

Example: 50

defaultPrioritystringOptional

Default priority level for routing

Default: MEDIUMExample: MEDIUM

highPriorityWeightnumberOptional

Weight for high priority tasks

Default: 0.75Example: 0.7

mediumPriorityWeightnumberOptional

Weight for medium priority tasks

Default: 0.2Example: 0.2

lowPriorityWeightnumberOptional

Weight for low priority tasks

Default: 0.05Example: 0.1

considerServiceRegionsbooleanOptional

Whether to consider service regions in routing

Example: true

organizationIdintegerRequired

ID of the organization

Example: 1

defaultbooleanOptional

Whether the routing algorithm is default

Example: true

Responses

200Success

application/json

Responseany

put

/api/routing/config/{id}

HTTPcURLJavaScriptPython

PUT /api/routing/config/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 369

{
  "name": "Updated Routing Algorithm",
  "active": true,
  "description": "Default algorithm for general purpose routing",
  "distanceWeight": 0.7,
  "considerRealTimeTraffic": true,
  "maxTravelRadius": 50,
  "roleConfigs": [],
  "defaultPriority": "MEDIUM",
  "highPriorityWeight": 0.7,
  "mediumPriorityWeight": 0.2,
  "lowPriorityWeight": 0.1,
  "considerServiceRegions": true,
  "organizationId": 1,
  "default": true
}

200Success

No content