Reference for https://api.silentpassenger.com/rest/v2/{APIKEY}/send-snapshot
Generate and send SP QuickView for a vehicle.
Url: https://api.silentpassenger.com/rest/v2/{APIKEY}/send-snapshot
HTTP Method: POST
| Message direction | Format | Body |
|---|---|---|
| Request | Xml | Example,Schema |
| Request | Json | Example |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example request Xml body:
<DCSnapshot xmlns="http://schemas.datacontract.org/2004/07/VTS.API.DataContracts">
<Caption>String content</Caption>
<DateTimeCompleted>
<DateTime xmlns="http://schemas.datacontract.org/2004/07/System">1999-05-31T11:20:00</DateTime>
<OffsetMinutes xmlns="http://schemas.datacontract.org/2004/07/System">32767</OffsetMinutes>
</DateTimeCompleted>
<DestinationLandmarkId>2147483647</DestinationLandmarkId>
<EmailRecipients>String content</EmailRecipients>
<EndTime>
<DateTime xmlns="http://schemas.datacontract.org/2004/07/System">1999-05-31T11:20:00</DateTime>
<OffsetMinutes xmlns="http://schemas.datacontract.org/2004/07/System">32767</OffsetMinutes>
</EndTime>
<Metadata>
<DCSnapshotMetadata>
<IsVisible>true</IsVisible>
<Key>String content</Key>
<Value>String content</Value>
</DCSnapshotMetadata>
<DCSnapshotMetadata>
<IsVisible>true</IsVisible>
<Key>String content</Key>
<Value>String content</Value>
</DCSnapshotMetadata>
</Metadata>
<Notes>String content</Notes>
<ShowActualRoute>true</ShowActualRoute>
<ShowDriverPhoto>true</ShowDriverPhoto>
<ShowETA>true</ShowETA>
<ShowEstimatedRoute>true</ShowEstimatedRoute>
<ShowSpeed>true</ShowSpeed>
<StartTime>
<DateTime xmlns="http://schemas.datacontract.org/2004/07/System">1999-05-31T11:20:00</DateTime>
<OffsetMinutes xmlns="http://schemas.datacontract.org/2004/07/System">32767</OffsetMinutes>
</StartTime>
<VehicleId>2147483647</VehicleId>
</DCSnapshot>
The following is an example request Json body:
{
"Caption":"String content",
"DateTimeCompleted":{
"DateTime":"\/Date(928164000000-0400)\/",
"OffsetMinutes":32767
},
"DestinationLandmarkId":2147483647,
"EmailRecipients":"String content",
"EndTime":{
"DateTime":"\/Date(928164000000-0400)\/",
"OffsetMinutes":32767
},
"Metadata":[{
"IsVisible":true,
"Key":"String content",
"Value":"String content"
}],
"Notes":"String content",
"ShowActualRoute":true,
"ShowDriverPhoto":true,
"ShowETA":true,
"ShowEstimatedRoute":true,
"ShowSpeed":true,
"StartTime":{
"DateTime":"\/Date(928164000000-0400)\/",
"OffsetMinutes":32767
},
"VehicleId":2147483647
}
The following is an example response Xml body:
<TextValueOfstring xmlns="http://schemas.datacontract.org/2004/07/VTS.Business"> <Text>String content</Text> <Value>String content</Value> </TextValueOfstring>
The following is an example response Json body:
{
"Text":"String content",
"Value":"String content"
}
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VTS.API.DataContracts" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VTS.API.DataContracts" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.datacontract.org/2004/07/System" />
<xs:complexType name="DCSnapshot">
<xs:sequence>
<xs:element minOccurs="0" name="Caption" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="DateTimeCompleted" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/System" type="q1:DateTimeOffset" />
<xs:element minOccurs="0" name="DestinationLandmarkId" type="xs:int" />
<xs:element minOccurs="0" name="EmailRecipients" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="EndTime" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/System" type="q2:DateTimeOffset" />
<xs:element minOccurs="0" name="Metadata" nillable="true" type="tns:ArrayOfDCSnapshotMetadata" />
<xs:element minOccurs="0" name="Notes" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ShowActualRoute" type="xs:boolean" />
<xs:element minOccurs="0" name="ShowDriverPhoto" type="xs:boolean" />
<xs:element minOccurs="0" name="ShowETA" type="xs:boolean" />
<xs:element minOccurs="0" name="ShowEstimatedRoute" type="xs:boolean" />
<xs:element minOccurs="0" name="ShowSpeed" type="xs:boolean" />
<xs:element minOccurs="0" name="StartTime" xmlns:q3="http://schemas.datacontract.org/2004/07/System" type="q3:DateTimeOffset" />
<xs:element minOccurs="0" name="VehicleId" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="DCSnapshot" nillable="true" type="tns:DCSnapshot" />
<xs:complexType name="ArrayOfDCSnapshotMetadata">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="DCSnapshotMetadata" nillable="true" type="tns:DCSnapshotMetadata" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfDCSnapshotMetadata" nillable="true" type="tns:ArrayOfDCSnapshotMetadata" />
<xs:complexType name="DCSnapshotMetadata">
<xs:sequence>
<xs:element minOccurs="0" name="IsVisible" type="xs:boolean" />
<xs:element minOccurs="0" name="Key" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="DCSnapshotMetadata" nillable="true" type="tns:DCSnapshotMetadata" />
</xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/System" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/System" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:complexType name="DateTimeOffset">
<xs:annotation>
<xs:appinfo>
<IsValueType xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</IsValueType>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element name="DateTime" type="xs:dateTime" />
<xs:element name="OffsetMinutes" type="xs:short" />
</xs:sequence>
</xs:complexType>
<xs:element name="DateTimeOffset" nillable="true" type="tns:DateTimeOffset" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VTS.Business" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="TextValueOfstring">
<xs:annotation>
<xs:appinfo>
<GenericType Name="TextValueOf{0}{#}" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="string" Namespace="http://www.w3.org/2001/XMLSchema" />
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:complexContent mixed="false">
<xs:extension base="tns:BaseMappableItemOfTextValueOfstringGzr685TD">
<xs:sequence>
<xs:element minOccurs="0" name="Text" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="TextValueOfstring" nillable="true" type="tns:TextValueOfstring" />
<xs:complexType name="BaseMappableItemOfTextValueOfstringGzr685TD">
<xs:annotation>
<xs:appinfo>
<GenericType Name="BaseMappableItemOf{0}{#}" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="TextValueOf{0}{#}" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business">
<GenericParameter Name="string" Namespace="http://www.w3.org/2001/XMLSchema" />
</GenericParameter>
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:sequence />
</xs:complexType>
<xs:element name="BaseMappableItemOfTextValueOfstringGzr685TD" nillable="true" type="tns:BaseMappableItemOfTextValueOfstringGzr685TD" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>