Tempo aproximado para leitura: superior a 15 minutosAPI - Método GET
- URL: http://localhost:8084/rest/FwModel/tafa632/
- Método:
GET - Descrição: Este endpoint retorna uma lista dos movimentos do MIT
Exemplo de Resposta em Caso de Sucesso
JSON - Exemplo de resposta do GET
{
"total": 2,
"count": 2,
"startindex": 1,
"resources": [
{
"id": "TAFA632",
"operation": 1,
"pk": "RCBNRyAwMSA0YTVhYTQ3OC1hMzFkLWY1MWItOWJiMS1kYzJjOTYyMTAyYTc=",
"models": [
{
"id": "MODEL_T1A",
"modeltype": "FIELDS",
"fields": [
{
"id": "T1A_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "T1A_FILORI",
"order": 2,
"value": "T1D MG 01"
},
{
"id": "T1A_ID",
"order": 3,
"value": "4a5aa478-a31d-f51b-9bb1-dc2c962102a7"
},
{
"id": "T1A_IDDEBI",
"order": 4,
"value": "1"
},
{
"id": "T1A_ANOPOS",
"order": 5,
"value": "2020"
},
{
"id": "T1A_IDTRIB",
"order": 6,
"value": "000010"
},
{
"id": "T1A_PERAPU",
"order": 9,
"value": "052020"
},
{
"id": "T1A_CODREC",
"order": 10,
"value": "1010"
},
{
"id": "T1A_TRIPOS",
"order": 11,
"value": "1"
},
{
"id": "T1A_PERIOD",
"order": 12,
"value": "1"
},
{
"id": "T1A_CPNEST",
"order": 13,
"value": "53485215000106"
},
{
"id": "T1A_CNPINC",
"order": 14,
"value": "95167400000100"
},
{
"id": "T1A_VALTRI",
"order": 15,
"value": "200.00"
},
{
"id": "T1A_IDSCP",
"order": 17,
"value": "5157752e-c7c3-84ff-e528-d3efe9c42f3c"
},
{
"id": "T1A_UF",
"order": 20,
"value": "000001"
},
{
"id": "T1A_DTDEBI",
"order": 23,
"value": "20250131"
}
]
}
]
},
{
"id": "TAFA632",
"operation": 1,
"pk": "RCBNRyAwMSBmMjVmM2Y3Mi1iZTNmLWJmZGYtZTU2ZS03YjRmMTYyMjBhZjA=",
"models": [
{
"id": "MODEL_T1A",
"modeltype": "FIELDS",
"fields": [
{
"id": "T1A_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "T1A_FILORI",
"order": 2,
"value": "T1D MG 01"
},
{
"id": "T1A_ID",
"order": 3,
"value": "f25f3f72-be3f-bfdf-e56e-7b4f16220af0"
},
{
"id": "T1A_IDDEBI",
"order": 4,
"value": "2"
},
{
"id": "T1A_ANOPOS",
"order": 5,
"value": "2025"
},
{
"id": "T1A_IDTRIB",
"order": 6,
"value": "000010"
},
{
"id": "T1A_PERAPU",
"order": 9,
"value": "052020"
},
{
"id": "T1A_CODREC",
"order": 10,
"value": "1010"
},
{
"id": "T1A_CPNEST",
"order": 13,
"value": "53485215000106"
}
]
}
]
}
]
}
API - GET [pk]
- URL: http://localhost:8084/rest/FwModel/tafa632/RCBNRyAwMSA0YTVhYTQ3OC1hMzFkLWY1MWItOWJiMS1kYzJjOTYyMTAyYTc=
- Método:
GET[id] - Descrição: Este endpoint retorna um movimento Mit filtrado pela PK.
Exemplo de Resposta em Caso de Sucesso
JSON - Exemplo de resposta do GET por PK
{
"id": "TAFA632",
"operation": 1,
"pk": "RCBNRyAwMSA0YTVhYTQ3OC1hMzFkLWY1MWItOWJiMS1kYzJjOTYyMTAyYTc=",
"models": [
{
"id": "MODEL_T1A",
"modeltype": "FIELDS",
"fields": [
{
"id": "T1A_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "T1A_FILORI",
"order": 2,
"value": "T1D MG 01"
},
{
"id": "T1A_ID",
"order": 3,
"value": "4a5aa478-a31d-f51b-9bb1-dc2c962102a7"
},
{
"id": "T1A_IDDEBI",
"order": 4,
"value": "1"
},
{
"id": "T1A_ANOPOS",
"order": 5,
"value": "2020"
},
{
"id": "T1A_IDTRIB",
"order": 6,
"value": "000010"
},
{
"id": "T1A_PERAPU",
"order": 9,
"value": "052020"
},
{
"id": "T1A_CODREC",
"order": 10,
"value": "1010"
},
{
"id": "T1A_TRIPOS",
"order": 11,
"value": "1"
},
{
"id": "T1A_PERIOD",
"order": 12,
"value": "1"
},
{
"id": "T1A_CPNEST",
"order": 13,
"value": "53485215000106"
},
{
"id": "T1A_CNPINC",
"order": 14,
"value": "95167400000100"
},
{
"id": "T1A_VALTRI",
"order": 15,
"value": "200.00"
},
{
"id": "T1A_IDSCP",
"order": 17,
"value": "5157752e-c7c3-84ff-e528-d3efe9c42f3c"
},
{
"id": "T1A_UF",
"order": 20,
"value": "000001"
},
{
"id": "T1A_DTDEBI",
"order": 23,
"value": "20250131"
}
],
"models": [
{
"id": "MODEL_T1B",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "T1B_FILIAL",
"order": 1
},
{
"id": "T1B_ID",
"order": 2
},
{
"id": "T1B_IDPROC",
"order": 3
},
{
"id": "T1B_TERCEI",
"order": 5
},
{
"id": "T1B_VALSUS",
"order": 6
},
{
"id": "T1B_IDSUSP",
"order": 7
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "T1B_FILIAL",
"value": "D MG 01"
},
{
"id": "T1B_ID",
"value": "4a5aa478-a31d-f51b-9bb1-dc2c962102a7"
},
{
"id": "T1B_IDPROC",
"value": "000001"
},
{
"id": "T1B_TERCEI",
"value": "2"
},
{
"id": "T1B_VALSUS",
"value": "100.00"
},
{
"id": "T1B_IDSUSP",
"value": "00000117082017154055"
}
]
}
]
}
]
}
]
}
API - Metodo POST
- URL: http://localhost:8084/rest/FwModel/tafa632/
- Método:
POST - Descrição: Este endpoint inclui um movimento MIT no sistema.
Observação
Para o POST de um pagamento, seguiremos a mesma abordagem dos métodos das API's anteriores.
Removendo a PK do body e tratando os campos de controle interno do TAF (id).
Exemplo de Envio Esperado
JSON - Exemplo de envio do POST
{
"id": "TAFA632",
"operation": 1,
"models": [
{
"id": "MODEL_T1A",
"modeltype": "FIELDS",
"fields": [
{
"id": "T1A_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "T1A_FILORI",
"order": 2,
"value": "T1D MG 01"
},
{
"id": "T1A_ANOPOS",
"order": 5,
"value": "2020"
},
{
"id": "T1A_IDTRIB",
"order": 6,
"value": "000010"
},
{
"id": "T1A_PERAPU",
"order": 9,
"value": "052020"
},
{
"id": "T1A_CODREC",
"order": 10,
"value": "1010"
},
{
"id": "T1A_TRIPOS",
"order": 11,
"value": "1"
},
{
"id": "T1A_PERIOD",
"order": 12,
"value": "1"
},
{
"id": "T1A_CPNEST",
"order": 13,
"value": "53485215000106"
},
{
"id": "T1A_CNPINC",
"order": 14,
"value": "95167400000100"
},
{
"id": "T1A_VALTRI",
"order": 15,
"value": "200.00"
},
{
"id": "T1A_UF",
"order": 20,
"value": "000001"
},
{
"id": "T1A_DTDEBI",
"order": 23,
"value": "20250131"
}
],
"models": [
{
"id": "MODEL_T1B",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "T1B_FILIAL",
"order": 1
},
{
"id": "T1B_ID",
"order": 2
},
{
"id": "T1B_IDPROC",
"order": 3
},
{
"id": "T1B_TERCEI",
"order": 5
},
{
"id": "T1B_VALSUS",
"order": 6
},
{
"id": "T1B_IDSUSP",
"order": 7
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "T1B_FILIAL",
"value": "D MG 01"
},
{
"id": "T1B_IDPROC",
"value": "000001"
},
{
"id": "T1B_TERCEI",
"value": "2"
},
{
"id": "T1B_VALSUS",
"value": "100.00"
},
{
"id": "T1B_IDSUSP",
"value": "00000117082017154055"
}
]
}
]
}
]
}
]
}
Exemplo de Resposta em Caso de Sucesso
JSON - Exemplo de resposta do POST
{
"id": "TAFA632",
"operation": 1,
"pk": "RCBNRyAwMSA5NTMzYmIyNS0yYmNjLWM4M2EtNWRlOC0xYTMwMDczMjQxOGI=",
"models": [
{
"id": "MODEL_T1A",
"modeltype": "FIELDS",
"fields": [
{
"id": "T1A_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "T1A_FILORI",
"order": 2,
"value": "T1D MG 01"
},
{
"id": "T1A_ID",
"order": 3,
"value": "9533bb25-2bcc-c83a-5de8-1a300732418b"
},
{
"id": "T1A_IDDEBI",
"order": 4,
"value": "3"
},
{
"id": "T1A_ANOPOS",
"order": 5,
"value": "2020"
},
{
"id": "T1A_IDTRIB",
"order": 6,
"value": "000010"
},
{
"id": "T1A_PERAPU",
"order": 9,
"value": "052020"
},
{
"id": "T1A_CODREC",
"order": 10,
"value": "1010"
},
{
"id": "T1A_TRIPOS",
"order": 11,
"value": "1"
},
{
"id": "T1A_PERIOD",
"order": 12,
"value": "1"
},
{
"id": "T1A_CPNEST",
"order": 13,
"value": "53485215000106"
},
{
"id": "T1A_CNPINC",
"order": 14,
"value": "95167400000100"
},
{
"id": "T1A_VALTRI",
"order": 15,
"value": "200.00"
},
{
"id": "T1A_UF",
"order": 20,
"value": "000001"
},
{
"id": "T1A_DTDEBI",
"order": 23,
"value": "20250131"
}
],
"models": [
{
"id": "MODEL_T1B",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "T1B_FILIAL",
"order": 1
},
{
"id": "T1B_ID",
"order": 2
},
{
"id": "T1B_IDPROC",
"order": 3
},
{
"id": "T1B_TERCEI",
"order": 5
},
{
"id": "T1B_VALSUS",
"order": 6
},
{
"id": "T1B_IDSUSP",
"order": 7
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "T1B_FILIAL",
"value": "D MG 01"
},
{
"id": "T1B_ID",
"value": "9533bb25-2bcc-c83a-5de8-1a300732418b"
},
{
"id": "T1B_IDPROC",
"value": "000001"
},
{
"id": "T1B_TERCEI",
"value": "2"
},
{
"id": "T1B_VALSUS",
"value": "100.00"
},
{
"id": "T1B_IDSUSP",
"value": "00000117082017154055"
}
]
}
]
}
]
}
]
}
API - Metodo PUT
- URL: http://localhost:8084/rest/FwModel/tafa632/RCBNRyAwMSA0YTVhYTQ3OC1hMzFkLWY1MWItOWJiMS1kYzJjOTYyMTAyYTc=
- Método:
PUT[id] - Descrição: Este endpoint Altera um movimento MIT no sistema.
JSON - Exemplo de envio do PUT
{
"id": "TAFA632",
"operation": 1,
"models": [
{
"id": "MODEL_T1A",
"modeltype": "FIELDS",
"fields": [
{
"id": "T1A_FILORI",
"order": 2,
"value": "T1D MG 02"
}
]
}
]
}
Exemplo de Resposta em Caso de Sucesso
JSON - Exemplo de resposta do PUT
{
"id": "TAFA632",
"operation": 1,
"pk": "RCBNRyAwMSA0YTVhYTQ3OC1hMzFkLWY1MWItOWJiMS1kYzJjOTYyMTAyYTc=",
"models": [
{
"id": "MODEL_T1A",
"modeltype": "FIELDS",
"fields": [
{
"id": "T1A_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "T1A_FILORI",
"order": 2,
"value": "T1D MG 02"
},
{
"id": "T1A_ID",
"order": 3,
"value": "4a5aa478-a31d-f51b-9bb1-dc2c962102a7"
},
{
"id": "T1A_IDDEBI",
"order": 4,
"value": "1"
},
{
"id": "T1A_ANOPOS",
"order": 5,
"value": "2020"
},
{
"id": "T1A_IDTRIB",
"order": 6,
"value": "000010"
},
{
"id": "T1A_PERAPU",
"order": 9,
"value": "052020"
},
{
"id": "T1A_CODREC",
"order": 10,
"value": "1010"
},
{
"id": "T1A_TRIPOS",
"order": 11,
"value": "1"
},
{
"id": "T1A_PERIOD",
"order": 12,
"value": "1"
},
{
"id": "T1A_CPNEST",
"order": 13,
"value": "13004999000350"
},
{
"id": "T1A_CNPINC",
"order": 14,
"value": "95167400000100"
},
{
"id": "T1A_VALTRI",
"order": 15,
"value": "200.00"
},
{
"id": "T1A_IDSCP",
"order": 17,
"value": "5157752e-c7c3-84ff-e528-d3efe9c42f3c"
},
{
"id": "T1A_UF",
"order": 20,
"value": "000001"
},
{
"id": "T1A_DTDEBI",
"order": 23,
"value": "20250131"
}
],
"models": [
{
"id": "MODEL_T1B",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "T1B_FILIAL",
"order": 1
},
{
"id": "T1B_ID",
"order": 2
},
{
"id": "T1B_IDPROC",
"order": 3
},
{
"id": "T1B_TERCEI",
"order": 5
},
{
"id": "T1B_VALSUS",
"order": 6
},
{
"id": "T1B_IDSUSP",
"order": 7
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "T1B_FILIAL",
"value": "D MG 01"
},
{
"id": "T1B_ID",
"value": "4a5aa478-a31d-f51b-9bb1-dc2c962102a7"
},
{
"id": "T1B_IDPROC",
"value": "000001"
},
{
"id": "T1B_TERCEI",
"value": "2"
},
{
"id": "T1B_VALSUS",
"value": "100.00"
},
{
"id": "T1B_IDSUSP",
"value": "00000117082017154055"
}
]
}
]
}
]
}
]
}
API - Método DELETE
- URL: http://localhost:8084/rest/FwModel/tafa632/RCBNRyAwMSA0YTVhYTQ3OC1hMzFkLWY1MWItOWJiMS1kYzJjOTYyMTAyYTc=
- Método:
DELETE - Descrição: Este endpoint deleta um movimento MIT no sistema.
Exemplo de Resposta em Caso de Sucesso
JSON - Exemplo de resposta do DELETE
true
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas