SQL Server / Support API / Autocomplete Organizations
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'name', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'field_id', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'source', '<string>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://example.zendesk.com/api/v2/organizations/autocomplete', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @created_at nvarchar(4000)
DECLARE @details nvarchar(4000)
DECLARE @external_id nvarchar(4000)
DECLARE @group_id nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @notes nvarchar(4000)
DECLARE @Eiusmod_f nvarchar(4000)
DECLARE @shared_comments nvarchar(4000)
DECLARE @shared_tickets nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @url nvarchar(4000)
DECLARE @Nulla2 nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @strVal nvarchar(4000)
DECLARE @count nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @count OUT, 'count'
DECLARE @next_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @next_page OUT, 'next_page'
DECLARE @previous_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @previous_page OUT, 'previous_page'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'organizations'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'organizations[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @details OUT, 'organizations[i].details'
EXEC sp_OAMethod @jResp, 'StringOf', @external_id OUT, 'organizations[i].external_id'
EXEC sp_OAMethod @jResp, 'StringOf', @group_id OUT, 'organizations[i].group_id'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'organizations[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'organizations[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @notes OUT, 'organizations[i].notes'
EXEC sp_OAMethod @jResp, 'StringOf', @Eiusmod_f OUT, 'organizations[i].organization_fields.eiusmod_f'
EXEC sp_OAMethod @jResp, 'StringOf', @shared_comments OUT, 'organizations[i].shared_comments'
EXEC sp_OAMethod @jResp, 'StringOf', @shared_tickets OUT, 'organizations[i].shared_tickets'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'organizations[i].updated_at'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'organizations[i].url'
EXEC sp_OAMethod @jResp, 'StringOf', @Nulla2 OUT, 'organizations[i].organization_fields.nulla2'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'organizations[i].domain_names'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'organizations[i].domain_names[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'organizations[i].tags'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'organizations[i].tags[j]'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
