Skip to content
/API Reference

SERV Title Alert API (1.4.0)

SERV Title Alert API

Exposes functionality relating to alerting.

- Subscribe to title alert notifications.
Exposes functionality relating to alerting
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer.servictoria.io/_mock/portal/rest/ddp-title-alert-api/openapi
Production environment
https://api.servictoria.io/vicland
Test environment
https://test.api.servictoria.io/vicland

Subscribe to title information by volume/folio

Request

Subscribe to title information by volume/folio

Headers
Authorizationstring^.*$required

Used to send a valid OAuth 2 access token. Do not use with the "access_token" query. string parameter.

x-correlation-idstring^.*$

A unique transaction id used to correlate api requests end to end.

x-source-systemstring^.*$

A unique identification string for the source system. This could be a system name or hostname where a system is hosted on multiple hosts.

Content-Typestring^.+\/.+|^$

This is the format for what the API sends

Default application/json
Acceptstring^.+\/.+|^$

This is the format for what the API receives

Default application/json
Bodyapplication/json
volumeFoliostring^(?<VolumeNumber>[0-9]{1,5})/(?<FolioNumber>[...required

The unique identifier of a land title in the format of volume/folio.

Example: "9500/906"
customerRefstring<= 200 charactersrequired

Customer reference. Useful for differentiating between multiple customers.

Example: "CBA"
startDateTimestring(date-time)required

Start datetime for subscription in ISO 8601/RFC3339 format. Timezone information must be included.

Example: "2024-02-01T00:00:00Z"
endDateTimestring(date-time)required

End datetime for subscription in ISO 8601/RFC3339 format. Timezone information must be included.

Example: "2024-03-11T00:00:00Z"
curl -i -X POST \
  https://developer.servictoria.io/_mock/portal/rest/ddp-title-alert-api/openapi/vicland/alert/v1/titles/subscriptions \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'x-correlation-id: string' \
  -H 'x-source-system: string' \
  -d '{
    "volumeFolio": "9500/906",
    "customerRef": "CBA",
    "startDateTime": "2024-02-01T00:00:00Z",
    "endDateTime": "2024-03-11T00:00:00Z"
  }'

Responses

OK

Bodyapplication/json
subscriptionIdstring<= 200 charactersrequired

ID(UUID) for Subscription.

Example: "d3ca8a76-4c34-478d-a915-4679ee1bbfce"
Response
application/json
{
  "subscriptionId": "d3ca8a76-4c34-478d-a915-4679ee1bbfce"
}

Health

Request

Health Check

Headers
x-correlation-idstring

A unique transaction id used to correlate api requests end to end.

Example: 123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  https://developer.servictoria.io/_mock/portal/rest/ddp-title-alert-api/openapi/vicland/alert/v1/health \
  -H 'x-correlation-id: 123e4567-e89b-12d3-a456-426614174000'

Responses

OK

Bodyapplication/json
applicationNamestringrequired

Application Name

Example: "SERV Title Alert API"
applicationVersionstringrequired

Application Version

Example: "1.0.9"
apiNamestringrequired

API Name

Example: "serv-title-alert-api"
environmentstringrequired

Environment

Example: "DEV"
statusstringrequired

Status

Example: "running"
Response
application/json
{
  "applicationName": "SERV Title Alert API",
  "applicationVersion": "1.0.9",
  "apiName": "serv-title-alert-api",
  "environment": "DEV",
  "status": "running"
}