Skip to content

Commit

Permalink
ShippingCompany/v1/1_000 (#1170)
Browse files Browse the repository at this point in the history 
* Criação da api de transportadora do Backoffice RM

* Adição dos campos complementares na documentação.
  • Loading branch information
@Felipe-Alves-Sampaio
Felipe-Alves-Sampaio authored Oct 25, 2024
1 parent 819160b commit 90ed091
Show file tree
Hide file tree
Showing 2 changed files with 813 additions and 0 deletions.
367 changes: 367 additions & 0 deletions jsonschema/apis/ShippingCompany_1_000.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,367 @@
{
"openapi": "3.0.1",
"servers": [
{
"description": "API para a entidade Transportadora",
"url": "{{host}}/api/mov/v1",
"variables": {
"serverUrl": {
"default": "localhost"
},
"serverHttpPort": {
"default": "8080"
}
}
}
],
"info": {
"description": "API para a entidade Transportadora",
"version": "1.000",
"title": "Transportadora",
"contact": {
"name": "T-Talk",
"url": "https://api.totvs.com.br",
"email": "[email protected]"
},
"x-totvs": {
"messageDocumentation": {
"name": "ShippingCompany",
"description": "API para a entidade Transportadora",
"segment": "Serviços"
},
"productInformation": [
{
"product": "RM",
"contact": "[email protected]",
"description": "Cadastro de Transportadoras",
"adapter": "mats050.prw"
}
]
}
},
"paths": {
"/ShippingCompany": {
"get": {
"tags": ["ShippingCompany"],
"summary": "Retorna lista de Transportadoras",
"x-totvs": {
"productInformation": [
{
"product": "RM",
"available": true,
"note": "Este verbo esta disponivel com todos os parametros",
"minimalVersion": "12.1.34"
}
]
},
"description": "Retorna lista completa de Transportadoras",
"operationId": "getShippingCompany",
"parameters": [
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Order"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Page"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/PageSize"
}
],
"responses": {
"200": {
"description": "Operação realizada com sucesso!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/PagedShippingCompany"
}
}
}
},
"400": {
"description": "Erro na requisição!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
}
}
},
"post": {
"tags": ["ShippingCompany"],
"summary": "Inclui uma transportadora",
"description": "Inclui uma Transportadora conforme dados enviados na requisição.",
"operationId": "postShippingCompany",
"x-totvs": {
"productInformation": [
{
"product": "RM",
"available": true,
"note": "Este verbo esta disponível com o parametro Authorization",
"minimalVersion": "12.1.34"
}
]
},
"parameters": [
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
}
],
"requestBody": {
"description": "Transportadora a ser incluída.",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
}
}
}
},
"responses": {
"201": {
"description": "Operação realizada com sucesso!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
}
}
}
},
"400": {
"description": "Erro durante inclusão da Transportadora!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
}
}
}
},
"/ShippingCompany/{InternalId}": {
"get": {
"tags": ["InternalId"],
"summary": "Retorna a Transportadora pelo seu Internal Id",
"description": "Retorna a Transportadora conforme dados enviados na requisição",
"operationId": "getInternalId",
"x-totvs": {
"productInformation": [
{
"product": "RM",
"available": true,
"note": "Este verbo esta disponivel com todos os parametros",
"minimalVersion": "12.1.34"
}
]
},
"parameters": [
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Order"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Page"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/PageSize"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
},
{
"$ref": "#/components/parameters/InternalId"
}
],
"responses": {
"200": {
"description": "Operação realizada com sucesso!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
}
}
}
},
"404": {
"description": "Transportadora não localizada!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
}
}
},
"put": {
"tags": ["InternalId"],
"summary": "Altera uma transportadora",
"description": "Atualiza cadastro de Transportadoras conforme dados enviados na requisição",
"operationId": "putInternalId",
"x-totvs": {
"productInformation": [
{
"product": "RM",
"available": true,
"note": "Este verbo esta disponivel com todos os parametros",
"minimalVersion": "12.1.34"
}
]
},
"parameters": [
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
},
{
"$ref": "#/components/parameters/InternalId"
}
],
"requestBody": {
"description": "Transportadora a ser atualizada.",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
}
}
}
},
"responses": {
"200": {
"description": "Operação realizada com sucesso!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
}
}
}
},
"400": {
"description": "Erro durante a alteração da Transportadora!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
},
"404": {
"description": "Transportadora não localizada!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
}
}
},
"delete": {
"tags": ["InternalId"],
"summary": "Exclui uma transportadora",
"description": "Exclui cadastro de Transportadora conforme dados enviados na requisição.",
"operationId": "deleteInternalId",
"x-totvs": {
"productInformation": [
{
"product": "RM",
"available": true,
"note": "Este verbo esta disponível com os parâmetros Authorization e InternalId",
"minimalVersion": "12.1.21"
}
]
},
"parameters": [
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
},
{
"$ref": "#/components/parameters/InternalId"
}
],
"responses": {
"200": {
"description": "Operação realizada com sucesso!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
}
}
}
},
"400": {
"description": "Erro durante a exclusão da transportadora!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
},
"404": {
"description": "Transportadora não localizada!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
}
}
}
}
},
"components": {
"parameters": {
"InternalId": {
"name": "InternalId",
"in": "path",
"required": true,
"description": "Identificador único da Transportadora",
"example": "1|00001",
"schema": {
"type": "string"
},
"x-totvs": {
"productInformation": [
{
"product": "RM",
"available": true,
"note": "Informar os campos Código da coligada e Código da transportadora.",
"minimalVersion": "12.1.34"
}
]
}
}
},
"schemas": {}
}
}
Loading

0 comments on commit 90ed091

Please sign in to comment.