ParcelLifeCycleService-Public_2_0 Web Service Reference Version 2.0.0

Transcription

1 Version

2 Table of contents History... 4 Methods... 5 getparcellabelnumberforwebnumber... 6 gettrackingdata... 9 Complex Types types ContentItem ContentLine DataFault Fault ShipmentInfo StatusInfo SystemFault TrackingProperty TrackingResult getparcellabelnumberforwebnumber getparcellabelnumberforwebnumberresponse gettrackingdata gettrackingdataresponse types_authentication DPD Deutschland GmbH (c) 2017 Page 2 / 30

3 anonymous authentication authenticationfault Elements types datafault getparcellabelnumberforwebnumber getparcellabelnumberforwebnumberresponse gettrackingdata gettrackingdataresponse systemfault types_authentication authentication authenticationfault DPD Deutschland GmbH (c) 2017 Page 3 / 30

4 History Version Changed parameter parcellabelnumber to parcellabelnumber for method gettrackingdata - New method getparcellabelnumberforwebnumber added DPD Deutschland GmbH (c) 2017 Page 4 / 30

5 Methods Following methods are available for the service Method name getparcellabelnumberforwebnumber gettrackingdata Provides the parcel label number for the given web number. Deliver parcel tracking data for a parcel label number. An exception is thrown, if an error has occured. DPD Deutschland GmbH (c) 2017 Page 5 / 30

