Milestone Notification Service API (1.0.0)

Download OpenAPI specification:Download

Manage the callback configuration for transaction milestone notifications. This is primarily a technical pack intended for developers. It will provide an explanation of the service, the calls involved and some sample requests.

Getting Started

The Landmark API is a RESTful API based on HTTPS requests and JSON responses.

Endpoints

The API is accessed by making HTTPS requests to an endpoint URL. Each endpoint will use one of the methods; GET, POST, PUT, PATCH, and DELETE to dictate how you interact with the information available. Every endpoint is accessed only via the SSL-enabled HTTPS (port 443) protocol. The API uses semantic versioning, and the current release is v1.0.0

Environments

The API is available in two environments, both are identical in that they have the same specification infrastructure and functionality.

The 2 environments are:

  • User Acceptance Testing (UAT)
  • Production (PRD)

UAT

The UAT environment should be used during development, and interfaces with the Landmark UAT environments. You should use this whilst implementing and testing your integration.

The URLs for the UAT APIs are:

PRD

The PRD environment is a live instance, and this talks to the live Landmark environments. This should only be used once the integration is considered production ready and all testing has been completed on the UAT environment. Any actions performed on PRD will result in the creation and syncing of real data that may be seen by users.

The URLs for the production APIs are:

Requests & Authentication

Requests must be sent over HTTPS with any payload formatted in JSON. To authenticate against the API a Bearer Token Header must be provided.

Rate limiting

The API allows a maximum of 250 requests per customer per minute.

Versions

  • 1.0.0 (2024-02-15)
    • Added valuation callback milestone notification definitions.
  • 0.9.0 (2024-02-14)
    • First issued.

milestones

Operations to manage callback configurations for transaction milestone notifications

Register new milestone callback

Requests the registration of a new milestone callback configuration. The API will accept 3 types of authentication; Basic, Client ID & Secret, OAuth2.

Authorizations:
bearerAuth
Request Body schema: application/json
One of
type
required
string
Value: "basic"
Array of objects <= 20 items

The headers to be included within the callback request.

url
required
string (lgsUrl) <= 2048 characters ^([hH][tT][tT][pP][sS]:\/\/)([\da-zA-Z\.-]+)\...

Responses

Callbacks

Request samples

Content type
application/json
Example
{
  • "type": "basic",
  • "headers": [
    ],
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "callbackId": "ad682370-8122-4447-ac96-ca5ef6191aa9"
}

Callback payload samples

Callback
POST: request.body.url
Content type
application/json
Example
{
  • "milestoneId": "string",
  • "milestoneName": "string",
  • "surveyorBranchId": "02cad18b-a846-495c-8ae9-9e3ccfabb628",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "datePredicted": "2019-08-24T14:15:22Z",
  • "dateAchieved": "2019-08-24T14:15:22Z",
  • "transactionRequestMilestoneId": "b901c864-ddd1-4121-9408-ade77b667060",
  • "transactionRequestId": "2c639a22-bc15-4f63-afbb-9a7b148b1146",
  • "transactionRequestType": "string",
  • "additionalInformation": "string"
}

Update milestone callback

Requests the update to an existing milestone callback configuration. The API will accept 3 types of authentication; Basic, Client ID & Secret, OAuth2.

Authorizations:
bearerAuth
path Parameters
callbackId
required
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
Request Body schema: application/json
One of
type
required
string
Value: "basic"
Array of objects <= 20 items

The headers to be included within the callback request.

url
required
string (lgsUrl) <= 2048 characters ^([hH][tT][tT][pP][sS]:\/\/)([\da-zA-Z\.-]+)\...

Responses

Callbacks

Request samples

Content type
application/json
Example
{
  • "type": "basic",
  • "headers": [
    ],
  • "url": "string"
}

Response samples

Content type
application/problem+json
Example
{
  • "status": "400",
  • "code": "40000",
  • "title": "Invalid content type supplied"
}

Callback payload samples

Callback
POST: request.body.url
Content type
application/json
Example
{
  • "milestoneId": "string",
  • "milestoneName": "string",
  • "surveyorBranchId": "02cad18b-a846-495c-8ae9-9e3ccfabb628",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "datePredicted": "2019-08-24T14:15:22Z",
  • "dateAchieved": "2019-08-24T14:15:22Z",
  • "transactionRequestMilestoneId": "b901c864-ddd1-4121-9408-ade77b667060",
  • "transactionRequestId": "2c639a22-bc15-4f63-afbb-9a7b148b1146",
  • "transactionRequestType": "string",
  • "additionalInformation": "string"
}

Delete milestone callback

Requests the deletion of a milestone callback configuration

Authorizations:
bearerAuth
path Parameters
callbackId
required
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": "400",
  • "code": "40000",
  • "title": "Invalid content type supplied"
}