Chilkat Online Tools

PureBasic / Coupa Postman Collection - OAuth - Master / Add contract term

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"?>
    ; <contract-term>
    ;     <name>API Contract Term 1</name>
    ;     <contract-term-type>PriceRangeContractTerm</contract-term-type>
    ;     <use-pct-discounts type="boolean">true</use-pct-discounts>
    ;     <tier-1-upper-bound type="decimal">15.0</tier-1-upper-bound>
    ;     <tier-1-disc-pct type="decimal">6.0</tier-1-disc-pct>
    ;     <tier-2-disc-pct type="decimal">7.0</tier-2-disc-pct>
    ; </contract-term>
    ; 

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

    CkXml::setCkTag(xml, "contract-term")
    CkXml::ckUpdateChildContent(xml,"name","API Contract Term 1")
    CkXml::ckUpdateChildContent(xml,"contract-term-type","PriceRangeContractTerm")
    CkXml::ckUpdateAttrAt(xml,"use-pct-discounts",1,"type","boolean")
    CkXml::ckUpdateChildContent(xml,"use-pct-discounts","true")
    CkXml::ckUpdateAttrAt(xml,"tier-1-upper-bound",1,"type","decimal")
    CkXml::ckUpdateChildContent(xml,"tier-1-upper-bound","15.0")
    CkXml::ckUpdateAttrAt(xml,"tier-1-disc-pct",1,"type","decimal")
    CkXml::ckUpdateChildContent(xml,"tier-1-disc-pct","6.0")
    CkXml::ckUpdateAttrAt(xml,"tier-2-disc-pct",1,"type","decimal")
    CkXml::ckUpdateChildContent(xml,"tier-2-disc-pct","7.0")

    ; 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,"POST","https://domain.com/contracts/:id/contract_terms",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 POST
	-H "Authorization: Bearer <access_token>"
	-d '<?xml version="1.0" encoding="UTF-8"?>
<contract-term>
    <name>API Contract Term 1</name>
    <contract-term-type>PriceRangeContractTerm</contract-term-type>
    <use-pct-discounts type="boolean">true</use-pct-discounts>
    <tier-1-upper-bound type="decimal">15.0</tier-1-upper-bound>
    <tier-1-disc-pct type="decimal">6.0</tier-1-disc-pct>
    <tier-2-disc-pct type="decimal">7.0</tier-2-disc-pct>
</contract-term>'
https://domain.com/contracts/:id/contract_terms

Postman Collection Item JSON

{
  "name": "Add contract term",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<contract-term>\n    <name>API Contract Term 1</name>\n    <contract-term-type>PriceRangeContractTerm</contract-term-type>\n    <use-pct-discounts type=\"boolean\">true</use-pct-discounts>\n    <tier-1-upper-bound type=\"decimal\">15.0</tier-1-upper-bound>\n    <tier-1-disc-pct type=\"decimal\">6.0</tier-1-disc-pct>\n    <tier-2-disc-pct type=\"decimal\">7.0</tier-2-disc-pct>\n</contract-term>",
      "options": {
        "raw": {
          "language": "xml"
        }
      }
    },
    "url": {
      "raw": "{{URL}}/contracts/:id/contract_terms",
      "host": [
        "{{URL}}"
      ],
      "path": [
        "contracts",
        ":id",
        "contract_terms"
      ],
      "variable": [
        {
          "key": "id",
          "value": "377",
          "type": "string"
        }
      ]
    }
  },
  "response": [
  ]
}