Testing service

Introducer Supplier

ON HOLD

Development of this service is on hold.

Following feedback we have created a interactive functionality to assist developers to test their integrations.

We may revisit the testing service in the future.

WARNING

The use of this service is limited. It can only be used on Introducer and Supplier integration accounts setup for this purpose and it will not work in the production environment.

This service contains the following methods:

POST /testing/instruction Supplier

A 200 OK response may also return a dictionary of data (if needed).

Introducer testing operations

Notes about future work

Things that need to be done

  • Mimic Supplier to:
    • Book and rebook appointment
    • Confirm appointment completed and uncompleted
    • Upload and replace report
  • Mimic TMP service team
    • Accepting or rejecting a referral
    • Taking payment
    • Assigning a case to a supplier
    • Cancel and uncancel an instruction
    • Cancel an appointment
    • Reopen an instruction
    • Replace report (outside the allowed interval)
    • Add a note from TMP, Customer (and Introducer where allowed)
    • Changing your fee and the total fee

Supplier testing operations

Create instruction and allocate to supplier

POST /testing/instruction Supplier

This method will allow a supplier to create an instruction which will be allocated to themselves.

The payload for this method is:

{
  "productCode": "RICSL2SURVEY",
  "supplierFee": 500,
  "customerFirstName": "James",
  "customerLastName": "Smith",
  "propertyValueOrPurchasePrice": 450000,
  "propertyTypeCode": "TERRACED",
  "propertyAgeCode": "LESSTHANTENYEARS",
  "propertyAddress": {
    "addressFormatCode": "DEFAULT",
    "addressLine1": "8 An address",
    "addressLine2": "",
    "addressLine3": "ATown",
    "addressLine4": "",
    "postcode": "OX9 3AJ",
    "countryCode": "GB"
  },
  "correspondenceAddress": {
    "addressFormatCode": "NONE"
  },
  "accessDetails": {
    "accessTypeCode": "VENDOR",
    "firmName": "",
    "emailAddress": "vendor@vendor.co.uk",
    "contactName": "John Vendor",
    "telephoneNumber": "01234 121212"
  }
}

The response will provide you with the reference of the created instruction:

{
  "TMPReference": "TMP103493",
  "TMPCustomerReference": "TMP103493",
  "CaseIndex": "0"
}

Notes about future work

Things that need to be done

  • Mimic TMP service team performing admin operations
    • Cancel and uncancel an instruction
    • Cancel an appointment
    • Reopen an instruction
    • Replace report (outside the allowed interval)
    • Add a note from TMP, Customer (and Introducer where allowed)
    • Changing your fee
  • Mimic TMP service team performing operation on behalf of the supplier
    • Accept instruction
    • Decline instruction
    • Book and rebook appointment
    • Confirm appointment completed and uncompleted
    • Upload and replace report
Last Updated: