Skip to main content

About Topics

In the context of a DPS, a "topic" is used to organize and link related job orders, making it easier to keep track of and manage related tasks. The combination of a name and subject creates a unique topic, which allows job orders to be grouped and associated with each other.

This API is used to show the step-by-step process of creating topics.

URL Config
Endpoint: https://api-stage.dps.io/api
APIVersion: v1
route: topics
path:
Method
POST
Request Headers
{
    "Content-Type": "application/json",
    "x-api-key": "<YOUR_API_KEY>",
    "ShipperHash": "<YOUR_ShipperHash>",
}
Request Body
{
    "Name": "name of your topic",
    "Subject": "subject of your topic"
}
Response

{
    "ShipperHash": <your-shipper-hash>,
    "Name": "<Name of your topic>",
    "Subject": "<Subject of your topic>",
    "Tags": "",
    "CreatedDate": "2023-06-21T18:12:46.162333",
    "LastModified": "2023-06-21T18:12:46.162349",
    "TopicHash": "CcTj*******zAPMy"
}
Curl request
curl --location --request POST 'https://api-stage.dps.io/api/v1/topics' \
--header 'x-api-key: <your-api-key>' \
--header 'ShipperHash: <your-shipper-hash>' \
--header 'Content-Type: application/json' \
--data-raw '{
                "Name": "name of your topic",
                "Subject": "subject of your topic"
            }'