Chilkat Online Tools

Swift3 / GP-API Collection / DIA_1.2 Get Document

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    http.setRequestHeader("Content-Type", value: "application/json")
    http.setRequestHeader("X-GP-Version", value: "{{version}}")
    // Adds the "Authorization: Bearer {{token}}" header.
    http.authToken = "{{token}}"
    http.setRequestHeader("Accept", value: "application/json")

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://{{url}}/ucp/disputes/DIS_SAND_abcd1234/documents/DOC_MyEvidence_234234AVCDE-1", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("Response status code = \(http.lastStatus.intValue)")
    print("\(sbResponseBody.getAsString()!)")

}

Curl Command

curl -X GET
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{token}}"
	-H "Accept: application/json"
	-H "X-GP-Version: {{version}}"
https://{{url}}/ucp/disputes/DIS_SAND_abcd1234/documents/DOC_MyEvidence_234234AVCDE-1

Postman Collection Item JSON

{
  "name": "DIA_1.2 Get Document",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text",
        "disabled": true
      },
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{token}}"
      },
      {
        "key": "Accept",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "X-GP-Version",
        "type": "text",
        "value": "{{version}}"
      }
    ],
    "url": {
      "raw": "https://{{url}}/ucp/disputes/DIS_SAND_abcd1234/documents/DOC_MyEvidence_234234AVCDE-1",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "disputes",
        "DIS_SAND_abcd1234",
        "documents",
        "DOC_MyEvidence_234234AVCDE-1"
      ]
    },
    "description": "This request is for retrieving a document that has been provided by the Issuer in a dispute. You must provide the dispute id and also the document id in the query string. In the response, you should receive the document in base 64.\r\n\r\nFor more info on getting a document in a dispute, visit: https://developer.globalpay.com/api/disputes#/Document/get_disputes__id__documents__doc_id_"
  },
  "response": [
  ]
}