{"items":[{"type":"link","label":"SERV Title Alert API","link":"/portal/rest/ddp-title-alert-api/title-alert-api-schema","routeSlug":"/portal/rest/ddp-title-alert-api/title-alert-api-schema","content":{"contentType":"overview","meta":{"name":"SERV Title Alert API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"title-alert-api-schema.json","url":"/_bundle/portal/rest/ddp-title-alert-api/@latest/title-alert-api-schema.json?download"},{"kind":"download","label":"title-alert-api-schema.yaml","url":"/_bundle/portal/rest/ddp-title-alert-api/@latest/title-alert-api-schema.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/portal/rest/ddp-title-alert-api/title-alert-api-schema","description":"Mock server","isMockServer":true},{"url":"https://api.servictoria.io/vicland","description":"Production environment"},{"url":"https://test.api.servictoria.io/vicland","description":"Test environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"SERV Title Alert API (1.4.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"fence","attributes":{"content":"SERV Title Alert API\n\nExposes functionality relating to alerting.\n\n- Subscribe to title alert notifications.\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SERV Title Alert API\n\nExposes functionality relating to alerting.\n\n- Subscribe to title alert notifications.\n\n"},"children":[]}]}]}],"sectionId":"/portal/rest/ddp-title-alert-api/title-alert-api-schema"},{"nodeType":"external-docs","url":"https://lrsvic-systems.atlassian.net/wiki/spaces/IPF/pages/2526969858/Title+Alert+API+-+Subscribe+Technical+Specifications","description":"Exposes functionality relating to alerting"}],"sectionId":"/portal/rest/ddp-title-alert-api/title-alert-api-schema"}]}]}},{"label":"Subscribe to title information by volume/folio","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/rest/ddp-title-alert-api/title-alert-api-schema/other/subscribe to title information by volume/folio","routeSlug":"/portal/rest/ddp-title-alert-api/title-alert-api-schema/other/subscribe to title information by volume/folio","metadata":{"seo":{"title":"Subscribe to title information by volume/folio","description":"Subscribe to title information by volume/folio"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Subscribe to title information by volume/folio","name":"Subscribe to title information by volume/folio","isWebhook":false,"pointer":"/paths/~1vicland~1alert~1v1~1titles~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscribe to title information by volume/folio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Subscribe to title information by volume/folio"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauthClientCredentials","scopes":[]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_1467","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to send a valid OAuth 2 access token. Do not use with the \"access_token\" query. string parameter."},"children":[]}]}]}],"required":true},{"name":"x-correlation-id","in":"header","schemaId":"schema_1467","description":"A unique transaction id used to correlate api requests end to end."},{"name":"x-source-system","in":"header","schemaId":"schema_1467","description":"A unique identification string for the source system. This could be a system name or hostname where a system is hosted on multiple hosts."},{"name":"Content-Type","in":"header","schemaId":"schema_1468","description":"This is the format for what the API sends"},{"name":"Accept","in":"header","schemaId":"schema_1468","description":"This is the format for what the API receives"}],"pointer":"/paths/~1vicland~1alert~1v1~1titles~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionRequest"}},"schemaId":"components/schemas/SubscriptionRequest","pointer":"/paths/~1vicland~1alert~1v1~1titles~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/vicland/alert/v1/titles/subscriptions","servers":[{"url":"/_mock/portal/rest/ddp-title-alert-api/title-alert-api-schema","description":"Mock server","isMockServer":true},{"url":"https://api.servictoria.io/vicland","description":"Production environment"},{"url":"https://test.api.servictoria.io/vicland","description":"Test environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"schemaId":"schema_1467"},{"name":"x-correlation-id","in":"header","schemaId":"schema_1467"},{"name":"x-source-system","in":"header","schemaId":"schema_1467"},{"name":"Content-Type","in":"header","schemaId":"schema_1468"},{"name":"Accept","in":"header","schemaId":"schema_1468"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/vicland/alert/v1/titles/subscriptions","href":"other/subscribe to title information by volume/folio","openApiOperationId":"Subscribe to title information by volume/folio"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/portal/rest/ddp-title-alert-api/title-alert-api-schema","description":"Mock server","isMockServer":true},{"url":"https://api.servictoria.io/vicland","description":"Production environment"},{"url":"https://test.api.servictoria.io/vicland","description":"Test environment"}],"schemaId":"components/schemas/SubscriptionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionResponse"}},"schemaId":"components/schemas/SubscriptionResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1vicland~1alert~1v1~1titles~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/subscribe to title information by volume/folio"}],"panels":[]}]},"httpPath":"/vicland/alert/v1/titles/subscriptions"},{"label":"Health","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/rest/ddp-title-alert-api/title-alert-api-schema/other/health","routeSlug":"/portal/rest/ddp-title-alert-api/title-alert-api-schema/other/health","metadata":{"seo":{"title":"Health","description":"Health Check"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Health","name":"Health","isWebhook":false,"pointer":"/paths/~1vicland~1alert~1v1~1health/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Health Check"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-correlation-id","in":"header","schemaId":"schema_1469","description":"A unique transaction id used to correlate api requests end to end.","example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1vicland~1alert~1v1~1health/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/vicland/alert/v1/health","servers":[{"url":"/_mock/portal/rest/ddp-title-alert-api/title-alert-api-schema","description":"Mock server","isMockServer":true},{"url":"https://api.servictoria.io/vicland","description":"Production environment"},{"url":"https://test.api.servictoria.io/vicland","description":"Test environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-correlation-id","in":"header","example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_1469"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/vicland/alert/v1/health","href":"other/health","openApiOperationId":"Health"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/portal/rest/ddp-title-alert-api/title-alert-api-schema","description":"Mock server","isMockServer":true},{"url":"https://api.servictoria.io/vicland","description":"Production environment"},{"url":"https://test.api.servictoria.io/vicland","description":"Test environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HealthCheckResponse"}},"schemaId":"components/schemas/HealthCheckResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1vicland~1alert~1v1~1health/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HealthCheckResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HealthCheckResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/health"}],"panels":[]}]},"httpPath":"/vicland/alert/v1/health"}],"store":{"schemaStore":{"components/schemas/SubscriptionRequest":{"id":"components/schemas/SubscriptionRequest","kind":"json-schema","title":"SubscriptionRequest","data":{"required":["customerRef","endDateTime","startDateTime","volumeFolio"],"type":"object","properties":{"volumeFolio":{"pattern":"^(?<VolumeNumber>[0-9]{1,5})/(?<FolioNumber>[0-9]{3})(?<Suffix>[A-Z]?)$","type":"string","description":"The unique identifier of a land title in the format of  volume/folio."},"customerRef":{"maxLength":200,"type":"string","description":"Customer reference. Useful for differentiating between multiple customers."},"startDateTime":{"type":"string","description":"Start datetime for subscription in ISO 8601/RFC3339 format. Timezone information must be included.","format":"date-time","x-amf-examples":{"utc":"2015-07-04T21:00:00Z","non-utc":"2015-07-04T21:00:00+10:00"}},"endDateTime":{"type":"string","description":"End datetime for subscription in ISO 8601/RFC3339 format. Timezone information must be included.","format":"date-time","x-amf-examples":{"utc":"2015-07-28T21:00:00Z","non-utc":"2015-07-28T21:00:00+10:00"}}},"additionalProperties":false,"description":"Title Alert Subscription data type","example":{"volumeFolio":"9500/906","customerRef":"CBA","startDateTime":"2024-02-01T00:00:00Z","endDateTime":"2024-03-11T00:00:00Z"}}},"components/schemas/SubscriptionResponse":{"id":"components/schemas/SubscriptionResponse","kind":"json-schema","title":"SubscriptionResponse","data":{"required":["subscriptionId"],"type":"object","properties":{"subscriptionId":{"maxLength":200,"type":"string","description":"ID(UUID) for Subscription."}},"additionalProperties":false,"description":"Title Alert Subscribe Call Result","example":{"subscriptionId":"d3ca8a76-4c34-478d-a915-4679ee1bbfce"}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"required":["code","correlationId","description","errorType","timestamp"],"type":"object","properties":{"code":{"type":"integer","description":"The HTTP Status code of the response."},"errorType":{"type":"string","description":"Error Type"},"description":{"type":"string","description":"Error Description"},"timestamp":{"type":"string","description":"The time at which the API was invoked","format":"date-time"},"correlationId":{"type":"string","description":"Unique ID for API request"}},"additionalProperties":false,"description":"What a common error object looks like","x-amf-examples":{"value":{"code":"400","errorType":"APIKIT:BAD_REQUEST","description":"Bad Request","timestamp":"2022-01-17T03:31:09.691Z","correlationId":"2aa11828-1243-4026-8ee3-7b5c77cef796"}}}},"components/schemas/HealthCheckResponse":{"id":"components/schemas/HealthCheckResponse","kind":"json-schema","title":"HealthCheckResponse","data":{"required":["apiName","applicationName","applicationVersion","environment","status"],"type":"object","properties":{"applicationName":{"type":"string","description":"Application Name"},"applicationVersion":{"type":"string","description":"Application Version"},"apiName":{"type":"string","description":"API Name"},"environment":{"type":"string","description":"Environment"},"status":{"type":"string","description":"Status"}},"additionalProperties":false,"description":"The response for an API health check","example":{"applicationName":"SERV Title Alert API","applicationVersion":"1.0.9","apiName":"serv-title-alert-api","environment":"DEV","status":"running"}}},"schema_1467":{"kind":"json-schema","data":{"pattern":"^.*$","type":"string"},"id":"schema_1467"},"schema_1468":{"kind":"json-schema","data":{"pattern":"^.+\\/.+|^$","type":"string","default":"application/json"},"id":"schema_1468"},"schema_1469":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1469"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"/_mock/portal/rest/ddp-title-alert-api/title-alert-api-schema","isMockServer":true,"description":"Mock server"},{"url":"https://api.servictoria.io/vicland","description":"Production environment"},{"url":"https://test.api.servictoria.io/vicland","description":"Test environment"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/portal/rest/ddp-title-alert-api/title-alert-api-schema","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/portal/rest/ddp-title-alert-api/@latest/title-alert-api-schema.json?download"},{"url":"/_bundle/portal/rest/ddp-title-alert-api/@latest/title-alert-api-schema.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"SERV Title Alert API","description":"```\nSERV Title Alert API\n\nExposes functionality relating to alerting.\n\n- Subscribe to title alert notifications.\n\n```\n"}},"baseSlug":"/portal/rest/ddp-title-alert-api/title-alert-api-schema","routesMapping":{}}