Chilkat Online Tools

Foxpro / easybill REST API / Update Contact

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCity
LOCAL lcStreet
LOCAL lcState
LOCAL lcCompany_name
LOCAL lcCountry
LOCAL lcDepartment
LOCAL lcFax
LOCAL lcFirst_name
LOCAL lcId
LOCAL lcLast_name
LOCAL lcLogin_id
LOCAL lcMobile
LOCAL lcNote
LOCAL lnPersonal
LOCAL lcPhone_1
LOCAL lcPhone_2
LOCAL lcSalutation
LOCAL lcSuffix_1
LOCAL lcSuffix_2
LOCAL lcTitle
LOCAL lcZip_code
LOCAL lcCreated_at
LOCAL lcUpdated_at

* 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.

* {
*   "city": "<string>",
*   "street": "<string>",
*   "state": "<string>",
*   "company_name": "<string>",
*   "country": "<string>",
*   "department": null,
*   "fax": null,
*   "first_name": null,
*   "id": "<long>",
*   "last_name": null,
*   "login_id": "<long>",
*   "mobile": null,
*   "note": null,
*   "personal": false,
*   "phone_1": null,
*   "phone_2": null,
*   "salutation": "<integer>",
*   "suffix_1": null,
*   "suffix_2": null,
*   "title": null,
*   "zip_code": null,
*   "created_at": "<string>",
*   "updated_at": "<string>"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("city","<string>")
loJson.UpdateString("street","<string>")
loJson.UpdateString("state","<string>")
loJson.UpdateString("company_name","<string>")
loJson.UpdateString("country","<string>")
loJson.UpdateNull("department")
loJson.UpdateNull("fax")
loJson.UpdateNull("first_name")
loJson.UpdateString("id","<long>")
loJson.UpdateNull("last_name")
loJson.UpdateString("login_id","<long>")
loJson.UpdateNull("mobile")
loJson.UpdateNull("note")
loJson.UpdateBool("personal",0)
loJson.UpdateNull("phone_1")
loJson.UpdateNull("phone_2")
loJson.UpdateString("salutation","<integer>")
loJson.UpdateNull("suffix_1")
loJson.UpdateNull("suffix_2")
loJson.UpdateNull("title")
loJson.UpdateNull("zip_code")
loJson.UpdateString("created_at","<string>")
loJson.UpdateString("updated_at","<string>")

loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Authorization","{{apiKey}}")
loHttp.SetRequestHeader("Accept","application/json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://api.easybill.de/rest/v1/customers/:customerId/contacts/:id",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    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 loSbRequestBody
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

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

* {
*   "city": "<string>",
*   "street": "<string>",
*   "state": "<string>",
*   "company_name": "<string>",
*   "country": "<string>",
*   "department": null,
*   "fax": null,
*   "first_name": null,
*   "id": "<long>",
*   "last_name": null,
*   "login_id": "<long>",
*   "mobile": null,
*   "note": null,
*   "personal": false,
*   "phone_1": null,
*   "phone_2": null,
*   "salutation": "<integer>",
*   "suffix_1": null,
*   "suffix_2": null,
*   "title": null,
*   "zip_code": null,
*   "created_at": "<string>",
*   "updated_at": "<string>"
* }

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

lcCity = loJResp.StringOf("city")
lcStreet = loJResp.StringOf("street")
lcState = loJResp.StringOf("state")
lcCompany_name = loJResp.StringOf("company_name")
lcCountry = loJResp.StringOf("country")
lcDepartment = loJResp.StringOf("department")
lcFax = loJResp.StringOf("fax")
lcFirst_name = loJResp.StringOf("first_name")
lcId = loJResp.StringOf("id")
lcLast_name = loJResp.StringOf("last_name")
lcLogin_id = loJResp.StringOf("login_id")
lcMobile = loJResp.StringOf("mobile")
lcNote = loJResp.StringOf("note")
lnPersonal = loJResp.BoolOf("personal")
lcPhone_1 = loJResp.StringOf("phone_1")
lcPhone_2 = loJResp.StringOf("phone_2")
lcSalutation = loJResp.StringOf("salutation")
lcSuffix_1 = loJResp.StringOf("suffix_1")
lcSuffix_2 = loJResp.StringOf("suffix_2")
lcTitle = loJResp.StringOf("title")
lcZip_code = loJResp.StringOf("zip_code")
lcCreated_at = loJResp.StringOf("created_at")
lcUpdated_at = loJResp.StringOf("updated_at")

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X PUT
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "city": "<string>",
  "street": "<string>",
  "state": "<string>",
  "company_name": "<string>",
  "country": "<string>",
  "department": null,
  "fax": null,
  "first_name": null,
  "id": "<long>",
  "last_name": null,
  "login_id": "<long>",
  "mobile": null,
  "note": null,
  "personal": false,
  "phone_1": null,
  "phone_2": null,
  "salutation": "<integer>",
  "suffix_1": null,
  "suffix_2": null,
  "title": null,
  "zip_code": null,
  "created_at": "<string>",
  "updated_at": "<string>"
}'
https://api.easybill.de/rest/v1/customers/:customerId/contacts/:id

Postman Collection Item JSON

{
  "name": "Update Contact",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"city\": \"<string>\",\n  \"street\": \"<string>\",\n  \"state\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"country\": \"<string>\",\n  \"department\": null,\n  \"fax\": null,\n  \"first_name\": null,\n  \"id\": \"<long>\",\n  \"last_name\": null,\n  \"login_id\": \"<long>\",\n  \"mobile\": null,\n  \"note\": null,\n  \"personal\": false,\n  \"phone_1\": null,\n  \"phone_2\": null,\n  \"salutation\": \"<integer>\",\n  \"suffix_1\": null,\n  \"suffix_2\": null,\n  \"title\": null,\n  \"zip_code\": null,\n  \"created_at\": \"<string>\",\n  \"updated_at\": \"<string>\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/customers/:customerId/contacts/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "customers",
        ":customerId",
        "contacts",
        ":id"
      ],
      "variable": [
        {
          "key": "customerId",
          "value": "<long>",
          "description": "(Required) ID of customer"
        },
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of contact"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"city\": \"<string>\",\n  \"street\": \"<string>\",\n  \"state\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"country\": \"<string>\",\n  \"department\": null,\n  \"fax\": null,\n  \"first_name\": null,\n  \"id\": \"<long>\",\n  \"last_name\": null,\n  \"login_id\": \"<long>\",\n  \"mobile\": null,\n  \"note\": null,\n  \"personal\": false,\n  \"phone_1\": null,\n  \"phone_2\": null,\n  \"salutation\": \"<integer>\",\n  \"suffix_1\": null,\n  \"suffix_2\": null,\n  \"title\": null,\n  \"zip_code\": null,\n  \"created_at\": \"<string>\",\n  \"updated_at\": \"<string>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/customers/:customerId/contacts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "customers",
            ":customerId",
            "contacts",
            ":id"
          ],
          "variable": [
            {
              "key": "customerId"
            },
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"city\": \"<string>\",\n  \"street\": \"<string>\",\n  \"state\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"country\": \"<string>\",\n  \"department\": null,\n  \"fax\": null,\n  \"first_name\": null,\n  \"id\": \"<long>\",\n  \"last_name\": null,\n  \"login_id\": \"<long>\",\n  \"mobile\": null,\n  \"note\": null,\n  \"personal\": false,\n  \"phone_1\": null,\n  \"phone_2\": null,\n  \"salutation\": \"<integer>\",\n  \"suffix_1\": null,\n  \"suffix_2\": null,\n  \"title\": null,\n  \"zip_code\": null,\n  \"created_at\": \"<string>\",\n  \"updated_at\": \"<string>\"\n}"
    },
    {
      "name": "Invalid contact",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"city\": \"<string>\",\n  \"street\": \"<string>\",\n  \"state\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"country\": \"<string>\",\n  \"department\": null,\n  \"fax\": null,\n  \"first_name\": null,\n  \"id\": \"<long>\",\n  \"last_name\": null,\n  \"login_id\": \"<long>\",\n  \"mobile\": null,\n  \"note\": null,\n  \"personal\": false,\n  \"phone_1\": null,\n  \"phone_2\": null,\n  \"salutation\": \"<integer>\",\n  \"suffix_1\": null,\n  \"suffix_2\": null,\n  \"title\": null,\n  \"zip_code\": null,\n  \"created_at\": \"<string>\",\n  \"updated_at\": \"<string>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/customers/:customerId/contacts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "customers",
            ":customerId",
            "contacts",
            ":id"
          ],
          "variable": [
            {
              "key": "customerId"
            },
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"city\": \"<string>\",\n  \"street\": \"<string>\",\n  \"state\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"country\": \"<string>\",\n  \"department\": null,\n  \"fax\": null,\n  \"first_name\": null,\n  \"id\": \"<long>\",\n  \"last_name\": null,\n  \"login_id\": \"<long>\",\n  \"mobile\": null,\n  \"note\": null,\n  \"personal\": false,\n  \"phone_1\": null,\n  \"phone_2\": null,\n  \"salutation\": \"<integer>\",\n  \"suffix_1\": null,\n  \"suffix_2\": null,\n  \"title\": null,\n  \"zip_code\": null,\n  \"created_at\": \"<string>\",\n  \"updated_at\": \"<string>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/customers/:customerId/contacts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "customers",
            ":customerId",
            "contacts",
            ":id"
          ],
          "variable": [
            {
              "key": "customerId"
            },
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}