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 |
Requirements
...
existing endpoints with new releases. API Usage
|
Requirements
- TLS 1.2
- When calling the web services for CXT Cloud customers (designated by a domain in the format <CXTID>0.cxtsoftware.net), the calling system must connect with TLS 1.2
- TLS 1.2 is not supported on Windows 2008 R2 or below. The calling system can run Windows 7, 8.1 or 2012 or newer, all of which support TLS 1.2
...
- Navigate to URL: https://<domain>/CxtWebService/CXTWCF.svc/api-docs
Authenticate by either getting an authentication token or using basic authentication. See Authenticate. Depending on the user type allowed to access the endpoint, you may need different tokens.
If getting an authorization token, place token in the Authorization Token box at the top.
div- Make endpoint requests in JSON or XML
...
- 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):
...
Attachment Permissions > Maintenance > Permissions.
Type | List/View | Add | Edit | Delete |
---|---|---|---|---|
Order | Must have permissions enabled for X Dispatch Functions > Orders | If the order is Invoiced
If an order is Settled
For uninvoiced and unsettled orders
| Same as Add permission | Same as Add permission |
Customer | Must have permissions enabled for X Dispatch Functions > Customers | Must have X Dispatch Functions > Customers > Edit Customers permission enabled | Same as Add permission | Must have X Dispatch Functions > Customers > Delete Customers permission enabled |
Human Resource | Must have permission enabled for Maintenance Functions > Human Resources > View Contractor Maintenance Functions > Human Resources > View Employees Maintenance Functions > Human Resources > View HR Advanced Information | Must have Maintenance Functions' -> Human Resources > Edit Human Resources permissions enabled | Same as Add permission | Same as Add permission |
Customer Contract | Must have X Route Functions > Contracts | Must have Contracts > Add Contracts permission enabled | Must have Contracts > Edit Contracts permission enabled | Same as Edit permission |
...
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. 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
divValid duration of an authentication token: 30 days
Note title X Dispatch User Note"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
Div Valid duration of an authentication token: 20 minutes
title X Dispatch User Note "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
divValid duration of an authentication token: 30 days
Note Operations App User endpoint: /v2/Authentication/XdUser
Div - Valid duration of an authentication token: 3 hours
Token expiration is automatically extended with each call.
...
Basic authentication credentials must be sent with every request, base64 encoded and the username must be prefixed with 1 or 4 values to distinguish user type:
- Driver prefix: DRIVER
- Internet User prefix: INET
- Human Resources prefix: WORKER
- Operations App User prefix: XDISPATCH
An example of an internet user with the username "cxtsupport" is "INET-cxtsupport".
...
Creating a new order creates a new on demand order in X Dispatch the Operations App and requires an internet user authorization token. Before creating an order you will need a list of order types if a static order type is not provided. Order types in X Dispatch the Operations App define the timing and level of service for on demand orders.
...
Implementation Notes: Allowed requestors: [INet user, XDispatch user] The following permissions need to be enabled in X Dispatch the Operations App on the internet user record in the Options tab, Show Rates to see the initialBaseRate and Show Deliver By Time to see the deliveryTime. To see the initialBaseRate the Global Options in X Dispatch the Operations App also needs to have Total Charges enabled in the Internet Options tab.
...
How to Create a Route Stop
You can use the /v2/RouteStops endpoint to create new route stops in X Dispatchthe 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]
...
Order Status
Internet and X Dispatch Operations App users can get order status data. Including, but not limited to, confirmation, pickup, delivery, and POD details.
...
Parameter | Description | Parameter Type | Data Type |
---|---|---|---|
onDemandOrderId | The ID of the on demand order to be updated | path | string |
Troubleshooting
...