Chilkat Online Tools

Perl / easybill REST API / Update Contact

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

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

$json = chilkat::CkJsonObject->new();
$json->UpdateString("city","<string>");
$json->UpdateString("street","<string>");
$json->UpdateString("state","<string>");
$json->UpdateString("company_name","<string>");
$json->UpdateString("country","<string>");
$json->UpdateNull("department");
$json->UpdateNull("fax");
$json->UpdateNull("first_name");
$json->UpdateString("id","<long>");
$json->UpdateNull("last_name");
$json->UpdateString("login_id","<long>");
$json->UpdateNull("mobile");
$json->UpdateNull("note");
$json->UpdateBool("personal",0);
$json->UpdateNull("phone_1");
$json->UpdateNull("phone_2");
$json->UpdateString("salutation","<integer>");
$json->UpdateNull("suffix_1");
$json->UpdateNull("suffix_2");
$json->UpdateNull("title");
$json->UpdateNull("zip_code");
$json->UpdateString("created_at","<string>");
$json->UpdateString("updated_at","<string>");

$http->SetRequestHeader("Content-Type","application/json");
$http->SetRequestHeader("Authorization","{{apiKey}}");
$http->SetRequestHeader("Accept","application/json");

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);

# resp is a HttpResponse
$resp = $http->PTextSb("PUT","https://api.easybill.de/rest/v1/customers/:customerId/contacts/:id",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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

$city = $jResp->stringOf("city");
$street = $jResp->stringOf("street");
$state = $jResp->stringOf("state");
$company_name = $jResp->stringOf("company_name");
$country = $jResp->stringOf("country");
$department = $jResp->stringOf("department");
$fax = $jResp->stringOf("fax");
$first_name = $jResp->stringOf("first_name");
$id = $jResp->stringOf("id");
$last_name = $jResp->stringOf("last_name");
$login_id = $jResp->stringOf("login_id");
$mobile = $jResp->stringOf("mobile");
$note = $jResp->stringOf("note");
$personal = $jResp->BoolOf("personal");
$phone_1 = $jResp->stringOf("phone_1");
$phone_2 = $jResp->stringOf("phone_2");
$salutation = $jResp->stringOf("salutation");
$suffix_1 = $jResp->stringOf("suffix_1");
$suffix_2 = $jResp->stringOf("suffix_2");
$title = $jResp->stringOf("title");
$zip_code = $jResp->stringOf("zip_code");
$created_at = $jResp->stringOf("created_at");
$updated_at = $jResp->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": ""
    }
  ]
}