Fábrica de Software TOTVS BH

Atalhos

Páginas filhas
  • Documentação API - FIRJAN

Versões comparadas

Versão antiga 24

changes.mady.by.user Caroline dos Santos Lage

Gravado em

comparado com

Nova versão 25

changes.mady.by.user Caroline dos Santos Lage

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleAlterar Informações Contábeis
HTML
<div class="put">PUT</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/MatrizCurriculares/AlterarInformacoesContabies</div>


Consulta Contrato de um Aluno


Tabela Afetada: 

Interface RM: 

Authorization - Basic Auth

Username <username>

Password <password>

Parameters

Body


Bloco de código
languagec#
titleConsole
{
  "CodColigada": 2,
  "CodCurso": "",
  "CodHabilitacao": "",
  "CodGrade": "",
  "ItemContabil": "",
  "DtInicioItemContabil": "2023-04-13T18:36:06.583Z",
  "DtFimItemContabil": "2023-04-13T18:36:06.583Z",
  "ContaContabil": "",
  "DtInicioContaContabil": "2023-04-13T18:36:06.583Z",
  "DtFimContaContabil": "2023-04-13T18:36:06.583Z",
  "IdServico": 0,
  "DescServico": ""
}

Retorno


Bloco de código
languagec#
titleConsole
{
	"Message": "Sucesso ao incluir o Id. Lançamento 142.\r\n",
	"Status": "Sucesso",
}
Content
	"StatusCode": 200
}

Content

  • Message: Mensagem de retorno do consumo da requisição;
  • Status: Situação do processamento da requisição;
  • StatusCode: Código de status do processamento da requisição;
Expandir
titleConsultar Status
HTML
<div class="get">GET</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/MatrizCurriculares/ConsultarStatus</div>


O Gestor de Serviços poderá acionar um Web Service TOTVS capaz de retornar ao Gestor o Status da Matriz Curricular solicitada.


Tabela Afetada: Nenhuma

Interface RM: 

Authorization - Basic Auth

Username <username>

Password <password>

Parameters

  • codColigada: Código da Coligada no SGE
  • codCurso: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo)
  • codHabilitacao: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo)
  • codGrade: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo)

Retorno

Bloco de código
languagec#
titleConsole
"2"

Content

Status: 

0 = Ativa
1 = Inativa
2 = Atual

Expandir
titleAtualizar Pessoa
HTML
<div class="put">PUT</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/Pessoas/AtualizarPessoa</div>


Consulta Contrato de um Aluno


Tabela Afetada: 

Interface RM: 

Authorization - Basic Auth

Username <username>

Password <password>

Body


Bloco de código
languagec#
titleRaw
[     
	{
  		"ID": 0,
  		"CodPessoa": 0,
  		"Nome": "string",
  		"DataNascimento": "2023-04-11T17:46:24.482Z",
  		"EstadoCivil": "string",
 		"Sexo": "string",
  		"Cor": 0,
  		"NomeMae": "string",
  		"NomePai": "string",
  		"CPF": "string",
 		"Identidade": "string",
 		"OrgaoEmissor": "string",
 		"DataEmissao": "2023-04-11T17:46:24.482Z",
		"TituloEleitor": "string",
		"Passaporte": "string",
 		"Nacionalidade": "string",
 		"CidadeEnder": "string",
		"BairroEnder": "string",
		"UFEnder": "string",
  		"Estrangeiro": "string",
  		"Email": "string",
  		"DDD": "string",
  		"Telefone": "string",
  		"DDDCelular": "string",
  		"Celular": "string",
  		"Logradouro": "string",
  		"Complemento": "string",
  		"Numero": "string",
  		"CEP": "string",
  		"Municipio_IBGE": "string",
  		"TipoBeneficiario": "string",
  		"CodFilial": 0,
  		"CodUsuario": "string",
  		"IdCorporativo": 0,
  		"GrauInstrucao": "string",
  		"Matricula": "string",
  		"PaisNacionalidade": "string",
  		"EstadoNatal": "string",
  		"MunicipioNatal": "string",
  		"CodigoCliente": "string",
  		"FilialCliente": "string",
  		"TipoCliente": "string"
	} 
]

