Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
http.SetRequestHeader("Accept", value: "application/json")
let sbResponseBody = CkoStringBuilder()
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/users/:user_id", sbContent: sbResponseBody)
if success == false {
print("\(http.LastErrorText)")
return
}
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = http.LastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.LastHeader)")
print("Failed.")
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "attributes": {
// "created_at": "<dateTime>",
// "disabled": "<boolean>",
// "email": "<string>",
// "handle": "<string>",
// "icon": "<string>",
// "modified_at": "<dateTime>",
// "name": "<string>",
// "service_account": "<boolean>",
// "status": "<string>",
// "title": "<string>",
// "verified": "<boolean>"
// },
// "id": "<string>",
// "relationships": {
// "org": {
// "data": {
// "id": "<string>",
// "type": "orgs"
// }
// },
// "other_orgs": {
// "data": [
// {
// "id": "<string>",
// "type": "orgs"
// },
// {
// "id": "<string>",
// "type": "orgs"
// }
// ]
// },
// "other_users": {
// "data": [
// {
// "id": "<string>",
// "type": "users"
// },
// {
// "id": "<string>",
// "type": "users"
// }
// ]
// },
// "roles": {
// "data": [
// {
// "id": "<string>",
// "type": "roles"
// },
// {
// "id": "<string>",
// "type": "roles"
// }
// ]
// }
// },
// "type": "users"
// },
// "included": [
// {
// "type": "orgs",
// "attributes": {
// "created_at": "<dateTime>",
// "description": "<string>",
// "disabled": "<boolean>",
// "modified_at": "<dateTime>",
// "name": "<string>",
// "public_id": "<string>",
// "sharing": "<string>",
// "url": "<string>"
// },
// "id": "<string>"
// },
// {
// "type": "orgs",
// "attributes": {
// "created_at": "<dateTime>",
// "description": "<string>",
// "disabled": "<boolean>",
// "modified_at": "<dateTime>",
// "name": "<string>",
// "public_id": "<string>",
// "sharing": "<string>",
// "url": "<string>"
// },
// "id": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var id: String?
var v_type: String?
var attributesCreated_at: String?
var Description: String?
var attributesDisabled: String?
var attributesModified_at: String?
var attributesName: String?
var Public_id: String?
var Sharing: String?
var v_Url: String?
var Created_at: String? = jResp.StringOf("data.attributes.created_at")
var Disabled: String? = jResp.StringOf("data.attributes.disabled")
var v_Email: String? = jResp.StringOf("data.attributes.email")
var Handle: String? = jResp.StringOf("data.attributes.handle")
var Icon: String? = jResp.StringOf("data.attributes.icon")
var Modified_at: String? = jResp.StringOf("data.attributes.modified_at")
var Name: String? = jResp.StringOf("data.attributes.name")
var Service_account: String? = jResp.StringOf("data.attributes.service_account")
var Status: String? = jResp.StringOf("data.attributes.status")
var Title: String? = jResp.StringOf("data.attributes.title")
var Verified: String? = jResp.StringOf("data.attributes.verified")
var Id: String? = jResp.StringOf("data.id")
var DataId: String? = jResp.StringOf("data.relationships.org.data.id")
var v_Type: String? = jResp.StringOf("data.relationships.org.data.type")
var dataType: String? = jResp.StringOf("data.type")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("data.relationships.other_orgs.data").intValue
while i < count_i {
jResp.I = i
id = jResp.StringOf("data.relationships.other_orgs.data[i].id")
v_type = jResp.StringOf("data.relationships.other_orgs.data[i].type")
i = i + 1
}
i = 0
count_i = jResp.SizeOfArray("data.relationships.other_users.data").intValue
while i < count_i {
jResp.I = i
id = jResp.StringOf("data.relationships.other_users.data[i].id")
v_type = jResp.StringOf("data.relationships.other_users.data[i].type")
i = i + 1
}
i = 0
count_i = jResp.SizeOfArray("data.relationships.roles.data").intValue
while i < count_i {
jResp.I = i
id = jResp.StringOf("data.relationships.roles.data[i].id")
v_type = jResp.StringOf("data.relationships.roles.data[i].type")
i = i + 1
}
i = 0
count_i = jResp.SizeOfArray("included").intValue
while i < count_i {
jResp.I = i
v_type = jResp.StringOf("included[i].type")
attributesCreated_at = jResp.StringOf("included[i].attributes.created_at")
Description = jResp.StringOf("included[i].attributes.description")
attributesDisabled = jResp.StringOf("included[i].attributes.disabled")
attributesModified_at = jResp.StringOf("included[i].attributes.modified_at")
attributesName = jResp.StringOf("included[i].attributes.name")
Public_id = jResp.StringOf("included[i].attributes.public_id")
Sharing = jResp.StringOf("included[i].attributes.sharing")
v_Url = jResp.StringOf("included[i].attributes.url")
id = jResp.StringOf("included[i].id")
i = i + 1
}
}
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/users/:user_id
Postman Collection Item JSON
{
"name": "Get user details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id",
"value": "<string>"
}
]
},
"description": "Get a user in the organization specified by the user’s `user_id`."
},
"response": [
{
"name": "OK for get user",
"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_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"service_account\": \"<boolean>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n ]\n },\n \"other_users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"disabled\": \"<boolean>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"public_id\": \"<string>\",\n \"sharing\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"id\": \"<string>\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"disabled\": \"<boolean>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"public_id\": \"<string>\",\n \"sharing\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Authentication error",
"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_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not found",
"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_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"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_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"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}"
}
]
}
