POST api/v1/Jobs/Agents/{AgentID}/Jobs/{JobMasterNo}/StatusEvents

POSTAgents/{AgentID:int}/Jobs/{JobMasterNo}/StatusEvents/

Request Information

Parameters

NameDescriptionAdditional information
dto

Define this parameter in the request body.

JobMasterNo

Define this parameter in the request URI.

AgentID

Define this parameter in the request URI.

Request body formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "StatusID": 1,
  "StatusCode": "sample string 2",
  "Description": "sample string 3",
  "Location": {
    "Code": "sample string 1",
    "Name": "sample string 2",
    "Location": {
      "lat": 1.1,
      "lng": 2.1
    }
  },
  "Source": "sample string 4",
  "SourceName": "sample string 5",
  "Flights": {
    "Carrier": "sample string 1",
    "FlightNumber": "sample string 2",
    "ULD": [
      {
        "ULDNumber": "sample string 1"
      },
      {
        "ULDNumber": "sample string 1"
      },
      {
        "ULDNumber": "sample string 1"
      }
    ]
  },
  "Voyages": {
    "Carrier": "sample string 1",
    "Vessel": "sample string 2",
    "VoyageNumber": "sample string 3"
  },
  "LocalTransport": {
    "Carrier": "sample string 1",
    "VehicleReferenceNumber": "sample string 2",
    "ContainerNumber": "sample string 3"
  },
  "Containers": [
    {
      "ContainerNumber": "sample string 1"
    },
    {
      "ContainerNumber": "sample string 1"
    },
    {
      "ContainerNumber": "sample string 1"
    }
  ],
  "GoodsDetails": [
    {
      "ContainerNumber": "sample string 1",
      "PackageType": "sample string 2",
      "NoofPieces": 3,
      "GrossWeight": {
        "Value": 1.0,
        "UOM": "sample string 1"
      },
      "Volume": {
        "Value": 1.0,
        "UOM": "sample string 1"
      }
    },
    {
      "ContainerNumber": "sample string 1",
      "PackageType": "sample string 2",
      "NoofPieces": 3,
      "GrossWeight": {
        "Value": 1.0,
        "UOM": "sample string 1"
      },
      "Volume": {
        "Value": 1.0,
        "UOM": "sample string 1"
      }
    },
    {
      "ContainerNumber": "sample string 1",
      "PackageType": "sample string 2",
      "NoofPieces": 3,
      "GrossWeight": {
        "Value": 1.0,
        "UOM": "sample string 1"
      },
      "Volume": {
        "Value": 1.0,
        "UOM": "sample string 1"
      }
    }
  ],
  "EventDateTime": "2025-04-24T13:13:42",
  "EDockettID": [
    {
      "EDockettID": 1,
      "Location": "sample string 2",
      "Description": "sample string 3",
      "Filename": "sample string 4",
      "DocumentType": "sample string 5",
      "DocReferenceID": 1
    },
    {
      "EDockettID": 1,
      "Location": "sample string 2",
      "Description": "sample string 3",
      "Filename": "sample string 4",
      "DocumentType": "sample string 5",
      "DocReferenceID": 1
    },
    {
      "EDockettID": 1,
      "Location": "sample string 2",
      "Description": "sample string 3",
      "Filename": "sample string 4",
      "DocumentType": "sample string 5",
      "DocReferenceID": 1
    }
  ],
  "JobHouseNo": "sample string 6",
  "Name": "sample string 7",
  "Comments": "sample string 8",
  "IsDeleted": true,
  "Created": null,
  "Updated": {
    "AgentID": 1,
    "AgentIDAsText": "1",
    "AgentName": null,
    "ContactID": 0,
    "ContactIDAsText": "0",
    "ContactName": null,
    "Datetime": null,
    "DatetimeAsText": null
  }
}

application/xml, text/xml

