Integração API Web

API Web de Integração do SophiA
Versão 1.0
1
CONTEÚDO
1. INTRODUÇÃO ........................................................................................................ 5
2. REQUISITOS E INSTALAÇÃO ................................................................................... 5
3. ESTRUTURA DA API WEB ........................................................................................ 5
3.1. Ambiente ........................................................................................................... 5
3.2. Parâmetros do cabeçalho de requisição .................................................................. 5
3.2.1. Exemplo do cabeçalho de requisição ................................................................ 5
4. RECURSOS DA API WEB .......................................................................................... 7
4.1. POST - /Autenticacao/PostAutenticacao ................................................................. 7
4.1.1. Corpo da requisição ...................................................................................... 7
4.1.2. Respostas HTTP ............................................................................................ 7
4.1.3. Objetos de retorno ........................................................................................ 8
4.2. POST – /AutenticacaoPessoa/PostAutenticacao ....................................................... 8
4.2.1. Corpo da requisição ...................................................................................... 8
4.2.2. Respostas HTTP ............................................................................................ 8
4.2.3. Objetos de retorno ........................................................................................ 8
4.3. POST – /AutenticacaoPessoa/PostEnviarSenha ...................................................... 11
4.3.1. Corpo da requisição .................................................................................... 11
4.3.2. Respostas HTTP .......................................................................................... 11
4.3.3. Objetos de retorno ...................................................................................... 12
4.4. POST – /AutenticacaoPessoa/PostTrocarSenha...................................................... 12
4.4.2. Respostas HTTP .......................................................................................... 12
4.5. GET – /Aviso/GetAvisos ..................................................................................... 12
4.5.1. URL completa da requisição ......................................................................... 13
4.5.3. Respostas HTTP .......................................................................................... 13
4.6. POST – /Aviso/PostMarcarComoLido .................................................................... 13
4.6.2. Respostas HTTP .......................................................................................... 14
4.7. GET – /Boletim/GetFiltroBoletim ......................................................................... 14
2
4.7.3. Respostas HTTP .......................................................................................... 14
4.8. GET – /Boletim/GetTodasEtapasBoletim ............................................................... 15
4.8.3. Respostas HTTP .......................................................................................... 15
4.9. GET – /Calendario/GetCalendario ........................................................................ 33
4.9.3. Respostas HTTP .......................................................................................... 33
4.10. GET – /Campanha/GetCampanhas ................................................................... 35
4.10.1. Respostas HTTP ....................................................................................... 35
4.10.2. Objetos de retorno ................................................................................... 35
4.11. GET – /Curso/GetCursos ................................................................................. 36
4.11.1. Respostas HTTP ....................................................................................... 36
4.12. GET – /FichaFinanceira/GetBoleto .................................................................... 37
4.12.1. URL completa da requisição ...................................................................... 37
4.12.2. Corpo da requisição ................................................................................. 37
4.12.3. Respostas HTTP ....................................................................................... 38
4.13. GET – /FichaFinanceira/GetFichaFinanceira ....................................................... 38
4.13.3. Respostas HTTP ....................................................................................... 38
4.14. GET – /FichaFinanceira/GetFiltroRelatorioDemonstrativoPagamento ..................... 40
3
4.14.3. Respostas HTTP ....................................................................................... 40
4.15. GET – /Logotipo/GetLogotipo ........................................................................... 40
4.15.1. Respostas HTTP ....................................................................................... 40
4.16. GET – /Nota/ListarNotasRecentes ..................................................................... 43
4.16.3. Respostas HTTP ....................................................................................... 43
4.17. POST – /Pessoa/PostPessoa ............................................................................ 45
4.17.2. Respostas HTTP ....................................................................................... 46
4.18. POST – /Prospectivo/PostProspectivo ................................................................ 47
4.18.2. Respostas HTTP ....................................................................................... 47
4.18.4. Códigos de erro retornados ....................................................................... 48
4.19. GET – /SituacaoFunil/GetSituacoesFunil ............................................................ 48
4.19.1. Respostas HTTP ....................................................................................... 48
4.20. GET – /Unidade/GetUnidades .......................................................................... 49
4.20.1. Respostas HTTP ....................................................................................... 49
4
1. INTRODUÇÃO
Neste documento são apresentados os recursos da API Web de integração para o Sophia Gestão
Escolar Web na versão 1, bem como sua forma de uso.
2. REQUISITOS E INSTALAÇÃO
A API Web de integração necessita que o módulo Web API esteja ativado em sua instalação do
Sophia Gestão Escolar Web.
3. ESTRUTURA DA API WEB

A API Web de integração é construída sobre a arquitetura REST, onde seus recursos são expostos
por meio de um endereço (URI) e o método HTTP utilizado para requisição. Através destas duas
informações, a API consegue localizar o recurso necessário e devolver a informação solicitada ao
cliente.
Alguns recursos podem precisar de mais informações que o endereço do recurso e o método HTTP
apropriado. Qualquer dado enviado a um recurso da API Web de integração pode ser enviado nos
formatos JSON ou XML (fica a cargo do cliente, escolher o formato de dados preferido para seu
uso). Os dados devolvidos para os sistemas integrados, também podem ser enviados nos
formatos JSON ou XML (mais uma vez, a escolha fica a cargo do cliente). Neste documento,
disponibilizamos exemplos de utilização com os dois formatos de dados.
Para que a comunicação com a API Web de integração seja estabelecida corretamente, o
cabeçalho da requisição deve conter os seguintes parâmetros.
3.1. Ambiente
Para a integração com a API Web temos apenas o ambiente produtivo, onde para utilização, é
necessário o número de série (ex: 6150) e a versão da API (ex: v1), segue abaixo:
https://escolar.sophia.com.br/Gerenciador/{NumeroSerie}/api/{VersaoApi}
3.2. Parâmetros do cabeçalho de requisição

Parâmetro Valor do Parâmetro
User-Agent Nome do sistema (ex: SophiaBiblioteca)
Host Endereço do servidor que hospeda a API (ex: https://escolar.sophia.com.br)
Content-Type Formato do dado a ser envido para à API (text/xml ou application/json)
Accept Formato dos dados devolvidos pela API (text/xml ou application/json)
Token Token de autenticação do sistema (gerado pelos recursos de autenticação da
API)
3.2.1. Exemplo do cabeçalho de requisição
Caso o produto Sophia Biblioteca, deseje obter a lista de unidades do Sophia Gestão Escolar Web,
onde o seu número de série seja 6150, hospedado em https://escolar.sophia.com.br, deverá ser
feita uma requisição para o recurso
https://escolar.sophia.com.br/Gerenciador/6150/Api/v1/Unidade/GetUnidades, com o método
HTTP GET, e com um cabeçalho nos seguintes formatos (de acordo com o formato de dados
escolhido).
5
XML
User-Agent: SophiaBiblioteca
Host: https://escolar.sophia.com.br
Content-Type: text/xml
Accept: text/xml
Token: acdc03e3r3ea4ae5g30908bfa3da34ee
JSON
User-Agent: SophiaBiblioteca
Host: https://escolar.sophia.com.br
Content-Type: application/json
Accept: application/json
Token: acdc03e3r3ea4ae5g30908bfa3da34ee
6
4. RECURSOS DA API WEB
4.1. POST - /Autenticacao/PostAutenticacao

Este recurso tem a responsabilidade de realizar a autenticação na API Web e validar a sua
comunicação com os sistemas integrados.
Como mostrado acima, as requisições para a API Web devem conter em seu cabeçalho o Token
de autenticação. E cabe a este recurso gerar este Token e devolvê-lo ao sistema requisitante, ou
seja, não é necessário o Token no cabeçalho deste recurso.
Os demais recursos da API de integração, esperam por este Token, e validam o mesmo para
confirmar se o cliente realmente tem autorização para acessar determinado recurso. Só após
confirmada esta autorização, o recurso é processado.
Para gerar um Token, o sistema integrado deve fazer uma requisição para o recurso de
autenticação, passando como parâmetro o usuário e a senha de integração definidos em
Configurações > Integração com Web API > Segurança no Sophia Gestão Escolar Web
(conforme Figura 1). Este recurso valida os dados informados, e se estiverem corretos, gera um
novo Token, e devolve o mesmo para o sistema que fez a requisição. O Token gerado só pode
ser utilizado pelo equipamento que requisitou o mesmo (o Token fica atrelado ao endereço IP do
equipamento). Todo Token gerado é renovado a cada requisição feita a qualquer recurso da API.
Um Token se torna inválido, após 20 minutos de sua criação ou última renovação (enquanto não
se tornar inválido, um token pode ser reaproveitado em todas as requisições realizadas).
Figura 1. Configuração de autenticação da API Web
4.1.1. Corpo da requisição

Nome Tipo Tamanho Observações
Usuario Texto 255 Usuário de acesso ao módulo cadastrado no sistema.
Senha Texto 255 Senha de acesso ao módulo cadastrado no sistema.
4.1.2. Respostas HTTP

HTTP 200 OK.
Autenticação realizada com sucesso, Token gerado.
HTTP 401 Unauthorized.

Autenticação rejeitada, Login ou Senha incorretos.
7
4.1.3. Objetos de retorno
XML
<string> df28d07fdfd1452482d690ea12bb5296</string>
JSON
"df28d07fdfd1452482d690ea12bb5296"
4.2. POST – /AutenticacaoPessoa/PostAutenticacao

Este recurso tem a responsabilidade de fazer o login de uma pessoa (aluno, pai, mãe,
responsável, etc) cadastrada no Sophia Gestão Escolar Web, desde que essa pessoa tenha um
contato do tipo E-mail cadastrado e que tenha sido enviada uma senha pelo recurso Alunos >
Enviar e-mail de senha, de acordo com a Figura 2 abaixo:
Figura 2. Envio de e-mail de senha
No retorno da requisição existe o TokenRequisicao que também pode ser utilizado nas requisições
e tem a mesma validade de 20 minutos.

Usuario Texto 250 Usuário (e-mail) de acesso da pessoa.
Senha Texto 15 Senha de acesso da pessoa.

HTTP 200 OK.
Autenticação realizada com sucesso, Token gerado e dados da pessoa retornados.
HTTP 500 Internal Server Error.

Autenticação rejeitada, Login ou Senha incorretos.

XML
Login como pai
<AutenticarModelRetorno>
<Alunos>
<AutenticarAlunoModelRetorno>
<CodigoInterno>27</CodigoInterno>
<Foto i:nil="true" />
<Genero>o</Genero>
<Nome>aluno b</Nome>
<Recursos>
<d4p1:string>avisos</d4p1:string>
<d4p1:string>boletim</d4p1:string>
8
<d4p1:string>calendario</d4p1:string>
<d4p1:string>fichafinanceira</d4p1:string>
<d4p1:string>boleto</d4p1:string>
<d4p1:string>demonstrativopagamento</d4p1:string>
<d4p1:string>notasrecentes</d4p1:string>
</Recursos>
<ResponsavelFinanceiro>true</ResponsavelFinanceiro>
<ResponsavelPedagogico>true</ResponsavelPedagogico>
<TipoUsuario>2</TipoUsuario>
</AutenticarAlunoModelRetorno>
<Genero>a</Genero>
<Nome>aluno c</Nome>
<Recursos>
</Recursos>
<ResponsavelFinanceiro>true</ResponsavelFinanceiro>
<ResponsavelPedagogico>false</ResponsavelPedagogico>
</Alunos>
<CPF>882.911.702-15</CPF>
<Genero>o</Genero>
<Nome>Pai aluno b</Nome>
<TokenRequisicao>2d41072d24cd42dc885fb830f5764150</TokenRequisicao>
<TokenValidacao i:nil="true" />
</AutenticarModelRetorno>
JSON
Login como pai
{
"Alunos":[
{
"CodigoInterno":27,
"Genero":"o",
"Nome":"aluno b",
"Foto":null,
"Recursos":[
"avisos",
"boletim",
"calendario",
"fichafinanceira",
"boleto",
"demonstrativopagamento",
"notasrecentes"
9
],
"ResponsavelFinanceiro":true,
"ResponsavelPedagogico":true,
"TipoUsuario":2
},
{
"CodigoInterno":28,
"Genero":"a",
"Nome":"aluno c",
"Foto":null,
"Recursos":[
"avisos",
"boletim",
"calendario",
"fichafinanceira",
"boleto",
"notasrecentes"
],
"ResponsavelFinanceiro":true,
"ResponsavelPedagogico":false,
"TipoUsuario":2
}
],
"CPF":"882.911.702-15",
"Genero":"o",
"CodigoInterno":26,
"Nome":"Pai aluno b",
"TokenValidacao":null,
"TokenRequisicao":"d09927f86c854be7a86370817e4612ef"
}
XML
Login como aluno
<AutenticarModelRetorno>
<Alunos>
<Genero>o</Genero>
<Recursos>
</Recursos>
<ResponsavelFinanceiro>false</ResponsavelFinanceiro>
<ResponsavelPedagogico>false</ResponsavelPedagogico>
</Alunos>
10
<CPF>576.539.158-33</CPF>
<Genero>o</Genero>
<TokenRequisicao>bcab4dadf25d42e4b9a4c6e4e843c7ab</TokenRequisicao>
<TokenValidacao i:nil="true" />
</AutenticarModelRetorno>
JSON
Login como aluno
{
"Alunos":[
{
"CodigoInterno":27,
"Genero":"o",
"Nome":"aluno b",
"Foto":null,
"Recursos":[
"avisos",
"boletim",
"calendario",
"fichafinanceira",
"boleto",
"notasrecentes"
],
"ResponsavelFinanceiro":false,
"ResponsavelPedagogico":false,
"TipoUsuario":0
}
],
"CPF":"576.539.158-33",
"Genero":"o",
"CodigoInterno":27,
"Nome":"aluno b",
"TokenValidacao":null,
"TokenRequisicao":"2c95f8e870284f699d216638b9fb88ce"
}
4.3. POST – /AutenticacaoPessoa/PostEnviarSenha

Este recurso tem a responsabilidade de enviar o e-mail de recuperação de senha para o usuário.
Não é necessário o envio do token.

Email Texto 250 E-mail da pessoa.

HTTP 200 OK.
Requisição realizada com sucesso.
11
XML
<EnviarSenhaModelRetorno>
<MensagemSet>
<d2p1:string>E-mail enviado para alunob@prima.com.</d2p1:string>
</MensagemSet>
<Resultado>true</Resultado>
</EnviarSenhaModelRetorno>
JSON
{
"MensagemSet":[
"E-mail enviado para alunob@prima.com."
],
"Resultado":true
}
4.4. POST – /AutenticacaoPessoa/PostTrocarSenha

Este recurso tem a responsabilidade de fazer a troca de senha do usuário.

CodigoInterno Inteiro Código interno que é retornado pelo método de
autenticação /AutenticacaoPessoa/PostAutenticacao.
SenhaAntiga Texto 15
SenhaNova Texto 15

HTTP 200 OK.

XML
<TrocarSenhaModelRetorno>
<MensagemSet/>
</TrocarSenhaModelRetorno>
JSON
{
"MensagemSet":[
"Senha atual incorreta."
],
"Resultado":false
}
4.5. GET – /Aviso/GetAvisos

Este recurso tem a responsabilidade de trazer os avisos lançados no Sophia Gestão Escolar Web.
12
4.5.1. URL completa da requisição
/Aviso/GetAvisos?Codigo={Codigo}&CodigoUsuario={CodigoUsuario}&TipoUsuario={TipoUsuari
o}&ResponsavelPedagogico={ResponsavelPedagogico}&ResponsavelFinanceiro={ResponsavelFi
nanceiro}

Codigo Inteiro Código interno do aluno.
CodigoUsuario Inteiro Código interno do usuário logado.
TipoUsuario Inteiro Tipo de usuário do aluno.
ResponsavelPedagogico Boleano O usuário logado é o responsável
pedagógico pelo aluno?
ResponsavelFinanceiro Boleano O usuário logado é o responsável financeiro
pelo aluno?

HTTP 200 OK.

XML
<ArrayOfListarAvisosModelRetorno>
<ListarAvisosModelRetorno>
<Codigo>1</Codigo>
<Descricao>Haverá festa julina no dia 15/07/2018 às
18:00h no pátio da escola.</Descricao>
<Lido>false</Lido>
<Titulo>Festa julina</Titulo>
</ListarAvisosModelRetorno>
</ArrayOfListarAvisosModelRetorno>
JSON
[
{
"Codigo":1,
"Descricao":"Haverá festa julina no dia 15/07/2018 às 18:00h no
pátio da escola.",
"Titulo":"Festa julina",
"Lido":false
}
]
4.6. POST – /Aviso/PostMarcarComoLido

Este recurso tem a responsabilidade de marcar um aviso como lido.

CodigoPessoa Inteiro Código interno do usuário logado.
CodigoAviso Inteiro Código do aviso.
13
HTTP 204 No Content.
Requisição realizada com sucesso, porém sem nenhum retorno.
4.7. GET – /Boletim/GetFiltroBoletim

Este recurso tem a responsabilidade de trazer a árvore para montar filtro para chamada de
impressão boletim.
/Boletim/GetFiltroBoletim?codigo={codigo}

codigo Inteiro Código interno do aluno.

HTTP 200 OK.
O objeto de retorno é utilizado para montar o link de impressão do boletim na seguinte estrutura:
https://escolar.sophia.com.br/Gerenciador/{NumeroSerie}/BoletimRelatorio/Visualizar
?m={CodigoMatricula}&t={CodigoTurma}&b={CodigoBoletim}
XML
<ArrayOfBoletimUnidadeViewModel>
<BoletimUnidadeViewModel>
<BoletimPeriodoSet>
<BoletimPeriodoViewModel>
<BoletimTurmaSet>
<BoletimTurmaViewModel>
<Codigo>8</Codigo>
<CodigoBoletim i:nil="true" />
<CodigoMatricula>23</CodigoMatricula>
<Descricao>1º Ano - Turma B</Descricao>
<Parametrizado>false</Parametrizado>
</BoletimTurmaViewModel>
</BoletimTurmaSet>
<Codigo>1</Codigo>
<Descricao>2018</Descricao>
</BoletimPeriodoViewModel>
</BoletimPeriodoSet>
<Codigo>1</Codigo>
<Descricao>SGEW Prima 1</Descricao>
</BoletimUnidadeViewModel>
</ArrayOfBoletimUnidadeViewModel>
14
JSON
[
{
"Codigo":1,
"Descricao":"SGEW Prima 1",
"BoletimPeriodoSet":[
{
"Codigo":1,
"Descricao":"2018",
"BoletimTurmaSet":[
{
"Codigo":8,
"Descricao":"1º Ano - Turma B",
"CodigoBoletim":null,
"CodigoMatricula":23,
"Parametrizado":false
}
]
}
]
}
]
4.8. GET – /Boletim/GetTodasEtapasBoletim

Este recurso tem a responsabilidade de trazer a árvore do boletim com as etapas e notas.
/Boletim/GetTodasEtapasBoletim?codigo={codigo}

codigo Inteiro Código interno do aluno

HTTP 200 OK.

XML
<ArrayOfBoletimEtapaMobileViewModel>
<BoletimEtapaMobileViewModel>
<Descricao>Bimestre 1</Descricao>
<Disciplinas>
<BoletimDisciplinaMobileViewModel>
<AulasDadas>10</AulasDadas>
<Avaliacoes>
<BoletimAvaliacaoMobileViewModel>
<DataHora>-1</DataHora>
<Descricao>Prova 1</Descricao>
<MediaTurma/>
<MediaTurmaCor>000</MediaTurmaCor>
15
<NotaAluno>7,8</NotaAluno>
<NotaAlunoCor>000</NotaAlunoCor>
<Peso>1</Peso>
</BoletimAvaliacaoMobileViewModel>
</Avaliacoes>
<Descricao>História</Descricao>
<Faltas>0</Faltas>
<MediaAluno>7,8</MediaAluno>
<MediaAlunoCor>000</MediaAlunoCor>
<MediaTurma/>
<Observacao>-1</Observacao>
<Percentual>0</Percentual>
<Setores />
<TarefasDadas>10</TarefasDadas>
<TarefasRealizadas>10</TarefasRealizadas>
</BoletimDisciplinaMobileViewModel>
<Avaliacoes>
<Descricao>Trabalho 1</Descricao>
<MediaTurma/>
<Peso>1</Peso>
<MediaTurma/>
<Peso>1</Peso>
</Avaliacoes>
<Descricao>Português</Descricao>
<Faltas>0</Faltas>
<MediaTurma/>
<Setores />
<Avaliacoes>
16
<Peso>1</Peso>
<MediaTurma/>
<Peso>1</Peso>
</Avaliacoes>
<Descricao>Matemática</Descricao>
<Faltas>0</Faltas>
<MediaTurma/>
<Setores />
</Disciplinas>
<IdEtapa>4</IdEtapa>
<IdMatricula>10</IdMatricula>
</BoletimEtapaMobileViewModel>
<Disciplinas>
<Avaliacoes>
<MediaTurma/>
<NotaAluno i:nil="true" />
<Peso>1</Peso>
</Avaliacoes>
<Faltas>0</Faltas>
<MediaAluno/>
<MediaTurma/>
<Setores />
17
<Avaliacoes>
<MediaTurma/>
<Peso>1</Peso>
<MediaTurma/>
<Peso>1</Peso>
</Avaliacoes>
<Faltas>0</Faltas>
<MediaAluno/>
<MediaTurma/>
<Setores />
<Avaliacoes>
<MediaTurma/>
<Peso>1</Peso>
<MediaTurma/>
<Peso>1</Peso>
18
</Avaliacoes>
<Faltas>0</Faltas>
<MediaAluno/>
<MediaTurma/>
<Setores />
</Disciplinas>
<Disciplinas>
<Avaliacoes>
<MediaTurma/>
<Peso>1</Peso>
</Avaliacoes>
<Faltas>0</Faltas>
<MediaAluno/>
<MediaTurma/>
<Setores />
<Avaliacoes>
<MediaTurma/>
<Peso>1</Peso>
19
<MediaTurma/>
<Peso>1</Peso>
</Avaliacoes>
<Faltas>0</Faltas>
<MediaAluno/>
<MediaTurma/>
<Setores />
<Avaliacoes>
<MediaTurma/>
<Peso>1</Peso>
<MediaTurma/>
<Peso>1</Peso>
</Avaliacoes>
<Faltas>0</Faltas>
<MediaAluno/>
<MediaTurma/>
<Setores />
20
</Disciplinas>
<Disciplinas>
<Avaliacoes>
<MediaTurma/>
<Peso>1</Peso>
</Avaliacoes>
<Faltas>0</Faltas>
<MediaAluno/>
<MediaTurma/>
<Setores />
<Avaliacoes>
<MediaTurma/>
<Peso>1</Peso>
<MediaTurma/>
<Peso>1</Peso>
</Avaliacoes>
<Faltas>0</Faltas>
<MediaAluno/>
21
<MediaTurma/>
<Setores />
<Avaliacoes>
<MediaTurma/>
<Peso>1</Peso>
<MediaTurma/>
<Peso>1</Peso>
</Avaliacoes>
<Faltas>0</Faltas>
<MediaAluno/>
<MediaTurma/>
<Setores />
</Disciplinas>
<Descricao>Etapas de recuperação final - Recuperação</Descricao>
<Disciplinas>
<AulasDadas>-1</AulasDadas>
<Avaliacoes>
<MediaTurma/>
22
<Peso>1</Peso>
</Avaliacoes>
<Faltas>-1</Faltas>
<MediaAluno/>
<MediaTurma/>
<Setores />
<TarefasDadas>-1</TarefasDadas>
<TarefasRealizadas>-1</TarefasRealizadas>
<Avaliacoes>
<MediaTurma/>
<Peso>1</Peso>
</Avaliacoes>
<Faltas>-1</Faltas>
<MediaAluno/>
<MediaTurma/>
<Setores />
<Avaliacoes>
<MediaTurma/>
<Peso>1</Peso>
</Avaliacoes>
23
<Faltas>-1</Faltas>
<MediaAluno/>
<MediaTurma/>
<Setores />
</Disciplinas>
</ArrayOfBoletimEtapaMobileViewModel>
JSON
[
{
"Descricao":"Bimestre 1",
"IdEtapa":4,
"IdMatricula":10,
"Disciplinas":[
{
"Descricao":"História",
"MediaAluno":"7,8",
"MediaAlunoCor":"000",
"MediaTurma":"",
"MediaTurmaCor":"000",
"AulasDadas":10,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":10,
"TarefasRealizadas":10,
"Observacao":"-1",
"Avaliacoes":[
{
"Descricao":"Prova 1",
"NotaAluno":"7,8",
"NotaAlunoCor":"000",
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
},
{
"NotaAluno":"7,8",
24
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
},
{
"Descricao":"Português",
"MediaAluno":"7,7",
"MediaTurma":"",
"AulasDadas":10,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":10,
"Observacao":"-1",
"Avaliacoes":[
{
"Descricao":"Trabalho 1",
"NotaAluno":"6,9",
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
},
{
"NotaAluno":"8,4",
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
},
{
"Descricao":"Matemática",
"MediaAluno":"9,2",
"MediaTurma":"",
"AulasDadas":10,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":0,
25
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":"8,9",
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
},
{
"NotaAluno":"9,5",
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
}
]
},
{
"IdEtapa":3,
"IdMatricula":10,
"Disciplinas":[
{
"MediaAluno":"",
"MediaTurma":"",
"AulasDadas":0,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":0,
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
26
]
},
{
"MediaAluno":"",
"MediaTurma":"",
"AulasDadas":0,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":0,
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
},
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
},
{
"MediaAluno":"",
"MediaTurma":"",
"AulasDadas":0,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":0,
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":null,
"MediaTurma":"",
27
"Peso":"1",
"DataHora":"-1"
},
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
}
]
},
{
"IdEtapa":2,
"IdMatricula":10,
"Disciplinas":[
{
"MediaAluno":"",
"MediaTurma":"",
"AulasDadas":0,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":0,
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
},
{
"MediaAluno":"",
"MediaTurma":"",
28
"AulasDadas":0,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":0,
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
},
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
},
{
"MediaAluno":"",
"MediaTurma":"",
"AulasDadas":0,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":0,
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
},
{
"NotaAluno":null,
29
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
}
]
},
{
"IdEtapa":1,
"IdMatricula":10,
"Disciplinas":[
{
"MediaAluno":"",
"MediaTurma":"",
"AulasDadas":0,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":0,
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
},
{
"MediaAluno":"",
"MediaTurma":"",
"AulasDadas":0,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":0,
"Observacao":"-1",
"Avaliacoes":[
30
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
},
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
},
{
"MediaAluno":"",
"MediaTurma":"",
"AulasDadas":0,
"Faltas":0,
"Percentual":0.0,
"TarefasDadas":0,
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
},
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
31
]
}
]
},
{
"Descricao":"Etapas de recuperação final - Recuperação",
"IdEtapa":1,
"IdMatricula":10,
"Disciplinas":[
{
"MediaAluno":"",
"MediaTurma":"",
"AulasDadas":-1,
"Faltas":-1,
"Percentual":0.0,
"TarefasDadas":-1,
"TarefasRealizadas":-1,
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
},
{
"MediaAluno":"",
"MediaTurma":"",
"AulasDadas":-1,
"Faltas":-1,
"Percentual":0.0,
"TarefasDadas":-1,
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
32
}
],
"Setores":[
]
},
{
"MediaAluno":"",
"MediaTurma":"",
"AulasDadas":-1,
"Faltas":-1,
"Percentual":0.0,
"TarefasDadas":-1,
"Observacao":"-1",
"Avaliacoes":[
{
"NotaAluno":null,
"MediaTurma":"",
"Peso":"1",
"DataHora":"-1"
}
],
"Setores":[
]
}
]
}
]
4.9. GET – /Calendario/GetCalendario

Este recurso tem a responsabilidade de retornar os eventos do calendário da escola.
/Calendario/GetCalendario?Codigo={Codigo}&DataInicial={DataInicial}&DataFinal={DataFinal}

Codigo Inteiro Código interno do aluno.
DataInicial Data Data de início do filtro desejado.
DataFinal Data Data de fim do filtro desejado.

HTTP 200 OK.
33
XML
<ArrayOfGetCalendarioModelRetorno>
<GetCalendarioModelRetorno>
<Cor>FFCACA</Cor>
<Data>13/02/2018</Data>
<Eventos>
<GetCalendarioEventoModelRetorno>
<Cor>FFCACA</Cor>
<Descricao>CARNAVAL</Descricao>
<Horario/>
</GetCalendarioEventoModelRetorno>
</Eventos>
</GetCalendarioModelRetorno>
<GetCalendarioModelRetorno>
<Cor>FFCACA</Cor>
<Data>12/02/2018</Data>
<Eventos>
<GetCalendarioEventoModelRetorno>
<Cor>FFCACA</Cor>
<Descricao>PONTE CARNAVAL</Descricao>
<Horario/>
</GetCalendarioEventoModelRetorno>
</Eventos>
</GetCalendarioModelRetorno>
</ArrayOfGetCalendarioModelRetorno>
JSON
[
{
"Cor":"FFCACA",
"Data":"13/02/2018",
"Eventos":[
{
"Cor":"FFCACA",
"Descricao":"CARNAVAL",
"Horario":""
}
]
},
{
"Cor":"FFCACA",
"Data":"12/02/2018",
"Eventos":[
{
"Cor":"FFCACA",
"Descricao":"PONTE CARNAVAL",
"Horario":""
}
]
}
]
34
4.10. GET – /Campanha/GetCampanhas
Este recurso tem a responsabilidade de retornar as campanhas e mídias.