6 Method: getparcellabelnumberforwebnumber Provides the parcel label number for the given web number. Sample request: SOAP: <soapenv:envelope xmlns:soapenv=" xmlns:ns=" <soapenv:header/> <soapenv:body> <ns:getparcellabelnumberforwebnumber> <delisid>delis123</delisid> <webnumber>io </webnumber> <messagelanguage>en_en</messagelanguage> </ns:getparcellabelnumberforwebnumber> </soapenv:body> </soapenv:envelope> REST: URL: <server:port><path>/parcellifecycleservice/v2_0/getparcellabelnumberforwebnumber JSON data for POST request (for GET request data has to be sent with parameter "request" and for JSONP with parameter "jsonpcallback" to obtain a padding function name): { "authentication" : { "delisid" : "<your delisid>", "authtoken" : "<your authtoken>", "messagelanguage" : "en_en" "getparcellabelnumberforwebnumber" : { "webnumber" : "IO " } } REST result without error: { "getparcellabelnumberforwebnumberresponse": {"parcellabelnumber": " " "status": { "type": "OK", "code": "200", DPD Deutschland GmbH (c) 2017 Page 6 / 30

7 } } "message": "valid" REST result if an error occurred: {"status": { "type": "SystemFault", "code": "<Error code, e.g. 100>", "message": "<Error message>" }} Additional REST state on system error: Error-Code: 100 Error-Type: SystemFault Error-Message: <Message describing the error> Action Input The input for method getparcellabelnumberforwebnumber is as follows: Name authentication * parameters Element types_authentication:authentication types:getparcellabelnumberforwebnumber * header parameter Output The output for method getparcellabelnumberforwebnumber is as follows: Name parameters Element types:getparcellabelnumberforwebnumberresponse DPD Deutschland GmbH (c) 2017 Page 7 / 30

8 Faults The defined faults for method getparcellabelnumberforwebnumber are as follows: Name authenticationfault systemfault datafault Element types_authentication:authenticationfault types:systemfault types:datafault DPD Deutschland GmbH (c) 2017 Page 8 / 30

9 Method: gettrackingdata Deliver parcel tracking data for a parcel label number. An exception is thrown, if an error has occured. Sample request: SOAP: <soapenv:envelope xmlns:soapenv=" xmlns:ns=" xmlns:ns1=" <soapenv:header> <ns:authentication> <delisid>your delisid</delisid> <authtoken>your authtoken</authtoken> <messagelanguage>en_en</messagelanguage> </ns:authentication> </soapenv:header> <soapenv:body> <ns1:gettrackingdata> <parcellabelnumber> </parcellabelnumber> </ns1:gettrackingdata> </soapenv:body> </soapenv:envelope> REST: URL: <server:port><path>/parcellifecycleservice/v2_0/gettrackingdata JSON data for POST request (for GET request data has to be sent with parameter "request" and for JSONP with parameter "jsonpcallback" to obtain a padding function name): { "authentication" : { "delisid" : "<your delisid>", "authtoken" : "<your authtoken>", "messagelanguage" : "en_en" "gettrackingdata" : { "parcellabelnumber" : " " } } DPD Deutschland GmbH (c) 2017 Page 9 / 30

10 REST result without error: { "gettrackingdataresponse": {"trackingresult": { "shipmentinfo": { "receiver": null, "predictinformation": null, "service": { "label": { "content": "Your DPD service: ", "bold": false, "content": [ { "content": "DPD CLASSIC", "bold": false, }], "linktarget": "" "additionalserviceelements": null, "status": "SHIPMENT", "label": { "content": "Shipment information", "bold": true, "description": { "label": null, "content": [ { "content": "Details of your shipment", "bold": false, }], "linktarget": "" "statushasbeenreached": false, "iscurrentstatus": false, "showcontactinfo": false, "location": null, "date": null, "normalitems": null, "importantitems": null, "erroritems": null "statusinfo": [ DPD Deutschland GmbH (c) 2017 Page 10 / 30

11 { "status": "ACCEPTED", "label": { "content": "Parcel handed to DPD", "bold": true, "description": { "label": null, "content": [ { "content": "DPD has received your parcel.", "bold": false, }], "linktarget": "" "statushasbeenreached": true, "iscurrentstatus": false, "showcontactinfo": false, "location": null, "date": null, "normalitems": null, "importantitems": null, "erroritems": null { "status": "AT_SENDING_DEPOT", "label": { "content": "At dispatch depot", "bold": true, "description": { "label": null, "content": [ { "content": "The parcel is at the dispatch depot.", "bold": false, }], "linktarget": "" "statushasbeenreached": true, "iscurrentstatus": false, "showcontactinfo": false, "location": { "content": "Duisburg (DE)", DPD Deutschland GmbH (c) 2017 Page 11 / 30

12 "bold": true, "date": { "content": "16/08/2012, 17:00 ", "bold": true, "normalitems": null, "importantitems": null, "erroritems": null { "status": "ON_THE_ROAD", "label": { "content": "In transit", "bold": true, "description": { "label": null, "content": [ { "content": "Your parcel is on its way to the recipient depot.", "bold": false, }], "linktarget": "" "statushasbeenreached": true, "iscurrentstatus": false, "showcontactinfo": false, "location": null, "date": null, "normalitems": null, "importantitems": null, "erroritems": null { "status": "AT_DELIVERY_DEPOT", "label": { "content": "At recipient depot", "bold": true, "description": { "label": null, DPD Deutschland GmbH (c) 2017 Page 12 / 30

13 "content": [ { "content": "The parcel is at the recipient depot.", "bold": false, }], "linktarget": "" "statushasbeenreached": true, "iscurrentstatus": true, "showcontactinfo": false, "location": { "content": "Gudensberg (DE)", "bold": true, "date": { "content": "17/08/2012, 07:08 ", "bold": true, "normalitems": null, "importantitems": null, "erroritems": null { "status": "DELIVERED", "label": { "content": "Parcel delivered", "bold": true, "description": { "label": null, "content": [ { "content": "Your parcel has been delivered successfully.", "bold": false, }], "linktarget": "" "statushasbeenreached": false, "iscurrentstatus": false, "showcontactinfo": false, "location": null, "date": null, "normalitems": null, DPD Deutschland GmbH (c) 2017 Page 13 / 30

14 } "importantitems": null, "erroritems": null } ], "contactinfo": null } "status": { "type": "OK", "code": "200", "message": "valid" } REST result if an error occurred: {"status": { "type": "SystemFault", "code": "<Error code, e.g. 100>", "message": "<Error message>" }} Additional REST state on system error: Error-Code: 100 Error-Type: SystemFault Error-Message: <Message describing the error> Action Input The input for method gettrackingdata is as follows: Name authentication * parameters Element types_authentication:authentication types:gettrackingdata * header parameter Output DPD Deutschland GmbH (c) 2017 Page 14 / 30

15 The output for method gettrackingdata is as follows: Name parameters Element types:gettrackingdataresponse Faults The defined faults for method gettrackingdata are as follows: Name authenticationfault systemfault datafault Element types_authentication:authenticationfault types:systemfault types:datafault DPD Deutschland GmbH (c) 2017 Page 15 / 30

16 Complex Types URL: Complex Type: ContentItem Contains multiple content lines. label types:contentline / / content types:contentline / 1.. * / linktarget xsd:string / / Identifier for content item. Content of content item. If this field is filled, a link will be created from the content item. DPD Deutschland GmbH (c) 2017 Page 16 / 30

17 Complex Type: ContentLine Contains one text line and information about how the text has to be displayed. content xsd:string / bold xsd:boolean / paragraph xsd:boolean / Text element Indicates if text has to be printed bold. Indicates if there has to be a line break after text element. Complex Type: DataFault Is thrown if a data fault occurs. errorcode xsd:string / minlength: 1 maxlength: 4 errormessage xsd:string / minlength: 1 Error code. Error message text. DPD Deutschland GmbH (c) 2017 Page 17 / 30

18 maxlength: 255 Complex Type: Fault The data structure for error data. errorcode xsd:string / minlength: 1 maxlength: 4 errormessage xsd:string / minlength: 1 maxlength: 255 Error code. Error message text. DPD Deutschland GmbH (c) 2017 Page 18 / 30

19 Complex Type: ShipmentInfo Contains general shipment information (e.g. service code). receiver types:contentitem / / predictinformation types:contentitem / / service types:contentitem / / Receiver of parcel. Information about estimated delivery time of parcel (DPD Predict). Name of DPD product of the parcel (e.g. DPD Classic). additionalservice Elements types:contentitem / / Additional services for DPD product. trackingproperty types:trackingproperty / 0.. * / status xsd:string / SHIPMENT ACCEPTED AT_SENDING_DEPOT ON_THE_ROAD AT_DELIVERY_DEPOT DELIVERED label types:contentline / description types:contentitem / statushasbeenreached xsd:boolean / Properties. Status Name of status. of status. Indicates if status has been reached. DPD Deutschland GmbH (c) 2017 Page 19 / 30

20 iscurrentstatus xsd:boolean / showcontactinfo xsd:boolean / location types:contentline / / date types:contentline / / normalitems types:contentitem / 0.. * / importantitems types:contentitem / 0.. * / erroritems types:contentitem / 0.. * / Indicates if status is current status. Defines if contact information shall be displayed on detail page of the status. Contains the location of the last scan. Contains date and time of the last scan. A list of content items which describe events classified as NORMAL. A list of content items which describe events classified as IMPORTANT. A list of content items which describe events classified as ERROR. Complex Type: StatusInfo Contains all information and scan data for a status. status xsd:string / SHIPMENT ACCEPTED AT_SENDING_DEPOT ON_THE_ROAD AT_DELIVERY_DEPOT DELIVERED Status DPD Deutschland GmbH (c) 2017 Page 20 / 30

21 label types:contentline / description types:contentitem / statushasbeenreached xsd:boolean / iscurrentstatus xsd:boolean / showcontactinfo xsd:boolean / location types:contentline / / date types:contentline / / normalitems types:contentitem / 0.. * / importantitems types:contentitem / 0.. * / erroritems types:contentitem / 0.. * / Name of status. of status. Indicates if status has been reached. Indicates if status is current status. Defines if contact information shall be displayed on detail page of the status. Contains the location of the last scan. Contains date and time of the last scan. A list of content items which describe events classified as NORMAL. A list of content items which describe events classified as IMPORTANT. A list of content items which describe events classified as ERROR. DPD Deutschland GmbH (c) 2017 Page 21 / 30

22 Complex Type: SystemFault Is thrown if an internal system fault occurs. errorcode xsd:string / minlength: 1 maxlength: 4 errormessage xsd:string / minlength: 1 maxlength: 255 Error code. Error message text. Complex Type: TrackingProperty key xsd:string / value xsd:string / Property key. Possible keys: - showfollowmyparcellink (value: true) Property value. DPD Deutschland GmbH (c) 2017 Page 22 / 30

23 Complex Type: TrackingResult Result type for tracking data. shipmentinfo types:shipmentinfo / / statusinfo types:statusinfo / 0.. * / contactinfo types:contentitem / / Information about the shipment. Status information. Contact information. Complex Type: getparcellabelnumberforwebnumber webnumber xsd:string / minlength: 1 maxlength: 9 The web information number. DPD Deutschland GmbH (c) 2017 Page 23 / 30

24 Complex Type: getparcellabelnumberforwebnumberresponse parcellabelnumber xsd:string / / The parcel label number. Complex Type: gettrackingdata parcellabelnumber xsd:string / length: 14 Parcel label number Complex Type: gettrackingdataresponse Response object of method gettrackingdata. trackingresult types:trackingresult / Result object with tracking data. DPD Deutschland GmbH (c) 2017 Page 24 / 30

25 _authentication URL: _authentication Anonymous Complex Type of Element: authentication The data structure for authentication data. delisid xsd:string / minlength: 8 maxlength: 10 authtoken xsd:string / minlength: 0 maxlength: 64 messagelanguage xsd:string / minlength: 5 maxlength: 5 The delis user id for authentication. The token for authentication. Field authtoken of Login, as a result of Method "getauth" of LoginService. The language (Java format) for messages. "de_de" for german messages. "en_us" for english messages. DPD Deutschland GmbH (c) 2017 Page 25 / 30

26 _authentication Anonymous Complex Type of Element: authenticationfault The data structure for authentication errors. errorcode xsd:string / errormessage xsd:string / minlength: 1 maxlength: 255 The error code. Valid codes: NoAccessAuthenticationFault=-1 NoRightsAuthenticationFault=-2 The error message text. DPD Deutschland GmbH (c) 2017 Page 26 / 30

27 Elements URL: Element: datafault datafault types:datafault / Thrown if a data fault occurs. Element: getparcellabelnumberforwebnumber getparcellabelnumber ForWebNumber types:getparcellabel NumberForWebNumber / Input parameter of getparcellabelnumberforwebnumber. DPD Deutschland GmbH (c) 2017 Page 27 / 30

28 Element: getparcellabelnumberforwebnumberresponse getparcellabelnumber ForWebNumber Response types:getparcellabel NumberForWebNumber Response / Output parameter of getparcellabelnumberforwebnumber. Element: gettrackingdata gettrackingdata types:gettrackingdata / Input parameter of gettrackingdata. Element: gettrackingdataresponse gettrackingdata Response types:gettrackingdata Response / Output parameter of gettrackingdata. DPD Deutschland GmbH (c) 2017 Page 28 / 30

29 Element: systemfault systemfault types:systemfault / Thrown if an internal system fault occurs. DPD Deutschland GmbH (c) 2017 Page 29 / 30

30 _authentication URL: _authentication Element: authentication Anonymous Complex Type types_authentication:authentication _authentication Element: authenticationfault Anonymous Complex Type types_authentication:authenticationfault DPD Deutschland GmbH (c) 2017 Page 30 / 30