Sample:
<JobStatusUpdateDTO>
  <StatusID>1</StatusID>
  <StatusCode>sample string 2</StatusCode>
  <Description>sample string 3</Description>
  <Location>
    <Code>sample string 1</Code>
    <Name>sample string 2</Name>
    <Location>
      <lat>1.1</lat>
      <lng>2.1</lng>
    </Location>
  </Location>
  <Source>sample string 4</Source>
  <SourceName>sample string 5</SourceName>
  <Flights>
    <Carrier>sample string 1</Carrier>
    <FlightNumber>sample string 2</FlightNumber>
    <ULD>
      <JobStatusEventULDDTO>
        <ULDNumber>sample string 1</ULDNumber>
      </JobStatusEventULDDTO>
      <JobStatusEventULDDTO>
        <ULDNumber>sample string 1</ULDNumber>
      </JobStatusEventULDDTO>
      <JobStatusEventULDDTO>
        <ULDNumber>sample string 1</ULDNumber>
      </JobStatusEventULDDTO>
    </ULD>
  </Flights>
  <Voyages>
    <Carrier>sample string 1</Carrier>
    <Vessel>sample string 2</Vessel>
    <VoyageNumber>sample string 3</VoyageNumber>
  </Voyages>
  <LocalTransport>
    <Carrier>sample string 1</Carrier>
    <VehicleReferenceNumber>sample string 2</VehicleReferenceNumber>
    <ContainerNumber>sample string 3</ContainerNumber>
  </LocalTransport>
  <Containers>
    <JobStatusEventContainerDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
    </JobStatusEventContainerDTO>
    <JobStatusEventContainerDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
    </JobStatusEventContainerDTO>
    <JobStatusEventContainerDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
    </JobStatusEventContainerDTO>
  </Containers>
  <GoodsDetails>
    <JobStatusEventGoodsDetailDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
      <PackageType>sample string 2</PackageType>
      <NoofPieces>3</NoofPieces>
      <GrossWeight>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </GrossWeight>
      <Volume>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </Volume>
    </JobStatusEventGoodsDetailDTO>
    <JobStatusEventGoodsDetailDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
      <PackageType>sample string 2</PackageType>
      <NoofPieces>3</NoofPieces>
      <GrossWeight>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </GrossWeight>
      <Volume>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </Volume>
    </JobStatusEventGoodsDetailDTO>
    <JobStatusEventGoodsDetailDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
      <PackageType>sample string 2</PackageType>
      <NoofPieces>3</NoofPieces>
      <GrossWeight>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </GrossWeight>
      <Volume>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </Volume>
    </JobStatusEventGoodsDetailDTO>
  </GoodsDetails>
  <EventDateTime>2025-04-24T13:13:42.5644301+00:00</EventDateTime>
  <EDockettID>
    <JobStatusUpdateEDockettDTO>
      <EDockettID>1</EDockettID>
      <Location>sample string 2</Location>
      <Description>sample string 3</Description>
      <Filename>sample string 4</Filename>
      <DocumentType>sample string 5</DocumentType>
      <DocReferenceID>1</DocReferenceID>
    </JobStatusUpdateEDockettDTO>
    <JobStatusUpdateEDockettDTO>
      <EDockettID>1</EDockettID>
      <Location>sample string 2</Location>
      <Description>sample string 3</Description>
      <Filename>sample string 4</Filename>
      <DocumentType>sample string 5</DocumentType>
      <DocReferenceID>1</DocReferenceID>
    </JobStatusUpdateEDockettDTO>
    <JobStatusUpdateEDockettDTO>
      <EDockettID>1</EDockettID>
      <Location>sample string 2</Location>
      <Description>sample string 3</Description>
      <Filename>sample string 4</Filename>
      <DocumentType>sample string 5</DocumentType>
      <DocReferenceID>1</DocReferenceID>
    </JobStatusUpdateEDockettDTO>
  </EDockettID>
  <JobHouseNo>sample string 6</JobHouseNo>
  <Name>sample string 7</Name>
  <Comments>sample string 8</Comments>
  <IsDeleted>true</IsDeleted>
  <Updated>
    <AgentID>1</AgentID>
    <AgentName />
    <ContactID>0</ContactID>
    <ContactName />
  </Updated>
