Chilkat Online Tools

PureBasic / Coupa Postman Collection - OAuth - Master / Update Existing Address

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkXml.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 XML: Generate Code to Create XML

    ; The following XML is sent in the request body.

    ; <?xml version="1.0" encoding="utf-8"?>
    ; <address>
    ;     <name>address name is ok</name>
    ;     <location-code>CODEUPDATE1</location-code>
    ;     <street1>lineaddress1</street1>
    ;     <street2>lineaddress2</street2>
    ;     <city>Elko</city>
    ;     <state>NV</state>
    ;     <postal-code>08551-3423</postal-code>
    ;     <active>true</active>
    ;     <country>
    ;         <code>US</code>
    ;     </country>
    ;     <custom-fields>
    ;         <date type="dateTime">2021-11-12</date>
    ;     </custom-fields>
    ; </address>
    ; 

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

    CkXml::setCkTag(xml, "address")
    CkXml::ckUpdateChildContent(xml,"name","address name is ok")
    CkXml::ckUpdateChildContent(xml,"location-code","CODEUPDATE1")
    CkXml::ckUpdateChildContent(xml,"street1","lineaddress1")
    CkXml::ckUpdateChildContent(xml,"street2","lineaddress2")
    CkXml::ckUpdateChildContent(xml,"city","Elko")
    CkXml::ckUpdateChildContent(xml,"state","NV")
    CkXml::ckUpdateChildContent(xml,"postal-code","08551-3423")
    CkXml::ckUpdateChildContent(xml,"active","true")
    CkXml::ckUpdateChildContent(xml,"country|code","US")
    CkXml::ckUpdateAttrAt(xml,"custom-fields|date",1,"type","dateTime")
    CkXml::ckUpdateChildContent(xml,"custom-fields|date","2021-11-12")

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

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

    CkXml::ckGetXmlSb(xml,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/addresses/:id?fields=[" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "name" + Chr(34) + "," + Chr(34) + "active" + Chr(34) + "," + Chr(34) + "street1" + Chr(34) + "," + Chr(34) + "street2" + Chr(34) + "," + Chr(34) + "city" + Chr(34) + "," + Chr(34) + "state" + Chr(34) + "," + Chr(34) + "postal_code" + Chr(34) + "," + Chr(34) + "location_code" + Chr(34) + ",{" + Chr(34) + "country" + Chr(34) + ":{}},{" + Chr(34) + "tax_registrations" + Chr(34) + ":{}},{" + Chr(34) + "custom_fields" + Chr(34) + ":{}}]",sbRequestBody,"utf-8","application/xml",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkXml::ckDispose(xml)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkXml::ckDispose(xml)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '<address>
    <name>address name is ok</name>
    <location-code>CODEUPDATE1</location-code>
    <street1>lineaddress1</street1>
    <street2>lineaddress2</street2>
    <city>Elko</city>
    <state>NV</state>
    <postal-code>08551-3423</postal-code>
    <active>true</active>
    <country>
        <code>US</code>
    </country>
    <custom-fields>
        <date type="dateTime">2021-11-12</date>
    </custom-fields>
</address>'
https://domain.com/addresses/:id?fields=["id","name","active","street1","street2","city","state","postal_code","location_code",{"country":{}},{"tax_registrations":{}},{"custom_fields":{}}]

Postman Collection Item JSON

{
  "name": "Update Existing Address",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "<address>\n    <name>address name is ok</name>\n    <location-code>CODEUPDATE1</location-code>\n    <street1>lineaddress1</street1>\n    <street2>lineaddress2</street2>\n    <city>Elko</city>\n    <state>NV</state>\n    <postal-code>08551-3423</postal-code>\n    <active>true</active>\n    <country>\n        <code>US</code>\n    </country>\n    <custom-fields>\n        <date type=\"dateTime\">2021-11-12</date>\n    </custom-fields>\n</address>",
      "options": {
        "raw": {
          "language": "xml"
        }
      }
    },
    "url": {
      "raw": "{{URL}}/addresses/:id?fields=[\"id\",\"name\",\"active\",\"street1\",\"street2\",\"city\",\"state\",\"postal_code\",\"location_code\",{\"country\":{}},{\"tax_registrations\":{}},{\"custom_fields\":{}}]",
      "host": [
        "{{URL}}"
      ],
      "path": [
        "addresses",
        ":id"
      ],
      "query": [
        {
          "key": "fields",
          "value": "[\"id\",\"name\",\"active\",\"street1\",\"street2\",\"city\",\"state\",\"postal_code\",\"location_code\",{\"country\":{}},{\"tax_registrations\":{}},{\"custom_fields\":{}}]"
        }
      ],
      "variable": [
        {
          "key": "id",
          "value": "4882"
        }
      ]
    }
  },
  "response": [
  ]
}