HTTP 200 OK.

XML
<ArrayOfCampanha>
<Campanha>
<Codigo>1</Codigo>
<Descricao>Verão</Descricao>
<MidiaSet>
<Midia>
<Codigo>1</Codigo>
<Descricao>TV</Descricao>
</Midia>
<Midia>
<Codigo>2</Codigo>
<Descricao>Rádio</Descricao>
</Midia>
<Midia>
<Codigo>3</Codigo>
<Descricao>Mailing de eventos</Descricao>
</Midia>
</MidiaSet>
</Campanha>
</ArrayOfCampanha>
JSON
[
{
"Codigo":1,
"Descricao":"Verão",
"MidiaSet":[
{
"Codigo":1,
"Descricao":"TV"
},
{
"Codigo":2,
"Descricao":"Rádio"
},
{
"Codigo":3,
"Descricao":"Mailing de eventos"
}
]
}
]
35
4.11. GET – /Curso/GetCursos
Este recurso tem a responsabilidade de retornar todos os cursos da escola.

HTTP 200 OK.

XML
<ArrayOfCurso>
<Curso>
<Codigo>1</Codigo>
<Descricao>Curso 1</Descricao>
<Tipo>CursoSeriado</Tipo>
</Curso>
<Curso>
<Codigo>1</Codigo>
<Descricao>Curso 1 - PRIMEIRA</Descricao>
<Tipo>CursoSerie</Tipo>
</Curso>
<Curso>
<Codigo>2</Codigo>
<Descricao>curso 2</Descricao>
</Curso>
<Curso>
<Codigo>2</Codigo>
<Descricao>curso 2 - primeira</Descricao>
</Curso>
<Curso>
<Codigo>3</Codigo>
<Descricao>curso 3</Descricao>
</Curso>
<Curso>
<Codigo>3</Codigo>
<Descricao>curso 3 - SEGUNDA</Descricao>
</Curso>
<Curso>
<Codigo>6</Codigo>
<Descricao>Curso 4</Descricao>
</Curso>
<Curso>
<Codigo>6</Codigo>
<Descricao>Curso 4 - 4 - A</Descricao>
</Curso>
</ArrayOfCurso>
36
JSON
[
{
"Codigo":1,
"Descricao":"Curso 1",
"Tipo":1
},
{
"Codigo":1,
"Descricao":"Curso 1 - PRIMEIRA",
"Tipo":2
},
{
"Codigo":2,
"Descricao":"curso 2",
"Tipo":1
},
{
"Codigo":2,
"Descricao":"curso 2 - primeira",
"Tipo":2
},
{
"Codigo":3,
"Descricao":"curso 3",
"Tipo":1
},
{
"Codigo":3,
"Descricao":"curso 3 - SEGUNDA",
"Tipo":2
},
{
"Codigo":6,
"Descricao":"Curso 4",
"Tipo":1
},
{
"Codigo":6,
"Descricao":"Curso 4 - 4 - A",
"Tipo":2
}
]
4.12. GET – /FichaFinanceira/GetBoleto

Este recurso tem a responsabilidade de retornar o boleto desejado.
/FichaFinanceira/GetBoleto?idTitulo={idTitulo}

idTitulo Inteiro IdTitulo retornado pelo método
/FichaFinanceira/GetFichaFinanceira.
37
HTTP 200 OK.

XML
<GetBoletoRetorno>
<CaminhoPDF>http://localhost/sgew/6150/financeiro/Home/BoletoRelatorio/GerarRel
atorioBoletoLaserPorTitulo?c=1</CaminhoPDF>
<LinhaDigitavel>00190.00009 03321.321006 00000.003212 1
73950000003080</LinhaDigitavel>
</GetBoletoRetorno>
JSON
{
"CaminhoPDF":"http://localhost/sgew/6150/financeiro/Home/BoletoRelatorio/GerarRelatorioB
oletoLaserPorTitulo?c=1",
"LinhaDigitavel":"00190.00009 03321.321006 00000.003212 1 73950000003080"
}
4.13. GET – /FichaFinanceira/GetFichaFinanceira