</JobStatusUpdateDTO>

Response Information

Response body formats

application/json, text/json

Sample:
{
  "StatusID": 1,
  "StatusCode": "sample string 2",
  "Description": "sample string 3",
  "Location": {
    "Code": "sample string 1",
    "Name": "sample string 2",
    "Location": {
      "lat": 1.1,
      "lng": 2.1
    }
  },
  "Source": "sample string 4",
  "SourceName": "sample string 5",
  "Flights": {
    "Carrier": "sample string 1",
    "FlightNumber": "sample string 2",
    "ULD": [
      {
        "ULDNumber": "sample string 1"
      },
      {
        "ULDNumber": "sample string 1"
      },
      {
        "ULDNumber": "sample string 1"
      }
    ]
  },
  "Voyages": {
    "Carrier": "sample string 1",
    "Vessel": "sample string 2",
    "VoyageNumber": "sample string 3"
  },
  "LocalTransport": {
    "Carrier": "sample string 1",
    "VehicleReferenceNumber": "sample string 2",
    "ContainerNumber": "sample string 3"
  },
  "Containers": [
    {
      "ContainerNumber": "sample string 1"
    },
    {
      "ContainerNumber": "sample string 1"
    },
    {
      "ContainerNumber": "sample string 1"
    }
  ],
  "GoodsDetails": [
    {
      "ContainerNumber": "sample string 1",
      "PackageType": "sample string 2",
      "NoofPieces": 3,
      "GrossWeight": {
        "Value": 1.0,
        "UOM": "sample string 1"
      },
      "Volume": {
        "Value": 1.0,
        "UOM": "sample string 1"
      }
    },
    {
      "ContainerNumber": "sample string 1",
      "PackageType": "sample string 2",
      "NoofPieces": 3,
      "GrossWeight": {
        "Value": 1.0,
        "UOM": "sample string 1"
      },
      "Volume": {
        "Value": 1.0,
        "UOM": "sample string 1"
      }
    },
    {
      "ContainerNumber": "sample string 1",
      "PackageType": "sample string 2",
      "NoofPieces": 3,
      "GrossWeight": {
        "Value": 1.0,
        "UOM": "sample string 1"
      },
      "Volume": {
        "Value": 1.0,
        "UOM": "sample string 1"
      }
    }
  ],
  "EventDateTime": "2025-04-24T13:13:42",
  "EDockettID": [
    {
      "EDockettID": 1,
      "Location": "sample string 2",
      "Description": "sample string 3",
      "Filename": "sample string 4",
      "DocumentType": "sample string 5",
      "DocReferenceID": 1
    },
    {
      "EDockettID": 1,
      "Location": "sample string 2",
      "Description": "sample string 3",
      "Filename": "sample string 4",
      "DocumentType": "sample string 5",
      "DocReferenceID": 1
    },
    {
      "EDockettID": 1,
      "Location": "sample string 2",
      "Description": "sample string 3",
      "Filename": "sample string 4",
      "DocumentType": "sample string 5",
      "DocReferenceID": 1
    }
  ],
  "JobHouseNo": "sample string 6",
  "Name": "sample string 7",
  "Comments": "sample string 8",
  "IsDeleted": true,
  "Created": null,
  "Updated": {
    "AgentID": 1,
    "AgentIDAsText": "1",
    "AgentName": null,
    "ContactID": 0,
    "ContactIDAsText": "0",
    "ContactName": null,
    "Datetime": null,
    "DatetimeAsText": null
  }
}

application/xml, text/xml

