| Anchor | ||||
|---|---|---|---|---|
|
| Table of Contents | ||
|---|---|---|
|
...
| Panel | ||
|---|---|---|
| ||
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
|
...
- 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.
Attachments
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.
To authenticate, select sending an authorization token or doing a basic authentication with the call.
| Info |
|---|
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
Valid duration of an authentication token: 30 days
See Human Resources - New / Edit Human Resource.
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: https://XXXX0.cxtsoftware.net/CxtWebService/CXTWCF.svc/api-docs/index.html?url=/CxtWebService/CXTWCF.svc/v2/swagger.json#!/Route_Stops/CxtSoftware_MiddleTier_WebService_CXTWCF_PostRouteStopV2
Section: Route Stops
Endpoint: /v2/RouteStops
Implementation Notes: Allowed requestors: [XD User]
...
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| onDemandOrderId | The ID of the on demand order to be updated | path | string |
Troubleshooting
...