Este recurso tem a responsabilidade de retornar a ficha financeira do aluno.
/FichaFinanceira/GetFichaFinanceira?codigo{codigo}

codigo Inteiro Código interno do aluno.

HTTP 200 OK.
Observação: Este recurso só é retornado no formato JSON e as datas utilizam o formato

Microsoft JSON format.
Ex: "\/Date(1198908717056)\/".
JSON
[
{
"Boleto":85,
"DataPagamento":"\/Date(-62135596800000)\/",
"DataVcto":"\/Date(1543975200000-0200)\/",
"Descricao":"Fundamental - teste - 1º Ano - 10/10",
38
"LinhaDigitavel":"00190.00009 01234.012344 00000.085019 1 77290000240000",
"Numero":321,
"Pago":false,
"ResponsavelFinanceiro":"Pai aluno b",
"TemBoleto":true,
"ValorPago":0.0,
"ValorPrevisto":850.0000
},
{
"Boleto":null,
"DataPagamento":"\/Date(-62135596800000)\/",
"DataVcto":"\/Date(1546826400000-0200)\/",
"Descricao":"Educação Infantil - Maternal I - 11/12",
"IdTitulo":265,
"LinhaDigitavel":"Não se aplica",
"Numero":265,
"Pago":false,
"TemBoleto":false,
"ValorPago":0.0,
},
{
"Boleto":null,
"DataPagamento":"\/Date(1520564400000-0300)\/",
"DataVcto":"\/Date(1520305200000-0300)\/",
"IdTitulo":255,
"Numero":255,
"Pago":true,
"TemBoleto":false,
"ValorPago":567.0800,
},
{
"Boleto":null,
"DataPagamento":"\/Date(1520564400000-0300)\/",
"DataVcto":"\/Date(1525662000000-0300)\/",
"IdTitulo":257,
"Numero":257,
"Pago":true,
"TemBoleto":false,
"ValorPago":500.0000,
}
]
39
4.14. GET –
/FichaFinanceira/GetFiltroRelatorioDemonstrativoPagamento
Este recurso tem a responsabilidade de retornar os demonstrativos de pagamento dos
alunos/responsáveis.
/FichaFinanceira/GetFiltroRelatorioDemonstrativoPagamento?
codigoResponsavel={codigoResponsavel}

codigoResponsavel Inteiro Código interno do usuário logado.

HTTP 200 OK.

XML
<ArrayOfRetornoFiltroDemonstrativoPagamento>
<RetornoFiltroDemonstrativoPagamento>
<Ano>2018</Ano>
<Url>http://localhost/sgew/6150/DemonstrativoPagamentoRelatorio/VisualizarRelatori
oDemonstrativoPagamentoPorResponsavel?c=5&a=2018</Url>
</RetornoFiltroDemonstrativoPagamento>
</ArrayOfRetornoFiltroDemonstrativoPagamento>
JSON
[
{
"Url":"http://localhost/sgew/6150/DemonstrativoPagamentoRelatorio/VisualizarRelatorioDem
onstrativoPagamentoPorResponsavel?c=5&a=2018",
"Ano":2018
}
]
4.15. GET – /Logotipo/GetLogotipo

Este recurso tem a responsabilidade de retornar a string na base 64 do logotipo.
Não é necessário o token no header.

