Chilkat Online Tools

PureBasic / Support API / Show Organization Field

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/organization_fields/:organization_field_id",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    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 = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

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

    ; {
    ;   "organization_field": {
    ;     "key": "<string>",
    ;     "type": "<string>",
    ;     "title": "<string>",
    ;     "active": "<boolean>",
    ;     "created_at": "<dateTime>",
    ;     "custom_field_options": [
    ;       {
    ;         "name": "<string>",
    ;         "value": "<string>",
    ;         "id": "<integer>",
    ;         "position": "<integer>",
    ;         "raw_name": "<string>",
    ;         "url": "<string>"
    ;       },
    ;       {
    ;         "name": "<string>",
    ;         "value": "<string>",
    ;         "id": "<integer>",
    ;         "position": "<integer>",
    ;         "raw_name": "<string>",
    ;         "url": "<string>"
    ;       }
    ;     ],
    ;     "description": "<string>",
    ;     "id": "<integer>",
    ;     "position": "<integer>",
    ;     "raw_description": "<string>",
    ;     "raw_title": "<string>",
    ;     "regexp_for_validation": "<string>",
    ;     "relationship_filter": {},
    ;     "relationship_target_type": "<string>",
    ;     "system": "<boolean>",
    ;     "tag": "<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

    name.s
    value.s
    id.s
    position.s
    raw_name.s
    url.s

    Key.s = CkJsonObject::ckStringOf(jResp,"organization_field.key")
    v_Type.s = CkJsonObject::ckStringOf(jResp,"organization_field.type")
    Title.s = CkJsonObject::ckStringOf(jResp,"organization_field.title")
    Active.s = CkJsonObject::ckStringOf(jResp,"organization_field.active")
    Created_at.s = CkJsonObject::ckStringOf(jResp,"organization_field.created_at")
    Description.s = CkJsonObject::ckStringOf(jResp,"organization_field.description")
    Id.s = CkJsonObject::ckStringOf(jResp,"organization_field.id")
    Position.s = CkJsonObject::ckStringOf(jResp,"organization_field.position")
    Raw_description.s = CkJsonObject::ckStringOf(jResp,"organization_field.raw_description")
    Raw_title.s = CkJsonObject::ckStringOf(jResp,"organization_field.raw_title")
    Regexp_for_validation.s = CkJsonObject::ckStringOf(jResp,"organization_field.regexp_for_validation")
    Relationship_target_type.s = CkJsonObject::ckStringOf(jResp,"organization_field.relationship_target_type")
    System.s = CkJsonObject::ckStringOf(jResp,"organization_field.system")
    Tag.s = CkJsonObject::ckStringOf(jResp,"organization_field.tag")
    Updated_at.s = CkJsonObject::ckStringOf(jResp,"organization_field.updated_at")
    v_Url.s = CkJsonObject::ckStringOf(jResp,"organization_field.url")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"organization_field.custom_field_options")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        name = CkJsonObject::ckStringOf(jResp,"organization_field.custom_field_options[i].name")
        value = CkJsonObject::ckStringOf(jResp,"organization_field.custom_field_options[i].value")
        id = CkJsonObject::ckStringOf(jResp,"organization_field.custom_field_options[i].id")
        position = CkJsonObject::ckStringOf(jResp,"organization_field.custom_field_options[i].position")
        raw_name = CkJsonObject::ckStringOf(jResp,"organization_field.custom_field_options[i].raw_name")
        url = CkJsonObject::ckStringOf(jResp,"organization_field.custom_field_options[i].url")
        i = i + 1
    Wend


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


    ProcedureReturn
EndProcedure

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/organization_fields/:organization_field_id

Postman Collection Item JSON

{
  "name": "Show Organization Field",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organization_fields/:organization_field_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organization_fields",
        ":organization_field_id"
      ],
      "variable": [
        {
          "key": "organization_field_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### 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/organization_fields/:organization_field_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organization_fields",
            ":organization_field_id"
          ],
          "variable": [
            {
              "key": "organization_field_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"organization_field\": {\n    \"key\": \"<string>\",\n    \"type\": \"<string>\",\n    \"title\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"custom_field_options\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"raw_description\": \"<string>\",\n    \"raw_title\": \"<string>\",\n    \"regexp_for_validation\": \"<string>\",\n    \"relationship_filter\": {},\n    \"relationship_target_type\": \"<string>\",\n    \"system\": \"<boolean>\",\n    \"tag\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}