POST api/TransportRequest/AddTransportRequest

Add Transport Request

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ClientReferenceNumber	UNITI reference number	string	Required
TransportRequestDateUTC	Transport request date UTC - [e.g. 2020-05-08T07:00:00.001Z]	date	Required
FromLocationDescription	Start location description, [e.g. Saldanha Bay], (Max 100 characters)	string	Required
ToLocationDescription	Destination location description - [e.g. Engcobo] (Max 100 characters)	string	Required
FromLocation	From Location	AddressDTO	Required
ToLocation	To Location	AddressDTO	Required
PassengerType	Type of passengers for the transport request [e.g. FrontLine, Quarantine etc]	PassengerTypeDTO	Required
PassengerCount	Number of passengers (a family will be transported as one transport request)	integer	Required
Passengers	Collection of passengers to transport	Collection of PassengerDTO	Required

Request Formats

application/json, text/json

Sample:

{
  "ClientReferenceNumber": "sample string 1",
  "TransportRequestDateUTC": "2025-12-11T05:25:10.0389028+02:00",
  "FromLocationDescription": "sample string 3",
  "ToLocationDescription": "sample string 4",
  "FromLocation": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "AddressLine3": "sample string 3",
    "PostCode": "sample string 4",
    "Latitude": 1.1,
    "Longitude": 1.1
  },
  "ToLocation": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "AddressLine3": "sample string 3",
    "PostCode": "sample string 4",
    "Latitude": 1.1,
    "Longitude": 1.1
  },
  "PassengerType": {
    "PassengerType": "sample string 1",
    "IsAllowedPatientStatus": true
  },
  "PassengerCount": 5,
  "Passengers": [
    {
      "PassengerName": "sample string 1",
      "ContactNumber": "sample string 2",
      "PassengerRef": "sample string 3"
    },
    {
      "PassengerName": "sample string 1",
      "ContactNumber": "sample string 2",
      "PassengerRef": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<TransportRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMS.Models">
  <ClientReferenceNumber>sample string 1</ClientReferenceNumber>
  <FromLocation>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <AddressLine3>sample string 3</AddressLine3>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <PostCode>sample string 4</PostCode>
  </FromLocation>
  <FromLocationDescription>sample string 3</FromLocationDescription>
  <PassengerCount>5</PassengerCount>
  <PassengerType>
    <IsAllowedPatientStatus>true</IsAllowedPatientStatus>
    <PassengerType>sample string 1</PassengerType>
  </PassengerType>
  <Passengers>
    <PassengerDTO>
      <ContactNumber>sample string 2</ContactNumber>
      <PassengerName>sample string 1</PassengerName>
      <PassengerRef>sample string 3</PassengerRef>
    </PassengerDTO>
    <PassengerDTO>
      <ContactNumber>sample string 2</ContactNumber>
      <PassengerName>sample string 1</PassengerName>
      <PassengerRef>sample string 3</PassengerRef>
    </PassengerDTO>
  </Passengers>
  <ToLocation>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <AddressLine3>sample string 3</AddressLine3>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <PostCode>sample string 4</PostCode>
  </ToLocation>
  <ToLocationDescription>sample string 4</ToLocationDescription>
  <TransportRequestDateUTC>2025-12-11T05:25:10.0389028+02:00</TransportRequestDateUTC>
</TransportRequestDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TransportRequestDTO'.

Response Information

Resource Description

Id of inserted record

TransportRequestInserted

Name	Description	Type	Additional information
TransportRequestId	Unique Transport Request id of inserted record. A valid inserted request must return a value larger than 0	integer	Required

Response Formats

application/json, text/json

Sample:

{
  "TransportRequestId": 1
}

application/xml, text/xml

Sample:

<TransportRequestInserted xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMS.Models">
  <TransportRequestId>1</TransportRequestId>
</TransportRequestInserted>