Send realisation data

Endpoint

Production URL : https://sct-tracking-data-api.services.simacan.com/api/v1/realisation
Staging URL : https://sct-tracking-data-api-stg.services.simacan.com/api/v1/realisation

This is the primary endpoint for the SCT Tracking Data API. The realised part of the trip will be sent to this endpoint. The format should be strict to the XML Schema Definition

Field definition

Key	Description
heading	The heading is the direction where the nose of the vehicle is pointing to. The heading is indicated in degrees from 0-360; where 0 is the absolute north
speed	The speed of the vehicle indicated in kilometres per hour
x	X-coordinate or longitude of the vehicle
y	Y-coordinate or latitude of the vehicle

Responses

Key	Description
200	Ok
204	No Content Indicates that your request was successful. However we will not be sending you any data
400	Bad Request You will receive this status, when the data you’ve delivered is not in the correct XML format. You will see an entity describing what went wrong
401	Unauthorized Whenever you will get a 401 status, you have either provided the wrong credentials or none at all. Check if you bearer token has not expired
403	Forbidden You will receive this status, when you successfully supplied credentials, but your username does not have the necessary permissions for the resource
404	Not Found Whenever you will get a 404, you are probably using a malformed or incorrect URL

XML Schema Definition

Copy

Copied

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0.1"
           targetNamespace="http://api.transportcloud.io/schemas/carrier/v1/realisation"
           xmlns:tc="http://api.transportcloud.io/schemas/carrier/v1/realisation"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">

    <xs:element name="realisation" type="tc:realisation"/>

    <xs:complexType name="realisation">
        <xs:sequence>
            <xs:element name="tripRealisation" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>

    <xs:complexType name="tripRealisation">
        <xs:sequence>
            <xs:element name="externalDeviceId">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="100"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="timestamp" type="xs:dateTime"/>
            <xs:element name="heading" minOccurs="0">
                <xs:simpleType>
                    <xs:restriction base="xs:double">
                        <xs:minInclusive value="0.0"/>
                        <xs:maxInclusive value="360.0"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="speed" type="xs:double"/>
            <xs:element name="x" type="xs:double"/>
            <xs:element name="y" type="xs:double"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>