HomeGuidesAPI ReferenceSupport
API Reference
Contact

Preview Route Assignment

post
https://wh.route4me.com/modules/api/v5.0/routes/assign-preview

Generates a preview of route assignments based on the provided filters, grouping, sorting, and assignment strategy (Single, Round Robin, Weighted Round Robin) without applying changes. Returns grouped results and subtotals for review.

Body Params
string | null
string | null
filters
object
exclude_ids
array of strings
exclude_ids
string | null

IANA timezone string

string | null

Group by field

exist_fields
array of strings
exist_fields
order_by
array of arrays of strings | null

Sorting: array of [field, direction]

order_by
integer | null
≥ 1

Pagination page number

integer | null
1 to 500

Items per page

filtersfacility_ids
array of strings | null

Facility IDs as array of hex strings

filtersfacility_ids

Single or multiple route IDs in hex

member_ids
array of numbers

List of member IDs to assign

member_ids
vehicle_ids
array of strings

List of vehicle IDs to assign

vehicle_ids
facility_ids
array of strings

List of facility IDs to assign

facility_ids
number
enum

Assign Strategy: 1 (Single), 2 (Round Robin), 3 (Weighted Round Robin)

Allowed:
number

Property used only when assign_type is set to Weighted Round Robin. Max number of assignments. Max: 100

Responses

Updated 4 months ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago