...
Esse documento tem o objetivo de exemplificar o uso da API da Tabela de Preços utilizando todos os métodos implementados. E as api's complementares referente às matrizes aplicadas e aos período letivo períodos letivos de ingresso associados à tabela de preços. A Para a utilização das api's é importante observar a responsabilidade e o papel de cada uma e o papel dela para o no cadastro e manutenção das informações da tabela de preços.
A API da tabela de preços terá tem a responsabilidade de realizar a manutenção das informações das da própria tabela de preços e das suas matrizes aplicadas e dos seus períodos letivos de ingressos associados na tabela de preçosà ela. Não sendo possível inserir, alterar ou remover as os dados das disciplinas associadas às matrizes aplicadas. Essa manipulação será de responsabilidade da api da matriz aplicada.
A API da matriz aplicada terá tem a responsabilidade de realizar a manutenção das informações da matriz aplicada e das disciplinas vinculadas à ela. Nessa api será possível alterar e remover a matriz aplicada além de . E inserir, alterar e remover os dados das disciplinas vinculadas à matriz aplicada. Nessa api não será possível inserir uma nova matriz aplicada na tabela de preços, essa responsabilidade está na api da tabela de preços.
A API do período letivo de ingresso terá tem a responsabilidade de realizar somente a remoção do período letivo de ingresso na tabela de preços. A responsabilidade somente a inclusão e alteração do período letivo de ingresso na tabela de preços é da está na própria api da própria tabela de preços.
1 - Tabela de Preços
...
| Expandir |
|---|
| Informações |
|---|
| A inclusão de uma nova tabela de preços será feita contendo os seus dados, e os dados das suas matrizes aplicadas vinculadas. Não sendo possível inserir a tabela de preços com suas matrizes aplicadas contendo suas disciplinas, e os períodos letivos de ingresso dessa tabela de preço. Essas informações serão inseridas em outras api's com essa responsabilidade. Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetable | Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Entrada |
|---|
| | Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"companyCode": 1,
"levelEducationCode": 1,
"code": "00005",
"name": "Tabela de Precos via Postman",
"active": false,
"appliedMatrixes": []
}
ou
{
"companyCode": 1,
"levelEducationCode": 1,
"code": "00005",
"name": "Tabela de Precos via Postman",
"active": false,
"appliedMatrixes": [
{
"companyCode": 1,
"branchCode": 1,
"levelEducationCode": 1,
"appliedMatrixCode": 132,
"priceTableCode": 3,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "1-1",
"courseName": "Curso Tabela de Preços",
"curriculumGridCode": "1",
"curriculumGridName": "Matriz Tabela de Preços",
"majorCode": "1",
"majorName": "Habilitação Tabela de Preços",
"classShiftCode": 11,
"classShiftName": "INTEGRAL",
"status": 0,
"actionState": 0
}
]
} |
|
|
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Positivo |
|---|
| | Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"companyCode": 1,
"levelEducationCode": 1,
"id": 25,
"internalId": "1|1|25",
"code": "00007",
"name": "Tabela de Precos via Postman",
"active": false,
"priceTableInUse": false,
"appliedMatrixes": []
}
ou
{
"companyCode": 1,
"levelEducationCode": 1,
"id": 12,
"internalId": "1|1|12",
"code": "00005",
"name": "Tabela de Precos via Postman",
"active": false,
"priceTableInUse": false,
"appliedMatrixes": [
{
"companyCode": 1,
"branchCode": 1,
"levelEducationCode": 1,
"appliedMatrixCode": 132,
"priceTableCode": 12,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "1-1",
"courseName": "Curso Tabela de Preços",
"curriculumGridCode": "1",
"curriculumGridName": "Matriz Tabela de Preços",
"majorCode": "1",
"majorName": "Habilitação Tabela de Preços",
"classShiftCode": 11,
"classShiftName": "INTEGRAL",
"status": 0,
"actionState": 0
}
]
} |
|
|
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Negativo |
|---|
| | Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"code": null,
"message": "Não foi possível incluir/editar a tabela de preços. Código do nível de ensino está inválido.",
"detailedMessage": null,
"helpUrl": null,
"details": null
} |
|
|
|
|
...
| Expandir |
|---|
| Informações |
|---|
| A atualização da tabela de preços será feita contendo os seus dados e os dados das suas matrizes aplicadas, e os dados dos seus períodos letivos de ingresso. E a inclusão de novos períodos letivos de ingresso. Não sendo possível inserir a tabela de preços com suas matrizes aplicadas contendo suas disciplinas. Essas informações serão inseridas em outras api's com essa responsabilidade. Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetable/{internalId} | Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Entrada |
|---|
| | Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"companyCode": 1,
"levelEducationCode": 1,
"id": 14,
"internalId": "1|1|14",
"code": "00003",
"name": "Tabela de Precos via Postman ALT",
"active": false,
"appliedMatrixes": [],
"terms": []
} |
|
|
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Positivo |
|---|
| | Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"companyCode": 1,
"levelEducationCode": 1,
"id": 14,
"internalId": "1|1|14",
"code": "00003",
"name": "Tabela de Precos via Postman ALT",
"active": false,
"priceTableInUse": false,
"appliedMatrixes": [],
"terms": []
} |
|
|
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Negativo |
|---|
| | Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"code": null,
"message": "Não foi possível incluir/editar a tabela de preços. Código do nível de ensino está inválido.",
"detailedMessage": null,
"helpUrl": null,
"details": null
} |
|
|
|
|
...
