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::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://api.app.ddog-gov.com/api/v2/users/:user_uuid/memberships",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)
; {
; "data": [
; {
; "id": "<string>",
; "type": "team_memberships",
; "attributes": {
; "role": "admin"
; },
; "relationships": {
; "user": {
; "data": {
; "id": "<string>",
; "type": "users"
; }
; }
; }
; },
; {
; "id": "<string>",
; "type": "team_memberships",
; "attributes": {
; "role": "admin"
; },
; "relationships": {
; "user": {
; "data": {
; "id": "<string>",
; "type": "users"
; }
; }
; }
; }
; ],
; "links": {
; "first": "<string>",
; "last": "<string>",
; "next": "<string>",
; "prev": "<string>",
; "self": "<string>"
; },
; "meta": {
; "pagination": {
; "first_offset": "<long>",
; "last_offset": "<long>",
; "limit": "<long>",
; "next_offset": "<long>",
; "offset": "<long>",
; "prev_offset": "<long>",
; "total": "<long>",
; "type": "<string>"
; }
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s
v_type.s
Role.s
Id.s
DataType.s
First.s = CkJsonObject::ckStringOf(jResp,"links.first")
Last.s = CkJsonObject::ckStringOf(jResp,"links.last")
v_Next.s = CkJsonObject::ckStringOf(jResp,"links.next")
Prev.s = CkJsonObject::ckStringOf(jResp,"links.prev")
v_Self.s = CkJsonObject::ckStringOf(jResp,"links.self")
First_offset.s = CkJsonObject::ckStringOf(jResp,"meta.pagination.first_offset")
Last_offset.s = CkJsonObject::ckStringOf(jResp,"meta.pagination.last_offset")
Limit.s = CkJsonObject::ckStringOf(jResp,"meta.pagination.limit")
Next_offset.s = CkJsonObject::ckStringOf(jResp,"meta.pagination.next_offset")
Offset.s = CkJsonObject::ckStringOf(jResp,"meta.pagination.offset")
Prev_offset.s = CkJsonObject::ckStringOf(jResp,"meta.pagination.prev_offset")
Total.s = CkJsonObject::ckStringOf(jResp,"meta.pagination.total")
v_Type.s = CkJsonObject::ckStringOf(jResp,"meta.pagination.type")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data[i].id")
v_type = CkJsonObject::ckStringOf(jResp,"data[i].type")
Role = CkJsonObject::ckStringOf(jResp,"data[i].attributes.role")
Id = CkJsonObject::ckStringOf(jResp,"data[i].relationships.user.data.id")
DataType = CkJsonObject::ckStringOf(jResp,"data[i].relationships.user.data.type")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/users/:user_uuid/memberships
Postman Collection Item JSON
{
"name": "Get user memberships",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid",
"value": "<string>"
}
]
},
"description": "Get a list of memberships for a user"
},
"response": [
{
"name": "Represents a user's association to a team",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"<string>\",\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"first\": \"<string>\",\n \"last\": \"<string>\",\n \"next\": \"<string>\",\n \"prev\": \"<string>\",\n \"self\": \"<string>\"\n },\n \"meta\": {\n \"pagination\": {\n \"first_offset\": \"<long>\",\n \"last_offset\": \"<long>\",\n \"limit\": \"<long>\",\n \"next_offset\": \"<long>\",\n \"offset\": \"<long>\",\n \"prev_offset\": \"<long>\",\n \"total\": \"<long>\",\n \"type\": \"<string>\"\n }\n }\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}