Sample:
<JobStatusUpdateDTO>
  <StatusID>1</StatusID>
  <StatusCode>sample string 2</StatusCode>
  <Description>sample string 3</Description>
  <Location>
    <Code>sample string 1</Code>
    <Name>sample string 2</Name>
    <Location>
      <lat>1.1</lat>
      <lng>2.1</lng>
    </Location>
  </Location>
  <Source>sample string 4</Source>
  <SourceName>sample string 5</SourceName>
  <Flights>
    <Carrier>sample string 1</Carrier>
    <FlightNumber>sample string 2</FlightNumber>
    <ULD>
      <JobStatusEventULDDTO>
        <ULDNumber>sample string 1</ULDNumber>
      </JobStatusEventULDDTO>
      <JobStatusEventULDDTO>
        <ULDNumber>sample string 1</ULDNumber>
      </JobStatusEventULDDTO>
      <JobStatusEventULDDTO>
        <ULDNumber>sample string 1</ULDNumber>
      </JobStatusEventULDDTO>
    </ULD>
  </Flights>
  <Voyages>
    <Carrier>sample string 1</Carrier>
    <Vessel>sample string 2</Vessel>
    <VoyageNumber>sample string 3</VoyageNumber>
  </Voyages>
  <LocalTransport>
    <Carrier>sample string 1</Carrier>
    <VehicleReferenceNumber>sample string 2</VehicleReferenceNumber>
    <ContainerNumber>sample string 3</ContainerNumber>
  </LocalTransport>
  <Containers>
    <JobStatusEventContainerDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
    </JobStatusEventContainerDTO>
    <JobStatusEventContainerDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
    </JobStatusEventContainerDTO>
    <JobStatusEventContainerDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
    </JobStatusEventContainerDTO>
  </Containers>
  <GoodsDetails>
    <JobStatusEventGoodsDetailDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
      <PackageType>sample string 2</PackageType>
      <NoofPieces>3</NoofPieces>
      <GrossWeight>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </GrossWeight>
      <Volume>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </Volume>
    </JobStatusEventGoodsDetailDTO>
    <JobStatusEventGoodsDetailDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
      <PackageType>sample string 2</PackageType>
      <NoofPieces>3</NoofPieces>
      <GrossWeight>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </GrossWeight>
      <Volume>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </Volume>
    </JobStatusEventGoodsDetailDTO>
    <JobStatusEventGoodsDetailDTO>
      <ContainerNumber>sample string 1</ContainerNumber>
      <PackageType>sample string 2</PackageType>
      <NoofPieces>3</NoofPieces>
      <GrossWeight>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </GrossWeight>
      <Volume>
        <Value>1</Value>
        <UOM>sample string 1</UOM>
      </Volume>
    </JobStatusEventGoodsDetailDTO>
  </GoodsDetails>
  <EventDateTime>2025-04-24T13:13:42.5644301+00:00</EventDateTime>
  <EDockettID>
    <JobStatusUpdateEDockettDTO>
      <EDockettID>1</EDockettID>
      <Location>sample string 2</Location>
      <Description>sample string 3</Description>
      <Filename>sample string 4</Filename>
      <DocumentType>sample string 5</DocumentType>
      <DocReferenceID>1</DocReferenceID>
    </JobStatusUpdateEDockettDTO>
    <JobStatusUpdateEDockettDTO>
      <EDockettID>1</EDockettID>
      <Location>sample string 2</Location>
      <Description>sample string 3</Description>
      <Filename>sample string 4</Filename>
      <DocumentType>sample string 5</DocumentType>
      <DocReferenceID>1</DocReferenceID>
    </JobStatusUpdateEDockettDTO>
    <JobStatusUpdateEDockettDTO>
      <EDockettID>1</EDockettID>
      <Location>sample string 2</Location>
      <Description>sample string 3</Description>
      <Filename>sample string 4</Filename>
      <DocumentType>sample string 5</DocumentType>
      <DocReferenceID>1</DocReferenceID>
    </JobStatusUpdateEDockettDTO>
  </EDockettID>
  <JobHouseNo>sample string 6</JobHouseNo>
  <Name>sample string 7</Name>
  <Comments>sample string 8</Comments>
  <IsDeleted>true</IsDeleted>
  <Updated>
    <AgentID>1</AgentID>
    <AgentName />
    <ContactID>0</ContactID>
    <ContactName />
  </Updated>
</JobStatusUpdateDTO>