Sigen+ Service

Agenda

Descrição dos métodos do serviço selecionado. [Exibir/Ocultar Ajuda]

Todas as operações aceitam dois tipos de requisição: Cabeçalho de Requisição: (Request Header) Content-Type

Disable Cache

Todas as operações tem o retorno definido da seguinte maneira:

Conteúdo: xml/json [Representação do objeto de retorno conforme definido nas operações abaixo.]

Lista de Operações Disponíveis

/Agenda/ObterDadosAgenda Métodos aceitos = POST Método utilizado para obter os dados da agenda no sigen + Filtros Possíveis:
// Dados referente ao mês informadonrMes : Int32// Dados referente ao ano informadonrAno : Int32// Código do agentoidAgenda : Int32// base64 string formado por: Usuario:ChaveauthToken : String [Obrigatorio]
Parâmetros: FiltroObterAgenda filtro
// Dados referente ao mês informadonrMes : Int32// Dados referente ao ano informadonrAno : Int32// Código do agentoidAgenda : Int32// base64 string formado por: Usuario:ChaveauthToken : String [Obrigatorio]

Tipo de retorno:

Mensagem

[HttpStatusCode = 400, 401, 404]

ResponseObterAgenda

[HttpStatusCode = 200]

/Agenda/Incluir Métodos aceitos = POST Parâmetros: RequestIncluirAgenda agenda
// Código do EventoidAgendaEvento : Int32 [Obrigatorio]// Titulo do evento a ser criado.dsTitulo : String [Obrigatorio]// Data inicio do evento.dhInicioPeriodo : DateTime [Obrigatorio]// Data fim do evento.dhFimPeriodo : DateTime [Obrigatorio]// Marcar se o evento for o dia inteiro.flDiaInteiro : String [Obrigatorio]// Marcar se o evento for privado.flPrivado : String [Obrigatorio]// Observação referente ao evento a ser criado.dsObservacao : String// Local em que será realizado o evento.dsLocal : String// Informar se o evento precisa de confirmação.flConfirmar : String// Lista dos colaboradores ou pessoas externas que serão convidados para o evento.listaColaboradorConvidado : ColaboradorConvidado[]idPessoaColaborador : Int32idAgendaEventoConvidadoCol : Int32nmPessoa : Stringtipo : StringnmEmpresa : StringdsEmail : StringnrMatriculaColaborador : StringflExterno : Boolean// Parâmetro utilizado para identificar o envio pelo web service.flWebService : Boolean// base64 string formado por: Usuario:ChaveauthToken : String [Obrigatorio]

Tipo de retorno:

Mensagem

[HttpStatusCode = 400, 401, 404]

ResponseIncluirAgenda

[HttpStatusCode = 200]

/Agenda/BuscarConvidados Métodos aceitos = GET Retorna os dados da pessoa de acordo com CPF/CNPJ informado.
Ex.: /Agenda/BuscarConvidados?authToken=ZWR1b2RhOjEy&nrDocumento=01123456000122 Filtros Possíveis:
// Nr. da MatriculanrMatricula : String// base64 string formado por: Usuario:ChaveauthToken : String [Obrigatorio]

Tipo de retorno:

ResponseBuscarConvidados

[HttpStatusCode = 200]

Mensagem

[HttpStatusCode = 400, 401, 404]

/Agenda/ListaColaboradores Métodos aceitos = Parâmetros: DataAccessParameter] parameter
Capacity : Int32Count : Int32Item : DataAccessParameterDbTypeNull : BooleanParameterName : StringDbType : DbTypeValue : ObjectDirection : ParameterDirection

Tipo de retorno:

Sem objeto de retorno

/Agenda/Delete Métodos aceitos = POST Método utilizado pra excluir um evento da agenda Parâmetros: RequestDelete agenda
// Código do EventoidAgendaEvento : Int32 [Obrigatorio]// base64 string formado por: Usuario:ChaveauthToken : String [Obrigatorio]

Tipo de retorno:

Mensagem

[HttpStatusCode = 400, 401, 404]

Mensagem

[HttpStatusCode = 200]

/Agenda/Index Métodos aceitos = GET Exibe a documentação dos serviços disponíveis.

Tipo de retorno:

HTML