Chilkat Online Tools

PureBasic / Salesforce Platform APIs / Publish single event

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.

    ; {
    ;   "Annual_Mileage__c": 12000,
    ;   "Current_Vehicle__c": "Fast car",
    ;   "Model_Year__c": 2019
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateInt(json,"Annual_Mileage__c",12000)
    CkJsonObject::ckUpdateString(json,"Current_Vehicle__c","Fast car")
    CkJsonObject::ckUpdateInt(json,"Model_Year__c",2019)

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/sobjects/:EventApiName/","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)

    ; {
    ;   "id": "e00xx0000000001AAA",
    ;   "success": true,
    ;   "errors": [
    ;     {
    ;       "statusCode": "OPERATION_ENQUEUED",
    ;       "message": "234995b6-53b6-4887-93fc-ecd0fac8b36c",
    ;       "fields": [
    ;       ]
    ;     }
    ;   ]
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    statusCode.s
    message.s
    j.i
    count_j.i

    id.s = CkJsonObject::ckStringOf(jResp,"id")
    success.i = CkJsonObject::ckBoolOf(jResp,"success")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"errors")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        statusCode = CkJsonObject::ckStringOf(jResp,"errors[i].statusCode")
        message = CkJsonObject::ckStringOf(jResp,"errors[i].message")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"errors[i].fields")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            j = j + 1
        Wend
        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: Bearer <access_token>"
	-d '{
    "Annual_Mileage__c": 12000,
    "Current_Vehicle__c": "Fast car",
    "Model_Year__c": 2019
}'
https://domain.com/services/data/v{{version}}/sobjects/:EventApiName/

Postman Collection Item JSON

{
  "name": "Publish single event",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"Annual_Mileage__c\": 12000,\n    \"Current_Vehicle__c\": \"Fast car\",\n    \"Model_Year__c\": 2019\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/sobjects/:EventApiName/",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "sobjects",
        ":EventApiName",
        ""
      ],
      "variable": [
        {
          "key": "EventApiName",
          "value": "Carbon_Comparison__e"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Publish single event",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"Message__c\": \"Hello World!\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/sobjects/:EventApiName/",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "sobjects",
            ":EventApiName",
            ""
          ],
          "variable": [
            {
              "key": "EventApiName",
              "value": "Sample__e"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 03 Jul 2023 13:18:20 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=16/15000"
        },
        {
          "key": "Location",
          "value": "/services/data/v58.0/sobjects/Sample__e/e00xx0000000001AAA"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"id\": \"e00xx0000000001AAA\",\n    \"success\": true,\n    \"errors\": [\n        {\n            \"statusCode\": \"OPERATION_ENQUEUED\",\n            \"message\": \"234995b6-53b6-4887-93fc-ecd0fac8b36c\",\n            \"fields\": []\n        }\n    ]\n}"
    }
  ]
}