{
  "openapi": "3.0.1",
  "info": {
    "title": "Point Of Interest Descriptions",
    "description": "Create and administer point of interest descriptions.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Point Of Interest Descriptions",
      "description": "Provide RESTful services to manage point of interest descriptions."
    }
  ],
  "paths": {
    "/point-of-interest-descriptions": {
      "get": {
        "tags": [
          "Point Of Interest Descriptions"
        ],
        "description": "Get a collection of point of interest descriptions.",
        "operationId": "getPointOfInterestDescriptions",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying the point of interest description.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "pointOfInterestId",
            "in": "query",
            "description": "The unique numeric ID for identifying the point of interest.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "languageId",
            "in": "query",
            "description": "The unique ID for identifying the language for the point of interest description.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "shortDescription",
            "in": "query",
            "description": "The translated short description of the point of interest.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "longDescription",
            "in": "query",
            "description": "The translated long description of the point of insterest.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "displayImage1",
            "in": "query",
            "description": "The URL of the display image 1 for the point of interest.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "displayImage2",
            "in": "query",
            "description": "The URL of the display image 2 for the point of interest.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "The translated name of the point of interest.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field1",
            "in": "query",
            "description": "Customizable field 1.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "field2",
            "in": "query",
            "description": "Customizable field 2.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "field3",
            "in": "query",
            "description": "Customizable field 3.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of point of interest descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PointOfInterestDescriptionCollection"
                },
                "example": {
                  "href": "https://10.190.66.207:8000/rest/admin/v2/point-of-interest-descriptions",
                  "items": [
                    {
                      "id": -10003,
                      "pointOfInterestId": 10003,
                      "languageId": -1,
                      "shortDescription": "Markham Centre",
                      "longDescription": null,
                      "displayImage1": null,
                      "displayImage2": null,
                      "name": "Markham Centre",
                      "field1": null,
                      "field2": null,
                      "field3": null,
                      "links": {
                        "self": {
                          "href": "https://10.190.66.207:8000/rest/admin/v2/point-of-interest-descriptions/-10003"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Point Of Interest Descriptions"
        ],
        "description": "Create a point of interest description.",
        "operationId": "createPointOfInterestDescription",
        "requestBody": {
          "description": "The point of interest description.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PointOfInterestDescriptions"
              },
              "example": {
                "id": 23000,
                "pointOfInterestId": 0,
                "languageId": "0,",
                "shortDescription": "string",
                "longDescription": "string",
                "displayImage1": "string",
                "displayImage2": "string",
                "name": "string",
                "field1": 0,
                "field2": 0,
                "field3": "string"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Point Of Interest Descriptions.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetPointOfInterestDescriptionsById": {
                "operationRef": "#/paths/~1point-of-interest-descriptions~1{id}/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /point-of-interest-descriptions/{id}`.\n"
              },
              "DeletePointOfInterestDescriptionsById": {
                "operationRef": "#/paths/~1point-of-interest-descriptions~1{id}/delete",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /point-of-interest-descriptions/{id}`.\n"
              },
              "UpdatePointOfInterestDescriptionsById": {
                "operationRef": "#/paths/~1point-of-interest-descriptions~1{id}/patch",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /point-of-interest-descriptions/{id}`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "PointOfInterestDescription"
      }
    },
    "/point-of-interest-descriptions/{id}": {
      "get": {
        "tags": [
          "Point Of Interest Descriptions"
        ],
        "description": "Get a point of interest description.",
        "operationId": "getPointOfInterestDescriptionById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the point of interest description.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The point of interest description.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PointOfInterestDescription"
                },
                "example": {
                  "id": -10004,
                  "pointOfInterestId": 10004,
                  "languageId": -1,
                  "shortDescription": "Markville Mall",
                  "longDescription": null,
                  "displayImage1": null,
                  "displayImage2": null,
                  "name": "Markville Mall",
                  "field1": null,
                  "field2": null,
                  "field3": null
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Point Of Interest Descriptions"
        ],
        "description": "Delete a point of interest description.",
        "operationId": "deletePointOfInterestDescriptionById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the point of interest description.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Point Of Interest Descriptions"
        ],
        "description": "Update a point of interest description.",
        "operationId": "updatePointOfInterestDescriptionById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the point of interest description.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "description": "The point of interest description.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PointOfInterestDescriptions"
              },
              "example": {
                "id": -10003,
                "pointOfInterestId": 10003,
                "languageId": -1,
                "shortDescription": "Markville Mall",
                "longDescription": null,
                "displayImage1": null,
                "displayImage2": null,
                "name": "Markville Mall",
                "field1": null,
                "field2": null,
                "field3": null
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "PointOfInterestDescription"
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          }
        },
        "description": "Links to related resources."
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "PointOfInterestDescription": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the point of interest description.",
            "format": "int64"
          },
          "pointOfInterestId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the point of interest.",
            "format": "int64"
          },
          "languageId": {
            "type": "integer",
            "description": "The unique ID for identifying the language for the point of interest description.",
            "format": "int32"
          },
          "shortDescription": {
            "type": "string",
            "description": "The translated short description of the point of interest."
          },
          "longDescription": {
            "type": "string",
            "nullable": true,
            "description": "The translated long description of the point of insterest."
          },
          "displayImage1": {
            "type": "string",
            "nullable": true,
            "description": "The URL of the display image 1 for the point of interest."
          },
          "displayImage2": {
            "type": "string",
            "nullable": true,
            "description": "The URL of the display image 2 for the point of interest."
          },
          "name": {
            "type": "string",
            "description": "The translated name of the point of interest."
          },
          "field1": {
            "type": "integer",
            "nullable": true,
            "description": "Customizable field 1.",
            "format": "int64"
          },
          "field2": {
            "type": "number",
            "nullable": true,
            "description": "Customizable field 2."
          },
          "field3": {
            "type": "string",
            "nullable": true,
            "description": "Customizable field 3."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The self link."
              }
            }
          }
        },
        "description": "The point of interest description."
      },
      "PointOfInterestDescriptions": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the point of interest description.",
            "format": "int64"
          },
          "pointOfInterestId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the point of interest.",
            "format": "int64"
          },
          "languageId": {
            "type": "integer",
            "description": "The unique ID for identifying the language for the point of interest description.",
            "format": "int32"
          },
          "shortDescription": {
            "type": "string",
            "description": "The translated short description of the point of interest."
          },
          "longDescription": {
            "type": "string",
            "nullable": true,
            "description": "The translated long description of the point of insterest."
          },
          "displayImage1": {
            "type": "string",
            "nullable": true,
            "description": "The URL of the display image 1 for the point of interest."
          },
          "displayImage2": {
            "type": "string",
            "nullable": true,
            "description": "The URL of the display image 2 for the point of interest."
          },
          "name": {
            "type": "string",
            "description": "The translated name of the point of interest."
          },
          "field1": {
            "type": "integer",
            "nullable": true,
            "description": "Customizable field 1.",
            "format": "int64"
          },
          "field2": {
            "type": "number",
            "nullable": true,
            "description": "Customizable field 2."
          },
          "field3": {
            "type": "string",
            "nullable": true,
            "description": "Customizable field 3."
          }
        }
      },
      "PointOfInterestDescriptionCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/PointOfInterestDescription"
            }
          }
        },
        "description": "A collection of point of interest descriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}