Chilkat Online Tools

Swift3 / Support API / Search Organizations by External ID

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.basicAuth = true
    http.login = "login"
    http.password = "password"

    let queryParams = CkoJsonObject()!
    queryParams.update("external_id", value: "<integer>")

    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://example.zendesk.com/api/v2/organizations/search", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "count": "<integer>",
    //   "next_page": "<string>",
    //   "organizations": [
    //     {
    //       "created_at": "<string>",
    //       "details": "<string>",
    //       "domain_names": [
    //         "<string>",
    //         "<string>"
    //       ],
    //       "external_id": "<string>",
    //       "group_id": "<integer>",
    //       "id": "<integer>",
    //       "name": "<string>",
    //       "notes": "<string>",
    //       "organization_fields": {
    //         "eiusmod_f": "<string>"
    //       },
    //       "shared_comments": "<boolean>",
    //       "shared_tickets": "<boolean>",
    //       "tags": [
    //         "<string>",
    //         "<string>"
    //       ],
    //       "updated_at": "<string>",
    //       "url": "<string>"
    //     },
    //     {
    //       "created_at": "<string>",
    //       "details": "<string>",
    //       "domain_names": [
    //         "<string>",
    //         "<string>"
    //       ],
    //       "external_id": "<string>",
    //       "group_id": "<integer>",
    //       "id": "<integer>",
    //       "name": "<string>",
    //       "notes": "<string>",
    //       "organization_fields": {
    //         "nulla2": "<string>"
    //       },
    //       "shared_comments": "<boolean>",
    //       "shared_tickets": "<boolean>",
    //       "tags": [
    //         "<string>",
    //         "<string>"
    //       ],
    //       "updated_at": "<string>",
    //       "url": "<string>"
    //     }
    //   ],
    //   "previous_page": "<string>"
    // }

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

    var created_at: String?
    var details: String?
    var external_id: String?
    var group_id: String?
    var id: String?
    var name: String?
    var notes: String?
    var Eiusmod_f: String?
    var shared_comments: String?
    var shared_tickets: String?
    var updated_at: String?
    var url: String?
    var Nulla2: String?
    var j: Int
    var count_j: Int
    var strVal: String?

    var count: String? = jResp.string(of: "count")
    var next_page: String? = jResp.string(of: "next_page")
    var previous_page: String? = jResp.string(of: "previous_page")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "organizations").intValue
    while i < count_i {
        jResp.i = i
        created_at = jResp.string(of: "organizations[i].created_at")
        details = jResp.string(of: "organizations[i].details")
        external_id = jResp.string(of: "organizations[i].external_id")
        group_id = jResp.string(of: "organizations[i].group_id")
        id = jResp.string(of: "organizations[i].id")
        name = jResp.string(of: "organizations[i].name")
        notes = jResp.string(of: "organizations[i].notes")
        Eiusmod_f = jResp.string(of: "organizations[i].organization_fields.eiusmod_f")
        shared_comments = jResp.string(of: "organizations[i].shared_comments")
        shared_tickets = jResp.string(of: "organizations[i].shared_tickets")
        updated_at = jResp.string(of: "organizations[i].updated_at")
        url = jResp.string(of: "organizations[i].url")
        Nulla2 = jResp.string(of: "organizations[i].organization_fields.nulla2")
        j = 0
        count_j = jResp.size(ofArray: "organizations[i].domain_names").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "organizations[i].domain_names[j]")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "organizations[i].tags").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "organizations[i].tags[j]")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl  -u login:password -G -d "external_id=%3Cinteger%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/search

Postman Collection Item JSON

{
  "name": "Search Organizations by External ID",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organizations/search?external_id=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organizations",
        "search"
      ],
      "query": [
        {
          "key": "external_id",
          "value": "<integer>",
          "description": "(Required) The external id of an organization"
        }
      ]
    },
    "description": "If you set the `external_id` value of an organization to associate it to an external record, you can use the external id to search for the organization.\n\n#### Allowed For:\n\n* Admins\n* Agents assigned to a custom role with permissions to add or modify organizations (Enterprise only)\n\nSee [Creating custom agent roles](https://support.zendesk.com/hc/en-us/articles/203662026#topic_cxn_hig_bd) in the Support Help Center.\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/organizations/search?external_id=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations",
            "search"
          ],
          "query": [
            {
              "key": "external_id",
              "value": "<integer>",
              "description": "(Required) The external id of an organization"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"organizations\": [\n    {\n      \"created_at\": \"<string>\",\n      \"details\": \"<string>\",\n      \"domain_names\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"external_id\": \"<string>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"organization_fields\": {\n        \"eiusmod_f\": \"<string>\"\n      },\n      \"shared_comments\": \"<boolean>\",\n      \"shared_tickets\": \"<boolean>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"created_at\": \"<string>\",\n      \"details\": \"<string>\",\n      \"domain_names\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"external_id\": \"<string>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"organization_fields\": {\n        \"nulla2\": \"<string>\"\n      },\n      \"shared_comments\": \"<boolean>\",\n      \"shared_tickets\": \"<boolean>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ],\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}