Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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 JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "status": "completed",
; "partnerStatus": "Inspection Scheduled",
; "referenceNumber": "ORDER_REFERENCE_NUMBER",
; "respondingParty ": {
; "name": "COMPANY_NAME",
; "address": "COMPANY_STREET_ADDRESS",
; "city": "COMPANY_CITY",
; "state": "COMPANY_STATE",
; "postalCode": "COMPANY_ZIP_CODE",
; "pointOfContact": {
; "name": "CONTACT_NAME",
; "role": "CONTACT_ROLE",
; "phone": "CONTACT_PHONE_NUMBER",
; "email": "CONTACT_EMAIL"
; }
; },
; "loanFormat": "application/vnd.plm-2.0.0+json",
; "loan": {
; "propertyAppraisedValueAmount": "1000000"
; },
; "resources": [
; {
; "id": "{{partner_resource_id}}",
; "name": "{{partner_resource_name}}",
; "mimeType": "{{partner_resource_mimeType}}"
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"status","completed")
CkJsonObject::ckUpdateString(json,"partnerStatus","Inspection Scheduled")
CkJsonObject::ckUpdateString(json,"referenceNumber","ORDER_REFERENCE_NUMBER")
CkJsonObject::ckUpdateString(json,Chr(34) + "respondingParty " + Chr(34) + ".name","COMPANY_NAME")
CkJsonObject::ckUpdateString(json,Chr(34) + "respondingParty " + Chr(34) + ".address","COMPANY_STREET_ADDRESS")
CkJsonObject::ckUpdateString(json,Chr(34) + "respondingParty " + Chr(34) + ".city","COMPANY_CITY")
CkJsonObject::ckUpdateString(json,Chr(34) + "respondingParty " + Chr(34) + ".state","COMPANY_STATE")
CkJsonObject::ckUpdateString(json,Chr(34) + "respondingParty " + Chr(34) + ".postalCode","COMPANY_ZIP_CODE")
CkJsonObject::ckUpdateString(json,Chr(34) + "respondingParty " + Chr(34) + ".pointOfContact.name","CONTACT_NAME")
CkJsonObject::ckUpdateString(json,Chr(34) + "respondingParty " + Chr(34) + ".pointOfContact.role","CONTACT_ROLE")
CkJsonObject::ckUpdateString(json,Chr(34) + "respondingParty " + Chr(34) + ".pointOfContact.phone","CONTACT_PHONE_NUMBER")
CkJsonObject::ckUpdateString(json,Chr(34) + "respondingParty " + Chr(34) + ".pointOfContact.email","CONTACT_EMAIL")
CkJsonObject::ckUpdateString(json,"loanFormat","application/vnd.plm-2.0.0+json")
CkJsonObject::ckUpdateString(json,"loan.propertyAppraisedValueAmount","1000000")
CkJsonObject::ckUpdateString(json,"resources[0].id","{{partner_resource_id}}")
CkJsonObject::ckUpdateString(json,"resources[0].name","{{partner_resource_name}}")
CkJsonObject::ckUpdateString(json,"resources[0].mimeType","{{partner_resource_mimeType}}")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
; Adds the "Authorization: Bearer {{partner_token}}" header.
CkHttp::setCkAuthToken(http, "{{partner_token}}")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PATCH","https://domain.com/",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndProcedure
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Authorization: Bearer {{partner_token}}"
-d '{
"status": "completed",
"partnerStatus": "Inspection Scheduled",
"referenceNumber": "ORDER_REFERENCE_NUMBER",
"respondingParty ": {
"name": "COMPANY_NAME",
"address": "COMPANY_STREET_ADDRESS",
"city": "COMPANY_CITY",
"state": "COMPANY_STATE",
"postalCode": "COMPANY_ZIP_CODE",
"pointOfContact": {
"name": "CONTACT_NAME",
"role": "CONTACT_ROLE",
"phone": "CONTACT_PHONE_NUMBER",
"email": "CONTACT_EMAIL"
}
},
"loanFormat": "application/vnd.plm-2.0.0+json",
"loan": {
"propertyAppraisedValueAmount": "1000000"
},
"resources": [
{
"id": "{{partner_resource_id}}",
"name": "{{partner_resource_name}}",
"mimeType": "{{partner_resource_mimeType}}"
}
]
}'
https://domain.com/
Postman Collection Item JSON
{
"name": "[Partner] Send Completed Response",
"_postman_id": "476af59a-fb96-4126-8f16-4a59f0f324e1",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "Authorization",
"value": "Bearer {{partner_token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"completed\",\n \"partnerStatus\": \"Inspection Scheduled\",\n \"referenceNumber\": \"ORDER_REFERENCE_NUMBER\",\n \"respondingParty \": {\n \"name\": \"COMPANY_NAME\",\n \"address\": \"COMPANY_STREET_ADDRESS\",\n \"city\": \"COMPANY_CITY\",\n \"state\": \"COMPANY_STATE\",\n \"postalCode\": \"COMPANY_ZIP_CODE\",\n \"pointOfContact\": {\n \"name\": \"CONTACT_NAME\",\n \"role\": \"CONTACT_ROLE\",\n \"phone\": \"CONTACT_PHONE_NUMBER\",\n \"email\": \"CONTACT_EMAIL\"\n }\n },\n \"loanFormat\": \"application/vnd.plm-2.0.0+json\",\n \"loan\": {\n \"propertyAppraisedValueAmount\": \"1000000\"\n },\n \"resources\": [\n {\n \t\"id\": \"{{partner_resource_id}}\",\n \t\"name\": \"{{partner_resource_name}}\",\n \t\"mimeType\": \"{{partner_resource_mimeType}}\"\n }\n ]\n}"
},
"url": "{{api_host}}/partner/v2/transactions/{{transaction_id}}/response"
},
"response": [
]
}
