Chilkat Online Tools

PureBasic / Support API / List Sharing Agreements

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "login")
    CkHttp::setCkPassword(http, "password")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/sharing_agreements",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "sharing_agreements": [
    ;     {
    ;       "created_at": "<dateTime>",
    ;       "id": "<integer>",
    ;       "name": "<string>",
    ;       "partner_name": "<string>",
    ;       "remote_subdomain": "<string>",
    ;       "status": "<string>",
    ;       "type": "<string>",
    ;       "url": "<string>"
    ;     },
    ;     {
    ;       "created_at": "<dateTime>",
    ;       "id": "<integer>",
    ;       "name": "<string>",
    ;       "partner_name": "<string>",
    ;       "remote_subdomain": "<string>",
    ;       "status": "<string>",
    ;       "type": "<string>",
    ;       "url": "<string>"
    ;     }
    ;   ]
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    created_at.s
    id.s
    name.s
    partner_name.s
    remote_subdomain.s
    status.s
    v_type.s
    url.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"sharing_agreements")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        created_at = CkJsonObject::ckStringOf(jResp,"sharing_agreements[i].created_at")
        id = CkJsonObject::ckStringOf(jResp,"sharing_agreements[i].id")
        name = CkJsonObject::ckStringOf(jResp,"sharing_agreements[i].name")
        partner_name = CkJsonObject::ckStringOf(jResp,"sharing_agreements[i].partner_name")
        remote_subdomain = CkJsonObject::ckStringOf(jResp,"sharing_agreements[i].remote_subdomain")
        status = CkJsonObject::ckStringOf(jResp,"sharing_agreements[i].status")
        v_type = CkJsonObject::ckStringOf(jResp,"sharing_agreements[i].type")
        url = CkJsonObject::ckStringOf(jResp,"sharing_agreements[i].url")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/sharing_agreements

Postman Collection Item JSON

{
  "name": "List Sharing Agreements",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/sharing_agreements",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "sharing_agreements"
      ]
    },
    "description": "#### Allowed For\n\n* Agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/sharing_agreements",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sharing_agreements"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"sharing_agreements\": [\n    {\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"partner_name\": \"<string>\",\n      \"remote_subdomain\": \"<string>\",\n      \"status\": \"<string>\",\n      \"type\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"partner_name\": \"<string>\",\n      \"remote_subdomain\": \"<string>\",\n      \"status\": \"<string>\",\n      \"type\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}