Reference for https://api.silentpassenger.com/rest/v2/{APIKEY}/Stops
Send stop to a Garmin unit. StopItem object must be passed in the message body. If successfull, will return StopItem that can be used to monitor the stop status.
Url: https://api.silentpassenger.com/rest/v2/{APIKEY}/Stops
HTTP Method: PUT
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:
<StopItem xmlns="http://schemas.datacontract.org/2004/07/VTS.Business.Routing"> <IsAudited xmlns="http://schemas.datacontract.org/2004/07/VTS.Business">true</IsAudited> <Active>true</Active> <Address>String content</Address> <City>String content</City> <Completed>true</Completed> <CreatedBy>2147483647</CreatedBy> <DateCompleted>1999-05-31T11:20:00</DateCompleted> <DateCreated>1999-05-31T11:20:00</DateCreated> <DateDeleted>1999-05-31T11:20:00</DateDeleted> <DateSent>1999-05-31T11:20:00</DateSent> <Deleted>true</Deleted> <DriveAck>true</DriveAck> <Gallons>2147483647</Gallons> <IMEI>String content</IMEI> <LandmarkID>2147483647</LandmarkID> <Latitude>1.26743233E+15</Latitude> <Longitude>1.26743233E+15</Longitude> <MsgTxt>String content</MsgTxt> <Notes>String content</Notes> <PreviousStopID>2147483647</PreviousStopID> <RouteID>2147483647</RouteID> <State>String content</State> <StopID>2147483647</StopID> <StopName>String content</StopName> <StopPosition>2147483647</StopPosition> <StopSent>true</StopSent> <StopToBeSentOn>1999-05-31T11:20:00</StopToBeSentOn> <VehicleID>2147483647</VehicleID> <Zip>String content</Zip> <msg_StopID>2147483647</msg_StopID> </StopItem>
The following is an example request Json body:
{ "IsAudited":true, "Active":true, "Address":"String content", "City":"String content", "Completed":true, "CreatedBy":2147483647, "DateCompleted":"\/Date(928164000000-0400)\/", "DateCreated":"\/Date(928164000000-0400)\/", "DateDeleted":"\/Date(928164000000-0400)\/", "DateSent":"\/Date(928164000000-0400)\/", "Deleted":true, "DriveAck":true, "Gallons":2147483647, "IMEI":"String content", "LandmarkID":2147483647, "Latitude":1.26743233E+15, "Longitude":1.26743233E+15, "MsgTxt":"String content", "Notes":"String content", "PreviousStopID":2147483647, "RouteID":2147483647, "State":"String content", "StopID":2147483647, "StopName":"String content", "StopPosition":2147483647, "StopSent":true, "StopToBeSentOn":"\/Date(928164000000-0400)\/", "VehicleID":2147483647, "Zip":"String content", "msg_StopID":2147483647 }
The following is an example response Xml body:
<msg_Stop xmlns="http://schemas.datacontract.org/2004/07/VTS.Business.Routing"> <Active>true</Active> <Address>String content</Address> <City>String content</City> <Completed>true</Completed> <CreatedBy>2147483647</CreatedBy> <DateActivated>1999-05-31T11:20:00</DateActivated> <DateCompleted>1999-05-31T11:20:00</DateCompleted> <DateCreated>1999-05-31T11:20:00</DateCreated> <DateDeleted>1999-05-31T11:20:00</DateDeleted> <DateSent>1999-05-31T11:20:00</DateSent> <Deleted>true</Deleted> <DriveAck>true</DriveAck> <IMEI>String content</IMEI> <LandmarkID>2147483647</LandmarkID> <Latitude>1.26743233E+15</Latitude> <Longitude>1.26743233E+15</Longitude> <MsgTxt>String content</MsgTxt> <RouteID>2147483647</RouteID> <StopID>2147483647</StopID> <StopName>String content</StopName> <StopPosition>2147483647</StopPosition> <StopSent>true</StopSent> <StopToBeSentOn>1999-05-31T11:20:00</StopToBeSentOn> <Zip>String content</Zip> </msg_Stop>
The following is an example response Json body:
{ "Active":true, "Address":"String content", "City":"String content", "Completed":true, "CreatedBy":2147483647, "DateActivated":"\/Date(928164000000-0400)\/", "DateCompleted":"\/Date(928164000000-0400)\/", "DateCreated":"\/Date(928164000000-0400)\/", "DateDeleted":"\/Date(928164000000-0400)\/", "DateSent":"\/Date(928164000000-0400)\/", "Deleted":true, "DriveAck":true, "IMEI":"String content", "LandmarkID":2147483647, "Latitude":1.26743233E+15, "Longitude":1.26743233E+15, "MsgTxt":"String content", "RouteID":2147483647, "StopID":2147483647, "StopName":"String content", "StopPosition":2147483647, "StopSent":true, "StopToBeSentOn":"\/Date(928164000000-0400)\/", "Zip":"String content" }
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VTS.Business.Routing" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VTS.Business.Routing" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.datacontract.org/2004/07/VTS.Business" /> <xs:complexType name="StopItem"> <xs:complexContent mixed="false"> <xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/VTS.Business" base="q1:AuditableOfStopItemH_PdluRYZ"> <xs:sequence> <xs:element minOccurs="0" name="Active" type="xs:boolean" /> <xs:element minOccurs="0" name="Address" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="City" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Completed" type="xs:boolean" /> <xs:element minOccurs="0" name="CreatedBy" type="xs:int" /> <xs:element minOccurs="0" name="DateCompleted" type="xs:dateTime" /> <xs:element minOccurs="0" name="DateCreated" type="xs:dateTime" /> <xs:element minOccurs="0" name="DateDeleted" type="xs:dateTime" /> <xs:element minOccurs="0" name="DateSent" type="xs:dateTime" /> <xs:element minOccurs="0" name="Deleted" type="xs:boolean" /> <xs:element minOccurs="0" name="DriveAck" type="xs:boolean" /> <xs:element minOccurs="0" name="Gallons" type="xs:int" /> <xs:element minOccurs="0" name="IMEI" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="LandmarkID" type="xs:int" /> <xs:element minOccurs="0" name="Latitude" type="xs:double" /> <xs:element minOccurs="0" name="Longitude" type="xs:double" /> <xs:element minOccurs="0" name="MsgTxt" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Notes" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="PreviousStopID" type="xs:int" /> <xs:element minOccurs="0" name="RouteID" type="xs:int" /> <xs:element minOccurs="0" name="State" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StopID" type="xs:int" /> <xs:element minOccurs="0" name="StopName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StopPosition" type="xs:int" /> <xs:element minOccurs="0" name="StopSent" type="xs:boolean" /> <xs:element minOccurs="0" name="StopToBeSentOn" type="xs:dateTime" /> <xs:element minOccurs="0" name="VehicleID" type="xs:int" /> <xs:element minOccurs="0" name="Zip" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="msg_StopID" type="xs:int" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="StopItem" nillable="true" type="tns:StopItem" /> </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/VTS.Business" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="AuditableOfStopItemH_PdluRYZ"> <xs:annotation> <xs:appinfo> <GenericType Name="AuditableOf{0}{#}" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns="http://schemas.microsoft.com/2003/10/Serialization/"> <GenericParameter Name="StopItem" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business.Routing" /> </GenericType> </xs:appinfo> </xs:annotation> <xs:sequence> <xs:element minOccurs="0" name="IsAudited" type="xs:boolean" /> </xs:sequence> </xs:complexType> <xs:element name="AuditableOfStopItemH_PdluRYZ" nillable="true" type="tns:AuditableOfStopItemH_PdluRYZ" /> </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.Routing" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VTS.Business.Routing" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="msg_Stop"> <xs:sequence> <xs:element minOccurs="0" name="Active" type="xs:boolean" /> <xs:element minOccurs="0" name="Address" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="City" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Completed" type="xs:boolean" /> <xs:element minOccurs="0" name="CreatedBy" type="xs:int" /> <xs:element minOccurs="0" name="DateActivated" type="xs:dateTime" /> <xs:element minOccurs="0" name="DateCompleted" type="xs:dateTime" /> <xs:element minOccurs="0" name="DateCreated" type="xs:dateTime" /> <xs:element minOccurs="0" name="DateDeleted" type="xs:dateTime" /> <xs:element minOccurs="0" name="DateSent" type="xs:dateTime" /> <xs:element minOccurs="0" name="Deleted" type="xs:boolean" /> <xs:element minOccurs="0" name="DriveAck" type="xs:boolean" /> <xs:element minOccurs="0" name="IMEI" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="LandmarkID" type="xs:int" /> <xs:element minOccurs="0" name="Latitude" type="xs:double" /> <xs:element minOccurs="0" name="Longitude" type="xs:double" /> <xs:element minOccurs="0" name="MsgTxt" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="RouteID" type="xs:int" /> <xs:element minOccurs="0" name="StopID" type="xs:int" /> <xs:element minOccurs="0" name="StopName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StopPosition" type="xs:int" /> <xs:element minOccurs="0" name="StopSent" type="xs:boolean" /> <xs:element minOccurs="0" name="StopToBeSentOn" type="xs:dateTime" /> <xs:element minOccurs="0" name="Zip" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="msg_Stop" nillable="true" type="tns:msg_Stop" /> </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>