HTTP 200 OK.
40
XML
<string>/9j/4AAQSkZJRgABAQEAYABgAAD/4QA6RXhpZgAATU0AKgAAAAgAA1EQAAEAAAABA
QAAAFERAAQAAAABAAAOxFESAAQAAAABAAAOxAAAAAD/2wBDAAIBAQIBAQICAgICAgICAwU
DAwMDAwYEBAMFBwYHBwcGBwcICQsJCAgKCAcHCg0KCgsMDAwMBwkODw0MDgsMDAz/2wB
DAQICAgMDAwYDAwYMCAcIDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDA
wMDAwMDAwMDAwMDAwMDAwMDAz/wAARCAA4AGQDASIAAhEBAxEB/8QAHwAAAQUBAQEB
AQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUE
GE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFV
WV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5us
LDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAA
AAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiM
oEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWV
pjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsP
ExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD3j9t/9v34vft
eftaX3wn+Dupavpmk2d9JpVvFpMxtbjUpYiVlmkmBDLGGVsYIG0ZOc17/AP8ABM/4C/tKfs7/ALQ
TaX8TtW1zVvBeoabLIGm1X+0reK4GNo3MzMjdeAQDXyJ+yN4iX9jD/gr5eaX4hxDb/wBv3ujyTTf
wR3DMIZcnoCGRs+hr9ug3f5j3r7fPsQsHRhg6FOPs5QTvbVvvfufD5Dh5Y2tPGV6kvaRm1a+iS6
W7dAU4H054pQMjjt+tcR8Yf2kvAvwDtYpfGHijSNB8/mNLmcLI49QvXHvir3wp+N/hH436IdR8I+
INL160UgO9pMJPLP8AtDqv4ivjfY1OT2nK+XvbT7z7P29Nz9nzLm7X1+46kNtxSKefxrh739pj4fa
Xrd7ptx4x8Ow32mB2urd71Fkg2ctuGeMVX+En7Vvw5+O2pz2PhPxdouuXlqTvt7eYeYAOpC9SPc
Zp/V6vLz8rsutmL6zS5uXmV30uj86v+C2HxU8T+Cv24/h1Y6L4j17SLK40q1aa3stQmt4pSbyUEs
qMATjjJ7Cv1ViP7rrzivyM/wCC6x/4z3+Gv/YItf8A0tlr9J/FX7ZXwt8B+M18Oat448O2OtMQjWsl0A
yN6Mein2NfRZph5TwOE9nG75ZXsvNHzeV4iMMfi/aysuaNrvyZ8/8A/BYDx58dvA/hDwm3wbj1pb
ea6kGqz6Pai4ulbC+UpBViEPzcgcng19J/sy6j4t1b9n7wfd+PIRbeMZtLhfV49gUrcbRuyo4DeoHAO
a0/G3xn8JfDjSrO+17xDo+k2eoZ+yzXNyscdxgA/Kc4bgjp61J4q+IWm6V8K9R8Tw3UNxpdvps
moJcRtujkiEZcMD0wR3ryKlaU8NToezSs371tXfpfyPYp0IwxVTEe0bul7t9Fbql5n4ift1ftk+Mm/b98
XX2j+MPEVno+j64kENtbalNHbBYCqsPLVtvLK2eOa/Tn9pzVte+JfgHRZtIa0uJNY0SwudHjvjD9hu
Lp51NyZBMkkRYW5BUyI+3LFVJzX4s3nhO8+KXgrx58QJo5JGtdVjlnkH3Q9zK7HP4mv3E/4JleOr
f40/sGeAbi+jgvzDYCxuFlQOrPEShyDx2Ffa8RUYYahRqQin7N8r+5P9PxPiuG61TFV69OcmvaLmX
3tfr+BhfCvUvihb+EbePwdb2M9hHFCt4s4WOC3vhbxfaY7ZVJRYRJn5UJRXMirgDAK+n4IY7WFY4
o4444xtVVG1VHoBRXxMscm78kfmj7eGBaVvaS+TPym/4L/fstS+FfHWgfGLRIWjj1App2rPH/AMs
7iMZglP1UbSfVV9a+x/8AgnL+2la/tF/sZW/ijUpx/a3hO1e31sd98MZbzP8AgSKD9c165+038DdN
/aP+BXiXwbqsIkt9asniQkZaGUDMbr7qwBB9q/HD/gnj8Uta/Z6+IXxd+F+oNJF/bmgalZPCeiXdv
G+CB7qGH0r6TCpZllfsZfHRat/hf+S/JHzWKbyzNfbR+Csnf/Ev83+bOh/Zd+CF5/wWA/be8Za94
01S/Tw5pm+6lWCQ7ljZykEEZPCrhSTj096seGdJ1L/gkf8A8FS9P8O2Wq3dz4Q1eaBXEjY+1WFy
do8wdC8bA8+qA969c/4NvUU/8LUbjzN1gPfH76uJ/wCC8Y8r9vP4ePDjzjotoTjufts2K9r6xKeaVMs
f8Lksl0Wid/U8RYeMMrp5mv4vPdy6v3mreh5lZ/s1Wv7WX/BW7xd4LvtQuNN06+1y8lu5IDiR4k5
ZB/vdK6P/AIKG/sd3H/BK/wCOfgnx38M9R1KDSbiXzLdppSz29xEQXidv4kdT0PUEiuj/AGJDI3/Bb
rXWk/1hur8v/vbFzX0D/wAHEaQn9lfwmxA81fEQCHjODA+f6Up46tDMcPhb3pygk10d0/8AIKeBo
zy3EYu1qkZtp9VZr/M+V/8Agsd8Ql+PXx1+DfifR5DB/wAJZ4NsL62Y8GFpp5CP++WP6V6R+3l/
wSF8L/s+/sa33jtdc1rVfHemtFc6pe3M5eK9d2/eYXtyeD14r5m+O81xNo37MbXO4yDwrAq7v7g1
W7Cf+Oha/V3/AILB8f8ABPbxx/1xh/8AQxWeIxFXCSweGoytHmafmlJKxph8PSxccZia8by5U15N
xvc/L39oz4iaj8Rf+CYPwVfUriW6m0nXNU06OSRtzeXGI9gz7Div0M+N/wASR8Lf+CItrfiXyZLzwR
Y6bCw/v3EUcI/9Dr80/if/AMowvhZ/2Nmsf+gxV9Vf8FP/AImnw3/wSb+A/hiNmWTxNa6fLIB/HD
b2isQf+2kkR/CtcdhlUqYeklp7Wf3JtszwOKdKGIqt6+xh97SSPOv2SPgJ/wAJR/wR2+NmteS0k91f
x3MOF+Y/ZAG4/wC+/wBK+mf+Def4hf2/+zH4k0CSSRn0HWCyKf4UlQNx+Oa+Qf2d/wDgrJp3
wK/YxufhHJ8P21Rb23uoZ9Q/tQRb2nz83l+UenH8XavQf+Ddv4l/2N+0D4w8LvIwh1zSlu4kJ4Dw
yYP4kOPyqc3wmIlg8U60bLmUo6rVKy6eSKyfGYeONwioyu+Rxlo9G7v82fsBj6/kaKTj/OKK/Mz9
OPg2y/4L1fDvw5Dr+m+KtH1rT/Eeg311ZfZ7WHzoLsxSMiMr8bd20ZDYwa+Qf+Cc/wAOda/bi/4
KA+IvHDae9noc5vrzUJAP3cAuI3jSLPQthv0Nfo58Uv8Agkl8C/jB41uPEGpeEvs+oXk5uLk2dw0Ed
w5OSWUccnrXtHwa+BPhP9n3wlHoXg/Q7PQ9Nj58u3TBkP8AeY9WP1r6xZxgMNQmsDCSnNWd9
l3sfJPJ8ficRB46cXCm7qy1fa5+Rv8AwT+/aEtf+ </string>
41
JSON
"/9j/4AAQSkZJRgABAQEAYABgAAD/4QA6RXhpZgAATU0AKgAAAAgAA1EQAAEAAAABAQAAAFE
RAAQAAAABAAAOxFESAAQAAAABAAAOxAAAAAD/2wBDAAIBAQIBAQICAgICAgICAwUDAwMDA
wYEBAMFBwYHBwcGBwcICQsJCAgKCAcHCg0KCgsMDAwMBwkODw0MDgsMDAz/2wBDAQICAg
MDAwYDAwYMCAcIDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwM
DAwMDAwMDAwMDAwMDAz/wAARCAA4AGQDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAA
AAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJ
xFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZW
mNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXG
x8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAE
CAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKR
obHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ
2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMn
K0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD3j9t/9v34vfteftaX3wn
+Dupavpmk2d9JpVvFpMxtbjUpYiVlmkmBDLGGVsYIG0ZOc17/AP8ABM/4C/tKfs7/ALQTaX8TtW
1zVvBeoabLIGm1X+0reK4GNo3MzMjdeAQDXyJ+yN4iX9jD/gr5eaX4hxDb/wBv3ujyTTfwR3DMI
ZcnoCGRs+hr9ug3f5j3r7fPsQsHRhg6FOPs5QTvbVvvfufD5Dh5Y2tPGV6kvaRm1a+iS6W7dAU4H
054pQMjjt+tcR8Yf2kvAvwDtYpfGHijSNB8/mNLmcLI49QvXHvir3wp+N/hH436IdR8I+INL160Ug
O9pMJPLP8AtDqv4ivjfY1OT2nK+XvbT7z7P29Nz9nzLm7X1+46kNtxSKefxrh739pj4faXrd7ptx4x
8Ow32mB2urd71Fkg2ctuGeMVX+En7Vvw5+O2pz2PhPxdouuXlqTvt7eYeYAOpC9SPcZp/V6vLz8
rsutmL6zS5uXmV30uj86v+C2HxU8T+Cv24/h1Y6L4j17SLK40q1aa3stQmt4pSbyUEsqMATjjJ7C
v1ViP7rrzivyM/wCC6x/4z3+Gv/YItf8A0tlr9J/FX7ZXwt8B+M18Oat448O2OtMQjWsl0AyN6Mein2
NfRZph5TwOE9nG75ZXsvNHzeV4iMMfi/aysuaNrvyZ8/8A/BYDx58dvA/hDwm3wbj1pbea6kGqz6
Pai4ulbC+UpBViEPzcgcng19J/sy6j4t1b9n7wfd+PIRbeMZtLhfV49gUrcbRuyo4DeoHAOa0/G3xn8
JfDjSrO+17xDo+k2eoZ+yzXNyscdxgA/Kc4bgjp61J4q+IWm6V8K9R8Tw3UNxpdvpsmoJcRtujki
EZcMD0wR3ryKlaU8NToezSs371tXfpfyPYp0IwxVTEe0bul7t9Fbql5n4ift1ftk+Mm/b98XX2j+MPE
Vno+j64kENtbalNHbBYCqsPLVtvLK2eOa/Tn9pzVte+JfgHRZtIa0uJNY0SwudHjvjD9huLp51NyZB
MkkRYW5BUyI+3LFVJzX4s3nhO8+KXgrx58QJo5JGtdVjlnkH3Q9zK7HP4mv3E/4JleOrf40/sGeAb
i+jgvzDYCxuFlQOrPEShyDx2Ffa8RUYYahRqQin7N8r+5P9PxPiuG61TFV69OcmvaLmX3tfr+BhfC
vUvihb+EbePwdb2M9hHFCt4s4WOC3vhbxfaY7ZVJRYRJn5UJRXMirgDAK+n4IY7WFY4o4444xtV
VG1VHoBRXxMscm78kfmj7eGBaVvaS+TPym/4L/fstS+FfHWgfGLRIWjj1App2rPH/AMs7iMZglP1
UbSfVV9a+x/8AgnL+2la/tF/sZW/ijUpx/a3hO1e31sd98MZbzP8AgSKD9c165+038DdN/aP+BXiX
wbqsIkt9asniQkZaGUDMbr7qwBB9q/HD/gnj8Uta/Z6+IXxd+F+oNJF/bmgalZPCeiXdvG+CB7qG
H0r6TCpZllfsZfHRat/hf+S/JHzWKbyzNfbR+Csnf/Ev83+bOh/Zd+CF5/wWA/be8Za9401S/Tw5p
m+6lWCQ7ljZykEEZPCrhSTj096seGdJ1L/gkf8A8FS9P8O2Wq3dz4Q1eaBXEjY+1WFydo8wdC8b
A8+qA969c/4NvUU/8LUbjzN1gPfH76uJ/wCC8Y8r9vP4ePDjzjotoTjufts2K9r6xKeaVMsf8Lksl0Wi
d/U8RYeMMrp5mv4vPdy6v3mreh5lZ/s1Wv7WX/BW7xd4LvtQuNN06+1y8lu5IDiR4k5ZB/vdK6P
/AIKG/sd3H/BK/wCOfgnx38M9R1KDSbiXzLdppSz29xEQXidv4kdT0PUEiuj/AGJDI3/BbrXWk/1hu
r8v/vbFzX0D/wAHEaQn9lfwmxA81fEQCHjODA+f6Up46tDMcPhb3pygk10d0/8AIKeBozy3EYu1q
kZtp9VZr/M+V/8Agsd8Ql+PXx1+DfifR5DB/wAJZ4NsL62Y8GFpp5CP++WP6V6R+3l/wSF8L/s+/
sa33jtdc1rVfHemtFc6pe3M5eK9d2/eYXtyeD14r5m+O81xNo37MbXO4yDwrAq7v7g1W7Cf+Oha
/V3/AILB8f8ABPbxx/1xh/8AQxWeIxFXCSweGoytHmafmlJKxph8PSxccZia8by5U15Nxvc/L39oz4
iaj8Rf+CYPwVfUriW6m0nXNU06OSRtzeXGI9gz7Div0M+N/wASR8Lf+CItrfiXyZLzwRY6bCw/v3E
UcI/9Dr80/if/AMowvhZ/2Nmsf+gxV9Vf8FP/AImnw3/wSb+A/hiNmWTxNa6fLIB/HDb2isQf+2kk
R/CtcdhlUqYeklp7Wf3JtszwOKdKGIqt6+xh97SSPOv2SPgJ/wAJR/wR2+NmteS0k91fx3MOF+Y/
ZAG4/wC+/wBK+mf+Def4hf2/+zH4k0CSSRn0HWCyKf4UlQNx+Oa+Qf2d/wDgrJp3wK/YxufhH
J8P21Rb23uoZ9Q/tQRb2nz83l+UenH8XavQf+Ddv4l/2N+0D4w8LvIwh1zSlu4kJ4DwyYP4kOPyq
c3wmIlg8U60bLmUo6rVKy6eSKyfGYeONwioyu+Rxlo9G7v82fsBj6/kaKTj/OKK/Mz9OPg2y/4L1f
Dvw5Dr+m+KtH1rT/Eeg311ZfZ7WHzoLsxSMiMr8bd20ZDYwa+Qf+Cc/wAOda/bi/4KA+IvHDae
9noc5vrzUJAP3cAuI3jSLPQthv0Nfo58Uv8Agkl8C/jB41uPEGpeEvs+oXk5uLk2dw0Edw5OSWUcc
nrXtHwa+BPhP9n3wlHoXg/Q7PQ9Nj58u3TBkP8AeY9WP1r6xZxgMNQmsDCSnNWd9l3sfJPJ8fic
RB46cXCm7qy1fa5+Rv8AwT+/aEtf+”
42
4.16. GET – /Nota/ListarNotasRecentes
Este recurso tem a responsabilidade de retornar as notas recentes do aluno.
/Nota/ListarNotasRecentes?codigo={codigo}

