API Documentation

Creating an Access Token

Note: You have to be authorized by Cascade to have API access. If you do not see an API section on your profile page, you do not have API access. Please contact us to request API access.

You can create an API Access Token from your Profile page.

Simply supply a Token Name, your Email Address, your current Password and click "Create API Token".

Please copy and save your token in a safe place.
This token allows the same access as your username and password.
You cannot view this token again. If you lose it, you will need to delete it and create a new token from your profile page.

Important: All API calls require you to set an Authorization Bearer Token with your token.

GET /api/v1/jobs HTTP/1.1
Host: tracker.cascade-assets.com
Authorization: Bearer {YOUR-ACCESS-TOKEN}

Replace {YOUR-ACCESS-TOKEN} with your actual access token.

Jobs

Get Your Job IDs

Returns an array of your job IDs. Replace {YOUR-ACCESS-TOKEN} with your actual access token.

    GET /api/v1/jobs HTTP/1.1
    Host: tracker.cascade-assets.com
    Authorization: Bearer {YOUR-ACCESS-TOKEN}

Get Your Job IDs Based on Dates

Returns an array of your job IDs based on the provided date(s). Replace {YOUR-ACCESS-TOKEN} with your actual access token and use one or more dates as form data in the body of the request. Valid date names are "schedule_date_start", "schedule_date_end", "collected_date_start", "collected_date_end", "received_date_start", "received_date_end", "processed_date_start", "processed_date_end", "ordered_date_start" and "ordered_date_end". All dates must be in YYYY-MM-DD format.

    POST /api/v1/jobs-by-date HTTP/1.1
    Host: tracker.cascade-assets.com
    Authorization: Bearer {YOUR-ACCESS-TOKEN}
    Content-Type: multipart/form-data;
    Content-Disposition: form-data; name="schedule_date_start"
    2020-01-01
    Content-Disposition: form-data; name="schedule_date_end"
    2020-12-31
    Content-Disposition: form-data; name="collected_date_start"
    2020-01-01
    Content-Disposition: form-data; name="collected_date_end"
    2020-12-31
    Content-Disposition: form-data; name="received_date_start"
    2020-01-01
    Content-Disposition: form-data; name="received_date_end"
    2020-12-31
    Content-Disposition: form-data; name="processed_date_start"
    2020-01-01
    Content-Disposition: form-data; name="processed_date_end"
    2020-12-31
    Content-Disposition: form-data; name="ordered_date_start"
    2020-01-01
    Content-Disposition: form-data; name="ordered_date_end"
    2020-12-31

Get Job Details

Returns the details for your job. Replace {JOB-ID} with the Job ID you are requesting and {YOUR-ACCESS-TOKEN} with your actual access token.

    GET /api/v1/job/{JOB-ID} HTTP/1.1
    Host: tracker.cascade-assets.com
    Authorization: Bearer {YOUR-ACCESS-TOKEN}

Get Job Assets

Returns an array of the asset IDs that belong to this job. Replace {JOB-ID} with the Job ID you are requesting and {YOUR-ACCESS-TOKEN} with your actual access token.

    GET /api/v1/job/{JOB-ID}/assets HTTP/1.1
    Host: tracker.cascade-assets.com
    Authorization: Bearer {YOUR-ACCESS-TOKEN}

Assets

Get Your Asset IDs

Returns an array of your asset IDs. Replace {YOUR-ACCESS-TOKEN} with your actual access token.

    GET /api/v1/assets HTTP/1.1
    Host: tracker.cascade-assets.com
    Authorization: Bearer {YOUR-ACCESS-TOKEN}

Get Asset Details

Returns the details for your asset. Replace {ASSET-ID} with the Asset ID you are requesting and {YOUR-ACCESS-TOKEN} with your actual access token.

    GET /api/v1/asset/{ASSET-ID} HTTP/1.1
    Host: tracker.cascade-assets.com
    Authorization: Bearer {YOUR-ACCESS-TOKEN}

Get Asset Statuses In Use

Returns an array of asset statuses currently in use by your assets. Replace {YOUR-ACCESS-TOKEN} with your actual access token.

    GET /api/v1/asset-statuses HTTP/1.1
    Host: tracker.cascade-assets.com
    Authorization: Bearer {YOUR-ACCESS-TOKEN}

Get Assets by Statuses

Returns an array of assets with the supplied status. Replace {STATUS} with the status you are requesting and {YOUR-ACCESS-TOKEN} with your actual access token.
Examples of statuses are: "End_of_Life", "Shipped_as_product", "Tested_working", "Staging_area" and "Sent_to_recycling".

    GET /api/v1/assets-by-status/{STATUS} HTTP/1.1
    Host: tracker.cascade-assets.com
    Authorization: Bearer {YOUR-ACCESS-TOKEN}

Get Your Asset IDs Based on Dates

Returns an array of your asset IDs based on the provided date(s). Replace {YOUR-ACCESS-TOKEN} with your actual access token and use one or more dates as form data in the body of the request. Valid date names are "schedule_date_start", "schedule_date_end", "collected_date_start", "collected_date_end", "received_date_start", "received_date_end", "processed_date_start", "processed_date_end", "ordered_date_start", "ordered_date_end", "resale_date_start", "resale_date_end", "modified_date_start" and "modified_date_end", . All dates must be in YYYY-MM-DD format.

    POST /api/v1/assets-by-date HTTP/1.1
    Host: tracker.cascade-assets.com
    Authorization: Bearer {YOUR-ACCESS-TOKEN}
    Content-Type: multipart/form-data;
    Content-Disposition: form-data; name="schedule_date_start"
    2020-01-01
    Content-Disposition: form-data; name="schedule_date_end"
    2020-12-31
    Content-Disposition: form-data; name="collected_date_start"
    2020-01-01
    Content-Disposition: form-data; name="collected_date_end"
    2020-12-31
    Content-Disposition: form-data; name="received_date_start"
    2020-01-01
    Content-Disposition: form-data; name="received_date_end"
    2020-12-31
    Content-Disposition: form-data; name="processed_date_start"
    2020-01-01
    Content-Disposition: form-data; name="processed_date_end"
    2020-12-31
    Content-Disposition: form-data; name="ordered_date_start"
    2020-01-01
    Content-Disposition: form-data; name="ordered_date_end"
    2020-12-31
    Content-Disposition: form-data; name="resale_date_start"
    2020-01-01
    Content-Disposition: form-data; name="resale_date_end"
    2020-12-31
    Content-Disposition: form-data; name="modified_date_start"
    2020-01-01
    Content-Disposition: form-data; name="modified_date_end"
    2020-12-31

Get Asset by Serial Number

Returns the details for your asset with a matching serial number. Replace {SERIAL-NUMBER} with the serial number you are searching for and {YOUR-ACCESS-TOKEN} with your actual access token.

    POST /api/v1/asset/by-serial-number HTTP/1.1
    Host: tracker.cascade-assets.com
    Authorization: Bearer {YOUR-ACCESS-TOKEN}
    Content-Type: multipart/form-data;
    Content-Disposition: form-data; name="serial_number"
    {SERIAL-NUMBER}