Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
exclude.*How will versioning be handled?.


titleImportant Items to Note
  • Authentication is needed for most endpoints. You will need to send an authorization token or do a basic authentication with the call.
  • Dates entered should be in milliseconds in UTC for JSON requests (e.g. 1559651878000) and ISO-8601 standard for XML requests (e.g. 2019-06-04T07:36:53).
  • Dates returned are formatted according to the Operations App global options settings and localized to where the order was picked up/delivered with the timezone noted.
  • When entering the workOrderId parameter it must be in the following format:

    • route stop: r<stopID>
    • on demand pickup: p<orderID>
    • on demand delivery: d<orderID>

How will versioning be handled?

CXT Software will support the latest version, plus one previously published version. Response and Request objects, in addition to URLs, may have properties added with new releases. Business logic within the endpoints may change, and/or permission hardening may be applicable to existing endpoints with new releases.

API Usage

  • You must understand exactly what is being sent, and why, for the various endpoints and all their properties.

  • Assistance can be requested if the EP/property documentation is unclear, and/or you do not understand how a property is intended to be used.

  • Note that endpoints/logic that may be hardened from security, permissions, and/or data integrity standpoint when the Operations App is updated.


  • If the "Enforce Address Validation" global option is checked inside the Operations App, an order/stop will be successfully placed only if the address is validated; the order will fail if the address cannot be validated. If "Enforce Address Validation" is unchecked, the order placement will succeed regardless of validation.
  • Only the geocode (lat/lon) is updated when the addresses can be validated. 
  • If the "Enforce address validation when using web service" global option is checked inside the Operations App, route stops created through the web service will have address validation enforced.


Requirements for uploading a file (attachment creation/update):


You can see which user type(s) are required for an endpoint under "Implementation Notes". For example, "Allowed requestors: [Inet user]" requires an authenticated internet user and  "Allowed requestors: [Mobile Users]" requires an authenticated driver user.  

Image Modified

To authenticate, select sending an authorization token or doing a basic authentication with the call.


Permissions of the authenticated user(s) are based on their user settings in the Operations App. 

 Token Based Authentication 


  • Driver endpoint: /v2/Authentication/Drivers 

    • Valid duration of an authentication token: 30 days  

    • "Allow web access" must be enabled on the driver record in the Operations App application. See Drivers (Classic Operations App).

  • Internet User endpoint: /v2/Authentication/InetUser 

    • Valid duration of an authentication token: 20 minutes

    • "Allow Web Service API" must be enabled on the internet user record in the Operations App application. See Internet Users (Classic Operations App).

  • Human Resources endpoint: /v2/Authentication/Worker  

  • Operations App User endpoint: /v2/Authentication/XdUser 

    • Valid duration of an authentication token: 3 hours 


How to Create a Route Stop

You can use the /v2/RouteStops endpoint to create new route stops in the Operations App.

Endpoint URL!/Route_Stops/CxtSoftware_MiddleTier_WebService_CXTWCF_PostRouteStopV2

SectionRoute Stops

Endpoint: /v2/RouteStops

Implementation Notes: Allowed requestors: [XD User]


ParameterDescriptionParameter TypeData Type

The ID of the on demand order to be updated