codigo Inteiro Codigo interno do aluno.

HTTP 200 OK.

XML
<ArrayOfNotaRecenteAvaliacaoMobileViewModel>
<NotaRecenteAvaliacaoMobileViewModel>
<Codigo>15</Codigo>
<Cor>000</Cor>
<DataHora/>
<Disciplina>Matemática</Disciplina>
<Etapa>Bimestre 1 - Bimestre 1</Etapa>
<MediaTurma>-1</MediaTurma>
<Nota>8,3</Nota>
<Professor>-1</Professor>
<Setores/>
<Turma>1ª Série A EF</Turma>
</NotaRecenteAvaliacaoMobileViewModel>
<NotaRecenteAvaliacaoMobileViewModel>
<Codigo>16</Codigo>
<Cor>000</Cor>
<DataHora/>
<Disciplina>Matemática</Disciplina>
<Etapa>Bimestre 1 - Bimestre 1</Etapa>
<MediaTurma>-1</MediaTurma>
<Nota>7,9</Nota>
<Professor>-1</Professor>
<Setores/>
<Turma>1ª Série A EF</Turma>
</NotaRecenteAvaliacaoMobileViewModel>
</ArrayOfNotaRecenteAvaliacaoMobileViewModel>
43
JSON
[
{
"Codigo":15,
"Cor":"000",
"DataHora":"",
"Disciplina":"Matemática",
"Etapa":"Bimestre 1 - Bimestre 1",
"MediaTurma":"-1",
"Nota":"8,3",
"Professor":"-1",
"Setores":[
],
"Turma":"1ª Série A EF"
},
{
"Codigo":16,
"Cor":"000",
"DataHora":"",
"Disciplina":"Matemática",
"Etapa":"Bimestre 1 - Bimestre 1",
"MediaTurma":"-1",
"Nota":"7,9",
"Professor":"-1",
"Setores":[
],
"Turma":"1ª Série A EF"
}
]
44
4.17. POST – /Pessoa/PostPessoa
Recurso responsável por fazer a inclusão de pessoa.
4.17.1.1. Pessoa

Deve ser utilizado com o valor true quando o
aluno mora em endereço próprio e não no
MoraCom Boleano endereço de algum responsável.
ResponsavelFinanceiro Boleano responsável financeiro é o próprio aluno.
ResponsavelPedagogico Boleano responsável pedagógico é o próprio aluno.
Nome Texto 100 Nome do aluno.
CPF (opcional) Texto 11 CPF do aluno.
Sexo do aluno. (M para masculino e F para
Sexo Texto 1 feminino)
RgNumero (opcional) Texto 12 Número do RG do aluno.
RgOrgaoEmissor
(opcional) Texto 15 Orgão emissor do RG do aluno.
DataNascimento
(opcional) Data Data de nascimento no formato yyyy-MM-dd.
CidadeNascimento
(opcional) Texto 250 Cidade de nascimento do aluno.
UFNascimento
(opcional) Texto 2 Estado de nascimento do aluno.
Observacoes (opcional) Texto 8000
Lista de
ContatoSet (opcional) contatos Estrutura de lista do objeto ContatoSet.
Cep (opcional) Texto 9 CEP da residência do aluno.
Bairro (opcional) Texto 250 Bairro da residência do aluno.
Cidade (opcional) Texto 250 Cidade da residência do aluno.
UF (opcional) Texto 2 Estado da residência do aluno.
Logradouro (opcional) Texto 400 Logradouro da residência do aluno.
Numero (opcional) Texto 20 Número da residência do aluno.
Complemento
(opcional) Texto 250 Complemento da residência do aluno.
ResponsavelSet Lista de
(opcional) responsáveis Estrutura de lista de ResponsavelSet
4.17.1.2. ResponsavelSet

MoraCom Boleano aluno mora com este responsável.
Deve ser utilizado com o valor true quando este
ResponsavelFinanceiro Boleano responsável é o financeiro.
Deve ser utilizado com o valor true quando este
ResponsavelPedagogico Boleano responsável é o pedagógico.
45
Parentesco Texto 15
Sexo do responsável. (M para masculino e F para
Sexo Texto 1 feminino)
Nome Texto 100 Nome do responsável.
CPF (opcional) Texto 11
DataNascimento
(opcional) Data Data de nascimento no formato yyyy-MM-dd.
RG (opcional) Texto 12 Número do RG do responsável.
RgOrgaoEmissor
(opcional) Texto 15 Orgão emissor do RG do responsável.
Lista de
ContatoSet (opcional) contatos Estrutura de lista do objeto ContatoSet.
Cep (opcional) Texto 9 CEP da residência do responsável.
Bairro (opcional) Texto 250 Bairro da residência do responsável.
Cidade (opcional) Texto 250 Cidade da residência do responsável.
UF (opcional) Texto 2 Estado da residência do responsável.
Logradouro (opcional) Texto 400 Logradouro da residência do responsável.
Numero (opcional) Texto 20 Número da residência do responsável.
Complemento
(opcional) Texto 250 Complemento da residência do responsável.
EmpresaTrabalha
(opcional) Texto 100 Nome da empresa que o responsável trabalha.
Profissao (opcional) Texto 100 Nome da profissão do responsável.
4.17.1.3. ContatoSet

Tipo de contato (Email, Celular, Residencial,
Tipo Texto 15 Comercial, Outro).
Valor Texto 250 Contato do tipo especificado.

HTTP 201 Created.
Cadastro realizado com sucesso.
400 Bad Request

Requisição inválida.

XML
<RetornoOperacaoOfint>
<MensagemSet />
<Codigo>0</Codigo>
<CodigoSet />
</RetornoOperacaoOfint>
46
JSON
{
"Codigo":0,
"CodigoSet":[
],
"MensagemSet":[
],
"Resultado":true
}
4.18. POST – /Prospectivo/PostProspectivo

Recurso responsável por fazer a inclusão de prospectivos.

