PureBasic / Support API / Show Many Organizations
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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")
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"ids","<string>")
CkJsonObject::ckUpdateString(queryParams,"external_ids","<string>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://example.zendesk.com/api/v2/organizations/show_many",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
created_at.s
details.s
external_id.s
group_id.s
id.s
name.s
notes.s
Eiusmod_f.s
shared_comments.s
shared_tickets.s
updated_at.s
url.s
Nulla2.s
j.i
count_j.i
strVal.s
count.s = CkJsonObject::ckStringOf(jResp,"count")
next_page.s = CkJsonObject::ckStringOf(jResp,"next_page")
previous_page.s = CkJsonObject::ckStringOf(jResp,"previous_page")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"organizations")
While i < count_i
CkJsonObject::setCkI(jResp, i)
created_at = CkJsonObject::ckStringOf(jResp,"organizations[i].created_at")
details = CkJsonObject::ckStringOf(jResp,"organizations[i].details")
external_id = CkJsonObject::ckStringOf(jResp,"organizations[i].external_id")
group_id = CkJsonObject::ckStringOf(jResp,"organizations[i].group_id")
id = CkJsonObject::ckStringOf(jResp,"organizations[i].id")
name = CkJsonObject::ckStringOf(jResp,"organizations[i].name")
notes = CkJsonObject::ckStringOf(jResp,"organizations[i].notes")
Eiusmod_f = CkJsonObject::ckStringOf(jResp,"organizations[i].organization_fields.eiusmod_f")
shared_comments = CkJsonObject::ckStringOf(jResp,"organizations[i].shared_comments")
shared_tickets = CkJsonObject::ckStringOf(jResp,"organizations[i].shared_tickets")
updated_at = CkJsonObject::ckStringOf(jResp,"organizations[i].updated_at")
url = CkJsonObject::ckStringOf(jResp,"organizations[i].url")
Nulla2 = CkJsonObject::ckStringOf(jResp,"organizations[i].organization_fields.nulla2")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"organizations[i].domain_names")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"organizations[i].domain_names[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"organizations[i].tags")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"organizations[i].tags[j]")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -u login:password -G -d "ids=%3Cstring%3E"
-d "external_ids=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/show_many
Postman Collection Item JSON
{
"name": "Show Many Organizations",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/show_many?ids=<string>&external_ids=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"show_many"
],
"query": [
{
"key": "ids",
"value": "<string>",
"description": "A list of organization ids"
},
{
"key": "external_ids",
"value": "<string>",
"description": "A list of external ids"
}
]
},
"description": "Accepts a comma-separated list of up to 100 organization ids or external ids.\n\n#### Allowed For\n\n* Admins\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/show_many?ids=<string>&external_ids=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"show_many"
],
"query": [
{
"key": "ids",
"value": "<string>",
"description": "A list of organization ids"
},
{
"key": "external_ids",
"value": "<string>",
"description": "A list of external ids"
}
]
}
},
"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}"
}
]
}
