Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

project44 REST API (4.0.0)

Version 4.0.0 of project44's API

Download OpenAPI description
api.json
api.yaml
Overview
License © 2024 project44 - Terms of Use
Languages
Servers
Mock server
https://developers.project44.com/_mock/guides/shippers/visibility/rail/api/
API endpoint for project44 tenants created in NA region
https://na12.api.project44.com/
API endpoint for project44 tenants created in EU region
https://eu12.api.project44.com/
API endpoint for project44 tenants created in the Sandbox environment
https://na12.api.sandbox.p-44.com/

Manage Client Applications

Operations

Generate Tokens

Operations

Unified Shipment Tracking

Operations

Rail Asset Tracking

Operations

Enroll an asset for tracking.

Request

The Asset Tracking API offers users a way to enroll an asset for tracking, and conversely, to unenroll an asset from tracking. Prior to enrolling an asset, users must have an endpoint configured to receive the asset location data.

Information about the location of the asset will be pushed to the enrollee until the asset is un-enrolled from tracking. The payload can be JSON or XML, e.g., 

{   "webhookName": "KBX001",   "equipmentIdentifier": {"type": "RAIL_CAR_ID", "value": "ABCD1234567"},   "expirationDateTime": "2019-05-01T00:00:00-05:00" }
OR 
<AssetTrackingSubscription>   <webhookName>KBX001</webhookName>   <equipmentIdentifier>     <type>RAIL_CAR_ID</type>     <value>ABCD1234567</value>   </equipmentIdentifier>   <expirationDateTime>2019-05-01T00:00:00-05:00</expirationDateTime> </AssetTrackingSubscription>

The call will return with an HTTP 200 status if enrollment is successful. Otherwise, it will return an appropriate HTTP error status code and error message.


Required Fields

  • equipmentIdentifier: The type of asset (either CONTAINER_ID, RAIL_CAR_ID, or TRAILER_ID) and unique identifier, e.g., BNSF654321.
  • webhookName: The id of the previously registered webhook. This indicates where to send the asset tracking information..
Optional Field
  • expirationDateTime: Optional parameter to indicate when to stop tracking the asset. If not provided, expiration will default to six months from the enrollment date. The format is a date-time string with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as 2020-05-01T00:00:00-05:00.
Body
required

subscription

equipmentIdentifierobject(EquipmentIdentifier)
expirationDateTimestring

Optional time to stop tracking as asset. This is a date-time with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as 2019-12-03T10:15:30+01:00. If not provided, it will be set to six months from the enrollment time.

idstring(uuid)
webhookNamestring

The name of the previously registered webhook. This indicates where to send the asset tracking information.

curl -i -X POST \
  https://developers.project44.com/_mock/guides/shippers/visibility/rail/api/api/v4/assets/tracking \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "equipmentIdentifier": {
      "type": "CONTAINER_ID",
      "value": "string"
    },
    "expirationDateTime": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "webhookName": "string"
  }'

Responses

OK

Body

Unenroll an asset for tracking.

Request

Unenroll an asset from tracking. Information about the location of the asset will no longer be pushed. Required Query Parameters

  • equipmentIdentifier.type: the asset type (either CONTAINER_ID, RAIL_CAR_ID, or TRAILER_ID)
  • equipmentIdentifier.value: the unique identifier of the asset, e.g., BNSF654321

The call will return with an HTTP 200 status if unenrollment is successful. Otherwise, it will return an appropriate HTTP error status code and error message.

Query
equipmentIdentifier.typestringrequired

equipmentIdentifier.type

equipmentIdentifier.valuestringrequired

equipmentIdentifier.value

curl -i -X DELETE \
  'https://developers.project44.com/_mock/guides/shippers/visibility/rail/api/api/v4/assets/tracking?equipmentIdentifier.type=string&equipmentIdentifier.value=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body

Deprecated Rail Tracking

Operations

Webhook

Operations