GET {repositoryId}/Data/{id}/TrackingMessage/{messageId}

Reads a TrackingMessage.

Request Information

URI Parameters

Name	Description	Type	Additional information
repositoryId	ID of the resource repository (optional).	string	Default value is
id	The ID of the Data resource.	string	Required
messageId	The ID of the TrackingMessage.	string	Required

Body Parameters

None.

Response Information

Resource Description

The requested TrackingMessage.

TrackingMessage

Name	Type	Additional information
RepositoryId	string	None.
Id	string	None.
Name	string	None.
Description	string	None.
Created	ChangeStatusInformation	None.
OwnerId	string	None.
Correspondent	NamedReference	None.
Address	NamedReference	None.
Carrier	NamedReference	None.
Transport	Transport	None.
SendId	string	None.
Status	TrackingStatus	None.
Date	date	None.
Recurrence	integer	None.
References	Collection of NamedReference	None.

Response Formats

application/json, text/json

Sample:

{
  "RepositoryId": "sample string 1",
  "Id": "sample string 2",
  "Name": "sample string 3",
  "Description": "sample string 4",
  "Created": {
    "IdentityReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "PositionReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "Date": "2024-11-25T08:49:31.4019558+01:00"
  },
  "OwnerId": "sample string 5",
  "Correspondent": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "Address": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "Carrier": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "Transport": 0,
  "SendId": "sample string 6",
  "Status": 0,
  "Date": "2024-11-25T08:49:31.4019558+01:00",
  "Recurrence": 8,
  "References": [
    {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    }
  ]
}

application/xml, text/xml

Sample:

<TrackingMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.openworkbpm.com/schema">
  <Address>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </Address>
  <Carrier>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </Carrier>
  <Correspondent>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </Correspondent>
  <Created>
    <Date>2024-11-25T08:49:31.4019558+01:00</Date>
    <IdentityReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </IdentityReference>
    <PositionReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </PositionReference>
  </Created>
  <Date>2024-11-25T08:49:31.4019558+01:00</Date>
  <Description>sample string 4</Description>
  <Id>sample string 2</Id>
  <Name>sample string 3</Name>
  <OwnerId>sample string 5</OwnerId>
  <Recurrence>8</Recurrence>
  <References>
    <NamedReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </NamedReference>
    <NamedReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </NamedReference>
  </References>
  <RepositoryId>sample string 1</RepositoryId>
  <SendId>sample string 6</SendId>
  <Status>Unknown</Status>
  <Transport>Unknown</Transport>
</TrackingMessage>