Data service

Introducer Supplier

This service is used to retrieve sets of static data. This is data that does not change very often. It is expected that when you need any of the data exposed by these methods you should use your own local cache and only update the lists at periodic intervals (e.g. daily) or when you have any issues.

The following methods are in this service:

GET /data/{setCode}

Get a dataset

GET /data/{setCode}

This method will get a standard list of data. The following data can be retrieved:

`SetCode`	Description
IntroducerSupplier CANCELAPPOINTMENTREASONS	Reasons to cancel an appointment.
IntroducerSupplier CANCELCASEREASONS	Reasons to cancel a case.
IntroducerSupplier CASEONHOLDREASONS	Reasons a case is put on hold.
IntroducerSupplier CHANGECASEPRODUCTREASONS	Reasons for the product being changed.
Supplier DEALLOCATCASEREASONS	Reasons for a case to be deallocated.
Supplier DECLINECASEREASONS	Reasons for a supplier to decline a case offered to them.
IntroducerSupplier REBOOKAPPOINTMENTREASONS	Reasons to rebook an appointment.
IntroducerSupplier REOPENREASONS	Reasons to reopen a completed case - used rarely (if at all).
Introducer REJECTCASEREASONS	Reasons TMP has rejected a case at the `New` status.
Introducer UNCANCELCASES	Reasons to uncancel a case. Should only be used at the `New` or `Referred` status and rarely used for an ordered case that was cancelled.

IntroducerSupplier APPOINTMENTTIMES	Appointment time slot codes.

IntroducerSupplier CASEATTRIBUTES	Attributes associated with a case (e.g. Rewrite associated with Help to Buy Valuation representing a desktop valuation). The Information property will contain further information, with a Key of DisplayText showing what the attribute should be displayed as.

IntroducerSupplier DEFAULT-PROPERTYAGES	List of default property age codes.
IntroducerSupplier DEFAULT-PROPERTYTYPES	List of default property type codes.
IntroducerSupplier DEFAULT-PROPERTYVALUETIERS	List of default property value tier codes.

IntroducerSupplier SPECIALISTREPORTS	List of specialist reports which can be specified as recommendations when completing a case or uploading a report.

IntroducerSupplier COUNTRYLIST	List of allowed country codes and name associated with the code.

IntroducerSupplier ACTIVEPRODUCTS	List of all active products (not just those for your firm).
IntroducerSupplier ALLPRODUCTS	List of all products (not just those for your firm).
IntroducerSupplier MYPRODUCTS	List of all products for your firm.

If a setCode has been provided that is not recognised or not available to the type of user requesting it a 404 Not Found response will be returned.

A successful request will return a 200 Ok response.

Example data set

As an example of a data set used for the reasons for rebooking an appointment, we might have:

{
  "dataSetCode": "REBOOKAPPOINTMENTREASONS",
  "items": [
    {
      "sequence": 10,
      "code": "CLIENTREQUESTED",
      "description": "Client request",
      "isOther": false,
      "isActive": true,
      "information": null
    },
    {
      "sequence": 20,
      "code": "VENDORREQUESTED",
      "description": "Vendor request",
      "isOther": false,
      "isActive": true,
      "information": null
    },
    {
      "sequence": 30,
      "code": "AGENTREQUESTED",
      "description": "Agent request",
      "isOther": false,
      "isActive": false,
      "information": null
    },
    {
      "sequence": 9999,
      "code": "OTHER",
      "description": "Other",
      "isOther": true,
      "isActive": true,
      "information": null
    }
  ]
}

In this example there are four possible codes:

Code	Active	Other
CLIENTREQUESTED	Yes	No
VENDORREQUESTED	Yes	No
AGENTREQUESTED	No	No
OTHER	Yes	Yes

All the possible codes may be valid for displaying of data with that used that code.

However, AGENTREQUESTED is not Active - which usually means it may have been active at one point and subsequently disabled or it may be enabled soon (i.e. new functionality).

A Supplier would only use the codes that are Active when performing the action.

The OTHER code is marked as being "Other" - in which case when the Supplier provides this code they must also provide further information. See Key concepts for more information.