Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Purpose

This Web Service Call allows a third party application to retrieve the labels associated to a consignment. The response is a Base64 encoded PDF file in a 4 in. x 6 in. label format.


Info

In this instance I am making a call to GetChargeQuote in my uat environment through postman, Things  

Things I need to perform this call:

  1. My Session Credentials form my previous Login Call
    1. Note Session Credentials will expire If
      1. You Have generated a new "Key"
      2. You Have Passed the Expiry Date of the Session
      3. The User has been Deleted/made inactive

  2. Consignment ID

*Learn how to chain this call in 5) Creating Chained Requests

Endpoint: https://bau-uat-wsthirdpartywcf.flipgroup.azurewebsitescom.netau/Data/ChainIT/DataService.svc

Headers: 

Body:

Code Block
languagexml
themeRDark
firstline1
titleWeb Service Call
linenumberstrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:GenerateLabels>

  <!-- Session Credentials Available By following the "Login Web Service Call"
                            https://flipgroup.atlassian.net/wiki/spaces/FLIP/pages/703102977/2a+Example+Web+Service+Call+Login-->     
         <cha:session>
            <cha:AccountID>115860</cha:AccountID>
            <!--Mandatory:-->
            <cha:DistributorID>101605</cha:DistributorID>
            <!--Mandatory:-->
            <cha:Expires>2018-08-16T15:15:55.89</cha:Expires>
            <!--Mandatory:-->
            <cha:Key>E36D344D-DCA9-45B8-8FCD-2F049B1E73B3</cha:Key>
            <!--Mandatory:-->
            <cha:UserID>64796</cha:UserID>
            <!--Mandatory:-->
         </cha:session>

         <cha:consignmentID>?<consignmentID>99999999987</cha:consignmentID>
      </cha:GenerateLabels>
   </soapenv:Body>
</soapenv:Envelope>

...

