{ "$schema": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#", "definitions": { "Paging": { "type": "object", "properties": { "hasNext": { "type": "boolean", "example": false } } }, "ErrorModel": { "type": "object", "allOf": [ { "$ref": "#/definitions/ErrorModelBase" }, { "$ref": "#/definitions/ErrorDetail" } ] }, "ErrorModelBase": { "type": "object", "required": [ "code", "message", "detailedMessage" ], "properties": { "code": { "type": "string", "description": "Código identificador do erro." }, "message": { "type": "string", "description": "Literal no idioma da requisição descrevendo o erro para o usuário." }, "detailedMessage": { "type": "string", "description": "Mensagem técnica e mais detalhada do erro." }, "helpUrl": { "type": "string", "format": "uri", "description": "URI para documentação do erro." } } }, "ErrorDetail": { "type": "object", "properties": { "details": { "type": "array", "items": { "$ref": "#/definitions/ErrorModelBase" } } } }, "ExpandablesType": { "type": "object", "properties": { "_expandables": { "type": "array", "items": { "type": "string" } } } } }, "parameters": { "Authorization": { "name": "Authorization", "in": "header", "required": true, "description": "Cabeçalho usado para autorização das requisições", "schema": { "type": "string" } }, "Order": { "name": "order", "in": "query", "description": "Ordenação da Coleção", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } }, "Page": { "name": "page", "in": "query", "description": "Paginação da Coleção", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1, "exclusiveMinimum": false } }, "PageSize": { "name": "pageSize", "in": "query", "description": "Quantidade de Itens por Página", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, "AcceptLanguage": { "name": "Accept-Language", "in": "header", "description": "Descreve qual o idioma que o cliente vai compreender", "required": false, "schema": { "type": "string" } }, "Fields": { "name": "fields", "in": "query", "description": "Filtering records fields", "required": false, "schema": { "type": "string" } }, "Expand": { "name": "expand", "in": "query", "description": "Expandable fields selected", "required": false, "schema": { "type": "string" } } } }