PureBasic / Support API / List Identities
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/users/:user_id/identities",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)
; {
; "identities": [
; {
; "user_id": "<integer>",
; "type": "phone_number",
; "value": "<string>",
; "created_at": "<dateTime>",
; "deliverable_state": "<string>",
; "id": "<integer>",
; "primary": "<boolean>",
; "undeliverable_count": "<integer>",
; "updated_at": "<dateTime>",
; "url": "<string>",
; "verified": "<boolean>"
; },
; {
; "user_id": "<integer>",
; "type": "google",
; "value": "<string>",
; "created_at": "<dateTime>",
; "deliverable_state": "<string>",
; "id": "<integer>",
; "primary": "<boolean>",
; "undeliverable_count": "<integer>",
; "updated_at": "<dateTime>",
; "url": "<string>",
; "verified": "<boolean>"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
user_id.s
v_type.s
value.s
created_at.s
deliverable_state.s
id.s
primary.s
undeliverable_count.s
updated_at.s
url.s
verified.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"identities")
While i < count_i
CkJsonObject::setCkI(jResp, i)
user_id = CkJsonObject::ckStringOf(jResp,"identities[i].user_id")
v_type = CkJsonObject::ckStringOf(jResp,"identities[i].type")
value = CkJsonObject::ckStringOf(jResp,"identities[i].value")
created_at = CkJsonObject::ckStringOf(jResp,"identities[i].created_at")
deliverable_state = CkJsonObject::ckStringOf(jResp,"identities[i].deliverable_state")
id = CkJsonObject::ckStringOf(jResp,"identities[i].id")
primary = CkJsonObject::ckStringOf(jResp,"identities[i].primary")
undeliverable_count = CkJsonObject::ckStringOf(jResp,"identities[i].undeliverable_count")
updated_at = CkJsonObject::ckStringOf(jResp,"identities[i].updated_at")
url = CkJsonObject::ckStringOf(jResp,"identities[i].url")
verified = CkJsonObject::ckStringOf(jResp,"identities[i].verified")
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/users/:user_id/identities
Postman Collection Item JSON
{
"name": "List Identities",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/identities",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"identities"
],
"variable": [
{
"key": "user_id",
"value": "<integer>"
}
]
},
"description": "Returns a list of identities for the given user.\n\nUse the first endpoint if authenticating as an agent. Use the second if authenticating as an end user. End users can only list email and phone number identities.\n\n#### Pagination\n\n* Cursor pagination (recommended)\n* Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Agents\n* Verified end users\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/users/:user_id/identities",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"identities"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"identities\": [\n {\n \"user_id\": \"<integer>\",\n \"type\": \"phone_number\",\n \"value\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"deliverable_state\": \"<string>\",\n \"id\": \"<integer>\",\n \"primary\": \"<boolean>\",\n \"undeliverable_count\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n {\n \"user_id\": \"<integer>\",\n \"type\": \"google\",\n \"value\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"deliverable_state\": \"<string>\",\n \"id\": \"<integer>\",\n \"primary\": \"<boolean>\",\n \"undeliverable_count\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ]\n}"
}
]
}
