{ "swagger": "2.0", "info": { "title": "nasqah", "version": "1", "description": "API generated with Nx\/APIREST" }, "host": "api.nasqah.com", "basePath": "\/", "schemes": [ "http" ], "consumes": [ "application\/json", "multipart\/form-data", "application\/x-www-form-urlencoded" ], "produces": [ "application\/json" ], "securityDefinitions": { "basicAuth": { "type": "basic", "description": "Global Security" } }, "tags": [ { "name": "AnonymousRequests" }, { "name": "CompanyTypes" }, { "name": "DocumentationFileCategories" }, { "name": "DocumentationFileThumbnails" }, { "name": "DocumentationFiles" }, { "name": "FeedbackImages" }, { "name": "FeedbackTopics" }, { "name": "FeedbackTypes" }, { "name": "Feedbacks" }, { "name": "Languages" }, { "name": "News" }, { "name": "Orders" }, { "name": "PricingRequestImageTypes" }, { "name": "PricingRequestImages" }, { "name": "PricingRequestResponseOrders" }, { "name": "PricingRequestResponses" }, { "name": "PricingRequests" }, { "name": "ProductBrands" }, { "name": "ProductImportedFiles" }, { "name": "ProductManufacturers" }, { "name": "ProductShapes" }, { "name": "ProductTypes" }, { "name": "Products" }, { "name": "Regions" }, { "name": "TanalsContactTypes" }, { "name": "TanalsContacts" }, { "name": "TokboxEvents" }, { "name": "TokboxSessions" }, { "name": "UnitHardness" }, { "name": "UnitLength" }, { "name": "UnitPower" }, { "name": "UnitTorque" }, { "name": "UsageExampleCategories" }, { "name": "UsageExampleImages" }, { "name": "UsageExamples" }, { "name": "Users" }, { "name": "VisitReportImages" }, { "name": "VisitReports" }, { "name": "XmlRequests" } ], "paths": { "\/AnonymousRequest": { "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\/AnonymousRequestModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "AnonymousRequests" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/AnonymousRequestModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "AnonymousRequests" ] } }, "\/AnonymousRequest\/{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\/AnonymousRequestModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "AnonymousRequests" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/AnonymousRequestModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "AnonymousRequests" ] } }, "\/CompanyType": { "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\/CompanyTypeModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "CompanyTypes" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/CompanyTypeModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "CompanyTypes" ] } }, "\/CompanyType\/{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\/CompanyTypeModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "CompanyTypes" ] }, "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": [ "disabled_dt" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/CompanyTypeModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "CompanyTypes" ] } }, "\/DocumentationFileCategory": { "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\/DocumentationFileCategoryModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFileCategories" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/DocumentationFileCategoryModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFileCategories" ] } }, "\/DocumentationFileCategory\/{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\/DocumentationFileCategoryModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFileCategories" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/DocumentationFileCategoryModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFileCategories" ] } }, "\/DocumentationFileThumbnail": { "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\/DocumentationFileThumbnailModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFileThumbnails" ] }, "post": { "summary": "Create", "consumes": [ "multipart\/form-data" ], "parameters": [ { "name": "file", "in": "formData", "description": "File to upload", "required": true, "type": "file" }, { "name": "id", "in": "formData", "required": true, "type": "string" }, { "name": "path", "in": "formData", "required": true, "type": "string" }, { "name": "mime", "in": "formData", "required": true, "type": "string" }, { "name": "creation_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "change_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "deleted", "in": "formData", "required": true, "type": "boolean" }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFileThumbnails" ] } }, "\/DocumentationFileThumbnail\/{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\/DocumentationFileThumbnailModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFileThumbnails" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/DocumentationFileThumbnailModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFileThumbnails" ] } }, "\/DocumentationFile": { "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\/DocumentationFileModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFiles" ] }, "post": { "summary": "Create", "consumes": [ "multipart\/form-data" ], "parameters": [ { "name": "file", "in": "formData", "description": "File to upload", "required": true, "type": "file" }, { "name": "id", "in": "formData", "required": true, "type": "string" }, { "name": "name", "in": "formData", "required": true, "type": "string" }, { "name": "language_id", "in": "formData", "required": true, "type": "string" }, { "name": "category_id", "in": "formData", "required": true, "type": "string" }, { "name": "thumbnail_id", "in": "formData", "required": false, "type": "string" }, { "name": "path", "in": "formData", "required": true, "type": "string" }, { "name": "mime", "in": "formData", "required": true, "type": "string" }, { "name": "public", "in": "formData", "required": true, "type": "boolean" }, { "name": "brand", "in": "formData", "required": false, "type": "string" }, { "name": "manufacturer", "in": "formData", "required": false, "type": "string" }, { "name": "family", "in": "formData", "required": false, "type": "string" }, { "name": "creation_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "change_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "deleted", "in": "formData", "required": true, "type": "boolean" }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFiles" ] } }, "\/DocumentationFile\/{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\/DocumentationFileModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFiles" ] }, "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": [ "thumbnail_id", "brand", "manufacturer", "family" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/DocumentationFileModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "DocumentationFiles" ] } }, "\/DocumentationFile\/{id}\/thumbnail": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" } ], "consumes": [ "application\/x-www-form-urlencoded" ], "summary": "Get thumbnail_id for generated thumbnail (``DocumentationFileThumbnail``).", "tags": [ "DocumentationFiles" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#\/definitions\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "\/FeedbackImage": { "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\/FeedbackImageModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackImages" ] }, "post": { "summary": "Create", "consumes": [ "multipart\/form-data" ], "parameters": [ { "name": "file", "in": "formData", "description": "File to upload", "required": true, "type": "file" }, { "name": "id", "in": "formData", "required": true, "type": "string" }, { "name": "path", "in": "formData", "required": true, "type": "string" }, { "name": "mime", "in": "formData", "required": true, "type": "string" }, { "name": "creation_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "change_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "deleted", "in": "formData", "required": true, "type": "boolean" }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackImages" ] } }, "\/FeedbackImage\/{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\/FeedbackImageModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackImages" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/FeedbackImageModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackImages" ] } }, "\/FeedbackTopic": { "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\/FeedbackTopicModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackTopics" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/FeedbackTopicModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackTopics" ] } }, "\/FeedbackTopic\/{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\/FeedbackTopicModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackTopics" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/FeedbackTopicModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackTopics" ] } }, "\/FeedbackType": { "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\/FeedbackTypeModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackTypes" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/FeedbackTypeModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackTypes" ] } }, "\/FeedbackType\/{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\/FeedbackTypeModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackTypes" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/FeedbackTypeModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "FeedbackTypes" ] } }, "\/Feedback": { "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\/FeedbackModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Feedbacks" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/FeedbackModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Feedbacks" ] } }, "\/Feedback\/{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\/FeedbackModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Feedbacks" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/FeedbackModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Feedbacks" ] } }, "\/Language": { "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\/LanguageModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Languages" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/LanguageModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Languages" ] } }, "\/Language\/{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\/LanguageModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Languages" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/LanguageModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Languages" ] } }, "\/News": { "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\/NewsModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "News" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/NewsModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "News" ] } }, "\/News\/{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\/NewsModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "News" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/NewsModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "News" ] } }, "\/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\/OrderModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Orders" ] } }, "\/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\/OrderModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Orders" ] } }, "\/PricingRequestImageType": { "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\/PricingRequestImageTypeModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestImageTypes" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/PricingRequestImageTypeModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestImageTypes" ] } }, "\/PricingRequestImageType\/{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\/PricingRequestImageTypeModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestImageTypes" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/PricingRequestImageTypeModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestImageTypes" ] } }, "\/PricingRequestImage": { "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\/PricingRequestImageModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestImages" ] }, "post": { "summary": "Create", "consumes": [ "multipart\/form-data" ], "parameters": [ { "name": "file", "in": "formData", "description": "File to upload", "required": true, "type": "file" }, { "name": "id", "in": "formData", "required": true, "type": "string" }, { "name": "image_type_id", "in": "formData", "required": true, "type": "string" }, { "name": "path", "in": "formData", "required": true, "type": "string" }, { "name": "mime", "in": "formData", "required": true, "type": "string" }, { "name": "creation_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "change_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "deleted", "in": "formData", "required": true, "type": "boolean" }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestImages" ] } }, "\/PricingRequestImage\/{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\/PricingRequestImageModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestImages" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/PricingRequestImageModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestImages" ] } }, "\/PricingRequestResponseOrder": { "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\/PricingRequestResponseOrderModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestResponseOrders" ] }, "post": { "summary": "Create", "consumes": [ "multipart\/form-data" ], "parameters": [ { "name": "file", "in": "formData", "description": "File to upload", "required": true, "type": "file" }, { "name": "id", "in": "formData", "required": true, "type": "string" }, { "name": "pricing_request_response_id", "in": "formData", "required": true, "type": "string" }, { "name": "selected_offer_name", "in": "formData", "required": true, "type": "string" }, { "name": "selected_offer_currency", "in": "formData", "required": true, "type": "string" }, { "name": "selected_offer_proposed_value", "in": "formData", "required": true, "type": "integer" }, { "name": "selected_offer_agreed_value", "in": "formData", "required": true, "type": "integer" }, { "name": "selected_offer_due_date", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "path", "in": "formData", "required": true, "type": "string" }, { "name": "mime", "in": "formData", "required": true, "type": "string" }, { "name": "creation_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "change_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "deleted", "in": "formData", "required": true, "type": "boolean" }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestResponseOrders" ] } }, "\/PricingRequestResponseOrder\/{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\/PricingRequestResponseOrderModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestResponseOrders" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/PricingRequestResponseOrderModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestResponseOrders" ] } }, "\/PricingRequestResponse": { "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\/PricingRequestResponseModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestResponses" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/PricingRequestResponseModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestResponses" ] } }, "\/PricingRequestResponse\/{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\/PricingRequestResponseModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestResponses" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/PricingRequestResponseModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequestResponses" ] } }, "\/PricingRequest": { "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\/PricingRequestModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequests" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/PricingRequestModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequests" ] } }, "\/PricingRequest\/{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\/PricingRequestModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequests" ] }, "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": [ "name" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/PricingRequestModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "PricingRequests" ] } }, "\/ProductBrand": { "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\/ProductBrandModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductBrands" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/ProductBrandModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductBrands" ] } }, "\/ProductBrand\/{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\/ProductBrandModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductBrands" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/ProductBrandModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductBrands" ] } }, "\/ProductImportedFile": { "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\/ProductImportedFileModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductImportedFiles" ], "security": [ { "basicAuth": [] } ] }, "post": { "summary": "Create", "consumes": [ "multipart\/form-data" ], "parameters": [ { "name": "file", "in": "formData", "description": "File to upload", "required": true, "type": "file" }, { "name": "id", "in": "formData", "required": true, "type": "string" }, { "name": "format", "in": "formData", "required": true, "type": "string", "enum": [ "csv" ] }, { "name": "path", "in": "formData", "required": true, "type": "string" }, { "name": "mime", "in": "formData", "required": true, "type": "string" }, { "name": "creation_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "change_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "deleted", "in": "formData", "required": true, "type": "boolean" }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductImportedFiles" ], "security": [ { "basicAuth": [] } ] } }, "\/ProductImportedFile\/{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\/ProductImportedFileModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductImportedFiles" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/ProductImportedFileModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductImportedFiles" ], "security": [ { "basicAuth": [] } ] } }, "\/ProductManufacturer": { "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\/ProductManufacturerModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductManufacturers" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/ProductManufacturerModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductManufacturers" ] } }, "\/ProductManufacturer\/{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\/ProductManufacturerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductManufacturers" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/ProductManufacturerModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductManufacturers" ] } }, "\/ProductShape": { "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\/ProductShapeModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductShapes" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/ProductShapeModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductShapes" ] } }, "\/ProductShape\/{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\/ProductShapeModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductShapes" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/ProductShapeModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductShapes" ] } }, "\/ProductType": { "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\/ProductTypeModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductTypes" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/ProductTypeModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductTypes" ] } }, "\/ProductType\/{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\/ProductTypeModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductTypes" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/ProductTypeModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "ProductTypes" ] } }, "\/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\/ProductModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Products" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/ProductModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Products" ] } }, "\/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\/ProductModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Products" ] }, "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": [ "description", "type_id", "brand_id", "shape_id", "step_unit_length_id", "length", "length_unit_length_id", "width", "width_unit_length_id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/ProductModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Products" ] } }, "\/Region": { "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\/RegionModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Regions" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/RegionModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Regions" ] } }, "\/Region\/{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\/RegionModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Regions" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/RegionModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Regions" ] } }, "\/TanalsContactType": { "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\/TanalsContactTypeModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TanalsContactTypes" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/TanalsContactTypeModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TanalsContactTypes" ] } }, "\/TanalsContactType\/{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\/TanalsContactTypeModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TanalsContactTypes" ] }, "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": [ "disabled_dt" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/TanalsContactTypeModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TanalsContactTypes" ] } }, "\/TanalsContact": { "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\/TanalsContactModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TanalsContacts" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/TanalsContactModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TanalsContacts" ] } }, "\/TanalsContact\/{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\/TanalsContactModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TanalsContacts" ] }, "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": [ "disabled_dt" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/TanalsContactModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TanalsContacts" ] } }, "\/TokboxEvent": { "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\/TokboxEventModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TokboxEvents" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/TokboxEventModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TokboxEvents" ] } }, "\/TokboxEvent\/{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\/TokboxEventModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TokboxEvents" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/TokboxEventModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TokboxEvents" ] } }, "\/TokboxSession": { "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\/TokboxSessionModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TokboxSessions" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/TokboxSessionModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TokboxSessions" ] } }, "\/TokboxSession\/{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\/TokboxSessionModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TokboxSessions" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/TokboxSessionModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "TokboxSessions" ] } }, "\/TokboxSession\/{id}\/getNewToken": { "patch": { "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "duration", "in": "formData", "required": false, "type": "integer" } ], "consumes": [ "application\/x-www-form-urlencoded" ], "summary": "Get a new token from the OpenTok API", "tags": [ "TokboxSessions" ], "responses": { "200": { "description": "The patch method return item.", "schema": { "$ref": "#\/definitions\/TokBoxTokenModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } } } }, "\/UnitHardness": { "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\/UnitHardnessModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitHardness" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/UnitHardnessModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitHardness" ] } }, "\/UnitHardness\/{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\/UnitHardnessModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitHardness" ] }, "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": [ "base_unit_length_id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/UnitHardnessModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitHardness" ] } }, "\/UnitLength": { "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\/UnitLengthModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitLength" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/UnitLengthModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitLength" ] } }, "\/UnitLength\/{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\/UnitLengthModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitLength" ] }, "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": [ "base_unit_id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/UnitLengthModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitLength" ] } }, "\/UnitPower": { "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\/UnitPowerModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitPower" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/UnitPowerModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitPower" ] } }, "\/UnitPower\/{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\/UnitPowerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitPower" ] }, "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": [ "base_unit_id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/UnitPowerModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitPower" ] } }, "\/UnitTorque": { "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\/UnitTorqueModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitTorque" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/UnitTorqueModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitTorque" ] } }, "\/UnitTorque\/{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\/UnitTorqueModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitTorque" ] }, "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": [ "base_unit_id" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/UnitTorqueModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UnitTorque" ] } }, "\/UsageExampleCategory": { "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\/UsageExampleCategoryModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExampleCategories" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/UsageExampleCategoryModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExampleCategories" ] } }, "\/UsageExampleCategory\/{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\/UsageExampleCategoryModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExampleCategories" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/UsageExampleCategoryModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExampleCategories" ] } }, "\/UsageExampleImage": { "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\/UsageExampleImageModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExampleImages" ] }, "post": { "summary": "Create", "consumes": [ "multipart\/form-data" ], "parameters": [ { "name": "file", "in": "formData", "description": "File to upload", "required": true, "type": "file" }, { "name": "id", "in": "formData", "required": true, "type": "string" }, { "name": "path", "in": "formData", "required": true, "type": "string" }, { "name": "mime", "in": "formData", "required": true, "type": "string" }, { "name": "creation_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "change_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "deleted", "in": "formData", "required": true, "type": "boolean" }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExampleImages" ] } }, "\/UsageExampleImage\/{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\/UsageExampleImageModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExampleImages" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/UsageExampleImageModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExampleImages" ] } }, "\/UsageExample": { "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\/UsageExampleModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExamples" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/UsageExampleModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExamples" ] } }, "\/UsageExample\/{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\/UsageExampleModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExamples" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/UsageExampleModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "UsageExamples" ] } }, "\/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\/UserModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Users" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/UserModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Users" ] } }, "\/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\/UserModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Users" ] }, "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": [ "pwd", "pwd_tmp", "docwall_id", "group_name", "geo_zone", "customer_code", "activated_dt", "disabled_dt" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/UserModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Users" ] } }, "\/me": { "get": { "summary": "Read current logged user infos", "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/UserModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Users" ] }, "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": [ "pwd", "pwd_tmp", "docwall_id", "group_name", "geo_zone", "customer_code", "activated_dt", "disabled_dt" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/UserModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "Users" ] } }, "\/VisitReportImage": { "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\/VisitReportImageModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "VisitReportImages" ] }, "post": { "summary": "Create", "consumes": [ "multipart\/form-data" ], "parameters": [ { "name": "file", "in": "formData", "description": "File to upload", "required": true, "type": "file" }, { "name": "id", "in": "formData", "required": true, "type": "string" }, { "name": "path", "in": "formData", "required": true, "type": "string" }, { "name": "mime", "in": "formData", "required": true, "type": "string" }, { "name": "creation_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "change_dt", "in": "formData", "required": true, "type": "string", "format": "date-time" }, { "name": "deleted", "in": "formData", "required": true, "type": "boolean" }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "VisitReportImages" ] } }, "\/VisitReportImage\/{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\/VisitReportImageModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "VisitReportImages" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "string" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/VisitReportImageModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "VisitReportImages" ] } }, "\/VisitReport": { "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\/VisitReportModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "VisitReports" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/VisitReportModel" } }, { "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\/StringModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "VisitReports" ] } }, "\/VisitReport\/{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\/VisitReportModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "VisitReports" ] }, "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": [ "pricing_request_id", "note" ] } }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/VisitReportModel" } }, { "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\/IntegerModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "VisitReports" ] } }, "\/XmlRequest": { "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\/XmlRequestModel" } } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "XmlRequests" ] } }, "\/XmlRequest\/{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\/XmlRequestModel" } }, "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 *ErrorModel for more information.", "type": "string" }, "Nx-Error-Domain": { "description": "The domain of the error. See ErrorsDomainModel for more information.", "type": "string" }, "Nx-Error": { "description": "A debug description of the error that occurred.", "type": "string" } } } }, "tags": [ "XmlRequests" ] } } }, "definitions": { "BooleanModel": { "type": "object", "properties": { "value": { "type": "boolean" } } }, "StringModel": { "type": "object", "properties": { "value": { "type": "string" } } }, "IntegerModel": { "type": "object", "properties": { "value": { "type": "integer" } } }, "NumberModel": { "type": "object", "properties": { "value": { "type": "number" } } }, "AnonymousRequestModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "email": { "type": "string" }, "type": { "type": "string", "enum": [ "pwd_recovery" ] }, "client_ip_address": { "type": "string" }, "client_app_install": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "email", "type", "client_ip_address", "client_app_install", "creation_dt", "change_dt", "deleted" ] }, "CompanyTypeModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "disabled_dt": { "type": "string", "format": "date-time" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "DocumentationFileCategoryModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "DocumentationFileThumbnailModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "path": { "type": "string" }, "mime": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "path", "mime", "creation_dt", "change_dt", "deleted" ] }, "DocumentationFileModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "language_id": { "type": "string" }, "category_id": { "type": "string" }, "thumbnail_id": { "type": "string" }, "path": { "type": "string" }, "mime": { "type": "string" }, "public": { "type": "boolean" }, "brand": { "type": "string" }, "manufacturer": { "type": "string" }, "family": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "language_id", "category_id", "path", "mime", "public", "creation_dt", "change_dt", "deleted" ] }, "FeedbackImageModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "path": { "type": "string" }, "mime": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "path", "mime", "creation_dt", "change_dt", "deleted" ] }, "FeedbackTopicModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "FeedbackTypeModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "FeedbackModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "user_id": { "type": "string" }, "content": { "type": "string" }, "feedback_topic_id": { "type": "string" }, "feedback_type_id": { "type": "string" }, "feedback_images": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "user_id", "content", "feedback_topic_id", "feedback_type_id", "feedback_images", "creation_dt", "change_dt", "deleted" ] }, "LanguageModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "NewsModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "title": { "type": "string" }, "content": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "title", "content", "creation_dt", "change_dt", "deleted" ] }, "OrderModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "selected_offer_name": { "type": "string" }, "selected_offer_currency": { "type": "string" }, "selected_offer_proposed_value": { "type": "integer" }, "selected_offer_agreed_value": { "type": "integer" }, "selected_offer_due_date": { "type": "string", "format": "date-time" }, "path": { "type": "string" }, "order_date": { "type": "string", "format": "date-time" }, "price_list": { "type": "string" }, "summary": { "type": "string" }, "offer_date": { "type": "string", "format": "date-time" }, "request": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "phone_number": { "type": "string" }, "company_name": { "type": "string" }, "city_name": { "type": "string" }, "zip_code": { "type": "string" }, "customer_code": { "type": "string" } }, "required": [ "id", "selected_offer_name", "selected_offer_currency", "selected_offer_proposed_value", "selected_offer_agreed_value", "selected_offer_due_date", "path", "order_date", "price_list", "summary", "offer_date", "request", "email", "first_name", "last_name", "phone_number", "company_name", "city_name", "zip_code" ] }, "PricingRequestImageTypeModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "PricingRequestImageModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "image_type_id": { "type": "string" }, "path": { "type": "string" }, "mime": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "image_type_id", "path", "mime", "creation_dt", "change_dt", "deleted" ] }, "PricingRequestResponseOrderModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "pricing_request_response_id": { "type": "string" }, "selected_offer_name": { "type": "string" }, "selected_offer_currency": { "type": "string" }, "selected_offer_proposed_value": { "type": "integer" }, "selected_offer_agreed_value": { "type": "integer" }, "selected_offer_due_date": { "type": "string", "format": "date-time" }, "path": { "type": "string" }, "mime": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "pricing_request_response_id", "selected_offer_name", "selected_offer_currency", "selected_offer_proposed_value", "selected_offer_agreed_value", "selected_offer_due_date", "path", "mime", "creation_dt", "change_dt", "deleted" ] }, "PricingRequestResponseModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "pricing_request_id": { "type": "string" }, "summary": { "type": "string" }, "design": { "type": "string" }, "price_list": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "pricing_request_id", "summary", "design", "price_list", "creation_dt", "change_dt", "deleted" ] }, "PricingRequestModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "user_id": { "type": "string" }, "name": { "type": "string" }, "images": { "type": "string" }, "payload": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "user_id", "images", "payload", "creation_dt", "change_dt", "deleted" ] }, "ProductBrandModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "ProductImportedFileModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "format": { "type": "string", "enum": [ "csv" ] }, "path": { "type": "string" }, "mime": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "format", "path", "mime", "creation_dt", "change_dt", "deleted" ] }, "ProductManufacturerModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "ProductShapeModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "ProductTypeModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "ProductModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "code": { "type": "string" }, "manufacturer_id": { "type": "string" }, "description": { "type": "string" }, "type_id": { "type": "string" }, "brand_id": { "type": "string" }, "shape_id": { "type": "string" }, "step_unit_length_id": { "type": "string" }, "length": { "type": "number", "format": "double" }, "length_unit_length_id": { "type": "string" }, "width": { "type": "number", "format": "double" }, "width_unit_length_id": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "code", "manufacturer_id", "creation_dt", "change_dt", "deleted" ] }, "RegionModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "TanalsContactTypeModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "disabled_dt": { "type": "string", "format": "date-time" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "name", "creation_dt", "change_dt", "deleted" ] }, "TanalsContactModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "phone_number": { "type": "string" }, "contact_type_id": { "type": "string" }, "disabled_dt": { "type": "string", "format": "date-time" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "email", "first_name", "last_name", "phone_number", "contact_type_id", "creation_dt", "change_dt", "deleted" ] }, "TokboxEventModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "tokbox_session_id": { "type": "string" }, "type": { "type": "string", "enum": [ "connected", "connecting" ] }, "app_type": { "type": "string", "enum": [ "client", "staff" ] }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "tokbox_session_id", "type", "app_type", "creation_dt", "change_dt", "deleted" ] }, "TokboxSessionModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "tb_api_key": { "type": "string" }, "tb_session_id": { "type": "string" }, "user_id": { "type": "string" }, "app_install": { "type": "string" }, "app_identifier": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "tb_api_key", "tb_session_id", "user_id", "app_install", "app_identifier", "creation_dt", "change_dt", "deleted" ] }, "UnitHardnessModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "symbol": { "type": "string" }, "linear_conversion_factor": { "type": "number", "format": "double" }, "base_unit_length_id": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "symbol", "linear_conversion_factor", "creation_dt", "change_dt", "deleted" ] }, "UnitLengthModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "symbol": { "type": "string" }, "linear_conversion_factor": { "type": "number", "format": "double" }, "base_unit_id": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "symbol", "linear_conversion_factor", "creation_dt", "change_dt", "deleted" ] }, "UnitPowerModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "symbol": { "type": "string" }, "linear_conversion_factor": { "type": "number", "format": "double" }, "base_unit_id": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "symbol", "linear_conversion_factor", "creation_dt", "change_dt", "deleted" ] }, "UnitTorqueModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "symbol": { "type": "string" }, "linear_conversion_factor": { "type": "number", "format": "double" }, "base_unit_id": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "symbol", "linear_conversion_factor", "creation_dt", "change_dt", "deleted" ] }, "UsageExampleCategoryModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "name": { "type": "string" }, "image_id": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" }, "lang": { "type": "string" }, "order": { "type": "integer" } }, "required": [ "id", "name", "image_id", "creation_dt", "change_dt", "deleted", "lang", "order" ] }, "UsageExampleImageModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "path": { "type": "string" }, "mime": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "path", "mime", "creation_dt", "change_dt", "deleted" ] }, "UsageExampleModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "category_id": { "type": "string" }, "name": { "type": "string" }, "content": { "type": "string" }, "image_id": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" }, "lang": { "type": "string" }, "order": { "type": "integer" } }, "required": [ "id", "category_id", "name", "content", "image_id", "creation_dt", "change_dt", "deleted", "lang", "order" ] }, "UserModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "email": { "type": "string" }, "pwd": { "type": "string" }, "pwd_tmp": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "phone_number": { "type": "string" }, "company_name": { "type": "string" }, "company_type_id": { "type": "string" }, "docwall_id": { "type": "string" }, "group_name": { "type": "string" }, "region_id": { "type": "string" }, "city_name": { "type": "string" }, "zip_code": { "type": "string" }, "geo_zone": { "type": "string" }, "tanals_contacts": { "type": "string" }, "manufacturers_contacts": { "type": "string" }, "reports_contacts": { "type": "string" }, "customer_code": { "type": "string" }, "can_alter_pr_customer_code": { "type": "boolean" }, "activated_dt": { "type": "string", "format": "date-time" }, "disabled_dt": { "type": "string", "format": "date-time" }, "access_level": { "type": "integer" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "email", "first_name", "last_name", "phone_number", "company_name", "company_type_id", "region_id", "city_name", "zip_code", "tanals_contacts", "manufacturers_contacts", "reports_contacts", "can_alter_pr_customer_code", "access_level", "creation_dt", "change_dt", "deleted" ] }, "VisitReportImageModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "path": { "type": "string" }, "mime": { "type": "string" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "path", "mime", "creation_dt", "change_dt", "deleted" ] }, "VisitReportModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "user_id": { "type": "string" }, "pricing_request_id": { "type": "string" }, "images": { "type": "string" }, "note": { "type": "string" }, "case_name": { "type": "string" }, "client_name": { "type": "string" }, "contacts": { "type": "string" }, "sended": { "type": "boolean" }, "creation_dt": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" } }, "required": [ "id", "user_id", "images", "case_name", "client_name", "contacts", "sended", "creation_dt", "change_dt", "deleted" ] }, "XmlRequestModel": { "type": "object", "properties": { "id": { "type": "string", "x-primary-key": true }, "payload": { "type": "string" }, "images": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company_name": { "type": "string" } }, "required": [ "id", "payload", "images", "email", "first_name", "last_name", "company_name" ] }, "TokBoxTokenModel": { "type": "object", "properties": { "token": { "type": "string" }, "expiration_time": { "type": "string", "format": "date-time" }, "role": { "type": "string", "enum": [ "subscriber", "publisher", "moderator" ] } } }, "ApiCoreErrorModel": { "description": "An explicit code that represent the error that occurred within the ApiCore domain. 404: notFound | 405: methodNotAllowed | 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, 650, 655, 900, 901, 1024, 1234, 2001, 2002, 2003, 2004, 2005, 2006, 1100, 12001, 12002, 12003, 42421, 42422, 42423, 42424 ] }, "ProjectErrorModel": { "description": "An explicit code that represent the error that occurred within the Project domain. 42: unexpected | 1000: fieldIsLocked | 1100: userIsDisabled | 1101: userIsNotActivated | 1200: invalidPassword | 1201: invalidEmailAddress | 1202: emailAddressDuplicate | 1300: unableToSendMail | 1301: unrecognizedRequestType | 1302: dateMissing | 1303: missingEmail | 1304: missingType | 1305: missingPassword | 1400: userInstallDuplicate | 1500: unknownSymbol", "type": "string", "enum": [ 42, 1000, 1100, 1101, 1200, 1201, 1202, 1300, 1301, 1302, 1303, 1304, 1305, 1400, 1500 ] }, "ErrorsDomainModel": { "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" ] } } }