Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "email": "<string>",
; "role": "<string>",
; "first_name": "<string>",
; "last_name": "<string>"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"email","<string>")
CkJsonObject::ckUpdateString(json,"role","<string>")
CkJsonObject::ckUpdateString(json,"first_name","<string>")
CkJsonObject::ckUpdateString(json,"last_name","<string>")
CkHttp::ckSetRequestHeader(http,"Authorization","")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api.squadcast.com/v3/users","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "id": "5e9c204dbde1298f6bcb5ef2",
; "first_name": "Manigandan",
; "last_name": "Dharmalingam",
; "email": "manigandan@squadcast.com",
; "contact": {
; "dial_code": "",
; "phone_number": ""
; },
; "secondary_emails": null,
; "email_verified": false,
; "time_zone": "",
; "title": "",
; "bio": "",
; "notification_rules": [
; {
; "type": "Email",
; "time": 0
; },
; {
; "type": "Push",
; "time": 0
; },
; {
; "type": "SMS",
; "time": 1
; },
; {
; "type": "Phone",
; "time": 2
; }
; ],
; "user_image": false
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
v_type.s
time.i
Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
First_name.s = CkJsonObject::ckStringOf(jResp,"data.first_name")
Last_name.s = CkJsonObject::ckStringOf(jResp,"data.last_name")
v_Email.s = CkJsonObject::ckStringOf(jResp,"data.email")
Dial_code.s = CkJsonObject::ckStringOf(jResp,"data.contact.dial_code")
Phone_number.s = CkJsonObject::ckStringOf(jResp,"data.contact.phone_number")
Secondary_emails.s = CkJsonObject::ckStringOf(jResp,"data.secondary_emails")
Email_verified.i = CkJsonObject::ckBoolOf(jResp,"data.email_verified")
Time_zone.s = CkJsonObject::ckStringOf(jResp,"data.time_zone")
Title.s = CkJsonObject::ckStringOf(jResp,"data.title")
Bio.s = CkJsonObject::ckStringOf(jResp,"data.bio")
User_image.i = CkJsonObject::ckBoolOf(jResp,"data.user_image")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.notification_rules")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_type = CkJsonObject::ckStringOf(jResp,"data.notification_rules[i].type")
time = CkJsonObject::ckIntOf(jResp,"data.notification_rules[i].time")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: "
-H "Content-Type: application/json"
-d '{
"email": "<string>",
"role": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}'
https://api.squadcast.com/v3/users
Postman Collection Item JSON
{
"name": "Add User",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"<string>\",\n \"role\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
},
"description": "Add user to the organization with given role if not exists. Returns the user object in response. \nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope."
},
"response": [
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"manigandan@squadcast.com\",\n \"role\": \"admin\",\n \"first_name\": \"Manigandan\",\n \"last_name\": \"Dharmalingam\"\n}"
},
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"manigandan@squadcast.com\",\n \"role\": \"admin\",\n \"first_name\": \"Manigandan\",\n \"last_name\": \"Dharmalingam\"\n}"
},
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"manigandan@squadcast.com\",\n \"role\": \"admin\",\n \"first_name\": \"Manigandan\",\n \"last_name\": \"Dharmalingam\"\n}"
},
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"5e9c204dbde1298f6bcb5ef2\",\n \"first_name\": \"Manigandan\",\n \"last_name\": \"Dharmalingam\",\n \"email\": \"manigandan@squadcast.com\",\n \"contact\": {\n \"dial_code\": \"\",\n \"phone_number\": \"\"\n },\n \"secondary_emails\": null,\n \"email_verified\": false,\n \"time_zone\": \"\",\n \"title\": \"\",\n \"bio\": \"\",\n \"notification_rules\": [\n {\n \"type\": \"Email\",\n \"time\": 0\n },\n {\n \"type\": \"Push\",\n \"time\": 0\n },\n {\n \"type\": \"SMS\",\n \"time\": 1\n },\n {\n \"type\": \"Phone\",\n \"time\": 2\n }\n ],\n \"user_image\": false\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"manigandan@squadcast.com\",\n \"role\": \"admin\",\n \"first_name\": \"Manigandan\",\n \"last_name\": \"Dharmalingam\"\n}"
},
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 400,\n \"error_message\": \"email required\"\n }\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"manigandan@squadcast.com\",\n \"role\": \"admin\",\n \"first_name\": \"Manigandan\",\n \"last_name\": \"Dharmalingam\"\n}"
},
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 409,\n \"error_message\": \"cannot add same user manigandan2293@gmail.com again to the organization\"\n }\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"manigandan@squadcast.com\",\n \"role\": \"admin\",\n \"first_name\": \"Manigandan\",\n \"last_name\": \"Dharmalingam\"\n}"
},
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 401,\n \"error_message\": \"invalid access token\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"manigandan@squadcast.com\",\n \"role\": \"admin\",\n \"first_name\": \"Manigandan\",\n \"last_name\": \"Dharmalingam\"\n}"
},
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
}
]
}