Retorno


Bloco de código
languagec#
titleConsole
{
"Message": "Sucesso ao incluir o Id. Lançamento 142.\r\n",
"Status": "Sucesso",
"StatusCode": 200
}

Content

  • Message: Mensagem de retorno do consumo da requisição;
  • Status: Situação do processamento da requisição;
  • StatusCode: Código de status do processamento da requisição;
Expandir
titleAtualizar Responsável Financeiro
HTML
<div class="put">PUT</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/Pessoas/AtualizarResponsavelFinanceiro</div>


Consulta Contrato de um Aluno


Tabela Afetada: 

Interface RM: 

Authorization - Basic Auth

Username <username>

Password <password>

Body


Bloco de código
languagec#
titleRaw
[     
	{
  		"ID": 0,
  		"CodPessoa": 0,
  		"Nome": "string",
  		"DataNascimento": "2023-04-11T17:46:24.482Z",
  		"EstadoCivil": "string",
 		"Sexo": "string",
  		"Cor": 0,
  		"NomeMae": "string",
  		"NomePai": "string",
  		"CPF": "string",
 		"Identidade": "string",
 		"OrgaoEmissor": "string",
 		"DataEmissao": "2023-04-11T17:46:24.482Z",
		"TituloEleitor": "string",
		"Passaporte": "string",
 		"Nacionalidade": "string",
 		"CidadeEnder": "string",
		"BairroEnder": "string",
		"UFEnder": "string",
  		"Estrangeiro": "string",
  		"Email": "string",
  		"DDD": "string",
  		"Telefone": "string",
  		"DDDCelular": "string",
  		"Celular": "string",
  		"Logradouro": "string",
  		"Complemento": "string",
  		"Numero": "string",
  		"CEP": "string",
  		"Municipio_IBGE": "string",
  		"TipoBeneficiario": "string",
  		"CodFilial": 0,
  		"CodUsuario": "string",
  		"IdCorporativo": 0,
  		"GrauInstrucao": "string",
  		"Matricula": "string",
  		"PaisNacionalidade": "string",
  		"EstadoNatal": "string",
  		"MunicipioNatal": "string",
  		"CodigoCliente": "string",
  		"FilialCliente": "string",
  		"TipoCliente": "string"
	} 
]

Retorno


Bloco de código
languagec#
titleConsole
{
"Message": "Sucesso ao incluir o Id. Lançamento 142.\r\n",
"Status": "Sucesso",
"StatusCode": 200
}

Content

  • Message: Mensagem de retorno do consumo da requisição;
  • Status: Situação do processamento da requisição;
  • StatusCode: Código de status do processamento da requisição;


HTML
<style>
	.expand-control {
    	cursor: pointer;
    	text-decoration: none;
	    margin-bottom: 10px;
	    background-color: #ededed;
	    height: 30px;
	    font-size: 20px;
	    padding: 5px;
	}
	.expand-control-text {
    	vertical-align: top;
	    font-weight: bold;
		color: #242424;
	}
	.post {
    	background-color: #378000;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.get {
    	background-color: #004fd6;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.put {
    	background-color: #ffa200;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.delete {
    	background-color: #cf0000;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.endereco{
		display: inline-block;
		padding: 5px;
		font-weight: bold;
	}
</style>
<!-- 
EXEMPLO DE MARCAÇÃO PARA TIPO DE REQUEST:
<div class="post">POST</div>
<div class="get">GET</div>
<div class="put">PUT</div>
<div class="delete">DELETE</div>

O ENDEREÇO DEVE SER INSERIDO COM A SEGUINTE MARCAÇÃO:
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div>
-->