Chilkat Online Tools

PureBasic / Support API / Create Item

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")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    resp.i = CkHttp::ckQuickRequest(http,"POST","https://example.zendesk.com/api/v2/dynamic_content/items")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        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)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "item": {
    ;     "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

    content.s
    locale_id.s
    active.s
    created_at.s
    default.s
    id.s
    outdated.s
    updated_at.s
    url.s

    Name.s = CkJsonObject::ckStringOf(jResp,"item.name")
    Default_locale_id.s = CkJsonObject::ckStringOf(jResp,"item.default_locale_id")
    Created_at.s = CkJsonObject::ckStringOf(jResp,"item.created_at")
    Id.s = CkJsonObject::ckStringOf(jResp,"item.id")
    Outdated.s = CkJsonObject::ckStringOf(jResp,"item.outdated")
    Placeholder.s = CkJsonObject::ckStringOf(jResp,"item.placeholder")
    Updated_at.s = CkJsonObject::ckStringOf(jResp,"item.updated_at")
    v_Url.s = CkJsonObject::ckStringOf(jResp,"item.url")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"item.variants")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        content = CkJsonObject::ckStringOf(jResp,"item.variants[i].content")
        locale_id = CkJsonObject::ckStringOf(jResp,"item.variants[i].locale_id")
        active = CkJsonObject::ckStringOf(jResp,"item.variants[i].active")
        created_at = CkJsonObject::ckStringOf(jResp,"item.variants[i].created_at")
        default = CkJsonObject::ckStringOf(jResp,"item.variants[i].default")
        id = CkJsonObject::ckStringOf(jResp,"item.variants[i].id")
        outdated = CkJsonObject::ckStringOf(jResp,"item.variants[i].outdated")
        updated_at = CkJsonObject::ckStringOf(jResp,"item.variants[i].updated_at")
        url = CkJsonObject::ckStringOf(jResp,"item.variants[i].url")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items

Postman Collection Item JSON

{
  "name": "Create Item",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/dynamic_content/items",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dynamic_content",
        "items"
      ]
    },
    "description": "Create a new content item, with one or more variants in the item's `variants` array. See [Specifying item variants](#specifying-item-variants).\n\nThe `default_locale_id` and variant `locale_id` values must be one of the locales the account has active. You can get the list with the [List Locales](/api-reference/ticketing/account-configuration/locales/#list-locales) endpoint.\n\n#### Allowed For\n\n* Admins, Agents\n"
  },
  "response": [
    {
      "name": "Created response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/dynamic_content/items",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dynamic_content",
            "items"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"item\": {\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}"
    }
  ]
}