Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "username"
$oHttp.Password = "password"
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "externalId": "your-own-id",
; "signedUpAt": "2020-05-21T15:53:30.197Z",
; "profile": {
; "givenName": "Jane",
; "surname": "Doe",
; "email": "jane.doe@gmail.com",
; "avatarUrl": "https://s3.amazonaws.com/avatar.jpg"
; },
; "metadata": {
; "lang": "en-ca"
; }
; }
$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateString("externalId","your-own-id")
$oJson.UpdateString("signedUpAt","2020-05-21T15:53:30.197Z")
$oJson.UpdateString("profile.givenName","Jane")
$oJson.UpdateString("profile.surname","Doe")
$oJson.UpdateString("profile.email","jane.doe@gmail.com")
$oJson.UpdateString("profile.avatarUrl","https://s3.amazonaws.com/avatar.jpg")
$oJson.UpdateString("metadata.lang","en-ca")
$oHttp.SetRequestHeader "Content-Type","application/json"
Local $oResp = $oHttp.PostJson3("https://domain.com/","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "user": {
; "id": "7494535bff5cef41a15be74d",
; "externalId": "your-own-id",
; "signedUpAt": "2020-05-21T15:53:30.197Z",
; "profile": {
; "givenName": "Jane",
; "surname": "Doe",
; "email": "jane.doe@gmail.com",
; "avatarUrl": "https://s3.amazonaws.com/avatar.jpg"
; },
; "metadata": {
; "lang": "en-ca"
; }
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sId = $oJResp.StringOf("user.id")
Local $sExternalId = $oJResp.StringOf("user.externalId")
Local $sSignedUpAt = $oJResp.StringOf("user.signedUpAt")
Local $sGivenName = $oJResp.StringOf("user.profile.givenName")
Local $sSurname = $oJResp.StringOf("user.profile.surname")
Local $sV_Email = $oJResp.StringOf("user.profile.email")
Local $sAvatarUrl = $oJResp.StringOf("user.profile.avatarUrl")
Local $sLang = $oJResp.StringOf("user.metadata.lang")
Curl Command
curl -X POST
-u 'username:password'
-H "Content-Type: application/json"
-d '{
"externalId": "your-own-id",
"signedUpAt": "2020-05-21T15:53:30.197Z",
"profile": {
"givenName": "Jane",
"surname": "Doe",
"email": "jane.doe@gmail.com",
"avatarUrl": "https://s3.amazonaws.com/avatar.jpg"
},
"metadata": {
"lang": "en-ca"
}
}'
https://domain.com/
Postman Collection Item JSON
{
"name": "Create User",
"_postman_id": "44749d06-472c-4409-82b1-abc8a22ad666",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"externalId\": \"your-own-id\",\n \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n \"profile\": {\n \"givenName\": \"Jane\",\n \"surname\": \"Doe\",\n \"email\": \"jane.doe@gmail.com\",\n \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": "{{url}}/v2/apps/{{appId}}/users",
"description": "Creates a new user."
},
"response": [
{
"id": "2f2a4e6e-0d1a-4483-b30d-160379704ff5",
"name": "User already exists",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"externalId\": \"your-own-id\",\n \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n \"profile\": {\n \"givenName\": \"Jane\",\n \"surname\": \"Doe\",\n \"email\": \"jane.doe@gmail.com\",\n \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/users",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"users"
],
"variable": [
{
"key": "appId"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"id": "6a8ada4a-ff1f-4176-9d03-904fbc145bb6",
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"externalId\": \"your-own-id\",\n \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n \"profile\": {\n \"givenName\": \"Jane\",\n \"surname\": \"Doe\",\n \"email\": \"jane.doe@gmail.com\",\n \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/users",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"users"
],
"variable": [
{
"key": "appId"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"user\": {\n \"id\": \"7494535bff5cef41a15be74d\",\n \"externalId\": \"your-own-id\",\n \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n \"profile\": {\n \"givenName\": \"Jane\",\n \"surname\": \"Doe\",\n \"email\": \"jane.doe@gmail.com\",\n \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n }\n}"
}
]
}