CodigoUnidade Inteiro Código da unidade, retornado pelo método
/Unidade/GetUnidades.
CodigoCampanha Inteiro Código da campanha, retornado pelo método
/Campanha/GetCampanhas.
CodigoMidia Inteiro Código da mídia, retornado pelo método
/Campanha/GetCampanhas.
Agendamento Data e Data e hora no formato dd/MM/yyyy HH:mm.
(opcional) Hora
Nome Texto 100 Nome do prospectivo.
Email Texto 250 E-mail do prospectivo.
Telefone Texto 250 Telefone do prospectivo.
Observação Texto 8000
(opcional)
CodigoCurso Inteiro Código do curso, retornado pelo método
(opcional) /Curso/GetCursos
TipoCurso Inteiro Identificação do tipo de curso (0 – curso
(opcional) simples; 1 – curso seriado; 2 – curso série;)
CodigoSituacaoFunil Inteiro Código da situação do funil, retornado pelo
(opcional) método /SituacaoFunil/GetSituacoesFunil

HTTP 200 OK.
XML
<RetornoOperacaoOfint>
<RetornoSet />
<Codigo>0</Codigo>
<CodigoSet />
</RetornoOperacaoOfint>
47
JSON
{
"RetornoSet":[
],
"Codigo":0,
"CodigoSet":[
],
"Resultado":true
}
4.18.4. Códigos de erro retornados

Código Descrição
0 Erro geral {0}.
1 O valor informado no campo {0} é inválido.
2 {0} é uma dependência inexistente.
3 O campo {0} é obrigatório.
4 O campo {0} ultrapassou o tamanho máximo.
5 O e-mail informado no campo {0} é inválido.
6 O telefone informado no campo {0} é inválido.
7 A data informada no campo {0} está fora do intervalo permitido.
8 O número de série vinculado a unidade informada não é válido.
9 A configuração de integração com a WebApi não foi realizada no sistema.
10 A ordem de atendimento na configuração de integração com a WebApi não foi
cadastrada no sistema.
11 O valor informado no campo {0} é inválido ou não foi definido na configuração de
integração com a WebApi.
4.19. GET – /SituacaoFunil/GetSituacoesFunil

Recurso responsável por retornar as situações do funil.

HTTP 200 OK.
48
XML
<ArrayOfSituacaoFunil xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<SituacaoFunil>
<Codigo>1</Codigo>
<Descricao>Prospectivo</Descricao>
</SituacaoFunil>
<SituacaoFunil>
<Codigo>2</Codigo>
<Descricao>Contato efetivo</Descricao>
</SituacaoFunil>
<SituacaoFunil>
<Codigo>3</Codigo>
<Descricao>Visita agendada</Descricao>
</SituacaoFunil>
<SituacaoFunil>
<Codigo>4</Codigo>
<Descricao>Visita realizada</Descricao>
</SituacaoFunil>
</ArrayOfSituacaoFunil>
JSON
[
{
"Codigo":1,
"Descricao":"Prospectivo"
},
{
"Codigo":2,
"Descricao":"Contato efetivo"
},
{
"Codigo":3,
"Descricao":"Visita agendada"
},
{
"Codigo":4,
"Descricao":"Visita realizada"
}
]
4.20. GET – /Unidade/GetUnidades

Recurso utilizado para retornar as unidades.

HTTP 200 OK.
49
XML
<ArrayOfUnidade xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Unidade>
<Bairro>Residencial Independência</Bairro>
<Cidade>São José dos Campos</Cidade>
<Codigo>1</Codigo>
<Descricao>SGEW Prima Unidade 1</Descricao>
<Estado>SP</Estado>
</Unidade>
<Unidade>
<Bairro>Pilares</Bairro>
<Cidade>Rio de Janeiro</Cidade>
<Codigo>2</Codigo>
<Estado>RJ</Estado>
</Unidade>
<Unidade>
<Bairro i:nil="true" />
<Cidade i:nil="true" />
<Codigo>3</Codigo>
<Estado i:nil="true" />
</Unidade>
</ArrayOfUnidade>
JSON
[
{
"Codigo":1,
"Bairro":"Residencial Independência",
"Cidade":"São José dos Campos",
"Descricao":"SGEW Prima Unidade 1",
"Estado":"SP"
},
{
"Codigo":2,
"Bairro":"Pilares",
"Cidade":"Rio de Janeiro",
"Estado":"RJ"
},
{
"Codigo":3,
"Bairro":null,
"Cidade":null,
"Estado":null
}
]
50

Integração API Web

Enviado por

Dados do documento

Descrição original:

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Integração API Web

Enviado por

Direitos autorais:

Formatos disponíveis

API Web de Integração do SophiA

2. REQUISITOS E INSTALAÇÃO ................................................................................... 5

3. ESTRUTURA DA API WEB ........................................................................................ 5

3.1. Ambiente ........................................................................................................... 5

3.2. Parâmetros do cabeçalho de requisição .................................................................. 5

3.2.1. Exemplo do cabeçalho de requisição ................................................................ 5

4. RECURSOS DA API WEB .......................................................................................... 7

4.1. POST - /Autenticacao/PostAutenticacao ................................................................. 7

4.1.1. Corpo da requisição ...................................................................................... 7

4.1.2. Respostas HTTP ............................................................................................ 7

4.1.3. Objetos de retorno ........................................................................................ 8

4.2. POST – /AutenticacaoPessoa/PostAutenticacao ....................................................... 8

4.2.1. Corpo da requisição ...................................................................................... 8

4.2.2. Respostas HTTP ............................................................................................ 8

4.2.3. Objetos de retorno ........................................................................................ 8

4.3. POST – /AutenticacaoPessoa/PostEnviarSenha ...................................................... 11

4.3.1. Corpo da requisição .................................................................................... 11

4.3.2. Respostas HTTP .......................................................................................... 11

4.3.3. Objetos de retorno ...................................................................................... 12

4.4. POST – /AutenticacaoPessoa/PostTrocarSenha...................................................... 12

4.4.1. Corpo da requisição .................................................................................... 12

4.4.2. Respostas HTTP .......................................................................................... 12

4.4.3. Objetos de retorno ...................................................................................... 12

4.5. GET – /Aviso/GetAvisos ..................................................................................... 12

4.5.1. URL completa da requisição ......................................................................... 13

4.5.2. Corpo da requisição .................................................................................... 13

4.5.3. Respostas HTTP .......................................................................................... 13

4.5.4. Objetos de retorno ...................................................................................... 13

4.6. POST – /Aviso/PostMarcarComoLido .................................................................... 13

4.6.1. Corpo da requisição .................................................................................... 13

4.6.2. Respostas HTTP .......................................................................................... 14

4.7. GET – /Boletim/GetFiltroBoletim ......................................................................... 14

4.7.2. Corpo da requisição .................................................................................... 14

4.7.3. Respostas HTTP .......................................................................................... 14

4.7.4. Objetos de retorno ...................................................................................... 14

4.8. GET – /Boletim/GetTodasEtapasBoletim ............................................................... 15

4.8.1. URL completa da requisição ......................................................................... 15

4.8.2. Corpo da requisição .................................................................................... 15

4.8.3. Respostas HTTP .......................................................................................... 15

4.8.4. Objetos de retorno ...................................................................................... 15

4.9. GET – /Calendario/GetCalendario ........................................................................ 33

4.9.1. URL completa da requisição ......................................................................... 33

4.9.2. Corpo da requisição .................................................................................... 33

4.9.3. Respostas HTTP .......................................................................................... 33

4.9.4. Objetos de retorno ...................................................................................... 34

4.10. GET – /Campanha/GetCampanhas ................................................................... 35

4.10.1. Respostas HTTP ....................................................................................... 35

4.10.2. Objetos de retorno ................................................................................... 35

4.11. GET – /Curso/GetCursos ................................................................................. 36

4.11.1. Respostas HTTP ....................................................................................... 36

4.11.2. Objetos de retorno ................................................................................... 36

4.12. GET – /FichaFinanceira/GetBoleto .................................................................... 37

4.12.1. URL completa da requisição ...................................................................... 37

4.12.2. Corpo da requisição ................................................................................. 37

4.12.3. Respostas HTTP ....................................................................................... 38

4.12.4. Objetos de retorno ................................................................................... 38

4.13. GET – /FichaFinanceira/GetFichaFinanceira ....................................................... 38

4.13.1. URL completa da requisição ...................................................................... 38

4.13.2. Corpo da requisição ................................................................................. 38

4.13.3. Respostas HTTP ....................................................................................... 38

4.13.4. Objetos de retorno ................................................................................... 38

4.14. GET – /FichaFinanceira/GetFiltroRelatorioDemonstrativoPagamento ..................... 40

4.14.1. URL completa da requisição ...................................................................... 40