Code Block
languagexml
themeEclipseRDark
titleSuccessful Web Service Call Response
linenumberstrue
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <GenerateLabelsResponse xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
            <GenerateLabelsResult>JVBERi0xLjQNCjEgMCBvYmoNCjw8IA0KL0xlbmd0aCAxMDQwDQovRmlsdGVyIC9GbGF0ZURlY29kZQ0KPj4NCnN0cmVhbQ0KWIWlWE1vGzcQvetX8Jb2YJYcfuemRoogFJFSaYui59ZuUSA14vj/o2/IXWmldbRaLgwENqXhm68385ivCyWUoBiFNSReHhe/L/5baME/L39ff/a0+HXxdaFJSx+FVhL/OC1JBHky/bnJRqqzVuKwWfz0UQsnRPOEI22kSVo0f+EeIzXhG/j9h9V+fRS7fSM+7HfNcrsTq+Vusz7sfzuKzX6/Ov4omn8XD63Jg5PeJbZbN8WlJK1tPVIkyVa6RLghth59WB4O2/Xh3VE068Ono1juVuzcatts9zv8+bm4VEwGHnGOcHGQkQSRRP7gnYqjPnkZTm5Z3BFC9stIZbtMPX77832LnY8fgvS2D13gbJCpGhplDa6DDr6FPjw+nZFxOkDmoA0FqVEH4xl0MrQxWioziHo8YOMRcHWyTUDEYRDxx5fnL3eEjDqTrw8ZhdZ6Ushtw0dBznO8qdfvJzzn8peSdOyTM0YkJ0OPyPdcgryQSeUWhyh9zSUxoKaxdQXmKdXcopmoPs2NSBsrrZmdGM3pTfO94QSnOPsanHozN8Oko/TJzaw2UZJEoTKk7zAGXzozBkNXqzxuecz5C8KUkweNtGJVXDNVOelcj6njRI0dS1WUCR7cYmmSyrlrTEqWPa/BRGNIXYUZjUyVmCCrqcLkjcONjOJCPwTpxmqKfqUO1TEpb89A0N/FQUmJLLqtgy1TehT2FCy2jYn+JiyazQQzgA04RoIdRtL0kU/BSu0G4S5fX98L8fmfm/tdcypwgxOWzJB8KnHiWaShGIohje8x77axRauGWuMW2YHMhu2y/UTjgjwwJsw0YlGR+ONSZJ2F3lipo6SzoLLS69LZaM+QTuJz8+5bm/H2HB1usLD6NS8OQNwEO8mB3tjSRsmUqHNAn9TvH+vjGZ+PeXwpM6CYxuAEtSLHIseg9UXs5GRMY6y+irlIKQ9i8TDn1SAshmCaAkw8fFwHHPw1MGuqAbB1pRkISwM5I1shYclj0heGWS/TFXA5Gqi5FhgKIdlqZBPRQ0PkBq+bT+YufHxqfTW+w2TSlZG7OCPlnt5MOQf+y+YmPDPTdu8l7S2/qeY8mGzee/24y8lglqJWHGp+LLESq4E9P5Z4PvlL3PboOwFnXCxcX7FDerj3hls0EEBZ/ta+VgCr07QHWobFXrBUD+tRneFreOaypFwcHYn5lldOCK2AuGtr4dtgWr19wSeXR6zNvThpa174/5Y9mfwIJEsskky7xMb31uUMRzedZrg//xfJ9vXxi9g9d/nPnwyHeeuB8nM86G+RngfN86tgL+5zoShFDHfnWQLeL06hEjEZM7rDTqLLni9Hb8jTAqtjrIPVeDTVwGa2sZAQhRPTuQbJm4bqtHm+QbX/AbHsF3ANCmVuZHN0cmVhbQ0KZW5kb2JqDQoyIDAgb2JqDQo8PCANCi9UeXBlIC9DYXRhbG9nDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCjMgMCBvYmoNCjw8IA0KL1R5cGUgL1BhZ2VzDQovS2lkcyBbNCAwIFJdDQovQ291bnQgMQ0KL01lZGlhQm94IFswIDAgNTk2IDg0Ml0NCj4+DQplbmRvYmoNCjQgMCBvYmoNCjw8IA0KL1R5cGUgL1BhZ2UNCi9SZXNvdXJjZXMgPDwgDQovRm9udCA8PCANCi9GMSA1IDAgUg0KL0YyIDggMCBSDQovRjMgMTEgMCBSDQo+Pg0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQ10NCj4+DQovQ29udGVudHMgMSAwIFINCi9NZWRpYUJveCBbMCAwIDI4OCA0MzJdDQovUGFyZW50IDMgMCBSDQo+Pg0KZW5kb2JqDQo1IDAgb2JqDQo8PCANCi9UeXBlIC9Gb250DQovU3VidHlwZSAvVHJ1ZVR5cGUNCi9OYW1lIC9GMQ0KL0Jhc2VGb250IC9NaWNyb3NvZnRTYW5zU2VyaWYNCi9GaXJzdENoYXIgMzINCi9MYXN0Q2hhciAyNTUNCi9XaWR0aHMgNiAwIFINCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nDQovRm9udERlc2NyaXB0b3IgNyAwIFINCj4+DQplbmRvYmoNCjYgMCBvYmoNClsyNjUgMjc3IDM1NCA1NTYgNTU2IDg4OSA2NjYgMTkwDQogMzMzIDMzMyAzODkgNTgzIDI3NyAzMzMgMjc3IDI3Nw0KIDU1NiA1NTYgNTU2IDU1NiA1NTYgNTU2IDU1NiA1NTYNCiA1NTYgNTU2IDI3NyAyNzcgNTgzIDU4MyA1ODMgNTU2DQogMTAxNSA2NjYgNjY2IDcyMiA3MjIgNjY2IDYxMCA3NzcNCiA3MjIgMjc3IDUwMCA2NjYgNTU2IDgzMyA3MjIgNzc3DQogNjY2IDc3NyA3MjIgNjY2IDYxMCA3MjIgNjY2IDk0Mw0KIDY2NiA2NjYgNjEwIDI3NyAyNzcgMjc3IDQ2OSA1NTENCiAzMzMgNTU2IDU1NiA1MDAgNTU2IDU1NiAyNzcgNTU2DQogNTU2IDIyOCAyMjggNTAwIDIyOCA4MzMgNTU2IDU1Ng0KIDU1NiA1NTYgMzMzIDUwMCAyNzcgNTU2IDUwMCA3MjINCiA1MDAgNTAwIDUwMCAzMzMgMjU5IDMzMyA1ODMgMA0KIDAgMCA1NDkgNTQ5IDI4NSAwIDU0OSA1NDkNCiA0MDAgODYwIDUzMSA1NDkgMTA5NyAwIDAgMA0KIDAgMjIwIDIyMCA0NjEgNDYxIDAgNTg0IDEwOTMNCiAzNzEgMTAyMyA0MDAgMjc0IDYxMSAwIDAgNzY5DQogMjY1IDI3NyA1NTYgNTU2IDU1NiA1NTYgMjU5IDU1Ng0KIDMzMyA3MzYgMzcwIDU1NiA1ODMgMCA3MzYgNTAwDQogMzk5IDU4MyAzMzMgMzMzIDMzMyA1NTYgNTM3IDI3Nw0KIDMzMyAzMzMgMzY1IDU1NiA4MzMgODMzIDgzMyA1NTYNCiA2NjYgNjY2IDY2NiA2NjYgNjY2IDY2NiAxMDAwIDcyMg0KIDY2NiA2NjYgNjY2IDY2NiAyNzcgMjc3IDI3NyAyNzcNCiA3MjIgNzIyIDc3NyA3NzcgNzc3IDc3NyA3NzcgNTgzDQogNzc3IDcyMiA3MjIgNzIyIDcyMiA2NjYgNjY2IDYxMA0KIDU1NiA1NTYgNTU2IDU1NiA1NTYgNTU2IDg4OSA1MDANCiA1NTYgNTU2IDU1NiA1NTYgMjI4IDIyOCAyMjggMjI4DQogNTU2IDU1NiA1NTYgNTU2IDU1NiA1NTYgNTU2IDU4Mw0KIDU1NiA1NTYgNTU2IDU1NiA1NTYgNTAwIDU1NiA1MDANCl0NCmVuZG9iag0KNyAwIG9iag0KPDwgDQovVHlwZSAvRm9udERlc2NyaXB0b3INCi9Gb250TmFtZSAvTWljcm9zb2Z0U2Fuc1NlcmlmDQovQXNjZW50IDANCi9DYXBIZWlnaHQgNTAwDQovRGVzY2VudCAwDQovRmxhZ3MgMzINCi9Gb250QkJveCBbMCAwIDAgMF0NCi9JdGFsaWNBbmdsZSAwDQovU3RlbVYgMA0KPj4NCmVuZG9iag0KOCAwIG9iag0KPDwgDQovVHlwZSAvRm9udA0KL1N1YnR5cGUgL1RydWVUeXBlDQovTmFtZSAvRjINCi9CYXNlRm9udCAvVGltZXNOZXdSb21hbg0KL0ZpcnN0Q2hhciAzMg0KL0xhc3RDaGFyIDI1NQ0KL1dpZHRocyA5IDAgUg0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCi9Gb250RGVzY3JpcHRvciAxMCAwIFINCj4+DQplbmRvYmoNCjkgMCBvYmoNClsyNTAgMzMzIDQwOCA1MDAgNTAwIDgzMyA3NzcgMTgwDQogMzMzIDMzMyA1MDAgNTYzIDI1MCAzMzMgMjUwIDI3Nw0KIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDANCiA1MDAgNTAwIDI3NyAyNzcgNTYzIDU2MyA1NjMgNDQzDQogOTIwIDcyMiA2NjYgNjY2IDcyMiA2MTAgNTU2IDcyMg0KIDcyMiAzMzMgMzg5IDcyMiA2MTAgODg5IDcyMiA3MjINCiA1NTYgNzIyIDY2NiA1NTYgNjEwIDcyMiA3MjIgOTQzDQogNzIyIDcyMiA2MTAgMzMzIDI3NyAzMzMgNDY5IDUwMA0KIDMzMyA0NDMgNTAwIDQ0MyA1MDAgNDQzIDMzMyA1MDANCiA1MDAgMjc3IDI3NyA1MDAgMjc3IDc3NyA1MDAgNTAwDQogNTAwIDUwMCAzMzMgMzg5IDI3NyA1MDAgNTAwIDcyMg0KIDUwMCA1MDAgNDQzIDQ3OSAyMDAgNDc5IDU0MSAwDQogMCAwIDU0OSA1NDkgMjg1IDAgNTQ5IDU0OQ0KIDQwMCA4NjAgNTMxIDU0OSAxMDk3IDAgMCAwDQogMCAyMjAgMjIwIDQ2MSA0NjEgMCA1ODQgMTA5Mw0KIDM3MSAxMDIzIDQwMCAyNzQgNjExIDAgMCA3NjkNCiAyNTAgMzMzIDUwMCA1MDAgNTAwIDUwMCAyMDAgNTAwDQogMzMzIDc1OSAyNzUgNTAwIDU2MyAwIDc1OSA1MDANCiAzOTkgNTQ4IDI5OSAyOTkgMzMzIDU3NiA0NTMgMzMzDQogMzMzIDI5OSAzMTAgNTAwIDc1MCA3NTAgNzUwIDQ0Mw0KIDcyMiA3MjIgNzIyIDcyMiA3MjIgNzIyIDg4OSA2NjYNCiA2MTAgNjEwIDYxMCA2MTAgMzMzIDMzMyAzMzMgMzMzDQogNzIyIDcyMiA3MjIgNzIyIDcyMiA3MjIgNzIyIDU2Mw0KIDcyMiA3MjIgNzIyIDcyMiA3MjIgNzIyIDU1NiA1MDANCiA0NDMgNDQzIDQ0MyA0NDMgNDQzIDQ0MyA2NjYgNDQzDQogNDQzIDQ0MyA0NDMgNDQzIDI3NyAyNzcgMjc3IDI3Nw0KIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1NDgNCiA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwDQpdDQplbmRvYmoNCjEwIDAgb2JqDQo8PCANCi9UeXBlIC9Gb250RGVzY3JpcHRvcg0KL0ZvbnROYW1lIC9UaW1lc05ld1JvbWFuDQovQXNjZW50IDANCi9DYXBIZWlnaHQgNTAwDQovRGVzY2VudCAwDQovRmxhZ3MgMzINCi9Gb250QkJveCBbMCAwIDAgMF0NCi9JdGFsaWNBbmdsZSAwDQovU3RlbVYgMA0KPj4NCmVuZG9iag0KMTEgMCBvYmoNCjw8IA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UcnVlVHlwZQ0KL05hbWUgL0YzDQovQmFzZUZvbnQgL01pY3Jvc29mdFNhbnNTZXJpZixCb2xkDQovRmlyc3RDaGFyIDMyDQovTGFzdENoYXIgMjU1DQovV2lkdGhzIDEyIDAgUg0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCi9Gb250RGVzY3JpcHRvciAxMyAwIFINCj4+DQplbmRvYmoNCjEyIDAgb2JqDQpbMjY1IDI5NyAzNzUgNTc2IDU3NiA5MDkgNjg3IDIxMA0KIDM1MyAzNTMgNDA5IDYwNCAyOTcgMzUzIDI5NyAyOTcNCiA1NzYgNTc2IDU3NiA1NzYgNTc2IDU3NiA1NzYgNTc2DQogNTc2IDU3NiAyOTcgMjk3IDYwNCA2MDQgNjA0IDU3Ng0KIDEwMzUgNjg3IDY4NyA3NDIgNzQyIDY4NyA2MzAgNzk3DQogNzQyIDI5NyA1MjAgNjg3IDU3NiA4NTMgNzQyIDc5Nw0KIDY4NyA3OTcgNzQyIDY4NyA2MzAgNzQyIDY4NyA5NjMNCiA2ODcgNjg3IDYzMCAyOTcgMjk3IDI5NyA0ODkgNTcxDQogMzUzIDU3NiA1NzYgNTIwIDU3NiA1NzYgMjk3IDU3Ng0KIDU3NiAyNDggMjQ4IDUyMCAyNDggODUzIDU3NiA1NzYNCiA1NzYgNTc2IDM1MyA1MjAgMjk3IDU3NiA1MjAgNzQyDQogNTIwIDUyMCA1MjAgMzU0IDI3OSAzNTQgNjA0IDANCiAwIDAgNTU5IDU1OSAyODUgMCA1NTkgNTU5DQogNDEwIDg3MCA1NDEgNTU5IDExMDcgMCAwIDANCiAwIDIyOSAyMjkgNDcxIDQ3MSAwIDU5NCAxMTAzDQogMzgxIDEwMzMgNDEwIDI4NCA2MjEgMCAwIDc3OA0KIDI2NSAyOTcgNTc2IDU3NiA1NzYgNTc2IDI3OSA1NzYNCiAzNTMgNzU2IDM5MCA1NzYgNjA0IDAgNzU2IDUyMA0KIDQxOSA2MDQgMzUzIDM1MyAzNTMgNTc2IDU1NyAyOTcNCiAzNTMgMzUzIDM4NSA1NzYgODU0IDg1NCA4NTQgNTc2DQogNjg3IDY4NyA2ODcgNjg3IDY4NyA2ODcgMTAyMCA3NDINCiA2ODcgNjg3IDY4NyA2ODcgMjk3IDI5NyAyOTcgMjk3DQogNzQyIDc0MiA3OTcgNzk3IDc5NyA3OTcgNzk3IDYwNA0KIDc5NyA3NDIgNzQyIDc0MiA3NDIgNjg3IDY4NyA2MzANCiA1NzYgNTc2IDU3NiA1NzYgNTc2IDU3NiA5MDkgNTIwDQogNTc2IDU3NiA1NzYgNTc2IDI0OCAyNDggMjQ4IDI0OA0KIDU3NiA1NzYgNTc2IDU3NiA1NzYgNTc2IDU3NiA2MDQNCiA1NzYgNTc2IDU3NiA1NzYgNTc2IDUyMCA1NzYgNTIwDQpdDQplbmRvYmoNCjEzIDAgb2JqDQo8PCANCi9UeXBlIC9Gb250RGVzY3JpcHRvcg0KL0ZvbnROYW1lIC9NaWNyb3NvZnRTYW5zU2VyaWYsQm9sZA0KL0FzY2VudCAwDQovQ2FwSGVpZ2h0IDUwMA0KL0Rlc2NlbnQgMA0KL0ZsYWdzIDMyDQovRm9udEJCb3ggWzAgMCAwIDBdDQovSXRhbGljQW5nbGUgMA0KL1N0ZW1WIDANCj4+DQplbmRvYmoNCjE0IDAgb2JqDQo8PCANCi9Qcm9kdWNlciAo/v8ARABlAHYAZQBsAG8AcABlAHIAIABFAHgAcAByAGUAcwBzACAASQBuAGMALgAgAEQAWABwAGUAcgBpAGUAbgBjAGUAIABcKAB0AG0AXCkAIAB2ADEANAAuADIALgA3KQ0KL0NyZWF0aW9uRGF0ZSAoRDoyMDE5MDMyNjAwNDI0OFopDQo+Pg0KZW5kb2JqDQp4cmVmDQowIDE1DQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTAgMDAwMDAgbg0KMDAwMDAwMTEzMyAwMDAwMCBuDQowMDAwMDAxMTg5IDAwMDAwIG4NCjAwMDAwMDEyNzkgMDAwMDAgbg0KMDAwMDAwMTQ3NSAwMDAwMCBuDQowMDAwMDAxNjcyIDAwMDAwIG4NCjAwMDAwMDI2MjUgMDAwMDAgbg0KMDAwMDAwMjgwMiAwMDAwMCBuDQowMDAwMDAyOTk1IDAwMDAwIG4NCjAwMDAwMDM5NDYgMDAwMDAgbg0KMDAwMDAwNDExOSAwMDAwMCBuDQowMDAwMDA0MzI0IDAwMDAwIG4NCjAwMDAwMDUyNzggMDAwMDAgbg0KMDAwMDAwNTQ2MSAwMDAwMCBuDQp0cmFpbGVyDQo8PCANCi9TaXplIDE1DQovSW5mbyAxNCAwIFINCi9Sb290IDIgMCBSDQo+Pg0Kc3RhcnR4cmVmDQo1NjMzDQolJUVPRg==</GenerateLabelsResult>
        </GenerateLabelsResponse>
    </s:Body>
</s:Envelope>

...

Handling Response:

Note

The provided response is a Base64 encoded PDF file.

Methods to convert the provided response:


Tip

Auto-Printing the Downloaded PDF

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@20f86d
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "FLIP"
labelskb-how-to-article

...