Chilkat Online Tools

phpAx / EPC 2.0 - Partner Sandbox - 19.4 November [External] / [Partner] Send Completed Response

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('status','completed');
$json->UpdateString('partnerStatus','Inspection Scheduled');
$json->UpdateString('referenceNumber','ORDER_REFERENCE_NUMBER');
$json->UpdateString('\'respondingParty \'.name','COMPANY_NAME');
$json->UpdateString('\'respondingParty \'.address','COMPANY_STREET_ADDRESS');
$json->UpdateString('\'respondingParty \'.city','COMPANY_CITY');
$json->UpdateString('\'respondingParty \'.state','COMPANY_STATE');
$json->UpdateString('\'respondingParty \'.postalCode','COMPANY_ZIP_CODE');
$json->UpdateString('\'respondingParty \'.pointOfContact.name','CONTACT_NAME');
$json->UpdateString('\'respondingParty \'.pointOfContact.role','CONTACT_ROLE');
$json->UpdateString('\'respondingParty \'.pointOfContact.phone','CONTACT_PHONE_NUMBER');
$json->UpdateString('\'respondingParty \'.pointOfContact.email','CONTACT_EMAIL');
$json->UpdateString('loanFormat','application/vnd.plm-2.0.0+json');
$json->UpdateString('loan.propertyAppraisedValueAmount','1000000');
$json->UpdateString('resources[0].id','{{partner_resource_id}}');
$json->UpdateString('resources[0].name','{{partner_resource_name}}');
$json->UpdateString('resources[0].mimeType','{{partner_resource_mimeType}}');

$http->SetRequestHeader('Content-Type','application/json');
// Adds the "Authorization: Bearer {{partner_token}}" header.
$http->AuthToken = '{{partner_token}}';

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PATCH','https://domain.com/',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

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