NextGen APIs

GET /scheduling/r1/schedule-work/{scheduleWorkId}/tours

Http Verb

GET

Url

/scheduling/r1/schedule-work/{scheduleWorkId}/tours

Permissions required


Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2024 W3 (FSM 18.0)

Deprecated since


Removed since


Tech Tags

PAGINATION ORDERING-SERVER-SIDE

Business Logic

This API returns the tour informations related to a specific scheduling passed as input.

It is possible to retrieve the scheduling information by calling the API GET /scheduling/r1/schedule-work .

Path Parameters

Field

Note

scheduleWorkId


Query String Parameters

Filter ℹ️

Field

Validations

Note

totalRouteDistance



totalRouteTime



routeSchedulingsCount



startXCoordinate



startYCoordinate



endXCoordinate



endYCoordinate



routeStartDate



routeEndDate



Page ℹ️

Default.

Fields ℹ️

Default.

Language ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field

Note

totalRouteDistance


totalRouteTime


routeSchedulingsCount


startXCoordinate


startYCoordinate


endXCoordinate


endYCoordinate


routeStartDate


routeEndDate


Response error codes

NOT_FOUND