# Subscribe to title information by volume/folio

Subscribe to title information by volume/folio

Endpoint: POST /vicland/alert/v1/titles/subscriptions
Version: 1.4.0

## Header parameters:

  - `Authorization` (string, required)
    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query. string parameter.

  - `x-correlation-id` (string)
    A unique transaction id used to correlate api requests end to end.

  - `x-source-system` (string)
    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-Type` (string)
    This is the format for what the API sends

  - `Accept` (string)
    This is the format for what the API receives

## Request fields (application/json):

  - `volumeFolio` (string, required)
    The unique identifier of a land title in the format of  volume/folio.
    Example: "9500/906"

  - `customerRef` (string, required)
    Customer reference. Useful for differentiating between multiple customers.
    Example: "CBA"

  - `startDateTime` (string, required)
    Start datetime for subscription in ISO 8601/RFC3339 format. Timezone information must be included.
    Example: "2024-02-01T00:00:00Z"

  - `endDateTime` (string, required)
    End datetime for subscription in ISO 8601/RFC3339 format. Timezone information must be included.
    Example: "2024-03-11T00:00:00Z"

## Response 200 fields (application/json):

  - `subscriptionId` (string, required)
    ID(UUID) for Subscription.
    Example: "d3ca8a76-4c34-478d-a915-4679ee1bbfce"

## Response 400 fields (application/json):

  - `code` (integer, required)
    The HTTP Status code of the response.

  - `errorType` (string, required)
    Error Type

  - `description` (string, required)
    Error Description

  - `timestamp` (string, required)
    The time at which the API was invoked

  - `correlationId` (string, required)
    Unique ID for API request

## Response 401 fields (application/json):

  - `code` (integer, required)
    The HTTP Status code of the response.

  - `errorType` (string, required)
    Error Type

  - `description` (string, required)
    Error Description

  - `timestamp` (string, required)
    The time at which the API was invoked

  - `correlationId` (string, required)
    Unique ID for API request

## Response 403 fields (application/json):

  - `code` (integer, required)
    The HTTP Status code of the response.

  - `errorType` (string, required)
    Error Type

  - `description` (string, required)
    Error Description

  - `timestamp` (string, required)
    The time at which the API was invoked

  - `correlationId` (string, required)
    Unique ID for API request

## Response 404 fields (application/json):

  - `code` (integer, required)
    The HTTP Status code of the response.

  - `errorType` (string, required)
    Error Type

  - `description` (string, required)
    Error Description

  - `timestamp` (string, required)
    The time at which the API was invoked

  - `correlationId` (string, required)
    Unique ID for API request

## Response 429 fields (application/json):

  - `code` (integer, required)
    The HTTP Status code of the response.

  - `errorType` (string, required)
    Error Type

  - `description` (string, required)
    Error Description

  - `timestamp` (string, required)
    The time at which the API was invoked

  - `correlationId` (string, required)
    Unique ID for API request

## Response 500 fields (application/json):

  - `code` (integer, required)
    The HTTP Status code of the response.

  - `errorType` (string, required)
    Error Type

  - `description` (string, required)
    Error Description

  - `timestamp` (string, required)
    The time at which the API was invoked

  - `correlationId` (string, required)
    Unique ID for API request