Chilkat Online Tools

Foxpro / Support API / Show User Field

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcName
LOCAL lcValue
LOCAL lcId
LOCAL lcPosition
LOCAL lcRaw_name
LOCAL lcUrl
LOCAL lcKey
LOCAL lcV_Type
LOCAL lcTitle
LOCAL lcActive
LOCAL lcCreated_at
LOCAL lcDescription
LOCAL lcId
LOCAL lcPosition
LOCAL lcRaw_description
LOCAL lcRaw_title
LOCAL lcRegexp_for_validation
LOCAL lcRelationship_target_type
LOCAL lcSystem
LOCAL lcTag
LOCAL lcUpdated_at
LOCAL lcV_Url
LOCAL i
LOCAL lnCount_i

* 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 CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/user_fields/:user_field_id",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

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

* {
*   "user_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

lcKey = loJResp.StringOf("user_field.key")
lcV_Type = loJResp.StringOf("user_field.type")
lcTitle = loJResp.StringOf("user_field.title")
lcActive = loJResp.StringOf("user_field.active")
lcCreated_at = loJResp.StringOf("user_field.created_at")
lcDescription = loJResp.StringOf("user_field.description")
lcId = loJResp.StringOf("user_field.id")
lcPosition = loJResp.StringOf("user_field.position")
lcRaw_description = loJResp.StringOf("user_field.raw_description")
lcRaw_title = loJResp.StringOf("user_field.raw_title")
lcRegexp_for_validation = loJResp.StringOf("user_field.regexp_for_validation")
lcRelationship_target_type = loJResp.StringOf("user_field.relationship_target_type")
lcSystem = loJResp.StringOf("user_field.system")
lcTag = loJResp.StringOf("user_field.tag")
lcUpdated_at = loJResp.StringOf("user_field.updated_at")
lcV_Url = loJResp.StringOf("user_field.url")
i = 0
lnCount_i = loJResp.SizeOfArray("user_field.custom_field_options")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcName = loJResp.StringOf("user_field.custom_field_options[i].name")
    lcValue = loJResp.StringOf("user_field.custom_field_options[i].value")
    lcId = loJResp.StringOf("user_field.custom_field_options[i].id")
    lcPosition = loJResp.StringOf("user_field.custom_field_options[i].position")
    lcRaw_name = loJResp.StringOf("user_field.custom_field_options[i].raw_name")
    lcUrl = loJResp.StringOf("user_field.custom_field_options[i].url")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show User Field",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/user_fields/:user_field_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "user_fields",
        ":user_field_id"
      ],
      "variable": [
        {
          "key": "user_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/user_fields/:user_field_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "user_fields",
            ":user_field_id"
          ],
          "variable": [
            {
              "key": "user_field_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"user_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}"
    }
  ]
}