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
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "data": [
// {
// "type": "user_invitations",
// "relationships": {
// "user": {
// "data": {
// "id": "<string>",
// "type": "users"
// }
// }
// }
// },
// {
// "type": "user_invitations",
// "relationships": {
// "user": {
// "data": {
// "id": "<string>",
// "type": "users"
// }
// }
// }
// }
// ]
// }
let json = CkoJsonObject()!
json.update("data[0].type", value: "user_invitations")
json.update("data[0].relationships.user.data.id", value: "<string>")
json.update("data[0].relationships.user.data.type", value: "users")
json.update("data[1].type", value: "user_invitations")
json.update("data[1].relationships.user.data.id", value: "<string>")
json.update("data[1].relationships.user.data.type", value: "users")
http.setRequestHeader("Content-Type", value: "application/json")
http.setRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.postJson3("https://api.app.ddog-gov.com/api/v2/user_invitations", contentType: "application/json", json: json)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "attributes": {
// "created_at": "<dateTime>",
// "expires_at": "<dateTime>",
// "invite_type": "<string>",
// "uuid": "<string>"
// },
// "id": "<string>",
// "relationships": {
// "user": {
// "data": {
// "id": "<string>",
// "type": "users"
// }
// }
// },
// "type": "user_invitations"
// },
// {
// "attributes": {
// "created_at": "<dateTime>",
// "expires_at": "<dateTime>",
// "invite_type": "<string>",
// "uuid": "<string>"
// },
// "id": "<string>",
// "relationships": {
// "user": {
// "data": {
// "id": "<string>",
// "type": "users"
// }
// }
// },
// "type": "user_invitations"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var Created_at: String?
var Expires_at: String?
var Invite_type: String?
var Uuid: String?
var id: String?
var Id: String?
var v_Type: String?
var v_type: String?
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "data").intValue
while i < count_i {
jResp.i = i
Created_at = jResp.string(of: "data[i].attributes.created_at")
Expires_at = jResp.string(of: "data[i].attributes.expires_at")
Invite_type = jResp.string(of: "data[i].attributes.invite_type")
Uuid = jResp.string(of: "data[i].attributes.uuid")
id = jResp.string(of: "data[i].id")
Id = jResp.string(of: "data[i].relationships.user.data.id")
v_Type = jResp.string(of: "data[i].relationships.user.data.type")
v_type = jResp.string(of: "data[i].type")
i = i + 1
}
}
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": [
{
"type": "user_invitations",
"relationships": {
"user": {
"data": {
"id": "<string>",
"type": "users"
}
}
}
},
{
"type": "user_invitations",
"relationships": {
"user": {
"data": {
"id": "<string>",
"type": "users"
}
}
}
}
]
}'
https://api.app.ddog-gov.com/api/v2/user_invitations
Postman Collection Item JSON
{
"name": "Send invitation emails",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
},
"description": "Sends emails to one or more users inviting them to join the organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"expires_at\": \"<dateTime>\",\n \"invite_type\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"user_invitations\"\n },\n {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"expires_at\": \"<dateTime>\",\n \"invite_type\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"user_invitations\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"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": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"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}"
}
]
}
