phpAx / Support API / Show Many Items
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
$http->BasicAuth = 1;
$http->Login = 'login';
$http->Password = 'password';
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$queryParams = new COM("Chilkat.JsonObject");
$queryParams->UpdateString('identifiers','<string>');
$http->SetRequestHeader('Accept','application/json');
// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequestParams('GET','https://example.zendesk.com/api/v2/dynamic_content/items/show_many',$queryParams);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "items": [
// {
// "name": "<string>",
// "default_locale_id": "<integer>",
// "variants": [
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// ],
// "created_at": "<dateTime>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "placeholder": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "name": "<string>",
// "default_locale_id": "<integer>",
// "variants": [
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// ],
// "created_at": "<dateTime>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "placeholder": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$i = 0;
$count_i = $jResp->SizeOfArray('items');
while ($i < $count_i) {
$jResp->I = $i;
$name = $jResp->stringOf('items[i].name');
$default_locale_id = $jResp->stringOf('items[i].default_locale_id');
$created_at = $jResp->stringOf('items[i].created_at');
$id = $jResp->stringOf('items[i].id');
$outdated = $jResp->stringOf('items[i].outdated');
$placeholder = $jResp->stringOf('items[i].placeholder');
$updated_at = $jResp->stringOf('items[i].updated_at');
$url = $jResp->stringOf('items[i].url');
$j = 0;
$count_j = $jResp->SizeOfArray('items[i].variants');
while ($j < $count_j) {
$jResp->J = $j;
$content = $jResp->stringOf('items[i].variants[j].content');
$locale_id = $jResp->stringOf('items[i].variants[j].locale_id');
$active = $jResp->stringOf('items[i].variants[j].active');
$created_at = $jResp->stringOf('items[i].variants[j].created_at');
$default = $jResp->stringOf('items[i].variants[j].default');
$id = $jResp->stringOf('items[i].variants[j].id');
$outdated = $jResp->stringOf('items[i].variants[j].outdated');
$updated_at = $jResp->stringOf('items[i].variants[j].updated_at');
$url = $jResp->stringOf('items[i].variants[j].url');
$j = $j + 1;
}
$i = $i + 1;
}
?>
Curl Command
curl -u login:password -G -d "identifiers=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items/show_many
Postman Collection Item JSON
{
"name": "Show Many Items",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dynamic_content/items/show_many?identifiers=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items",
"show_many"
],
"query": [
{
"key": "identifiers",
"value": "<string>",
"description": "Identifiers for the dynamic contents"
}
]
},
"description": "#### Stability\n\n* Development\n\n#### Allowed For\n\n* Admins, 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/dynamic_content/items/show_many?identifiers=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items",
"show_many"
],
"query": [
{
"key": "identifiers",
"value": "<string>",
"description": "Identifiers for the dynamic contents"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"default_locale_id\": \"<integer>\",\n \"variants\": [\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"placeholder\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"default_locale_id\": \"<integer>\",\n \"variants\": [\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"placeholder\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
