{ "openapi": "3.0.0", "info": { "title": "Data Enhancement Service API Documentation", "description": "\nThis API blueprint is subject to change due to technology restrictions, performance optimizations or changing requirements.\n\n## Environments\nOur `Production API` is located at:\n\n```\nhttps://api.ldex.co/data-enhance/\n```\n\nOur `Staging API` is located at:\n```\nhttps://staging-api.ldex.co/data-enhance\n```\n\n## Versioning\nThis API uses versioning as identified in the URI. Newer versions MAY introduce breaking changes.\n\n`/api/v1/businesses`\n\n## HTTP Methods\nThis API uses HTTP verbs (methods) as following:\n\n - `GET` - *Read* - used to **read** (or retrieve) a representation of a resource,\n - `POST` - *Create* - used to **create** new resources.\n - `PUT` - *Update* - used to **update** an existing resource identified by a URI.\n - `DELETE` - *Delete* - used to **delete** a resource identified by a URI.\n\n## Media Type\nWhere applicable this API MUST use the `JSON` media-type. Requests with a message-body are using plain `JSON` to set or update resource states.\n\n`Content-type: application/json` and `Accept: application/json ` headers SHOULD be set on all requests if not stated otherwise.\n\n## Notational Conventions\nThe key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC2119](https://www.ietf.org/rfc/rfc2119).\n\n## Resource IDs\nThis API uses short non-sequential url-friendly unique ids. Every resource id `MUST` consists of 6 url-friendly characters: `A-Z` and `0-9`.\n\nResource Ids `MUST` be `UPPERCASE`. Resource Ids are still `CASE SENSITIVE` but should no longer cause duplicate key issues in databases with case insensitive collations.\n\n```\nExample: a6v3FG\n```\n\n## Representation of Date and Time\nAll exchange of date and time-related data `MUST` be done according to `ISO 8601` standard and stored in UTC.\n\nWhen returning date and time-related data `YYYY-MM-DDThh:mm:ss.SSSZ` format `MUST` be used.\n\n## Status Codes and Errors\nThis API uses HTTP status codes to communicate with the API consumer.\n\n - `200 OK` - Response to a successful GET, PUT, PATCH or DELETE.\n - `201 Created` - Response to a POST that results in a creation.\n - `202 Accepted` - Response to a request if an actioned will be queued for offline processing.\n - `204 No Content` - Response to a successful request that won't be returning a body (like a DELETE request).\n - `400 Bad Request` - Malformed request; form validation errors.\n - `401 Unauthorized` - When no or invalid authentication details are provided.\n - `403 Forbidden` - When authentication succeeded but authenticated user doesn't have access to the resource.\n - `404 Not Found` - When a non-existent resource is requested.\n - `405 Method Not Allowed` - Method not allowed.\n - `406 Not Acceptable` - Could not satisfy the request.\n - `415 Unsupported Media Type` - Unsupported media type in request.\n - `422 Validation failed` - Supplied data did not pass validation.\n - `500 Internal server error` - An uncaught exception occurred.\n - `502 Bad Gateway` - An error occurred in downstream service.\n\n## System Status\n\n