Foxpro / Support API / Get sources by target
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcName
LOCAL lcActive
LOCAL lcAlias
LOCAL lcChat_only
LOCAL lcCreated_at
LOCAL lcCustom_role_id
LOCAL lcDefault_group_id
LOCAL lcDetails
LOCAL lcEmail
LOCAL lcExternal_id
LOCAL lcIana_time_zone
LOCAL lcId
LOCAL lcLast_login_at
LOCAL lcLocale
LOCAL lcLocale_id
LOCAL lcModerator
LOCAL lcNotes
LOCAL lcOnly_private_comments
LOCAL lcOrganization_id
LOCAL lcPhone
LOCAL lnIn1f
LOCAL lnCillumb5
LOCAL lcRemote_photo_url
LOCAL lcReport_csv
LOCAL lcRestricted_agent
LOCAL lcRole
LOCAL lcRole_type
LOCAL lcV_shared
LOCAL lcShared_agent
LOCAL lcShared_phone_number
LOCAL lcSignature
LOCAL lcSuspended
LOCAL lcTags
LOCAL lcTicket_restriction
LOCAL lcTime_zone
LOCAL lcTwo_factor_auth_enabled
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL lcNisi_e
LOCAL lcVerified
LOCAL lnUt69
LOCAL lnMagna_4
LOCAL lnLoremcc
LOCAL lnDolore7
LOCAL lcPariaturf
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/:target_type/:target_id/relationship_fields/:field_id/:source_type",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)
* {
* "users": [
* {
* "name": "<string>",
* "active": "<boolean>",
* "alias": "<string>",
* "chat_only": "<boolean>",
* "created_at": "<string>",
* "custom_role_id": "<integer>",
* "default_group_id": "<integer>",
* "details": "<string>",
* "email": "<string>",
* "external_id": "<string>",
* "iana_time_zone": "<string>",
* "id": "<integer>",
* "last_login_at": "<string>",
* "locale": "<string>",
* "locale_id": "<integer>",
* "moderator": "<boolean>",
* "notes": "<string>",
* "only_private_comments": "<boolean>",
* "organization_id": "<integer>",
* "phone": "<string>",
* "photo": {
* "in1f": false,
* "cillumb5": true
* },
* "remote_photo_url": "<string>",
* "report_csv": "<boolean>",
* "restricted_agent": "<boolean>",
* "role": "<string>",
* "role_type": "<integer>",
* "shared": "<boolean>",
* "shared_agent": "<boolean>",
* "shared_phone_number": "<boolean>",
* "signature": "<string>",
* "suspended": "<boolean>",
* "tags": "<array>",
* "ticket_restriction": "<string>",
* "time_zone": "<string>",
* "two_factor_auth_enabled": "<boolean>",
* "updated_at": "<string>",
* "url": "<string>",
* "user_fields": {
* "nisi_e": "commodo exercitation consequat"
* },
* "verified": "<boolean>"
* },
* {
* "name": "<string>",
* "active": "<boolean>",
* "alias": "<string>",
* "chat_only": "<boolean>",
* "created_at": "<string>",
* "custom_role_id": "<integer>",
* "default_group_id": "<integer>",
* "details": "<string>",
* "email": "<string>",
* "external_id": "<string>",
* "iana_time_zone": "<string>",
* "id": "<integer>",
* "last_login_at": "<string>",
* "locale": "<string>",
* "locale_id": "<integer>",
* "moderator": "<boolean>",
* "notes": "<string>",
* "only_private_comments": "<boolean>",
* "organization_id": "<integer>",
* "phone": "<string>",
* "photo": {
* "ut69": true,
* "magna_4": -92520384
* },
* "remote_photo_url": "<string>",
* "report_csv": "<boolean>",
* "restricted_agent": "<boolean>",
* "role": "<string>",
* "role_type": "<integer>",
* "shared": "<boolean>",
* "shared_agent": "<boolean>",
* "shared_phone_number": "<boolean>",
* "signature": "<string>",
* "suspended": "<boolean>",
* "tags": "<array>",
* "ticket_restriction": "<string>",
* "time_zone": "<string>",
* "two_factor_auth_enabled": "<boolean>",
* "updated_at": "<string>",
* "url": "<string>",
* "user_fields": {
* "Loremcc": 52379422,
* "dolore7": true,
* "pariaturf": "magna consectet"
* },
* "verified": "<boolean>"
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
lnCount_i = loJResp.SizeOfArray("users")
DO WHILE i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("users[i].name")
lcActive = loJResp.StringOf("users[i].active")
lcAlias = loJResp.StringOf("users[i].alias")
lcChat_only = loJResp.StringOf("users[i].chat_only")
lcCreated_at = loJResp.StringOf("users[i].created_at")
lcCustom_role_id = loJResp.StringOf("users[i].custom_role_id")
lcDefault_group_id = loJResp.StringOf("users[i].default_group_id")
lcDetails = loJResp.StringOf("users[i].details")
lcEmail = loJResp.StringOf("users[i].email")
lcExternal_id = loJResp.StringOf("users[i].external_id")
lcIana_time_zone = loJResp.StringOf("users[i].iana_time_zone")
lcId = loJResp.StringOf("users[i].id")
lcLast_login_at = loJResp.StringOf("users[i].last_login_at")
lcLocale = loJResp.StringOf("users[i].locale")
lcLocale_id = loJResp.StringOf("users[i].locale_id")
lcModerator = loJResp.StringOf("users[i].moderator")
lcNotes = loJResp.StringOf("users[i].notes")
lcOnly_private_comments = loJResp.StringOf("users[i].only_private_comments")
lcOrganization_id = loJResp.StringOf("users[i].organization_id")
lcPhone = loJResp.StringOf("users[i].phone")
lnIn1f = loJResp.BoolOf("users[i].photo.in1f")
lnCillumb5 = loJResp.BoolOf("users[i].photo.cillumb5")
lcRemote_photo_url = loJResp.StringOf("users[i].remote_photo_url")
lcReport_csv = loJResp.StringOf("users[i].report_csv")
lcRestricted_agent = loJResp.StringOf("users[i].restricted_agent")
lcRole = loJResp.StringOf("users[i].role")
lcRole_type = loJResp.StringOf("users[i].role_type")
lcV_shared = loJResp.StringOf("users[i].shared")
lcShared_agent = loJResp.StringOf("users[i].shared_agent")
lcShared_phone_number = loJResp.StringOf("users[i].shared_phone_number")
lcSignature = loJResp.StringOf("users[i].signature")
lcSuspended = loJResp.StringOf("users[i].suspended")
lcTags = loJResp.StringOf("users[i].tags")
lcTicket_restriction = loJResp.StringOf("users[i].ticket_restriction")
lcTime_zone = loJResp.StringOf("users[i].time_zone")
lcTwo_factor_auth_enabled = loJResp.StringOf("users[i].two_factor_auth_enabled")
lcUpdated_at = loJResp.StringOf("users[i].updated_at")
lcUrl = loJResp.StringOf("users[i].url")
lcNisi_e = loJResp.StringOf("users[i].user_fields.nisi_e")
lcVerified = loJResp.StringOf("users[i].verified")
lnUt69 = loJResp.BoolOf("users[i].photo.ut69")
lnMagna_4 = loJResp.IntOf("users[i].photo.magna_4")
lnLoremcc = loJResp.IntOf("users[i].user_fields.Loremcc")
lnDolore7 = loJResp.BoolOf("users[i].user_fields.dolore7")
lcPariaturf = loJResp.StringOf("users[i].user_fields.pariaturf")
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/:target_type/:target_id/relationship_fields/:field_id/:source_type
Postman Collection Item JSON
{
"name": "Get sources by target",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/:target_type/:target_id/relationship_fields/:field_id/:source_type",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
":target_type",
":target_id",
"relationship_fields",
":field_id",
":source_type"
],
"variable": [
{
"key": "target_type",
"value": "<string>"
},
{
"key": "target_id",
"value": "<integer>"
},
{
"key": "field_id",
"value": "<integer>"
},
{
"key": "source_type",
"value": "<string>"
}
]
},
"description": "Returns a list of source objects whose values are populated with the id of a related target object. For example,\nif you have a lookup field called \"Success Manager\" on a ticket, this endpoint can answer the question,\n\"What tickets (sources) is this user (found by `target_type` and `target_id`)\nassigned as the 'Success Manager' (field referenced by `field_id`)?\"\n\n#### 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/:target_type/:target_id/relationship_fields/:field_id/:source_type",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
":target_type",
":target_id",
"relationship_fields",
":field_id",
":source_type"
],
"variable": [
{
"key": "target_type"
},
{
"key": "target_id"
},
{
"key": "field_id"
},
{
"key": "source_type"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"users\": [\n {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"in1f\": false,\n \"cillumb5\": true\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"nisi_e\": \"commodo exercitation consequat\"\n },\n \"verified\": \"<boolean>\"\n },\n {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"ut69\": true,\n \"magna_4\": -92520384\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"Loremcc\": 52379422,\n \"dolore7\": true,\n \"pariaturf\": \"magna consectet\"\n },\n \"verified\": \"<boolean>\"\n }\n ]\n}"
}
]
}
