Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// 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"
// }
// }
// }
// }
// ]
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"data[0].type" value: @"user_invitations"];
[json UpdateString: @"data[0].relationships.user.data.id" value: @"<string>"];
[json UpdateString: @"data[0].relationships.user.data.type" value: @"users"];
[json UpdateString: @"data[1].type" value: @"user_invitations"];
[json UpdateString: @"data[1].relationships.user.data.id" value: @"<string>"];
[json UpdateString: @"data[1].relationships.user.data.type" value: @"users"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http PostJson3: @"https://api.app.ddog-gov.com/api/v2/user_invitations" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *Created_at = 0;
NSString *Expires_at = 0;
NSString *Invite_type = 0;
NSString *Uuid = 0;
NSString *id = 0;
NSString *Id = 0;
NSString *v_Type = 0;
NSString *v_type = 0;
int i = 0;
int count_i = [[jResp SizeOfArray: @"data"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
Created_at = [jResp StringOf: @"data[i].attributes.created_at"];
Expires_at = [jResp StringOf: @"data[i].attributes.expires_at"];
Invite_type = [jResp StringOf: @"data[i].attributes.invite_type"];
Uuid = [jResp StringOf: @"data[i].attributes.uuid"];
id = [jResp StringOf: @"data[i].id"];
Id = [jResp StringOf: @"data[i].relationships.user.data.id"];
v_Type = [jResp StringOf: @"data[i].relationships.user.data.type"];
v_type = [jResp StringOf: @"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}"
}
]
}