Created
April 11, 2019 18:52
-
-
Save Leonardo-Ferreira/9d8b43f85c4f828cdc8ddc4f8f3a4bd3 to your computer and use it in GitHub Desktop.
JSON for buggy swagger-codegen genration
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"openapi": "3.0.1", | |
"info": { | |
"title": "Credenciamento", | |
"description": "API que habilita parceiros a credenciarem ou habilitarem estabelecimentos para que comecem a aceitar produtos Ticket. \r\nCredenciamento é o processo onde XPTO. Habilitação é um outro processo que WYK. \r\nPara realizar um credenciamento, o paceiro inicia o processo chamando o método POST de '/api/credenciamento/'", | |
"version": "v1" | |
}, | |
"paths": { | |
"/api/credenciamentos/{idCredenciamento}/adquirentes/{idAdquirente}": { | |
"get": { | |
"tags": [ | |
"Adquirentes" | |
], | |
"summary": "Obtem um adquirente do credenciamento informado", | |
"operationId": "Get_Adquirentes", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o adquirente pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idAdquirente", | |
"in": "path", | |
"description": "Id do adquirente que deseja obter", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Adquirentes" | |
], | |
"summary": "Exclui um adquirente do credenciamento informado", | |
"operationId": "Delete_Adquirentes", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o adquirente pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idAdquirente", | |
"in": "path", | |
"description": "Id do adquirente que deseja deletar", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Adquirentes" | |
], | |
"summary": "Atualiza os dados de um adquirente pertecente ao credenciamento informado", | |
"operationId": "Put_Adquirentes", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o adquirente pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idAdquirente", | |
"in": "path", | |
"description": "Id do adquirente que deseja alterar", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/adquirentes/{idAdquirente}/produtos/{idAdquirenteProduto}/status": { | |
"get": { | |
"tags": [ | |
"Adquirentes" | |
], | |
"summary": "Obtem o histórico de status de uma habilitação de um adquirente do credenciamento informado", | |
"operationId": "List_AdquirentesHistorico", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o adquirente pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idAdquirente", | |
"in": "path", | |
"description": "Id do adquirente que as habilitações pertencem", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idAdquirenteProduto", | |
"in": "path", | |
"description": "Id da habilitação que deseja procurar o histórico de status", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/AdquirenteHistorico" | |
} | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/adquirentes": { | |
"get": { | |
"tags": [ | |
"Adquirentes" | |
], | |
"summary": "Obtem os adquirentes do credenciamento informado", | |
"operationId": "List_Adquirentes", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que os adquirentes pertencem", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Adquirentes" | |
], | |
"summary": "Adiciona um adquirente no credenciamento informado", | |
"operationId": "Post_Adquirentes", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o adquirente pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AdquirenteModel" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/arquivos/cardapio": { | |
"get": { | |
"tags": [ | |
"Arquivos" | |
], | |
"summary": "Obtem o arquivo de fruta cardapio informado", | |
"operationId": "Get_Arquivos_Cardapio", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o arquivo pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Arquivos" | |
], | |
"summary": "Adiciona um arquivo de fruta cardapio ao credenciamento, é necessário subir um multi-form data", | |
"operationId": "Post_Arquivos_Cardapio", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o arquivo pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"415": { | |
"description": "Client Error" | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Arquivos" | |
], | |
"summary": "Exclui o arquivo de fruta cardapio do credenciamento informado", | |
"operationId": "Delete_Arquivos_Cardapio", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o arquivo pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/arquivos/contratosocial": { | |
"get": { | |
"tags": [ | |
"Arquivos" | |
], | |
"summary": "Obtem o arquivo de contrato social informado", | |
"operationId": "Get_Arquivos_ContratoSocial", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o arquivo pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Arquivos" | |
], | |
"summary": "Exclui o arquivo de contrato social do credenciamento informado", | |
"operationId": "Delete_Arquivos_ContratoSocial", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o arquivo pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Arquivos" | |
], | |
"summary": "Adiciona um arquivo de contrato social ao credenciamento, é necessário subir um multi-form data", | |
"operationId": "Post_Arquivos_ContratoSocial", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o arquivo pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"415": { | |
"description": "Client Error" | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/arquivos": { | |
"get": { | |
"tags": [ | |
"Arquivos" | |
], | |
"summary": "Obtem uma lista dos arquivos informados", | |
"operationId": "List_Arquivos", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que os arquivos pertencem", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CredenciamentoUpload" | |
} | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
} | |
} | |
} | |
}, | |
"/api/adquirentes": { | |
"get": { | |
"tags": [ | |
"Auxiliares" | |
], | |
"summary": "Lista os adquirentes disponíveis para credenciamento no momento", | |
"operationId": "List_Auxiliares_Adquirentes", | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/Adquirente" | |
} | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/bancos": { | |
"get": { | |
"tags": [ | |
"Auxiliares" | |
], | |
"summary": "Lista os bancos disponíveis para credenciamento no momento", | |
"operationId": "List_Auxiliares_Bancos", | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/Banco" | |
} | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/condicoescomerciais/{cdProduto}": { | |
"get": { | |
"tags": [ | |
"Auxiliares" | |
], | |
"summary": "Lista a condição comercial corrente do produto informado", | |
"operationId": "List_Auxiliares_CondicoesComerciais", | |
"parameters": [ | |
{ | |
"name": "cdProduto", | |
"in": "path", | |
"description": "Códigos dos produtos Ticket - 9: TAE - 12: TRE - 34: TKE", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"default": "" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CondicaoComercial" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/informacoesadicionais/numerolugares": { | |
"get": { | |
"tags": [ | |
"Auxiliares" | |
], | |
"summary": "Lista os diferentes números de lugar disponíveis no momento", | |
"operationId": "List_Auxiliares_NumerosLugares", | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CaracteristicaProdutoValor" | |
} | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CaracteristicaProdutoValor" | |
} | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CaracteristicaProdutoValor" | |
} | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/informacoesadicionais/numerorefeicoes": { | |
"get": { | |
"tags": [ | |
"Auxiliares" | |
], | |
"summary": "Lista os diferentes números de refeição disponíveis no momento", | |
"operationId": "List_Auxiliares_NumerosRefeicoes", | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CaracteristicaProdutoValor" | |
} | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CaracteristicaProdutoValor" | |
} | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CaracteristicaProdutoValor" | |
} | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/informacoesadicionais/areaatendimento": { | |
"get": { | |
"tags": [ | |
"Auxiliares" | |
], | |
"summary": "Lista as diferentes áreas de atendimento disponíveis no momento", | |
"operationId": "List_Auxiliares_AreaAtendimento", | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CaracteristicaProdutoValor" | |
} | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CaracteristicaProdutoValor" | |
} | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CaracteristicaProdutoValor" | |
} | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/cnaes": { | |
"get": { | |
"tags": [ | |
"CNAEs" | |
], | |
"summary": "Obtem os cnaes do credenciamento informado", | |
"operationId": "List_Cnaes", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que os cnaes pertencem", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/Cnae" | |
} | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"CNAEs" | |
], | |
"summary": "Adiciona um cnae no credenciamento informado", | |
"operationId": "Post_Cnaes", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o adquirente pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Cnae" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Cnae" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Cnae" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Cnae" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Cnae" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/cnaes/{codigo}/principal": { | |
"put": { | |
"tags": [ | |
"CNAEs" | |
], | |
"summary": "Atualiza se o cnae informado é o principal ou não", | |
"operationId": "Put_CnaesPrincipal", | |
"parameters": [ | |
{ | |
"name": "codigo", | |
"in": "path", | |
"description": "Código do cnae que deseja ser alterado", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"default": "" | |
} | |
}, | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o adquirente pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CnaePrincipal" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CnaePrincipal" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CnaePrincipal" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CnaePrincipal" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/cnaes/{codigo}": { | |
"delete": { | |
"tags": [ | |
"CNAEs" | |
], | |
"summary": "Exclui um cnae do credenciamento informado", | |
"operationId": "Delete_Cnaes", | |
"parameters": [ | |
{ | |
"name": "codigo", | |
"in": "path", | |
"description": "Código do cnae que deseja deletar", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"default": "" | |
} | |
}, | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o cnae pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos": { | |
"post": { | |
"tags": [ | |
"Credenciamento" | |
], | |
"summary": "Inicia um credenciamento.", | |
"description": "É o primeiro endpoint que deve ser utilizado na API. A partir dele é possível adicionar todos os recursos ao credenciamento criado. Os tipos possíveis de credenciamento são \"CREDENCIAMENTO\", \"DADOSBANCARIOS\" e \"HABILITACAO\".", | |
"operationId": "Post_Credenciamentos", | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SolicitacaoCredenciamento" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SolicitacaoCredenciamento" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SolicitacaoCredenciamento" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SolicitacaoCredenciamento" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoEstabelecimento" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"get": { | |
"tags": [ | |
"Credenciamento" | |
], | |
"summary": "Obtem os credenciamentos paginados que foram feitos", | |
"operationId": "List_Credenciamentos", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"in": "query", | |
"description": "Quantidade máxima de credenciamentos que devem retornar", | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "offSet", | |
"in": "query", | |
"description": "Quantidade de credenciamentos que devem pular", | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "cnpj", | |
"in": "query", | |
"description": "Cnpj que será usado de filtro para listagem", | |
"schema": { | |
"type": "string", | |
"default": "" | |
} | |
}, | |
{ | |
"name": "canal", | |
"in": "query", | |
"description": "Canal de entrada que será usado de filtro para listagem", | |
"schema": { | |
"type": "string", | |
"default": "" | |
} | |
}, | |
{ | |
"name": "razaoSocial", | |
"in": "query", | |
"description": "Razão social que será usada de filtro para listagem", | |
"schema": { | |
"type": "string", | |
"default": "" | |
} | |
}, | |
{ | |
"name": "dtInicio", | |
"in": "query", | |
"description": "Data para filtrar somente os credenciamentos que começaram depois da data informada", | |
"schema": { | |
"type": "string", | |
"default": "" | |
} | |
}, | |
{ | |
"name": "dtFim", | |
"in": "query", | |
"description": "Data para filtrar somente os credenciamentos que começaram antes da data informada", | |
"schema": { | |
"type": "string", | |
"default": "" | |
} | |
}, | |
{ | |
"name": "idStatusCredenciamento", | |
"in": "query", | |
"description": "Status que será usado para filtrar os credenciamentos que se encontram nesse status", | |
"schema": { | |
"type": "string", | |
"default": "" | |
} | |
}, | |
{ | |
"name": "idTipoCredenciamento", | |
"in": "query", | |
"description": "Tipo que será usado para filtrar os credenciamentos que se encontram nesse tipo", | |
"schema": { | |
"type": "string", | |
"default": "" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoEstabelecimentoPaginacao" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}": { | |
"get": { | |
"tags": [ | |
"Credenciamento" | |
], | |
"summary": "Obtem as informações do credenciamento a partir do id informado", | |
"operationId": "Get_Credenciamentos", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que deseja obter", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoEstabelecimento" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Credenciamento" | |
], | |
"summary": "Atualiza as informações do credenciamento", | |
"operationId": "Put_Credenciamentos", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que que deseja alterar", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Estabelecimento" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Estabelecimento" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Estabelecimento" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Estabelecimento" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/serpar": { | |
"put": { | |
"tags": [ | |
"Credenciamento" | |
], | |
"summary": "Alterar a opção de SERPAR para o credenciamento informado", | |
"operationId": "Put_CredenciamentosSerpar", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que que deseja alterar a opção de SERPAR", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoSerpar" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoSerpar" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoSerpar" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoSerpar" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/status": { | |
"get": { | |
"tags": [ | |
"Credenciamento" | |
], | |
"summary": "Obtem o histórico de status de um credenciamento informado", | |
"operationId": "List_CredenciamentosHistorico", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que que deseja obter o histórico", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CredencimentoHistorico" | |
} | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/status": { | |
"get": { | |
"tags": [ | |
"Credenciamento" | |
], | |
"summary": "Lista os status disponíveis para os credenciamento", | |
"operationId": "List_StatusCredenciamentos", | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"enum": [ | |
1, | |
2, | |
3, | |
101, | |
200, | |
201, | |
202, | |
203, | |
300, | |
301, | |
302, | |
303, | |
304, | |
305, | |
306, | |
307, | |
308, | |
309, | |
400, | |
401, | |
402, | |
500, | |
501, | |
502, | |
503, | |
504, | |
600, | |
601, | |
602, | |
603, | |
700, | |
701, | |
702, | |
703, | |
704, | |
705, | |
751, | |
752, | |
801, | |
802, | |
803, | |
804, | |
900, | |
901 | |
], | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/informacoesadicionais": { | |
"put": { | |
"tags": [ | |
"Credenciamento" | |
], | |
"summary": "Alterar as informações adicionais do credenciamento informado", | |
"operationId": "Put_CredenciamentosInformacoesAdicionais", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que que deseja alterar as informações adicionais", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoInformacoesAdicionais" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoInformacoesAdicionais" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoInformacoesAdicionais" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoInformacoesAdicionais" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/aceitecontrato": { | |
"post": { | |
"tags": [ | |
"Credenciamento" | |
], | |
"summary": "Endpoint para aceitar o contrato apresentado, esse deve ser o ultimo endpoint a ser chamado, todas as informações do credenciamento devem ser cadastradas antes de utilizar o endpoint", | |
"operationId": "Post_CredenciamentosAceiteContratos", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que deseja aceitar o contrato", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CondicaoComercialTarifas" | |
} | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CondicaoComercialTarifas" | |
} | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CondicaoComercialTarifas" | |
} | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CondicaoComercialTarifas" | |
} | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/dadosbancarios": { | |
"get": { | |
"tags": [ | |
"Dados Bancários" | |
], | |
"summary": "Obtem os dados bancários do credenciamento informado", | |
"operationId": "List_DadosBancarios", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que os dados bancários pertencem", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Dados Bancários" | |
], | |
"summary": "Adiciona um dado bancário no credenciamento informado", | |
"operationId": "Post_DadosBancarios", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o dado bancário pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/dadosbancarios/{idDadosBancarios}": { | |
"delete": { | |
"tags": [ | |
"Dados Bancários" | |
], | |
"summary": "Exclui um dado bancário do credenciamento informado", | |
"operationId": "Delete_DadosBancarios", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o dado bancário pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idDadosBancarios", | |
"in": "path", | |
"description": "Id do dado bancários que deseja excluir", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Dados Bancários" | |
], | |
"summary": "Atualiza o dado bancário pertecente ao credenciamento informado", | |
"operationId": "Put_DadosBancarios", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o dado bancário pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idDadosBancarios", | |
"in": "path", | |
"description": "Id do dado bancário que deseja alterar", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/DadosBancarios" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/enderecos": { | |
"post": { | |
"tags": [ | |
"Endereços" | |
], | |
"summary": "Adiciona um endereço no credenciamento informado", | |
"operationId": "Post_Endereco", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o endereço pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Endereco" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Endereco" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Endereco" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Endereco" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Endereco" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"get": { | |
"tags": [ | |
"Endereços" | |
], | |
"summary": "Obtem os endereços do credenciamento informado", | |
"operationId": "List_Endereco", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que os endereços pertencem", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/Endereco" | |
} | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/enderecos/{idEndereco}": { | |
"put": { | |
"tags": [ | |
"Endereços" | |
], | |
"summary": "Atualiza o endereço pertecente ao credenciamento informado", | |
"operationId": "Put_Endereco", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o endereço pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idEndereco", | |
"in": "path", | |
"description": "Id do endereço que deseja alterar", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Endereco" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Endereco" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Endereco" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Endereco" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Endereco" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Endereços" | |
], | |
"summary": "Exclui um endereço do credenciamento informado", | |
"operationId": "Delete_Endereco", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o endereço pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idEndereco", | |
"in": "path", | |
"description": "Id do endereço que deseja excluir", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/produtos/disponiveis": { | |
"get": { | |
"tags": [ | |
"Produtos" | |
], | |
"summary": "Mostra quais produtos estão disponíveis para o credenciamento atual, é necessário adicionar cnaes antes de utilizar esse endpoint", | |
"operationId": "List_ProdutosDisponiveis", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que será usado para verificar quais produtos estão disponíveis", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/Produto" | |
} | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/produtos": { | |
"post": { | |
"tags": [ | |
"Produtos" | |
], | |
"summary": "Adiciona um produto no credenciamento informado", | |
"operationId": "Post_Produtos", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o produto pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoProduto" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoProduto" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoProduto" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoProduto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"get": { | |
"tags": [ | |
"Produtos" | |
], | |
"summary": "Obtem os produtos e suas condições comerciais do credenciamento informado", | |
"operationId": "List_Produtos", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que os produtos pertencem", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CredenciamentoProduto" | |
} | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/produtos/{idProduto}": { | |
"get": { | |
"tags": [ | |
"Produtos" | |
], | |
"summary": "Obtem um produto e sua condição comercial do credenciamento informado", | |
"operationId": "Get_Produtos", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o produto pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idProduto", | |
"in": "path", | |
"description": "Id do produto que deseja obter", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredenciamentoProduto" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Produtos" | |
], | |
"summary": "Exclui um produto do credenciamento informado", | |
"operationId": "Delete_Produtos", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o produto pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idProduto", | |
"in": "path", | |
"description": "Id do produto que deseja excluir", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/representantes": { | |
"get": { | |
"tags": [ | |
"Representantes" | |
], | |
"summary": "Obtem os representantes do credenciamento informado", | |
"operationId": "List_Representantes", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que os representantes pertencem", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/Representante" | |
} | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Representantes" | |
], | |
"summary": "Adiciona um representante no credenciamento informado", | |
"operationId": "Post_Representantes", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o representante pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Representante" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Representante" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Representante" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Representante" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Representante" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/credenciamentos/{idCredenciamento}/representantes/{idRepresentante}": { | |
"put": { | |
"tags": [ | |
"Representantes" | |
], | |
"summary": "Atualiza o representante pertecente ao credenciamento informado", | |
"operationId": "Put_Representantes", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o representante pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idRepresentante", | |
"in": "path", | |
"description": "Id do representante que deseja alterar", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json-patch+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Representante" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Representante" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Representante" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/Representante" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Representante" | |
} | |
} | |
} | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Representantes" | |
], | |
"summary": "Exclui um representante do credenciamento informado", | |
"operationId": "Delete_Representantes", | |
"parameters": [ | |
{ | |
"name": "idCredenciamento", | |
"in": "path", | |
"description": "Id do credenciamento que o representante pertence", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "idRepresentante", | |
"in": "path", | |
"description": "Id do representante que deseja excluir", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BadRequest" | |
} | |
} | |
} | |
}, | |
"403": { | |
"description": "Forbidden" | |
}, | |
"404": { | |
"description": "Not Found" | |
}, | |
"500": { | |
"description": "Server Error", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InternalServerError" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"components": { | |
"schemas": { | |
"AdquirenteProduto": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"produto": { | |
"type": "string" | |
}, | |
"codigoProduto": { | |
"type": "string" | |
}, | |
"idStatus": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"status": { | |
"type": "string" | |
}, | |
"dataStatus": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"AdquirenteModel": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"nome": { | |
"type": "string" | |
}, | |
"codigo": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"numeroFiliacao": { | |
"type": "string" | |
}, | |
"produtos": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/AdquirenteProduto" | |
} | |
}, | |
"tipoAdquirente": { | |
"enum": [ | |
1, | |
2 | |
], | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Erro": { | |
"type": "object", | |
"properties": { | |
"codigo": { | |
"type": "string" | |
}, | |
"erro": { | |
"type": "string" | |
}, | |
"propriedade": { | |
"type": "string" | |
}, | |
"valor": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"BadRequest": { | |
"type": "object", | |
"properties": { | |
"mensagem": { | |
"type": "string" | |
}, | |
"erros": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/Erro" | |
} | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"InternalServerError": { | |
"type": "object", | |
"properties": { | |
"mensagem": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"AdquirenteHistorico": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"idStatus": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"status": { | |
"type": "string" | |
}, | |
"data": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"motivo": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CredenciamentoUpload": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"idCredenciamento": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"tipoUpload": { | |
"enum": [ | |
1, | |
2 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"idTipoUpload": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"descricaoTipoUpload": { | |
"type": "string" | |
}, | |
"nomeArquivo": { | |
"type": "string" | |
}, | |
"data": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Adquirente": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"cdAdquirente": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"nmAdquirente": { | |
"type": "string" | |
}, | |
"ativo": { | |
"type": "boolean" | |
}, | |
"qtdeMinCaracterFiliacao": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"qtdeMaxCaracterFiliacao": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"permiteZeroDireita": { | |
"type": "boolean" | |
}, | |
"nomeImagem": { | |
"type": "string" | |
}, | |
"legendaImagem": { | |
"type": "string" | |
}, | |
"imagem": { | |
"type": "string", | |
"format": "byte" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Banco": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"codigo": { | |
"type": "string" | |
}, | |
"nome": { | |
"type": "string" | |
}, | |
"mascaraAgencia": { | |
"type": "string" | |
}, | |
"mascaraConta": { | |
"type": "string" | |
}, | |
"prioridadePagamento": { | |
"type": "string" | |
}, | |
"dataInicial": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"dataFinal": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CondicaoComercialTarifas": { | |
"type": "object", | |
"properties": { | |
"tipoTarifa": { | |
"type": "string" | |
}, | |
"formaCalculo": { | |
"type": "string" | |
}, | |
"valorCondicaoComercial": { | |
"type": "number", | |
"format": "double" | |
}, | |
"dataAlteracao": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"descricaoTarifa": { | |
"type": "string" | |
}, | |
"codigoTarifa": { | |
"type": "string" | |
}, | |
"idFormaCalculo": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"ativo": { | |
"type": "boolean" | |
}, | |
"obrigatorio": { | |
"type": "boolean" | |
}, | |
"categoria": { | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CondicaoComercial": { | |
"type": "object", | |
"properties": { | |
"idCanal": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"nomeCanal": { | |
"type": "string" | |
}, | |
"diaCorte": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"periodoCorte": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"prazoReembolso": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"taxaAnuidade": { | |
"type": "boolean" | |
}, | |
"condicaoPadrao": { | |
"type": "boolean" | |
}, | |
"status": { | |
"type": "boolean" | |
}, | |
"tarifas": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CondicaoComercialTarifas" | |
} | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CaracteristicaProdutoValor": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"descricao": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Cnae": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"codigo": { | |
"type": "string" | |
}, | |
"nome": { | |
"type": "string" | |
}, | |
"principal": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CnaePrincipal": { | |
"type": "object", | |
"properties": { | |
"principal": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SolicitacaoCredenciamento": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"cnpj": { | |
"type": "string" | |
}, | |
"email": { | |
"type": "string" | |
}, | |
"utmSource": { | |
"type": "string" | |
}, | |
"utmMedium": { | |
"type": "string" | |
}, | |
"utmCampaign": { | |
"type": "string" | |
}, | |
"tipoCredenciamento": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CredenciamentoEstabelecimento": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"cnpj": { | |
"type": "string" | |
}, | |
"razaoSocial": { | |
"type": "string" | |
}, | |
"idStatus": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"descricaoStatus": { | |
"type": "string" | |
}, | |
"data": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"email": { | |
"type": "string" | |
}, | |
"nomeFantasia": { | |
"type": "string" | |
}, | |
"inscricaoEstadual": { | |
"type": "string" | |
}, | |
"telefone": { | |
"type": "string" | |
}, | |
"serpar": { | |
"type": "boolean" | |
}, | |
"temFotografia": { | |
"type": "boolean" | |
}, | |
"dataStatus": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"utmSource": { | |
"type": "string" | |
}, | |
"utmMedium": { | |
"type": "string" | |
}, | |
"utmCampaign": { | |
"type": "string" | |
}, | |
"tipoCredenciamento": { | |
"type": "string" | |
}, | |
"idTipoCredenciamento": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"numeroLugares": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"numeroRefeicoes": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"areaAtendimento": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"possuiFrutaCardapio": { | |
"type": "boolean" | |
}, | |
"estabelecimentoAlterado": { | |
"type": "boolean" | |
}, | |
"representanteAlterado": { | |
"type": "boolean" | |
}, | |
"enderecoAlterado": { | |
"type": "boolean" | |
}, | |
"cnaeAlterado": { | |
"type": "boolean" | |
}, | |
"possuiValidacaoBancaria": { | |
"type": "boolean" | |
}, | |
"idLoteAP": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Parametros": { | |
"type": "object", | |
"properties": { | |
"offset": { | |
"type": "integer", | |
"format": "int32", | |
"readOnly": true | |
}, | |
"limit": { | |
"type": "integer", | |
"format": "int32", | |
"readOnly": true | |
}, | |
"total": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CredenciamentoEstabelecimentoPaginacao": { | |
"type": "object", | |
"properties": { | |
"itens": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CredenciamentoEstabelecimento" | |
}, | |
"readOnly": true | |
}, | |
"parametros": { | |
"$ref": "#/components/schemas/Parametros" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Estabelecimento": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"cnpj": { | |
"type": "string" | |
}, | |
"email": { | |
"type": "string" | |
}, | |
"razaoSocial": { | |
"type": "string" | |
}, | |
"nomeFantasia": { | |
"type": "string" | |
}, | |
"inscricaoEstadual": { | |
"type": "string" | |
}, | |
"telefone": { | |
"type": "string" | |
}, | |
"serpar": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CredenciamentoSerpar": { | |
"type": "object", | |
"properties": { | |
"habilitar": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CredencimentoHistorico": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"status": { | |
"enum": [ | |
1, | |
2, | |
3, | |
101, | |
200, | |
201, | |
202, | |
203, | |
300, | |
301, | |
302, | |
303, | |
304, | |
305, | |
306, | |
307, | |
308, | |
309, | |
400, | |
401, | |
402, | |
500, | |
501, | |
502, | |
503, | |
504, | |
600, | |
601, | |
602, | |
603, | |
700, | |
701, | |
702, | |
703, | |
704, | |
705, | |
751, | |
752, | |
801, | |
802, | |
803, | |
804, | |
900, | |
901 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"descricaoStatus": { | |
"type": "string" | |
}, | |
"data": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"motivo": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CredenciamentoInformacoesAdicionais": { | |
"type": "object", | |
"properties": { | |
"numeroLugares": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"numeroRefeicoes": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"areaAtendimento": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"DadosBancarios": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"codigoBanco": { | |
"type": "string" | |
}, | |
"nome": { | |
"type": "string" | |
}, | |
"agencia": { | |
"type": "string" | |
}, | |
"contaCorrente": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Endereco": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"tipo": { | |
"type": "string" | |
}, | |
"logradouro": { | |
"type": "string" | |
}, | |
"numero": { | |
"type": "string" | |
}, | |
"cep": { | |
"type": "string" | |
}, | |
"bairro": { | |
"type": "string" | |
}, | |
"cidade": { | |
"type": "string" | |
}, | |
"uf": { | |
"type": "string" | |
}, | |
"complemento": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Produto": { | |
"type": "object", | |
"properties": { | |
"codigo": { | |
"type": "string" | |
}, | |
"nome": { | |
"type": "string" | |
}, | |
"descricao": { | |
"type": "string" | |
}, | |
"numeroLugares": { | |
"type": "boolean" | |
}, | |
"numeroRefeicoes": { | |
"type": "boolean" | |
}, | |
"areaAtendimento": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CondicaoComercialTarifa": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"tipoTarifa": { | |
"type": "string" | |
}, | |
"formaCalculo": { | |
"type": "string" | |
}, | |
"valorCondicaoComercial": { | |
"type": "number", | |
"format": "double" | |
}, | |
"dataAlteracao": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"descricaoTarifa": { | |
"type": "string" | |
}, | |
"codigoTarifa": { | |
"type": "string" | |
}, | |
"categoria": { | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CondicaoComercialModel": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"idProduto": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"canal": { | |
"type": "string" | |
}, | |
"diaCorte": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"periodoCorte": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"prazoReembolso": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"taxaAnuidade": { | |
"type": "boolean" | |
}, | |
"condicaoPadrao": { | |
"type": "boolean" | |
}, | |
"status": { | |
"type": "boolean" | |
}, | |
"tarifas": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CondicaoComercialTarifa" | |
} | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CredenciamentoProduto": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"codigo": { | |
"type": "string" | |
}, | |
"sigla": { | |
"type": "string" | |
}, | |
"descricao": { | |
"type": "string" | |
}, | |
"condicaoComercial": { | |
"$ref": "#/components/schemas/CondicaoComercialModel" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Representante": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"nome": { | |
"type": "string" | |
}, | |
"email": { | |
"type": "string" | |
}, | |
"cargo": { | |
"type": "string" | |
}, | |
"cpf": { | |
"type": "string" | |
}, | |
"rg": { | |
"type": "string" | |
}, | |
"dataNascimento": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"telefone": { | |
"type": "string" | |
}, | |
"celular": { | |
"type": "string" | |
}, | |
"interlocutor": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
} | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment