Chilkat Online Tools

lianja / Support API / Autocomplete Organizations

Back to Collection Items

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

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("name","<string>")
loQueryParams.UpdateString("field_id","<string>")
loQueryParams.UpdateString("source","<string>")

loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/organizations/autocomplete",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loQueryParams
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

lcCount = loJResp.StringOf("count")
lcNext_page = loJResp.StringOf("next_page")
lcPrevious_page = loJResp.StringOf("previous_page")
i = 0
lnCount_i = loJResp.SizeOfArray("organizations")
do while i < lnCount_i
    loJResp.I = i
    lcCreated_at = loJResp.StringOf("organizations[i].created_at")
    lcDetails = loJResp.StringOf("organizations[i].details")
    lcExternal_id = loJResp.StringOf("organizations[i].external_id")
    lcGroup_id = loJResp.StringOf("organizations[i].group_id")
    lcId = loJResp.StringOf("organizations[i].id")
    lcName = loJResp.StringOf("organizations[i].name")
    lcNotes = loJResp.StringOf("organizations[i].notes")
    lcEiusmod_f = loJResp.StringOf("organizations[i].organization_fields.eiusmod_f")
    lcShared_comments = loJResp.StringOf("organizations[i].shared_comments")
    lcShared_tickets = loJResp.StringOf("organizations[i].shared_tickets")
    lcUpdated_at = loJResp.StringOf("organizations[i].updated_at")
    lcUrl = loJResp.StringOf("organizations[i].url")
    lcNulla2 = loJResp.StringOf("organizations[i].organization_fields.nulla2")
    j = 0
    lnCount_j = loJResp.SizeOfArray("organizations[i].domain_names")
    do while j < lnCount_j
        loJResp.J = j
        lcStrVal = loJResp.StringOf("organizations[i].domain_names[j]")
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJResp.SizeOfArray("organizations[i].tags")
    do while j < lnCount_j
        loJResp.J = j
        lcStrVal = loJResp.StringOf("organizations[i].tags[j]")
        j = j + 1
    enddo
    i = i + 1
enddo


release loHttp
release loQueryParams
release loSbResponseBody
release loJResp

Curl Command

curl  -u login:password -G -d "name=%3Cstring%3E"
	-d "field_id=%3Cstring%3E"
	-d "source=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/autocomplete

Postman Collection Item JSON

{
  "name": "Autocomplete Organizations",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organizations/autocomplete?name=<string>&field_id=<string>&source=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organizations",
        "autocomplete"
      ],
      "query": [
        {
          "key": "name",
          "value": "<string>",
          "description": "(Required) A substring of an organization to search for"
        },
        {
          "key": "field_id",
          "value": "<string>",
          "description": "The id of a lookup relationship field.  The type of field is determined\nby the `source` param\n"
        },
        {
          "key": "source",
          "value": "<string>",
          "description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
        }
      ]
    },
    "description": "Returns an array of organizations whose name starts with the\nvalue specified in the `name` parameter.\n\n#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).\n\n#### 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/organizations/autocomplete?name=<string>&field_id=<string>&source=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations",
            "autocomplete"
          ],
          "query": [
            {
              "key": "name",
              "value": "<string>",
              "description": "(Required) A substring of an organization to search for"
            },
            {
              "key": "field_id",
              "value": "<string>",
              "description": "The id of a lookup relationship field.  The type of field is determined\nby the `source` param\n"
            },
            {
              "key": "source",
              "value": "<string>",
              "description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
            }
          ]
        }
      },
      "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}"
    },
    {
      "name": "Bad request",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/organizations/autocomplete?name=<string>&field_id=<string>&source=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations",
            "autocomplete"
          ],
          "query": [
            {
              "key": "name",
              "value": "<string>",
              "description": "(Required) A substring of an organization to search for"
            },
            {
              "key": "field_id",
              "value": "<string>",
              "description": "The id of a lookup relationship field.  The type of field is determined\nby the `source` param\n"
            },
            {
              "key": "source",
              "value": "<string>",
              "description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"<string>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\",\n      \"id\": \"<string>\",\n      \"links\": {},\n      \"source\": {},\n      \"status\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\",\n      \"id\": \"<string>\",\n      \"links\": {},\n      \"source\": {},\n      \"status\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/organizations/autocomplete?name=<string>&field_id=<string>&source=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations",
            "autocomplete"
          ],
          "query": [
            {
              "key": "name",
              "value": "<string>",
              "description": "(Required) A substring of an organization to search for"
            },
            {
              "key": "field_id",
              "value": "<string>",
              "description": "The id of a lookup relationship field.  The type of field is determined\nby the `source` param\n"
            },
            {
              "key": "source",
              "value": "<string>",
              "description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"<string>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\",\n      \"id\": \"<string>\",\n      \"links\": {},\n      \"source\": {},\n      \"status\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\",\n      \"id\": \"<string>\",\n      \"links\": {},\n      \"source\": {},\n      \"status\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/organizations/autocomplete?name=<string>&field_id=<string>&source=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations",
            "autocomplete"
          ],
          "query": [
            {
              "key": "name",
              "value": "<string>",
              "description": "(Required) A substring of an organization to search for"
            },
            {
              "key": "field_id",
              "value": "<string>",
              "description": "The id of a lookup relationship field.  The type of field is determined\nby the `source` param\n"
            },
            {
              "key": "source",
              "value": "<string>",
              "description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"<string>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\",\n      \"id\": \"<string>\",\n      \"links\": {},\n      \"source\": {},\n      \"status\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\",\n      \"id\": \"<string>\",\n      \"links\": {},\n      \"source\": {},\n      \"status\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}