Provide API to present information for a specific lead by id

[cbryanreapit]

Overview

This endpoint will be responsible for presenting information for a singular leads.

Location

GET /enquiries/{id} (protected: yes)

Request

Parameters

• id - string - provided by route

Response

Success

200 OK

{
      "id": 10001,
      "created": "2018-02-12T09:45:01.0000000Z",
      "modified": "2019-06-23T12:30:12.0000000Z",
      "type": "salesApplicant/lettingsApplicant/salesValuation/lettingsValuation", 
      "status" : "added" [pending()/added(A)/rejected(R)/alreadyonSystem(D)/duplicateEnquiry(M,N)/spam(S)]
      "message": "I would like to view this property",
      "propertyIds": [ "OXF200001" ],
      "officeId" : "OXF"
      "position" : "nothingToSell" [notSet(),renting(RE),instructedThisAgent(SU),instructedOtherAgent(OM),privateSale(PV),notOnMarket(OF)]
      "title": "Mr",
      "forename": "John",
      "surname": "Smith",
      "marketingConsent": "grant",
      "sourceName": "My Proptech",
      "homePhone": "01234 567890",
      "workPhone": null,
      "mobilePhone": "07890 123456",
      "email": "example@email.com",
      "address": {
        "buildingName": "",
        "buildingNumber": "15",
        "line1": "Example street",
        "line2": "Solihull",
        "line3": "West Midlands",
        "line4": "",
        "postcode": "B91 2XX",
        "countryId": "GB"
      },
}

Failure

400 Bad Request
401 Authorised
403 Forbidden
404 Not Found