Skip to main content
Skip table of contents

What API do I use to fetch/get RouteAssignment?

API Endpoint: v1/api/integration/routeassignment

Method: GET

Request Format: Query Parameter

Query Parameters:

Query Parameter

How to provide

Usage

modifiedbefore

v1/api/integration/routeassignment?modifiedbefore<=2025-08-21T08:17:33.115Z"

Gets the records modified before the mentioned date.

limit

v1/api/integration/routeassignment?limit=4

Gets the number of records mentioned by limit.

Valid values >= 1

pagenumber

v1/api/integration/routeassignment?limit=4&pagenumber=1

Gets the record on defined pagenumber in case limit is less than the total number of records in database.

Valid values >= 1

fields

/api/integration/routeassignment?limit=4&pagenumber=1&fields=id,name

Returns values mentioned in the fields
Available Fields:

  • id

  • name

  • primarypumpername

  • secondarypumpername

  • alternatepumpernames

orderby

/api/integration/routeassignment?limit=4&pagenumber=1&orderby=modifiedon

Returns result sorted by orderby attribute.

filteron

/api/integration/routeassignment?filteron=name[contains]=Route1

Returns result which satisfies conditions.
Note:

  • modified_on is not supported right now.

Common Reason for API failure:

What might be the issue

What is the resolution

Invalid field names in fields parameter

Use only allowed field names: id, name, primarypumpername, secondarypumpername, alternatepumpernames

No data being returned on giving modifiedbefore query parameter

Provide modifiedbefore query parameter in ISO format.

E.g., 2024-09-18T13:04:36.221Z, 2024-09-18

Authentication failure

Ensure proper x-api-key is provided in request headers

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.