Chilkat Online Tools

autoit / easybill REST API / Update Contact

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.Http")
Local $bSuccess

; 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>"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("city","<string>")
$oJson.UpdateString("street","<string>")
$oJson.UpdateString("state","<string>")
$oJson.UpdateString("company_name","<string>")
$oJson.UpdateString("country","<string>")
$oJson.UpdateNull("department")
$oJson.UpdateNull("fax")
$oJson.UpdateNull("first_name")
$oJson.UpdateString("id","<long>")
$oJson.UpdateNull("last_name")
$oJson.UpdateString("login_id","<long>")
$oJson.UpdateNull("mobile")
$oJson.UpdateNull("note")
$oJson.UpdateBool("personal",False)
$oJson.UpdateNull("phone_1")
$oJson.UpdateNull("phone_2")
$oJson.UpdateString("salutation","<integer>")
$oJson.UpdateNull("suffix_1")
$oJson.UpdateNull("suffix_2")
$oJson.UpdateNull("title")
$oJson.UpdateNull("zip_code")
$oJson.UpdateString("created_at","<string>")
$oJson.UpdateString("updated_at","<string>")

$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Authorization","{{apiKey}}"
$oHttp.SetRequestHeader "Accept","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://api.easybill.de/rest/v1/customers/:customerId/contacts/:id",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.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)

; {
;   "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

Local $sCity = $oJResp.StringOf("city")
Local $street = $oJResp.StringOf("street")
Local $state = $oJResp.StringOf("state")
Local $sCompany_name = $oJResp.StringOf("company_name")
Local $sCountry = $oJResp.StringOf("country")
Local $sDepartment = $oJResp.StringOf("department")
Local $sFax = $oJResp.StringOf("fax")
Local $sFirst_name = $oJResp.StringOf("first_name")
Local $sId = $oJResp.StringOf("id")
Local $sLast_name = $oJResp.StringOf("last_name")
Local $sLogin_id = $oJResp.StringOf("login_id")
Local $sMobile = $oJResp.StringOf("mobile")
Local $sNote = $oJResp.StringOf("note")
Local $bPersonal = $oJResp.BoolOf("personal")
Local $sPhone_1 = $oJResp.StringOf("phone_1")
Local $sPhone_2 = $oJResp.StringOf("phone_2")
Local $salutation = $oJResp.StringOf("salutation")
Local $suffix_1 = $oJResp.StringOf("suffix_1")
Local $suffix_2 = $oJResp.StringOf("suffix_2")
Local $sTitle = $oJResp.StringOf("title")
Local $sZip_code = $oJResp.StringOf("zip_code")
Local $sCreated_at = $oJResp.StringOf("created_at")
Local $sUpdated_at = $oJResp.StringOf("updated_at")

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": ""
    }
  ]
}