POST api/flock/journey

Create a journey

Request Information

URI Parameters

None.

Body Parameters

A FlockJourneyRequest

CreateFlockJourneyRequest
NameDescriptionTypeAdditional information
JourneyStartTelemetry

The telemetry for the journey start

TelemetryRecord

None.

JourneyEndTelemetry

The telemetry for the journey end

TelemetryRecord

None.

Imei

The unit imei

string

None.

TelemetryRecords

The telemetry for the journey

Collection of TelemetryRecord

None.

Request Formats

application/json, text/json

Sample:
{
  "JourneyStartTelemetry": {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "Timestamp": "2025-04-27T15:45:42.1362244+00:00",
    "Speed": 4.1,
    "GpsFix": 5,
    "Heading": 6.1,
    "MessageType": 0,
    "Odometer": 7
  },
  "JourneyEndTelemetry": {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "Timestamp": "2025-04-27T15:45:42.1362244+00:00",
    "Speed": 4.1,
    "GpsFix": 5,
    "Heading": 6.1,
    "MessageType": 0,
    "Odometer": 7
  },
  "Imei": "sample string 1",
  "TelemetryRecords": [
    {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "Timestamp": "2025-04-27T15:45:42.1362244+00:00",
      "Speed": 4.1,
      "GpsFix": 5,
      "Heading": 6.1,
      "MessageType": 0,
      "Odometer": 7
    },
    {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "Timestamp": "2025-04-27T15:45:42.1362244+00:00",
      "Speed": 4.1,
      "GpsFix": 5,
      "Heading": 6.1,
      "MessageType": 0,
      "Odometer": 7
    }
  ]
}

application/xml, text/xml

Sample:
<CreateFlockJourneyRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <JourneyStartTelemetry>
    <Latitude>1.1</Latitude>
    <Longitude>2.1</Longitude>
    <Timestamp>2025-04-27T15:45:42.1362244+00:00</Timestamp>
    <Speed>4.1</Speed>
    <GpsFix>5</GpsFix>
    <Heading>6.1</Heading>
    <MessageType>NO_EVENT</MessageType>
    <Odometer>7</Odometer>
  </JourneyStartTelemetry>
  <JourneyEndTelemetry>
    <Latitude>1.1</Latitude>
    <Longitude>2.1</Longitude>
    <Timestamp>2025-04-27T15:45:42.1362244+00:00</Timestamp>
    <Speed>4.1</Speed>
    <GpsFix>5</GpsFix>
    <Heading>6.1</Heading>
    <MessageType>NO_EVENT</MessageType>
    <Odometer>7</Odometer>
  </JourneyEndTelemetry>
  <Imei>sample string 1</Imei>
  <TelemetryRecords>
    <TelemetryRecord>
      <Latitude>1.1</Latitude>
      <Longitude>2.1</Longitude>
      <Timestamp>2025-04-27T15:45:42.1362244+00:00</Timestamp>
      <Speed>4.1</Speed>
      <GpsFix>5</GpsFix>
      <Heading>6.1</Heading>
      <MessageType>NO_EVENT</MessageType>
      <Odometer>7</Odometer>
    </TelemetryRecord>
    <TelemetryRecord>
      <Latitude>1.1</Latitude>
      <Longitude>2.1</Longitude>
      <Timestamp>2025-04-27T15:45:42.1362244+00:00</Timestamp>
      <Speed>4.1</Speed>
      <GpsFix>5</GpsFix>
      <Heading>6.1</Heading>
      <MessageType>NO_EVENT</MessageType>
      <Odometer>7</Odometer>
    </TelemetryRecord>
  </TelemetryRecords>
</CreateFlockJourneyRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Created on a success

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.