Provide API to present complete chain that a particular offer belongs to

[cbryanreapit]

Overview

This endpoint will be responsible for presenting the complete conveyancing chain that a specific offer belongs to

Location

GET /conveyancing/{id}/chain (protected: yes)

Request

Parameters

pageSize - int
pageNumber - int

Response

Success

200 OK

***** DRAFT *****
{
  "_embedded": [
    {
      "id": "RPT123456",
      "created": "2019-01-25T15:44:28.0000000Z",
      "modified": "2019-01-25T15:44:28.0000000Z",
       "offerId": "RPT123456",
      "propertyAddress": "15 High Street, Exampletown, WS12 1JJ",
      "propertyId": "RPT190001",
      "vendor": "Mr David Smith",
      "vendorId": "RPT190001",
      "vendorSolicitorId": "FOT201192",
      "buyer": "Mrs Jess Brown",
      "buyerId": "FOT192212",
      "buyerSolicitorId": "RPT19300011",
      "externalAgent": "Agency Estates",
      "externalAgentId": "",
      "upwardChainExists": false,
      "upwardChainId": "",
      "downwardExists": true,
      "downwardChainId": "OXF123412",
      "fixturesAndFittingsCompleted": "",
      "deedRequested": "2019-01-25",
      "deedRecieved": "2019-01-25",
      "enquiriesSent": "2019-01-25",
      "enquiriesAnswered": "2019-01-25",
      "searchesPaid": "2019-01-25",
      "searchesApplied": "2019-01-25",
      "searchesReceived": "2019-01-25",
      "contractSent": "2019-01-25",
      "contractReceived": "2019-01-25",
      "contractApproved": "2019-01-25",
      "contractVendorSigned": "2019-01-25",
      "contractBuyerSigned": "2019-01-25",
      "mortgageRequired": "yes/no/unknown",
      "mortgageLoanPercentage": 40,
      "mortgageSubmitted": "2019-01-25",
      "mortgageOfferRecieved": "2019-01-25",
      "mortgageLenderId": "OXF2131231",
      "mortgageBrokerId": "",
      "mortgateSurveyDate": "2019-01-25",
      "mortgageSurveyorId": "SSD121231",
      "additionalSurveyRequired": "yes/no/unknown",
      "additionalSurveyDate": "2019-01-25",
      "additionalSurveyorId": "SDS123131",
      "exchangedVendor": "2019-01-25",
      "exchangedBuyer": "2019-01-25",
      "completion": "2019-01-25"
    }
  ],
  "pageNumber": 1,
  "pageSize": 1,
  "pageCount": 1,
  "totalCount": 25,
  "_links": {
    "self": {
      "href": "/conveyancing/?PageNumber=1&PageSize=1"
    },
    "first": {
      "href": "/conveyancing/?PageNumber=1&PageSize=1"
    },
    "next": {
      "href": "/conveyancing/?PageNumber=2&PageSize=1"
    },
    "last": {
      "href": "/conveyancing/?PageNumber=25&PageSize=1"
    }
  }
}

Failure

400 Bad Request
401 Authorised
403 Forbidden
404 Not Found

Note

• The results should be ordered in the order the chain presents them (top down)
• Default page size 50 to avoid paging but retain familiar contract