{ "swagger": "2.0", "info": { "title": "test", "version": "6", "description": "API generated with Nx/APIREST" }, "host": "api.test.rohl.nartest.fr", "basePath": "/", "schemes": [ "https" ], "consumes": [ "application/json", "multipart/form-data", "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "securityDefinitions": { "basicAuth": { "type": "basic", "description": "Global Security" } }, "tags": [ { "name": "AccessLevel" }, { "name": "ArticleLamp" }, { "name": "ArticleLampColorRenderingIndexChoice" }, { "name": "ArticleLampManufacturerChoice" }, { "name": "ArticleLampModelChoice" }, { "name": "ArticleLampPhotoCieChoice" }, { "name": "ArticleLampRalTypeChoice" }, { "name": "ArticlePole" }, { "name": "ArticlePoleAnchorTypeChoice" }, { "name": "ArticlePoleFinishChoice" }, { "name": "ArticlePoleHeadDiamChoice" }, { "name": "ArticlePoleManufacturerChoice" }, { "name": "ArticlePoleMaterialChoice" }, { "name": "ArticlePoleModelChoice" }, { "name": "ArticlePoleRalTypeChoice" }, { "name": "ArticlePoleShapeChoice" }, { "name": "ArticlePoleTipChoice" }, { "name": "ArticleStick" }, { "name": "ArticleStickDiameterChoice" }, { "name": "ArticleStickKindChoice" }, { "name": "ArticleStickManufacturerChoice" }, { "name": "ArticleStickMaterialChoice" }, { "name": "ArticleStickRalTypeChoice" }, { "name": "ArticleStickReferenceChoice" }, { "name": "ArticleStickTypeChoice" }, { "name": "BleData" }, { "name": "BleModuleListing" }, { "name": "ContactMessage" }, { "name": "Document" }, { "name": "Driver" }, { "name": "Event" }, { "name": "EventListing" }, { "name": "ExportSetupItemListing" }, { "name": "Import" }, { "name": "LampDocument" }, { "name": "LampDocumentListing" }, { "name": "LightingGroup" }, { "name": "LightingProfile" }, { "name": "Order" }, { "name": "OrderDocument" }, { "name": "OrderDocumentListing" }, { "name": "OrderFile" }, { "name": "OrderItem" }, { "name": "OrderItemData" }, { "name": "OrderLamp" }, { "name": "OrderLampData" }, { "name": "OrderLampDetail" }, { "name": "OrderListing" }, { "name": "OrderListingUser" }, { "name": "OrderSet" }, { "name": "OrderSetListing" }, { "name": "Organization" }, { "name": "OrganizationAddress" }, { "name": "OrganizationAddressListing" }, { "name": "OrganizationListing" }, { "name": "OrganizationPark" }, { "name": "OrganizationParkListing" }, { "name": "OrganizationStatusListing" }, { "name": "Park" }, { "name": "ParkListing" }, { "name": "ParkOrder" }, { "name": "ParkOrderListing" }, { "name": "PasswordRenewal" }, { "name": "Product" }, { "name": "Registration" }, { "name": "Setup" }, { "name": "SetupCustomItem" }, { "name": "SetupFile" }, { "name": "SetupItem" }, { "name": "SetupItemBleModule" }, { "name": "SetupItemLightingGroup" }, { "name": "SetupItemListing" }, { "name": "SetupListing" }, { "name": "StaticContent" }, { "name": "User" }, { "name": "UserListing" }, { "name": "UserOrder" }, { "name": "UserOrderListing" }, { "name": "UserPark" }, { "name": "UserParkListing" }, { "name": "UserRole" }, { "name": "Voucher" } ], "paths": { "/AccessLevel": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessLevel" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "AccessLevel" ], "security": [ { "basicAuth": [] } ] } }, "/AccessLevel/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/AccessLevel" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "AccessLevel" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleLamp": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleLamp" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleLamp" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleLamp/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/ArticleLamp" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleLamp" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleLampColorRenderingIndexChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleLampColorRenderingIndexChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleLampColorRenderingIndexChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleLampManufacturerChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleLampManufacturerChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleLampManufacturerChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleLampModelChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleLampModelChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleLampModelChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleLampPhotoCieChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleLampPhotoCieChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleLampPhotoCieChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleLampRalTypeChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleLampRalTypeChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleLampRalTypeChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticlePole": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticlePole" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticlePole" ], "security": [ { "basicAuth": [] } ] } }, "/ArticlePole/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/ArticlePole" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticlePole" ], "security": [ { "basicAuth": [] } ] } }, "/ArticlePoleAnchorTypeChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticlePoleAnchorTypeChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticlePoleAnchorTypeChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticlePoleFinishChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticlePoleFinishChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticlePoleFinishChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticlePoleHeadDiamChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticlePoleHeadDiamChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticlePoleHeadDiamChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticlePoleManufacturerChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticlePoleManufacturerChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticlePoleManufacturerChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticlePoleMaterialChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticlePoleMaterialChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticlePoleMaterialChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticlePoleModelChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticlePoleModelChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticlePoleModelChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticlePoleRalTypeChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticlePoleRalTypeChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticlePoleRalTypeChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticlePoleShapeChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticlePoleShapeChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticlePoleShapeChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticlePoleTipChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticlePoleTipChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticlePoleTipChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleStick": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleStick" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleStick" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleStick/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/ArticleStick" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleStick" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleStickDiameterChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleStickDiameterChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleStickDiameterChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleStickKindChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleStickKindChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleStickKindChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleStickManufacturerChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleStickManufacturerChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleStickManufacturerChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleStickMaterialChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleStickMaterialChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleStickMaterialChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleStickRalTypeChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleStickRalTypeChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleStickRalTypeChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleStickReferenceChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleStickReferenceChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleStickReferenceChoice" ], "security": [ { "basicAuth": [] } ] } }, "/ArticleStickTypeChoice": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ArticleStickTypeChoice" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ArticleStickTypeChoice" ], "security": [ { "basicAuth": [] } ] } }, "/BleData": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/BleData" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "BleData" ], "security": [ { "basicAuth": [] } ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#/definitions/BleData" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the insert (same result as a get request). Otherwise it's just the item's ID. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#/definitions/String" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "BleData" ], "security": [ { "basicAuth": [] } ] } }, "/BleData/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/BleData" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "BleData" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "setnull", "in": "query", "description": "Array of fields to be set to null.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#/definitions/BleData" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the update (same result as a get request). Otherwise it's just the number of affected rows. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "BleData" ], "security": [ { "basicAuth": [] } ] } }, "/BleModuleListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/BleModuleListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "BleModuleListing" ], "security": [ { "basicAuth": [] } ] } }, "/ContactMessage": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ContactMessage" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ContactMessage" ], "security": [ { "basicAuth": [] } ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#/definitions/ContactMessage" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the insert (same result as a get request). Otherwise it's just the item's ID. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#/definitions/String" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ContactMessage" ], "security": [ { "basicAuth": [] } ] } }, "/ContactMessage/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/ContactMessage" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ContactMessage" ], "security": [ { "basicAuth": [] } ] } }, "/Document": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/Document" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Document" ], "security": [ { "basicAuth": [] } ] } }, "/Document/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/Document" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Document" ], "security": [ { "basicAuth": [] } ] } }, "/Driver": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/Driver" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Driver" ], "security": [ { "basicAuth": [] } ] } }, "/Driver/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/Driver" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Driver" ], "security": [ { "basicAuth": [] } ] } }, "/Event": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/Event" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Event" ], "security": [ { "basicAuth": [] } ] } }, "/Event/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/Event" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Event" ], "security": [ { "basicAuth": [] } ] } }, "/EventListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/EventListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "EventListing" ] } }, "/EventListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/EventListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "EventListing" ] } }, "/ExportSetupItemListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ExportSetupItemListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ExportSetupItemListing" ], "security": [ { "basicAuth": [] } ] } }, "/ExportSetupItemListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/ExportSetupItemListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ExportSetupItemListing" ], "security": [ { "basicAuth": [] } ] } }, "/Import": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/Import" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Import" ], "security": [ { "basicAuth": [] } ] } }, "/Import/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/Import" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Import" ], "security": [ { "basicAuth": [] } ] } }, "/LampDocument": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/LampDocument" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LampDocument" ], "security": [ { "basicAuth": [] } ] } }, "/LampDocument/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/LampDocument" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LampDocument" ], "security": [ { "basicAuth": [] } ] } }, "/LampDocumentListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/LampDocumentListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LampDocumentListing" ], "security": [ { "basicAuth": [] } ] } }, "/LampDocumentListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/LampDocumentListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LampDocumentListing" ], "security": [ { "basicAuth": [] } ] } }, "/LightingGroup": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/LightingGroup" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LightingGroup" ], "security": [ { "basicAuth": [] } ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#/definitions/LightingGroup" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the insert (same result as a get request). Otherwise it's just the item's ID. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#/definitions/String" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LightingGroup" ], "security": [ { "basicAuth": [] } ] } }, "/LightingGroup/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/LightingGroup" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LightingGroup" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "setnull", "in": "query", "description": "Array of fields to be set to null.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#/definitions/LightingGroup" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the update (same result as a get request). Otherwise it's just the number of affected rows. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LightingGroup" ], "security": [ { "basicAuth": [] } ] } }, "/LightingProfile": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/LightingProfile" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LightingProfile" ], "security": [ { "basicAuth": [] } ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#/definitions/LightingProfile" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the insert (same result as a get request). Otherwise it's just the item's ID. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#/definitions/String" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LightingProfile" ], "security": [ { "basicAuth": [] } ] } }, "/LightingProfile/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/LightingProfile" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LightingProfile" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "setnull", "in": "query", "description": "Array of fields to be set to null.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#/definitions/LightingProfile" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the update (same result as a get request). Otherwise it's just the number of affected rows. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LightingProfile" ], "security": [ { "basicAuth": [] } ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "LightingProfile" ], "security": [ { "basicAuth": [] } ] } }, "/Order": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/Order" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Order" ], "security": [ { "basicAuth": [] } ] } }, "/Order/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/Order" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Order" ], "security": [ { "basicAuth": [] } ] } }, "/Order/register": { "patch": { "parameters": [ { "name": "park_id", "in": "formData", "required": true, "type": "string" }, { "name": "name", "in": "formData", "required": false, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Register an order (user generated) for given park with given name.", "tags": [ "Order" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/Order" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/Order/{id}/initiateSetup": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "name", "in": "formData", "required": true, "type": "string" }, { "name": "coordinates", "in": "formData", "required": true, "type": "array", "items": { "type": "number" } }, { "name": "reverse", "in": "formData", "required": true, "type": "string" }, { "name": "order_items", "in": "formData", "required": true, "type": "array", "items": { "type": "string" } }, { "name": "articles", "in": "formData", "required": true, "type": "array", "items": { "type": "string" } } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Create setup.", "tags": [ "Order" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/Setup" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/Order/{id}/updateChangeDt": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Update change dt with max result of several queries.", "tags": [ "Order" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/String" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/OrderDocument": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderDocument" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderDocument" ], "security": [ { "basicAuth": [] } ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#/definitions/OrderDocument" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the insert (same result as a get request). Otherwise it's just the item's ID. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#/definitions/String" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderDocument" ], "security": [ { "basicAuth": [] } ] } }, "/OrderDocument/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderDocument" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderDocument" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "setnull", "in": "query", "description": "Array of fields to be set to null.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#/definitions/OrderDocument" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the update (same result as a get request). Otherwise it's just the number of affected rows. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderDocument" ], "security": [ { "basicAuth": [] } ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderDocument" ], "security": [ { "basicAuth": [] } ] } }, "/OrderDocumentListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderDocumentListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderDocumentListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrderDocumentListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderDocumentListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderDocumentListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrderFile": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderFile" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderFile" ], "security": [ { "basicAuth": [] } ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#/definitions/OrderFile" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the insert (same result as a get request). Otherwise it's just the item's ID. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#/definitions/String" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderFile" ], "security": [ { "basicAuth": [] } ] } }, "/OrderFile/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderFile" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderFile" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "setnull", "in": "query", "description": "Array of fields to be set to null.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#/definitions/OrderFile" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the update (same result as a get request). Otherwise it's just the number of affected rows. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderFile" ], "security": [ { "basicAuth": [] } ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderFile" ], "security": [ { "basicAuth": [] } ] } }, "/OrderItem": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderItem" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderItem" ], "security": [ { "basicAuth": [] } ] } }, "/OrderItem/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderItem" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderItem" ], "security": [ { "basicAuth": [] } ] } }, "/OrderItemData": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderItemData" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderItemData" ], "security": [ { "basicAuth": [] } ] } }, "/OrderItemData/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderItemData" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderItemData" ], "security": [ { "basicAuth": [] } ] } }, "/OrderLamp": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderLamp" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderLamp" ], "security": [ { "basicAuth": [] } ] } }, "/OrderLamp/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderLamp" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderLamp" ], "security": [ { "basicAuth": [] } ] } }, "/OrderLampData": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderLampData" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderLampData" ], "security": [ { "basicAuth": [] } ] } }, "/OrderLampData/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderLampData" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderLampData" ], "security": [ { "basicAuth": [] } ] } }, "/OrderLampDetail": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderLampDetail" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderLampDetail" ], "security": [ { "basicAuth": [] } ] } }, "/OrderLampDetail/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderLampDetail" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderLampDetail" ], "security": [ { "basicAuth": [] } ] } }, "/OrderListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrderListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrderListingUser": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderListingUser" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderListingUser" ] } }, "/OrderListingUser/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderListingUser" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderListingUser" ] } }, "/OrderSet": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderSet" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderSet" ], "security": [ { "basicAuth": [] } ] } }, "/OrderSet/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderSet" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderSet" ], "security": [ { "basicAuth": [] } ] } }, "/OrderSetListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderSetListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderSetListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrderSetListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrderSetListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrderSetListing" ], "security": [ { "basicAuth": [] } ] } }, "/Organization": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/Organization" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Organization" ], "security": [ { "basicAuth": [] } ] } }, "/Organization/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/Organization" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Organization" ], "security": [ { "basicAuth": [] } ] } }, "/Organization/{id}/createPark": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "name", "in": "formData", "required": true, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Create a park for the organization.", "tags": [ "Organization" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/OrganizationPark" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/OrganizationAddress": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrganizationAddress" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationAddress" ], "security": [ { "basicAuth": [] } ] } }, "/OrganizationAddress/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrganizationAddress" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationAddress" ], "security": [ { "basicAuth": [] } ] } }, "/OrganizationAddressListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrganizationAddressListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationAddressListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrganizationAddressListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrganizationAddressListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationAddressListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrganizationListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrganizationListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrganizationListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrganizationListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrganizationPark": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrganizationPark" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationPark" ], "security": [ { "basicAuth": [] } ] } }, "/OrganizationPark/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrganizationPark" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationPark" ], "security": [ { "basicAuth": [] } ] } }, "/OrganizationPark/associate": { "patch": { "parameters": [ { "name": "park_id", "in": "formData", "required": true, "type": "string" }, { "name": "organization_ids", "in": "formData", "required": true, "type": "array", "items": { "type": "string" } } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Associate given `park_id` with given `organization_ids`.", "tags": [ "OrganizationPark" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrganizationPark" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/OrganizationPark/{id}/deassociate": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "park_id", "in": "formData", "required": true, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Remove all association for park by given `park_id`.", "tags": [ "OrganizationPark" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/Boolean" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/OrganizationParkListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrganizationParkListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationParkListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrganizationParkListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrganizationParkListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationParkListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrganizationStatusListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrganizationStatusListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationStatusListing" ], "security": [ { "basicAuth": [] } ] } }, "/OrganizationStatusListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/OrganizationStatusListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "OrganizationStatusListing" ], "security": [ { "basicAuth": [] } ] } }, "/Park": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/Park" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Park" ], "security": [ { "basicAuth": [] } ] } }, "/Park/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/Park" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Park" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "setnull", "in": "query", "description": "Array of fields to be set to null.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#/definitions/Park" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the update (same result as a get request). Otherwise it's just the number of affected rows. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Park" ], "security": [ { "basicAuth": [] } ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Park" ], "security": [ { "basicAuth": [] } ] } }, "/ParkListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ParkListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ParkListing" ], "security": [ { "basicAuth": [] } ] } }, "/ParkListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/ParkListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ParkListing" ], "security": [ { "basicAuth": [] } ] } }, "/ParkOrder": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ParkOrder" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ParkOrder" ], "security": [ { "basicAuth": [] } ] } }, "/ParkOrder/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/ParkOrder" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ParkOrder" ], "security": [ { "basicAuth": [] } ] } }, "/ParkOrder/{id}/associate": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "park_id", "in": "formData", "required": true, "type": "string" }, { "name": "order_id", "in": "formData", "required": true, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Associate given `park_id` with given `voucher_id`.", "tags": [ "ParkOrder" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/ParkOrder" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/ParkOrder/{id}/deassociate": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "order_id", "in": "formData", "required": true, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Deassociate given `voucher_id` from any park.", "tags": [ "ParkOrder" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/Boolean" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/ParkOrderListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/ParkOrderListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ParkOrderListing" ], "security": [ { "basicAuth": [] } ] } }, "/ParkOrderListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/ParkOrderListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ParkOrderListing" ], "security": [ { "basicAuth": [] } ] } }, "/PasswordRenewal/ask": { "patch": { "parameters": [ { "name": "email", "in": "formData", "required": true, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Ask a new password for given email.", "tags": [ "PasswordRenewal" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/String" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/PasswordRenewal/{id}/confirm": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "code", "in": "formData", "required": true, "type": "string" }, { "name": "password", "in": "formData", "required": true, "type": "string" }, { "name": "confirmation", "in": "formData", "required": false, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Confirm password modification.", "tags": [ "PasswordRenewal" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/Boolean" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/Product": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/Product" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Product" ], "security": [ { "basicAuth": [] } ] } }, "/Product/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/Product" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Product" ], "security": [ { "basicAuth": [] } ] } }, "/Registration": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/Registration" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Registration" ], "security": [ { "basicAuth": [] } ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#/definitions/Registration" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the insert (same result as a get request). Otherwise it's just the item's ID. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#/definitions/String" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Registration" ] } }, "/Registration/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/Registration" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Registration" ], "security": [ { "basicAuth": [] } ] } }, "/Registration/confirm": { "patch": { "parameters": [ { "name": "email", "in": "formData", "required": true, "type": "string" }, { "name": "code", "in": "formData", "required": true, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Confirm registration (after receiving the email).", "tags": [ "Registration" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/User" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/Registration/resend": { "patch": { "parameters": [ { "name": "email", "in": "formData", "required": true, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Resend registration email.", "tags": [ "Registration" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/Boolean" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/Setup": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/Setup" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Setup" ], "security": [ { "basicAuth": [] } ] } }, "/Setup/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/Setup" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Setup" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "setnull", "in": "query", "description": "Array of fields to be set to null.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "id", "latitude", "longitude", "file_id", "comment" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#/definitions/Setup" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the update (same result as a get request). Otherwise it's just the number of affected rows. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Setup" ], "security": [ { "basicAuth": [] } ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Setup" ], "security": [ { "basicAuth": [] } ] } }, "/Setup/initiate": { "patch": { "parameters": [ { "name": "name", "in": "formData", "required": true, "type": "string" }, { "name": "coordinates", "in": "formData", "required": true, "type": "array", "items": { "type": "number" } }, { "name": "reverse", "in": "formData", "required": true, "type": "string" }, { "name": "order_items", "in": "formData", "required": true, "type": "array", "items": { "type": "string" } }, { "name": "articles", "in": "formData", "required": true, "type": "array", "items": { "type": "string" } }, { "name": "order_reference", "in": "formData", "required": false, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Create setup.", "tags": [ "Setup" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/Setup" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/Setup/{id}/updateItems": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "order_items", "in": "formData", "required": true, "type": "array", "items": { "type": "string" } }, { "name": "articles", "in": "formData", "required": true, "type": "array", "items": { "type": "string" } } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Update setup.", "tags": [ "Setup" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/Setup" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/SetupCustomItem": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/SetupCustomItem" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupCustomItem" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#/definitions/SetupCustomItem" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the insert (same result as a get request). Otherwise it's just the item's ID. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#/definitions/String" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupCustomItem" ] } }, "/SetupCustomItem/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/SetupCustomItem" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupCustomItem" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "setnull", "in": "query", "description": "Array of fields to be set to null.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "id", "article_id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#/definitions/SetupCustomItem" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the update (same result as a get request). Otherwise it's just the number of affected rows. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupCustomItem" ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupCustomItem" ] } }, "/SetupFile": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/SetupFile" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupFile" ], "security": [ { "basicAuth": [] } ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#/definitions/SetupFile" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the insert (same result as a get request). Otherwise it's just the item's ID. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#/definitions/String" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupFile" ], "security": [ { "basicAuth": [] } ] } }, "/SetupFile/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/SetupFile" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupFile" ], "security": [ { "basicAuth": [] } ] } }, "/SetupItem": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/SetupItem" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupItem" ], "security": [ { "basicAuth": [] } ] } }, "/SetupItem/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/SetupItem" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupItem" ], "security": [ { "basicAuth": [] } ] } }, "/SetupItem/{id}/setBleModule": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "name", "in": "formData", "required": true, "type": "string" }, { "name": "mac", "in": "formData", "required": true, "type": "string" }, { "name": "profile_id", "in": "formData", "required": true, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Define BLE module for given SetupItem.", "tags": [ "SetupItem" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/SetupItemBleModule" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/SetupItem/{id}/applyLightingProfile": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "profile_id", "in": "formData", "required": true, "type": "string" }, { "name": "profile_custom", "in": "formData", "required": false, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Apply lighting profile.", "tags": [ "SetupItem" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/SetupItemBleModule" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/SetupItem/{id}/applyLightingGroup": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "group_id", "in": "formData", "required": true, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Apply lighting group.", "tags": [ "SetupItem" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/SetupItemBleModule" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/SetupItemBleModule": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/SetupItemBleModule" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupItemBleModule" ], "security": [ { "basicAuth": [] } ] } }, "/SetupItemBleModule/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/SetupItemBleModule" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupItemBleModule" ], "security": [ { "basicAuth": [] } ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupItemBleModule" ], "security": [ { "basicAuth": [] } ] } }, "/SetupItemLightingGroup": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/SetupItemLightingGroup" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupItemLightingGroup" ], "security": [ { "basicAuth": [] } ] } }, "/SetupItemLightingGroup/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/SetupItemLightingGroup" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupItemLightingGroup" ], "security": [ { "basicAuth": [] } ] } }, "/SetupItemListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/SetupItemListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupItemListing" ], "security": [ { "basicAuth": [] } ] } }, "/SetupItemListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/SetupItemListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupItemListing" ], "security": [ { "basicAuth": [] } ] } }, "/SetupListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/SetupListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupListing" ], "security": [ { "basicAuth": [] } ] } }, "/SetupListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/SetupListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "SetupListing" ], "security": [ { "basicAuth": [] } ] } }, "/StaticContent": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/StaticContent" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "StaticContent" ] } }, "/StaticContent/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/StaticContent" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "StaticContent" ] } }, "/User": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/User" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "User" ], "security": [ { "basicAuth": [] } ] } }, "/User/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/User" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "User" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "setnull", "in": "query", "description": "Array of fields to be set to null.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "id", "organization_id", "role_id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#/definitions/User" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the update (same result as a get request). Otherwise it's just the number of affected rows. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "User" ], "security": [ { "basicAuth": [] } ] } }, "/User/bulkValidate": { "patch": { "parameters": [ { "name": "ids", "in": "formData", "required": true, "type": "array", "items": { "type": "string" } } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Validate users by given ids.", "tags": [ "User" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "type": "array", "items": { "$ref": "#/definitions/User" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/me": { "get": { "summary": "Read current logged user infos", "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/User" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "User" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update current logged user infos", "parameters": [ { "name": "setnull", "in": "query", "description": "Array of fields to be set to null.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "id", "organization_id", "role_id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#/definitions/User" } }, { "name": "return_item", "in": "query", "description": "If defined and equal to true (or 1), the response is the entire item after the update (same result as a get request). Otherwise it's just the number of affected rows. Defaults to false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "User" ], "security": [ { "basicAuth": [] } ] }, "delete": { "summary": "Delete current logged user", "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#/definitions/Integer" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "User" ] } }, "/UserListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UserListing" ], "security": [ { "basicAuth": [] } ] } }, "/UserListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/UserListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UserListing" ], "security": [ { "basicAuth": [] } ] } }, "/UserOrder": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserOrder" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UserOrder" ], "security": [ { "basicAuth": [] } ] } }, "/UserOrder/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/UserOrder" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UserOrder" ], "security": [ { "basicAuth": [] } ] } }, "/UserOrderListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserOrderListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UserOrderListing" ], "security": [ { "basicAuth": [] } ] } }, "/UserOrderListing/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/UserOrderListing" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UserOrderListing" ], "security": [ { "basicAuth": [] } ] } }, "/UserPark": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserPark" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UserPark" ], "security": [ { "basicAuth": [] } ] } }, "/UserPark/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/UserPark" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UserPark" ], "security": [ { "basicAuth": [] } ] } }, "/UserPark/associate": { "patch": { "parameters": [ { "name": "organization_id", "in": "formData", "required": true, "type": "string" }, { "name": "park_id", "in": "formData", "required": true, "type": "string" }, { "name": "user_ids", "in": "formData", "required": true, "type": "array", "items": { "type": "string" } } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Associate given `park_id` with given `user_ids`.", "tags": [ "UserPark" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserPark" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/UserPark/associateUserToParks": { "patch": { "parameters": [ { "name": "user_id", "in": "formData", "required": true, "type": "string" }, { "name": "park_ids", "in": "formData", "required": false, "type": "array" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Associate user (by given user_id) to parks (by given park_ids).", "tags": [ "UserPark" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserPark" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/UserPark/{id}/deassociate": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "organization_id", "in": "formData", "required": true, "type": "string" }, { "name": "park_id", "in": "formData", "required": true, "type": "string" } ], "consumes": [ "application/x-www-form-urlencoded" ], "summary": "Remove all association for park by given `park_id`.", "tags": [ "UserPark" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#/definitions/Boolean" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "/UserParkListing": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserParkListing" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UserParkListing" ] } }, "/UserRole": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserRole" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UserRole" ] } }, "/UserRole/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/UserRole" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UserRole" ] } }, "/Voucher": { "get": { "summary": "Read many elements", "parameters": [ { "name": "If-Modified-Since", "in": "header", "description": "Last date of change_dt", "required": false, "type": "string", "format": "date-time" }, { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "name": "calc_rows", "in": "query", "description": "Will add the number of rows as a header in the response", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#/definitions/Voucher" } } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Voucher" ] } }, "/Voucher/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#/definitions/Voucher" } }, "400": { "description": "An managed error occurred (status code may actually vary).", "headers": { "Nx-Error-Code": { "description": "An explicit code that represent the error that occurred. See all *Error for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomain for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Voucher" ] } } }, "definitions": { "Boolean": { "type": "object", "properties": { "value": { "type": "boolean" } } }, "String": { "type": "object", "properties": { "value": { "type": "string" } } }, "Integer": { "type": "object", "properties": { "value": { "type": "integer" } } }, "Number": { "type": "object", "properties": { "value": { "type": "number" } } }, "ArrayOfStrings": { "type": "array", "items": { "type": "string" } }, "ArrayOfIntegers": { "type": "array", "items": { "type": "integer" } }, "ArrayOfNumbers": { "type": "array", "items": { "type": "number" } }, "AccessLevel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "label": { "type": "string" }, "level": { "type": "integer" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "label", "level", "create_dt", "change_dt" ] }, "ArticleLamp": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "manufacturer": { "type": "string" }, "model": { "type": "string" }, "description": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "manufacturer", "model", "description", "deleted", "create_dt", "change_dt" ] }, "ArticleLampColorRenderingIndexChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "value", "label", "deleted", "create_dt", "change_dt" ] }, "ArticleLampManufacturerChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "description": "*", "required": [ "value", "label" ] }, "ArticleLampModelChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "manufacturer": { "type": "string" } }, "description": "*", "required": [ "value", "label", "manufacturer" ] }, "ArticleLampPhotoCieChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "value", "label", "deleted", "create_dt", "change_dt" ] }, "ArticleLampRalTypeChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "value", "label", "deleted", "create_dt", "change_dt" ] }, "ArticlePole": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "document_id": { "type": "string" }, "manufacturer": { "type": "string" }, "model": { "type": "string" }, "material": { "type": "string" }, "height": { "type": "number", "format": "float" }, "type": { "type": "string" }, "shape": { "type": "string" }, "anchor_type": { "type": "string" }, "anchor_distance_x": { "type": "integer" }, "anchor_distance_y": { "type": "integer" }, "visit_dimension_x": { "type": "integer" }, "visit_dimension_y": { "type": "integer" }, "tip": { "type": "string" }, "head_diam": { "type": "integer" }, "tail_diam": { "type": "integer" }, "comment": { "type": "string" }, "finish": { "type": "string" }, "description_1": { "type": "string" }, "description_2": { "type": "string" }, "stainless_steel_base": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "manufacturer", "material", "deleted", "create_dt", "change_dt" ] }, "ArticlePoleAnchorTypeChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "description": "*" }, "ArticlePoleFinishChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "description": "*" }, "ArticlePoleHeadDiamChoice": { "type": "object", "properties": { "value": { "type": "integer" }, "label": { "type": "integer" } }, "description": "*" }, "ArticlePoleManufacturerChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "description": "*", "required": [ "value", "label" ] }, "ArticlePoleMaterialChoice": { "type": "object", "properties": { "value": { "type": "string" }, "Label": { "type": "string" } }, "description": "*", "required": [ "value", "Label" ] }, "ArticlePoleModelChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "manufacturer": { "type": "string" } }, "description": "*", "required": [ "manufacturer" ] }, "ArticlePoleRalTypeChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "value", "label", "deleted", "create_dt", "change_dt" ] }, "ArticlePoleShapeChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "description": "*" }, "ArticlePoleTipChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "description": "*" }, "ArticleStick": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "manufacturer": { "type": "string" }, "reference": { "type": "string" }, "material": { "type": "string" }, "type": { "type": "string" }, "protrusion": { "type": "number", "format": "float" }, "description_1": { "type": "string" }, "description_2": { "type": "string" }, "description_3": { "type": "string" }, "description_4": { "type": "string" }, "description_5": { "type": "string" }, "comment": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "deleted", "create_dt", "change_dt" ] }, "ArticleStickDiameterChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "value", "label", "deleted", "create_dt", "change_dt" ] }, "ArticleStickKindChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "value", "label", "deleted", "create_dt", "change_dt" ] }, "ArticleStickManufacturerChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "value", "label", "deleted", "create_dt", "change_dt" ] }, "ArticleStickMaterialChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "description": "*" }, "ArticleStickRalTypeChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "value", "label", "deleted", "create_dt", "change_dt" ] }, "ArticleStickReferenceChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "manufacturer": { "type": "string" } }, "description": "*" }, "ArticleStickTypeChoice": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "value", "label", "deleted", "create_dt", "change_dt" ] }, "BleData": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "payload": { "type": "string" }, "ble_module_id": { "type": "string" }, "type": { "type": "integer" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "payload", "ble_module_id", "type", "deleted", "create_dt", "change_dt" ] }, "BleModuleListing": { "type": "object", "properties": { "data_id": { "type": "string" }, "data_type": { "type": "integer" }, "payload": { "type": "string" }, "name": { "type": "string" }, "mac": { "type": "string" }, "module_id": { "type": "string" }, "setup_item_id": { "type": "string" }, "setup_id": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "data_id", "data_type", "payload", "name", "mac", "module_id", "setup_item_id", "setup_id", "deleted", "create_dt", "change_dt" ] }, "ContactMessage": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "sender": { "type": "string" }, "user_id": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "sender", "title", "content", "deleted", "create_dt", "change_dt" ] }, "Document": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "path": { "type": "string" }, "mime": { "type": "string" }, "origin_path": { "type": "string" }, "sha1": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "path", "mime", "origin_path", "sha1", "deleted", "create_dt", "change_dt" ] }, "Driver": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "article_id": { "type": "string" }, "document_id": { "type": "string" }, "ean": { "type": "string" }, "gtin": { "type": "string" }, "supplier": { "type": "string" }, "supplier_naming": { "type": "string" }, "description_1": { "type": "string" }, "description_2": { "type": "string" }, "zhaga_format": { "type": "integer" }, "power_max": { "type": "integer" }, "tension_prim_nom": { "type": "integer" }, "tension_prim_min": { "type": "integer" }, "tension_prim_max": { "type": "integer" }, "current_prim_min": { "type": "integer" }, "current_prim_max": { "type": "integer" }, "freq_min": { "type": "integer" }, "freq_max": { "type": "integer" }, "thd": { "type": "number", "format": "float" }, "power_factor": { "type": "number", "format": "float" }, "efficiency": { "type": "number", "format": "float" }, "nb_10": { "type": "integer" }, "nb_16": { "type": "integer" }, "nb_20": { "type": "integer" }, "ripple": { "type": "number", "format": "float" }, "voltage_sec_min": { "type": "integer" }, "voltage_sec_max": { "type": "integer" }, "current_sec_min": { "type": "integer" }, "current_sec_max": { "type": "integer" }, "tc_max": { "type": "integer" }, "protec_foud_ln": { "type": "integer" }, "protec_foud_lnpe": { "type": "integer" }, "dali_1": { "type": "boolean" }, "dali_2": { "type": "boolean" }, "d4i": { "type": "string" }, "alim_iot_24v": { "type": "boolean" }, "ntc": { "type": "boolean" }, "amp_dim": { "type": "boolean" }, "dynadimmer": { "type": "boolean" }, "adjust_output": { "type": "boolean" }, "others": { "type": "boolean" }, "standby_consumption": { "type": "number", "format": "float" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "article_id", "supplier", "supplier_naming", "description_1", "description_2", "d4i", "deleted", "create_dt", "change_dt" ] }, "Event": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "tag": { "type": "string" }, "type": { "type": "string" }, "user_id": { "type": "string" }, "organization_id": { "type": "string" }, "setup_id": { "type": "string" }, "payload": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "tag", "type", "payload", "deleted", "create_dt", "change_dt" ] }, "EventListing": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "tag": { "type": "string" }, "type": { "type": "string" }, "user_id": { "type": "string" }, "user": { "type": "string" }, "organization_id": { "type": "string" }, "organization": { "type": "string" }, "setup_id": { "type": "string" }, "setup": { "type": "string" }, "payload": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "tag", "type", "payload", "deleted", "create_dt", "change_dt" ] }, "ExportSetupItemListing": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "setup_id": { "type": "string" }, "organization_id": { "type": "string" }, "order_id": { "type": "string" }, "order_reference": { "type": "string" }, "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "setup_name": { "type": "string" }, "setup_reverse": { "type": "string" }, "park_id": { "type": "string" }, "park_name": { "type": "string" }, "item_type": { "type": "string" }, "item_id": { "type": "string" }, "article_id": { "type": "string" }, "type": { "type": "integer" }, "description": { "type": "string" }, "payload": { "type": "string" }, "has_ble": { "type": "integer" }, "ble_module_id": { "type": "string" }, "ble_name": { "type": "string" }, "ble_mac": { "type": "string" }, "ble_data": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "setup_id", "organization_id", "order_id", "order_reference", "setup_name", "setup_reverse", "item_type", "has_ble", "deleted", "create_dt", "change_dt" ] }, "Import": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "payload": { "type": "string" }, "files_count": { "type": "integer" }, "success": { "type": "boolean" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "name", "payload", "files_count", "success", "deleted", "create_dt", "change_dt" ] }, "LampDocument": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "body_code": { "type": "string" }, "document_id": { "type": "string" }, "type": { "type": "integer" }, "deleted": { "type": "integer" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "body_code", "document_id", "type", "deleted", "create_dt", "change_dt" ] }, "LampDocumentListing": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "body_code": { "type": "string" }, "document_id": { "type": "string" }, "document_path": { "type": "string" }, "mime": { "type": "string" }, "type": { "type": "integer" }, "deleted": { "type": "integer" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "body_code", "document_id", "document_path", "mime", "type", "deleted", "create_dt", "change_dt" ] }, "LightingGroup": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "organization_id": { "type": "string" }, "name": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "organization_id", "name", "deleted", "create_dt", "change_dt" ] }, "LightingProfile": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "organization_id": { "type": "string" }, "name": { "type": "string" }, "payload": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "is_default": { "type": "boolean" } }, "description": "*", "required": [ "organization_id", "name", "payload", "deleted", "create_dt", "change_dt", "is_default" ] }, "Order": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "orphan": { "type": "boolean" }, "invoice_id": { "type": "string" }, "receipt_id": { "type": "string" }, "invoice_date": { "type": "string", "format": "date-time" }, "receipt_date": { "type": "string", "format": "date-time" }, "setup_dpt": { "type": "string" }, "rep_id": { "type": "string" }, "shipment_id": { "type": "string" }, "rae": { "type": "string" }, "generated": { "type": "boolean" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "reference", "organization_id", "orphan", "invoice_date", "receipt_date", "generated", "deleted", "create_dt", "change_dt" ] }, "OrderCounter": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "order_id": { "type": "string" } }, "description": "*", "required": [ "order_id" ] }, "OrderDocument": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "order_id": { "type": "string" }, "order_file_id": { "type": "string" }, "deleted": { "type": "integer" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "name", "order_id", "order_file_id", "deleted", "create_dt", "change_dt" ] }, "OrderDocumentListing": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "order_id": { "type": "string" }, "order_reference": { "type": "string" }, "organization_id": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "mime": { "type": "string" }, "deleted": { "type": "integer" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "order_id", "order_reference", "name", "path", "mime", "deleted", "create_dt", "change_dt" ] }, "OrderFile": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "path": { "type": "string" }, "mime": { "type": "string" }, "deleted": { "type": "integer" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "path", "mime", "deleted", "create_dt", "change_dt" ] }, "OrderItem": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "order_id": { "type": "string" }, "article_id": { "type": "string" }, "type": { "type": "integer" }, "set_name": { "type": "string" }, "line_num": { "type": "string" }, "quantity": { "type": "integer" }, "description": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "order_id", "article_id", "line_num", "quantity", "deleted", "create_dt", "change_dt" ] }, "OrderItemData": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "order_id": { "type": "string" }, "article_id": { "type": "string" }, "line_num": { "type": "string" }, "type": { "type": "integer" }, "description_1": { "type": "string" }, "description_2": { "type": "string" }, "description_3": { "type": "string" }, "description_4": { "type": "string" }, "ral": { "type": "string" }, "spare_date": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "order_id", "article_id", "line_num", "type", "description_1", "description_2", "description_3", "description_4", "ral", "deleted", "create_dt", "change_dt" ] }, "OrderLamp": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "order_id": { "type": "string" }, "article_id": { "type": "string" }, "set_name": { "type": "string" }, "line_num": { "type": "string" }, "quantity": { "type": "integer" }, "description": { "type": "string" }, "driver_id": { "type": "string" }, "body_code": { "type": "string" }, "description_1": { "type": "string" }, "description_2": { "type": "string" }, "description_3": { "type": "string" }, "description_4": { "type": "string" }, "brand": { "type": "string" }, "fabric_date": { "type": "string", "format": "date-time" }, "ral": { "type": "string" }, "nom_flow": { "type": "string" }, "nom_current": { "type": "string" }, "nom_consumption": { "type": "string" }, "color_temp": { "type": "integer" }, "module_leds": { "type": "integer" }, "leds_count": { "type": "integer" }, "optical_system": { "type": "string" }, "color_rendering_index": { "type": "integer" }, "dlor": { "type": "string" }, "dlor_mounted": { "type": "string" }, "flow_code_3": { "type": "string" }, "supplier_naming": { "type": "string" }, "gtin": { "type": "string" }, "ean": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "order_id", "article_id", "line_num", "quantity", "body_code", "description_1", "description_2", "description_3", "description_4", "ral", "optical_system", "deleted", "create_dt", "change_dt" ] }, "OrderLampData": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "order_id": { "type": "string" }, "article_id": { "type": "string" }, "line_num": { "type": "string" }, "description_1": { "type": "string" }, "description_2": { "type": "string" }, "description_3": { "type": "string" }, "description_4": { "type": "string" }, "driver": { "type": "string" }, "module": { "type": "string" }, "module_leds": { "type": "integer" }, "module_type": { "type": "string" }, "body_code": { "type": "string" }, "optical_system": { "type": "string" }, "color_temp": { "type": "integer" }, "mounting": { "type": "string" }, "cauldron": { "type": "integer" }, "color_rendering_index": { "type": "integer" }, "ral": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "order_id", "article_id", "line_num", "description_1", "description_2", "description_3", "description_4", "driver", "module", "module_type", "body_code", "optical_system", "mounting", "ral", "deleted", "create_dt", "change_dt" ] }, "OrderLampDetail": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "order_id": { "type": "string" }, "article_id": { "type": "string" }, "line_num": { "type": "string" }, "ean": { "type": "string" }, "gtin": { "type": "string" }, "brand": { "type": "string" }, "model": { "type": "string" }, "supplier_naming": { "type": "string" }, "nom_flow": { "type": "string" }, "nom_current": { "type": "string" }, "nom_consumption": { "type": "string" }, "flow_code_3": { "type": "string" }, "fabric_date": { "type": "string", "format": "date-time" }, "leds_count": { "type": "integer" }, "dlor": { "type": "string" }, "dlor_mounted": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "order_id", "article_id", "line_num", "deleted", "create_dt", "change_dt" ] }, "OrderListing": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "setup_dpt": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "organization_city": { "type": "string" }, "organization_department": { "type": "string" }, "park_id": { "type": "string" }, "park_name": { "type": "string" }, "park_create_dt": { "type": "string", "format": "date-time" }, "associated": { "type": "integer" }, "documents": { "type": "integer" }, "generated": { "type": "boolean" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "reference", "organization_id", "organization_name", "associated", "generated", "deleted", "create_dt", "change_dt" ] }, "OrderListingUser": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "setup_dpt": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "organization_city": { "type": "string" }, "organization_department": { "type": "string" }, "park_id": { "type": "string" }, "park_name": { "type": "string" }, "associated": { "type": "integer" }, "documents": { "type": "integer" }, "generated": { "type": "boolean" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "user_id": { "type": "string" } }, "description": "*", "required": [ "id", "reference", "organization_id", "organization_name", "associated", "generated", "deleted", "create_dt", "change_dt", "user_id" ] }, "OrderSet": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "order_id": { "type": "string" }, "quantity": { "type": "integer" }, "line_num": { "type": "string" }, "description": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "name", "order_id", "quantity", "line_num", "deleted", "create_dt", "change_dt" ] }, "OrderSetListing": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "order_id": { "type": "string" }, "order_reference": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "integer" }, "length": { "type": "integer" }, "item_ids": { "type": "string" }, "description": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "order_id", "order_reference", "name", "quantity", "deleted", "create_dt", "change_dt" ] }, "Organization": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "allow_super_admin": { "type": "boolean" } }, "description": "*", "required": [ "deleted", "create_dt", "change_dt", "allow_super_admin" ] }, "OrganizationAddress": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "organization_id": { "type": "string" }, "position": { "type": "integer" }, "name": { "type": "string" }, "legal_name": { "type": "string" }, "line_1": { "type": "string" }, "line_2": { "type": "string" }, "department": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" }, "telecopy": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "organization_id", "position", "name", "deleted", "create_dt", "change_dt" ] }, "OrganizationAddressListing": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "organization_id": { "type": "string" }, "name": { "type": "string" }, "legal_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "department": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" }, "telecopy": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "organization_id", "deleted", "create_dt" ] }, "OrganizationListing": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "zipcode": { "type": "string" }, "department": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" }, "setups": { "type": "integer" }, "users": { "type": "integer" }, "orders": { "type": "integer" }, "parks": { "type": "integer" }, "create_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "create_dt", "deleted" ] }, "OrganizationPark": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "organization_id": { "type": "string" }, "park_id": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "organization_id", "park_id", "deleted", "create_dt", "change_dt" ] }, "OrganizationParkListing": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "park_id": { "type": "string" }, "park_name": { "type": "string" }, "users": { "type": "integer" }, "orders": { "type": "integer" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "organization_id", "organization_name", "park_id", "park_name", "deleted", "create_dt", "change_dt" ] }, "OrganizationStatusListing": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "setups": { "type": "integer" }, "users": { "type": "integer" }, "orders": { "type": "integer" }, "parks": { "type": "integer" }, "create_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "deleted" ] }, "Park": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "name", "deleted", "create_dt", "change_dt" ] }, "ParkListing": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "users": { "type": "integer" }, "organizations": { "type": "integer" }, "organization_ids": { "type": "string" }, "orders": { "type": "integer" }, "setups": { "type": "integer" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "name", "deleted", "create_dt", "change_dt" ] }, "ParkOrder": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "park_id": { "type": "string" }, "order_id": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "park_id", "order_id", "deleted", "create_dt", "change_dt" ] }, "ParkOrderListing": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "park_id": { "type": "string" }, "park_name": { "type": "string" }, "order_id": { "type": "string" }, "order_reference": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "generated": { "type": "boolean" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "park_id", "park_name", "order_id", "order_reference", "generated", "deleted", "create_dt" ] }, "PasswordRenewal": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "email": { "type": "string" }, "codes": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "Password renewal.", "required": [ "email", "codes", "deleted", "create_dt", "change_dt" ] }, "Product": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "name", "deleted", "create_dt", "change_dt" ] }, "Registration": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "email": { "type": "string" }, "password": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "organization_id": { "type": "string" }, "voucher_id": { "type": "string" }, "order_id": { "type": "string" }, "role_id": { "type": "string" }, "code": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "email", "password", "first_name", "last_name", "organization_id", "voucher_id", "role_id", "code", "deleted", "create_dt", "change_dt" ] }, "Setup": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "order_reference": { "type": "string" }, "user_id": { "type": "string" }, "name": { "type": "string" }, "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "reverse": { "type": "string" }, "file_id": { "type": "string" }, "comment": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "order_reference", "user_id", "name", "reverse", "deleted", "create_dt", "change_dt" ] }, "SetupCustomItem": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "article_id": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "integer" }, "payload": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "description", "type", "payload", "deleted", "create_dt", "change_dt" ] }, "SetupFile": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "path": { "type": "string" }, "mime": { "type": "string" }, "deleted": { "type": "integer" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "Describe files uploaded by an user during the setup creation.", "required": [ "path", "mime", "deleted", "create_dt", "change_dt" ] }, "SetupItem": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "setup_id": { "type": "string" }, "item_type": { "type": "string" }, "item_id": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "setup_id", "item_type", "item_id", "deleted", "create_dt", "change_dt" ] }, "SetupItemBleModule": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "setup_item_id": { "type": "string" }, "name": { "type": "string" }, "mac": { "type": "string" }, "profile_id": { "type": "string" }, "profile_custom": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "setup_item_id", "name", "mac", "deleted", "create_dt", "change_dt" ] }, "SetupItemLightingGroup": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "setup_item_id": { "type": "string" }, "lighting_group_id": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "setup_item_id", "lighting_group_id", "deleted", "create_dt", "change_dt" ] }, "SetupItemListing": { "type": "object", "properties": { "u_id": { "type": "string" }, "id": { "type": "string", "x-primary-key": true }, "setup_id": { "type": "string" }, "order_id": { "type": "string" }, "park_id": { "type": "string" }, "item_type": { "type": "string" }, "item_id": { "type": "string" }, "article_id": { "type": "string" }, "type": { "type": "integer" }, "description": { "type": "string" }, "payload": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "u_id", "id", "setup_id", "order_id", "item_type", "deleted", "create_dt", "change_dt" ] }, "SetupListing": { "type": "object", "properties": { "u_id": { "type": "string" }, "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "park_id": { "type": "string" }, "park_name": { "type": "string" }, "park_create_dt": { "type": "string", "format": "date-time" }, "order_id": { "type": "string" }, "order_reference": { "type": "string" }, "order": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "user_id": { "type": "string" }, "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "reverse": { "type": "string" }, "file_id": { "type": "string" }, "comment": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "user": { "type": "string" } }, "description": "*", "required": [ "u_id", "id", "name", "order_id", "order_reference", "organization_id", "organization_name", "user_id", "reverse", "deleted", "create_dt", "change_dt" ] }, "StaticContent": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "locale": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" }, "items": { "type": "string" }, "html": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "required": [ "locale", "slug", "title", "items", "deleted", "create_dt", "change_dt" ] }, "User": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "organization_id": { "type": "string" }, "role_id": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "access_level": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "validated": { "type": "boolean" }, "activated": { "type": "boolean" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "Describe an user (human).", "required": [ "email", "password", "access_level", "first_name", "last_name", "validated", "activated", "deleted", "create_dt", "change_dt" ] }, "UserListing": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "email": { "type": "string" }, "access_level": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "validated": { "type": "boolean" }, "activated": { "type": "boolean" }, "deleted": { "type": "boolean" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "allow_super_admin": { "type": "boolean" }, "role_id": { "type": "string" }, "role": { "type": "string" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "Listing (view) for users.", "required": [ "id", "email", "access_level", "first_name", "last_name", "validated", "activated", "deleted", "organization_name", "create_dt", "change_dt" ] }, "UserOrder": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "user_id": { "type": "string" }, "order_id": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "user_id", "order_id", "deleted", "create_dt", "change_dt" ] }, "UserOrderListing": { "type": "object", "properties": { "order_id": { "type": "string" }, "user_id": { "type": "string" }, "organization_id": { "type": "string" }, "deleted": { "type": "integer" }, "id": { "type": "string", "x-primary-key": true }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "order_id", "user_id", "organization_id", "deleted", "create_dt", "change_dt" ] }, "UserPark": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "user_id": { "type": "string" }, "park_id": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "Association between an user and a park.", "required": [ "user_id", "park_id", "deleted", "create_dt", "change_dt" ] }, "UserParkListing": { "type": "object", "properties": { "user_id": { "type": "string" }, "park_id": { "type": "string" }, "park_name": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "user_email": { "type": "string" }, "user_access_level": { "type": "integer" }, "user_first_name": { "type": "string" }, "user_last_name": { "type": "string" }, "user_validated": { "type": "integer" }, "user_activated": { "type": "integer" }, "deleted": { "type": "integer" }, "change_dt": { "type": "string", "format": "date-time" }, "create_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "user_id", "park_id", "park_name", "organization_name", "user_email", "user_access_level", "user_first_name", "user_last_name", "user_validated", "user_activated" ] }, "UserRole": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "label": { "type": "string" }, "deleted": { "type": "boolean" }, "create_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "label", "deleted", "create_dt", "change_dt" ] }, "Voucher": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "organization_id": { "type": "string" }, "order_id": { "type": "string" }, "deleted": { "type": "boolean" }, "change_dt": { "type": "string", "format": "date-time" }, "create_dt": { "type": "string", "format": "date-time" } }, "description": "*", "required": [ "id", "organization_id", "order_id", "deleted", "change_dt", "create_dt" ] }, "ApiCoreError": { "description": "An explicit code that represent the error that occurred within the ApiCore domain. 404: notFound | 405: methodNotAllowed | 406: methodUnavailable | 650: unknownObject | 655: missingMethodForPatch | 900: missingIdForUpdate | 901: missingIdForDelete | 1024: badLoginOrPassword | 1234: badResponseType | 2001: missingAlias | 2002: missingFieldsForUpdate | 2003: missingFieldsForInsert | 2004: missingWhereClause | 2005: missingParameter | 2006: writeOnly | 1100: locoUpdateFailed | 12001: notAllowed | 12002: missingLoginOrPassword | 12003: noUserSet | 42421: missingAppInstallIdentifier | 42422: missingAppIdentifier | 42423: missingAppVersionIdentifier | 42424: applicationVersionNotAllowed", "type": "string", "enum": [ 404, 405, 406, 650, 655, 900, 901, 1024, 1234, 2001, 2002, 2003, 2004, 2005, 2006, 1100, 12001, 12002, 12003, 42421, 42422, 42423, 42424 ] }, "ProjectError": { "description": "An explicit code that represent the error that occurred within the Project domain. 42: unexpected | 1024: loginError | 389: userRegisterEmailAlreadyInUse | 390: userRegisterRgistrationAlreadyProcessing | 2206: renewPasswordExpiredRequest | 2208: renewPasswordMismatch | 2209: renewPasswordInvalidCode | 2210: registrationInvalidCode | 234: loginMissingHeader | 235: loginJwtSignature | 236: loginFetchModel | 237: loginUnactivatedAccount | 820: humanUserExpected | 821: userMustBeOwner | 822: userMustBeSelf | 4400: canNotImpersonate | 4401: canNotBeImpersonated | 32256: canNotGenerateSerialID | 33846: canNotAssociateParkWithVoucher | 33847: voucherNotFoundById | 33848: orderNotFoundByReference | 42624: invalidGpsCoordinates | 52000: invalidSetupReverse | 52022: moduleMustBeCreated | 33847: canNotFindOrderItemInOrder | 2222: unexpectedValueException", "type": "string", "enum": [ 42, 1024, 389, 390, 2206, 2208, 2209, 2210, 234, 235, 236, 237, 820, 821, 822, 4400, 4401, 32256, 33846, 33847, 33848, 42624, 52000, 52022, 33847, 2222 ] }, "ErrorsDomain": { "description": "Represents an errors domain. Some error codes can be in several domain at the same time but a single domain can only contain an error code once.", "type": "string", "enum": [ "Sql", "ApiCore", "Project" ] } } }