Chilkat Online Tools

phpAx / Support API / Update SLA Policy

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';

$http->SetRequestHeader('Accept','application/json');

// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequest('PUT','https://example.zendesk.com/api/v2/slas/policies/:sla_policy_id');
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)

// {
//   "sla_policy": {
//     "title": "<string>",
//     "filter": {
//       "all": [
//         {
//           "field": "<string>",
//           "operator": "<string>",
//           "value": "<string>"
//         },
//         {
//           "field": "<string>",
//           "operator": "<string>",
//           "value": "<string>"
//         }
//       ],
//       "any": [
//         {
//           "field": "<string>",
//           "operator": "<string>",
//           "value": "<string>"
//         },
//         {
//           "field": "<string>",
//           "operator": "<string>",
//           "value": "<string>"
//         }
//       ]
//     },
//     "created_at": "<dateTime>",
//     "description": "<string>",
//     "id": "<integer>",
//     "policy_metrics": [
//       {
//         "business_hours": "<boolean>",
//         "metric": "<string>",
//         "priority": "<string>",
//         "target": "<integer>"
//       },
//       {
//         "business_hours": "<boolean>",
//         "metric": "<string>",
//         "priority": "<string>",
//         "target": "<integer>"
//       }
//     ],
//     "position": "<integer>",
//     "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

$Title = $jResp->stringOf('sla_policy.title');
$Created_at = $jResp->stringOf('sla_policy.created_at');
$Description = $jResp->stringOf('sla_policy.description');
$Id = $jResp->stringOf('sla_policy.id');
$Position = $jResp->stringOf('sla_policy.position');
$Updated_at = $jResp->stringOf('sla_policy.updated_at');
$v_Url = $jResp->stringOf('sla_policy.url');
$i = 0;
$count_i = $jResp->SizeOfArray('sla_policy.filter.all');
while ($i < $count_i) {
    $jResp->I = $i;
    $field = $jResp->stringOf('sla_policy.filter.all[i].field');
    $operator = $jResp->stringOf('sla_policy.filter.all[i].operator');
    $value = $jResp->stringOf('sla_policy.filter.all[i].value');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('sla_policy.filter.any');
while ($i < $count_i) {
    $jResp->I = $i;
    $field = $jResp->stringOf('sla_policy.filter.any[i].field');
    $operator = $jResp->stringOf('sla_policy.filter.any[i].operator');
    $value = $jResp->stringOf('sla_policy.filter.any[i].value');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('sla_policy.policy_metrics');
while ($i < $count_i) {
    $jResp->I = $i;
    $business_hours = $jResp->stringOf('sla_policy.policy_metrics[i].business_hours');
    $metric = $jResp->stringOf('sla_policy.policy_metrics[i].metric');
    $priority = $jResp->stringOf('sla_policy.policy_metrics[i].priority');
    $target = $jResp->stringOf('sla_policy.policy_metrics[i].target');
    $i = $i + 1;
}


?>

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/slas/policies/:sla_policy_id

Postman Collection Item JSON

{
  "name": "Update SLA Policy",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/slas/policies/:sla_policy_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "slas",
        "policies",
        ":sla_policy_id"
      ],
      "variable": [
        {
          "key": "sla_policy_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Updates the specified policy.\n\n#### Availability\n\n* Accounts on the Support Professional or Suite Growth plan or above\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/slas/policies/:sla_policy_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "slas",
            "policies",
            ":sla_policy_id"
          ],
          "variable": [
            {
              "key": "sla_policy_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"sla_policy\": {\n    \"title\": \"<string>\",\n    \"filter\": {\n      \"all\": [\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"any\": [\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    },\n    \"created_at\": \"<dateTime>\",\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"policy_metrics\": [\n      {\n        \"business_hours\": \"<boolean>\",\n        \"metric\": \"<string>\",\n        \"priority\": \"<string>\",\n        \"target\": \"<integer>\"\n      },\n      {\n        \"business_hours\": \"<boolean>\",\n        \"metric\": \"<string>\",\n        \"priority\": \"<string>\",\n        \"target\": \"<integer>\"\n      }\n    ],\n    \"position\": \"<integer>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}