Trendsic Platform Service

<back to all web services

CourierPhotoRemoveRequest

Requires Authentication
The following routes are available for this service:
DELETE,OPTIONS/v1/worker/dispatch/od/{Code}/photo/{PhotoId}
CourierPhotoRemoveRequest Parameters:
NameParameterData TypeRequiredDescription
CodepathstringNo
PhotoIdpathintNo
CourierDriverResponse Parameters:
NameParameterData TypeRequiredDescription
CourierformCourierDriverViewNo
ServerUtcformDateTimeNo
ResultformstringNo
DetailformstringNo
MessageformstringNo
PhotoIdformint?No
ResponseStatusformResponseStatusNo
CourierDriverView Parameters:
NameParameterData TypeRequiredDescription
DriverCodeformstringNo
NameformstringNo
OnlineformboolNo
OnRosterformboolNo
VanformCourierVanViewNo
CurrentformCourierDriverOrderNo
QueueformList<CourierDriverOrder>No
AboardformList<CourierDriverOrder>No
RunsformList<CourierRunView>No
UpNextformCourierDriverOrderNo
RadiusMiformdecimal?No
PingRadiusMiformdecimal?No
PingRadiusUntilUtcformDateTime?No
HideAddressesInHistoryformboolNo
CourierVanView Parameters:
NameParameterData TypeRequiredDescription
StateformstringNo
LeaveByUtcformDateTime?No
LeaveByTextformstringNo
SlackMinformint?No
InVanformintNo
CommittedformintNo
DeliveryformdecimalNo
Capformdecimal?No
CapUnitformstringNo
VehicleUnitformstringNo
CriticalCodeformstringNo
DriveMinformintNo
FacilityNameformstringNo
SendNoteformstringNo
GoMinformintNo
LastMinformintNo
NearFullformintNo
MarginMinformintNo
IntakeMinformintNo
FacilityAddressformstringNo
FacilityLatformdecimal?No
FacilityLngformdecimal?No
CourierDriverOrder Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
CourierStepformstringNo
RouteShapeformstringNo
ProfileNameformstringNo
UnitOneformstringNo
UnitManyformstringNo
FacilityNounformstringNo
FacilityNameformstringNo
LevelNameformstringNo
DueUtcformDateTime?No
DueTextformstringNo
UnitsformintNo
UnitsFoundformint?No
AreaformstringNo
Minutesformint?No
AddressformstringNo
UnitformstringNo
CityformstringNo
ZipformstringNo
CourierFacilityIdformint?No
Latformdecimal?No
Lngformdecimal?No
CustomerNameformstringNo
CustomerPhoneformstringNo
HandoffformstringNo
GateCodeformstringNo
InstructionsformstringNo
DropoffAddressformstringNo
DropoffContactNameformstringNo
DropLatformdecimal?No
DropLngformdecimal?No
ArrivedUtcformDateTime?No
TagsformList<CourierItemView>No
ProofformDictionary<string, string>No
PhotosformDictionary<string, int>No
NeedsformList<string>No
MissedWaitMinformintNo
MissedRequireContactformboolNo
MissedRequirePhotoformboolNo
MissedFeeformdecimalNo
DispatchOdRequestIDformintNo
UnitOneEsformstringNo
UnitManyEsformstringNo
FacilityNounEsformstringNo
PerPickupformdecimal?No
WaitAfterMinformint?No
WaitPerMinformdecimal?No
DropoffZipformstringNo
DamageNoteformstringNo
PickedUpUtcformDateTime?No
PhotoListformList<CourierPhotoView>No
CourierItemView Parameters:
NameParameterData TypeRequiredDescription
CourierItemIDformintNo
DispatchOdRequestIDformintNo
SeqformintNo
TagCodeformstringNo
CustodyformstringNo
IsOpenformboolNo
IsMissingformboolNo
MissingReasonformstringNo
IsManualformboolNo
ReTagFlagformboolNo
ScannedformboolNo
CourierPhotoView Parameters:
NameParameterData TypeRequiredDescription
PhotoIdformintNo
KindformstringNo
FileNameformstringNo
UrlformstringNo
TakenUtcformDateTime?No
CourierRunView Parameters:
NameParameterData TypeRequiredDescription
CourierRunIDformintNo
CodeformstringNo
StatusformstringNo
CourierProfileIdformintNo
ProfileNameformstringNo
CourierFacilityIdformintNo
FacilityNameformstringNo
FacilityAddressformstringNo
DriverContactIdformint?No
DriverNameformstringNo
EquipmentIDformint?No
VehicleUnitformstringNo
UnitOneformstringNo
UnitManyformstringNo
UnitOneEsformstringNo
UnitManyEsformstringNo
FacilityNounformstringNo
FacilityNounEsformstringNo
FacilityLatformdecimal?No
FacilityLngformdecimal?No
UnitsformintNo
StopCountformintNo
StopsDoneformintNo
Payformdecimal?No
BuiltUtcformDateTime?No
StartedUtcformDateTime?No
CompletedUtcformDateTime?No
ToLoadformintNo
ToReturnformintNo
ShelfformstringNo
StopsformList<CourierStopView>No
CourierStopView Parameters:
NameParameterData TypeRequiredDescription
SequenceformintNo
StatusformstringNo
DispatchOdRequestIDformintNo
CodeformstringNo
CourierStepformstringNo
AddressformstringNo
UnitformstringNo
CityformstringNo
ZipformstringNo
Latformdecimal?No
Lngformdecimal?No
CustomerNameformstringNo
CustomerPhoneformstringNo
HandoffformstringNo
GateCodeformstringNo
InstructionsformstringNo
UnitsformintNo
DueTextformstringNo
NoteformstringNo
NeedsformList<string>No
ProofformDictionary<string, string>No
PhotosformintNo
ItemsformList<CourierItemView>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /v1/worker/dispatch/od/{Code}/photo/{PhotoId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Courier":{"DriverCode":"String","Name":"String","Online":false,"OnRoster":false,"Van":{"State":"String","LeaveByUtc":"0001-01-01T00:00:00.0000000","LeaveByText":"String","SlackMin":0,"InVan":0,"Committed":0,"Delivery":0,"Cap":0,"CapUnit":"String","VehicleUnit":"String","CriticalCode":"String","DriveMin":0,"FacilityName":"String","SendNote":"String","GoMin":0,"LastMin":0,"NearFull":0,"MarginMin":0,"IntakeMin":0,"FacilityAddress":"String","FacilityLat":0,"FacilityLng":0},"Current":{"Code":"String","CourierStep":"String","RouteShape":"String","ProfileName":"String","UnitOne":"String","UnitMany":"String","FacilityNoun":"String","FacilityName":"String","LevelName":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Units":0,"UnitsFound":0,"Area":"String","Minutes":0,"Address":"String","Unit":"String","City":"String","Zip":"String","CourierFacilityId":0,"Lat":0,"Lng":0,"CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","DropoffAddress":"String","DropoffContactName":"String","DropLat":0,"DropLng":0,"ArrivedUtc":"0001-01-01T00:00:00.0000000","Tags":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}],"Proof":{"String":"String"},"Photos":{"String":0},"Needs":["String"],"MissedWaitMin":0,"MissedRequireContact":false,"MissedRequirePhoto":false,"MissedFee":0,"DispatchOdRequestID":0,"UnitOneEs":"String","UnitManyEs":"String","FacilityNounEs":"String","PerPickup":0,"WaitAfterMin":0,"WaitPerMin":0,"DropoffZip":"String","DamageNote":"String","PickedUpUtc":"0001-01-01T00:00:00.0000000","PhotoList":[{"PhotoId":0,"Kind":"String","FileName":"String","Url":"String","TakenUtc":"0001-01-01T00:00:00.0000000"}]},"Queue":[{"Code":"String","CourierStep":"String","RouteShape":"String","ProfileName":"String","UnitOne":"String","UnitMany":"String","FacilityNoun":"String","FacilityName":"String","LevelName":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Units":0,"UnitsFound":0,"Area":"String","Minutes":0,"Address":"String","Unit":"String","City":"String","Zip":"String","CourierFacilityId":0,"Lat":0,"Lng":0,"CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","DropoffAddress":"String","DropoffContactName":"String","DropLat":0,"DropLng":0,"ArrivedUtc":"0001-01-01T00:00:00.0000000","Tags":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}],"Proof":{"String":"String"},"Photos":{"String":0},"Needs":["String"],"MissedWaitMin":0,"MissedRequireContact":false,"MissedRequirePhoto":false,"MissedFee":0,"DispatchOdRequestID":0,"UnitOneEs":"String","UnitManyEs":"String","FacilityNounEs":"String","PerPickup":0,"WaitAfterMin":0,"WaitPerMin":0,"DropoffZip":"String","DamageNote":"String","PickedUpUtc":"0001-01-01T00:00:00.0000000","PhotoList":[{"PhotoId":0,"Kind":"String","FileName":"String","Url":"String","TakenUtc":"0001-01-01T00:00:00.0000000"}]}],"Aboard":[{"Code":"String","CourierStep":"String","RouteShape":"String","ProfileName":"String","UnitOne":"String","UnitMany":"String","FacilityNoun":"String","FacilityName":"String","LevelName":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Units":0,"UnitsFound":0,"Area":"String","Minutes":0,"Address":"String","Unit":"String","City":"String","Zip":"String","CourierFacilityId":0,"Lat":0,"Lng":0,"CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","DropoffAddress":"String","DropoffContactName":"String","DropLat":0,"DropLng":0,"ArrivedUtc":"0001-01-01T00:00:00.0000000","Tags":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}],"Proof":{"String":"String"},"Photos":{"String":0},"Needs":["String"],"MissedWaitMin":0,"MissedRequireContact":false,"MissedRequirePhoto":false,"MissedFee":0,"DispatchOdRequestID":0,"UnitOneEs":"String","UnitManyEs":"String","FacilityNounEs":"String","PerPickup":0,"WaitAfterMin":0,"WaitPerMin":0,"DropoffZip":"String","DamageNote":"String","PickedUpUtc":"0001-01-01T00:00:00.0000000","PhotoList":[{"PhotoId":0,"Kind":"String","FileName":"String","Url":"String","TakenUtc":"0001-01-01T00:00:00.0000000"}]}],"Runs":[{"CourierRunID":0,"Code":"String","Status":"String","CourierProfileId":0,"ProfileName":"String","CourierFacilityId":0,"FacilityName":"String","FacilityAddress":"String","DriverContactId":0,"DriverName":"String","EquipmentID":0,"VehicleUnit":"String","UnitOne":"String","UnitMany":"String","UnitOneEs":"String","UnitManyEs":"String","FacilityNoun":"String","FacilityNounEs":"String","FacilityLat":0,"FacilityLng":0,"Units":0,"StopCount":0,"StopsDone":0,"Pay":0,"BuiltUtc":"0001-01-01T00:00:00.0000000","StartedUtc":"0001-01-01T00:00:00.0000000","CompletedUtc":"0001-01-01T00:00:00.0000000","ToLoad":0,"ToReturn":0,"Shelf":"String","Stops":[{"Sequence":0,"Status":"String","DispatchOdRequestID":0,"Code":"String","CourierStep":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","Units":0,"DueText":"String","Note":"String","Needs":["String"],"Proof":{"String":"String"},"Photos":0,"Items":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}]}]}],"UpNext":{"Code":"String","CourierStep":"String","RouteShape":"String","ProfileName":"String","UnitOne":"String","UnitMany":"String","FacilityNoun":"String","FacilityName":"String","LevelName":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Units":0,"UnitsFound":0,"Area":"String","Minutes":0,"Address":"String","Unit":"String","City":"String","Zip":"String","CourierFacilityId":0,"Lat":0,"Lng":0,"CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","DropoffAddress":"String","DropoffContactName":"String","DropLat":0,"DropLng":0,"ArrivedUtc":"0001-01-01T00:00:00.0000000","Tags":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}],"Proof":{"String":"String"},"Photos":{"String":0},"Needs":["String"],"MissedWaitMin":0,"MissedRequireContact":false,"MissedRequirePhoto":false,"MissedFee":0,"DispatchOdRequestID":0,"UnitOneEs":"String","UnitManyEs":"String","FacilityNounEs":"String","PerPickup":0,"WaitAfterMin":0,"WaitPerMin":0,"DropoffZip":"String","DamageNote":"String","PickedUpUtc":"0001-01-01T00:00:00.0000000","PhotoList":[{"PhotoId":0,"Kind":"String","FileName":"String","Url":"String","TakenUtc":"0001-01-01T00:00:00.0000000"}]},"RadiusMi":0,"PingRadiusMi":0,"PingRadiusUntilUtc":"0001-01-01T00:00:00.0000000","HideAddressesInHistory":false},"ServerUtc":"0001-01-01T00:00:00.0000000","Result":"String","Detail":"String","Message":"String","PhotoId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}