Versions Compared

Key

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

...

Token based authentication uses one of the following endpoints to get the authorization token for the user:

  • Driver endpoint: /v1v2/Authentication/Drivers 

    Div

    Valid duration of an authentication token: 30 days  

    Note
    titleX Dispatch User Note

    "Allow web access" must be enabled on the driver record in the X Dispatch application. See Drivers - New / Edit Driver.



  • Internet User endpoint: /v1v2/Authentication/InetUser 

    Div

    Valid duration of an authentication token: 20 minutes

    Note
    titleX Dispatch User Note

    "Allow Web Service API" must be enabled on the internet user record in the X Dispatch application. See Internet Users - New / Edit Internet User.



  • Human Resources endpoint: /v1v2/Authentication/Worker  

    Div

    Valid duration of an authentication token: 30 days

    Note

    See Human Resources - New / Edit Human Resource



  • X Dispatch User endpoint: /v1v2/Authentication/XdUser 

    Div

    Valid duration of an authentication token: 60 minutes 


...

Paste code macro
titleCurl
curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" -d "{
  \"driverId\": 123,
  \"password\": \"password\",
}" "https://XXXX0.cxtsoftware.net/CxtWebService/CXTWCF.svc/v1v2/Authentication/Drivers"

Including Tokens in Subsequent Requests

...

Paste code macro
titleExample
curl -X GET --header "Accept: application/json" --header "Authorization: Token b1661ab49e5d42139b99a4a0ee741f0a" "https://XXXX0.cxtsoftware.net/CxtWebService/CXTWCF.svc/v1v2/Orders/9876"

Basic Authentication

...

To get a list of available order types, use the  /v1v2/Orders/RatesWithTimeWindows endpoint.

...

How to Create an Order

You can use the /v1v2/Orders endpoint to create new on demand order in X Dispatch.

...

Section: Work Orders

Endpoint: /v1v2/WorkOrders/Signatures

Implementation Notes: Allowed requestors: [Mobile User]

...