Versions Compared

Version Old Version 8 New Version Current
Changes made by

Elliot Dooleysmith

Elliot Dooleysmith

Saved on

Key

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

...

Note

A valid user account with ResourceXpress will be required to use this API.
The user's Role will determine which APIs they are granted access to.

Once you have successfully received the AuthToken, store this value for use with other APIs.
Take note of the expiry date, by default, the AuthToken will expire after 30 minutes.

Expand
titleExtend the AuthToken Expiry

If you are using ResourceXpress SaaS please contact our support team at helpdesk@qedas.com.

If you are using ResourceXpress On-Prem then you will need to modify the “AuthTokenExpiry” value found in the web.config file.

On your ResourceXpress server navigate to the RX install location. By default, this is C:\inetpub\wwwroot.

Open the web.configfile in your preferred text editor.

Image Added

Find the “AuthTokenExpiry” option, under <appSettings>.
If this value does not exist, add the below line.

Code Block
languagexml
<add key="AuthTokenExpiry" value="1800" />

Update the value to your desired duration in seconds.

Panel
panelIconId1f551
panelIcon:clock2:
panelIconText🕑
bgColor#DEEBFF

1800 = 30 minutes
86400 = 24 hrs
2678400 = 31 days
31536000 = 365 days

...

Using the API

Request Type

...

Headers (required)

Code Block
languagejson
{
  '"X-Requested-With'": '"com.resourcexpress.report'"
}

Body (required)

Code Block
languagejson
{
  '"EmailId'": '"<your-rx-email-address>'",
  '"Password'": '"<your-rx-password>'"
}

...

Example Response

Code Block
languagejson
{
  "UserId": <your-id>,
  "UserName": "<your-name>",
  "AuthToken": "9a841c01-****-****-****-4fd27be665c7",
  "BeaconUid": null,
  "TenantURL": "<your-server-address>",
  "ExpiresOn": "2022-04-06T12:52:27.526509+00:00",
  "ErrCode": "",
  "ErrDesc": "",
  "Response": true
}

Postman Examples

...