Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Contacts Ordered

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcValue
LOCAL i
LOCAL lnCount_i

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Use this online tool to generate code from sample JSON: Generate Code to Create JSON

* The following JSON is sent in the request body.

* {
*   "query": "query contactsOrderBy {\n  uiapi {\n    query {\n      Contact(orderBy: { Name: { order: ASC }}) {\n        edges {\n          node {\n            Id\n            Name {\n              value\n            }\n          }\n        }\n      }\n    }\n  }\n}",
*   "variables": ""
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("query","query contactsOrderBy {" + CHR(10) + "  uiapi {" + CHR(10) + "    query {" + CHR(10) + "      Contact(orderBy: { Name: { order: ASC }}) {" + CHR(10) + "        edges {" + CHR(10) + "          node {" + CHR(10) + "            Id" + CHR(10) + "            Name {" + CHR(10) + "              value" + CHR(10) + "            }" + CHR(10) + "          }" + CHR(10) + "        }" + CHR(10) + "      }" + CHR(10) + "    }" + CHR(10) + "  }" + CHR(10) + "}")
loJson.UpdateString("variables","")

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("X-Chatter-Entity-Encoding","false")

loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/graphql","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)

* {
*   "data": {
*     "uiapi": {
*       "query": {
*         "Contact": {
*           "edges": [
*             {
*               "node": {
*                 "Id": "00358000006c0n7AAA",
*                 "Name": {
*                   "value": "Alice Black"
*                 }
*               }
*             },
*             {
*               "node": {
*                 "Id": "0035800000iXli3AAC",
*                 "Name": {
*                   "value": "Amanda Smith"
*                 }
*               }
*             },
*             {
*               "node": {
*                 "Id": "00358000006woxyAAA",
*                 "Name": {
*                   "value": "Andy Young"
*                 }
*               }
*             },
*             {
*               "node": {
*                 "Id": "00358000006woy6AAA",
*                 "Name": {
*                   "value": "Arthur Song"
*                 }
*               }
*             },
*             {
*               "node": {
*                 "Id": "00358000006woy7AAA",
*                 "Name": {
*                   "value": "Ashley James"
*                 }
*               }
*             },
*             {
*               "node": {
*                 "Id": "00358000006woyBAAQ",
*                 "Name": {
*                   "value": "Avi Green"
*                 }
*               }
*             },
*             {
*               "node": {
*                 "Id": "00358000006woy3AAA",
*                 "Name": {
*                   "value": "Babara Levy"
*                 }
*               }
*             },
*             {
*               "node": {
*                 "Id": "00358000006c0n6AAA",
*                 "Name": {
*                   "value": "Basil Wenceslas"
*                 }
*               }
*             },
*             {
*               "node": {
*                 "Id": "0034H000029oY0FQAU",
*                 "Name": {
*                   "value": "Contact One"
*                 }
*               }
*             },
*             {
*               "node": {
*                 "Id": "0034H000029oY0HQAU",
*                 "Name": {
*                   "value": "Contact Three"
*                 }
*               }
*             }
*           ]
*         }
*       }
*     }
*   },
*   "errors": [
*   ]
* }

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

i = 0
lnCount_i = loJResp.SizeOfArray("data.uiapi.query.Contact.edges")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("data.uiapi.query.Contact.edges[i].node.Id")
    lcValue = loJResp.StringOf("data.uiapi.query.Contact.edges[i].node.Name.value")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("errors")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "X-Chatter-Entity-Encoding: false"
	--data-raw '{"query":"query contactsOrderBy {\n  uiapi {\n    query {\n      Contact(orderBy: { Name: { order: ASC }}) {\n        edges {\n          node {\n            Id\n            Name {\n              value\n            }\n          }\n        }\n      }\n    }\n  }\n}","variables":""}'
https://domain.com/services/data/v{{version}}/graphql

Postman Collection Item JSON

{
  "name": "Contacts Ordered",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-Chatter-Entity-Encoding",
        "value": "false",
        "type": "text"
      }
    ],
    "body": {
      "mode": "graphql",
      "graphql": {
        "query": "query contactsOrderBy {\n  uiapi {\n    query {\n      Contact(orderBy: { Name: { order: ASC }}) {\n        edges {\n          node {\n            Id\n            Name {\n              value\n            }\n          }\n        }\n      }\n    }\n  }\n}",
        "variables": ""
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/graphql",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "graphql"
      ]
    }
  },
  "response": [
    {
      "name": "Contacts Ordered",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "X-Chatter-Entity-Encoding",
            "value": "false"
          }
        ],
        "body": {
          "mode": "graphql",
          "graphql": {
            "query": "query contactsOrderBy {\n  uiapi {\n    query {\n      Contact(orderBy: { Name: { order: ASC }}) {\n        edges {\n          node {\n            Id\n            Name {\n              value\n            }\n          }\n        }\n      }\n    }\n  }\n}",
            "variables": ""
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/graphql",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "graphql"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 09:06:30 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": "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    \"data\": {\n        \"uiapi\": {\n            \"query\": {\n                \"Contact\": {\n                    \"edges\": [\n                        {\n                            \"node\": {\n                                \"Id\": \"00358000006c0n7AAA\",\n                                \"Name\": {\n                                    \"value\": \"Alice Black\"\n                                }\n                            }\n                        },\n                        {\n                            \"node\": {\n                                \"Id\": \"0035800000iXli3AAC\",\n                                \"Name\": {\n                                    \"value\": \"Amanda Smith\"\n                                }\n                            }\n                        },\n                        {\n                            \"node\": {\n                                \"Id\": \"00358000006woxyAAA\",\n                                \"Name\": {\n                                    \"value\": \"Andy Young\"\n                                }\n                            }\n                        },\n                        {\n                            \"node\": {\n                                \"Id\": \"00358000006woy6AAA\",\n                                \"Name\": {\n                                    \"value\": \"Arthur Song\"\n                                }\n                            }\n                        },\n                        {\n                            \"node\": {\n                                \"Id\": \"00358000006woy7AAA\",\n                                \"Name\": {\n                                    \"value\": \"Ashley James\"\n                                }\n                            }\n                        },\n                        {\n                            \"node\": {\n                                \"Id\": \"00358000006woyBAAQ\",\n                                \"Name\": {\n                                    \"value\": \"Avi Green\"\n                                }\n                            }\n                        },\n                        {\n                            \"node\": {\n                                \"Id\": \"00358000006woy3AAA\",\n                                \"Name\": {\n                                    \"value\": \"Babara Levy\"\n                                }\n                            }\n                        },\n                        {\n                            \"node\": {\n                                \"Id\": \"00358000006c0n6AAA\",\n                                \"Name\": {\n                                    \"value\": \"Basil Wenceslas\"\n                                }\n                            }\n                        },\n                        {\n                            \"node\": {\n                                \"Id\": \"0034H000029oY0FQAU\",\n                                \"Name\": {\n                                    \"value\": \"Contact One\"\n                                }\n                            }\n                        },\n                        {\n                            \"node\": {\n                                \"Id\": \"0034H000029oY0HQAU\",\n                                \"Name\": {\n                                    \"value\": \"Contact Three\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            }\n        }\n    },\n    \"errors\": []\n}"
    }
  ]
}