Versão 1.00
Parâmetros padrões:
| Nome | Obrigatório | Tipo de dado | Finalidade | Descrição |
|---|---|---|---|---|
| id | Não | Inteiro | Filtro | Utilizado para filtrar o Id do registro do agendamento de compromissos. |
| id_usuario | Não | Inteiro | Filtro | Utilizado para filtrar o registro a ser consultado pelo código do usuário. |
| data_inicial | Sim | Data | Filtro | Utilizado para filtrar o registro a ser consultado pela data inicial da agenda. |
| data_final | Sim | Data | Filtro | Utilizado para filtrar o registro a ser consultado pela data final da agenda. |
| id_inicial | Não | Inteiro | Filtro | Id inicial do registro a ser considerado. |
| id_final | Não | Inteiro | Filtro | Id final do registro a ser considerado. |
| max_registros | Não | Inteiro | Filtro | Determina a quantidade máxima de registros a serem retornados. |
Estrutura de retorno:
| Nome | Nível | Tipo de dado | Descrição |
|---|---|---|---|
| agenda_compromissos | 0 | Estrutural | |
| compromisso | 1 | Estrutural | |
| id | 2 | Inteiro | Id da agenda de compromissos. |
| tipo | 2 | Inteiro | Enviar o valor "0" como padrão; |
| data_inicio | 2 | Data | Data do início do agendamento do compromissos. |
| data_fim | 2 | Data | Data do fim do agendamento do compromissos. |
| opcoes | 2 | Inteiro | Informativo se o agendamento do compromisso vai durar o dia todo ou não. Exemplo: 6 = Intervalo por tempo; 7 = Dia todo; |
| assunto | 2 | Texto(255) | Assunto do agendamento de compromissos. |
| mensagem | 2 | Texto(255) | Mensagem do agendamento de compromissos. |
| local | 2 | Texto(255) | Local do agendamento de compromissos. |
| status | 2 | Inteiro | Informativo do status do agendamento de compromissos: Exemplo: 0 = Livre; 1 = Provisório; 2 = Ocupado; 3 = Ausência temporária. |
| id_usuario | 2 | Inteiro | Id do usuário do agendamento de compromissos. |
Exemplos de consultas
//Mostra a agenda de compromisso 3 <servico versao="1.00" token="tkn-vinhasoft-001" id_empresa="1" id="3"/>
//Todas as agendas de compromisso referente ao usuário 60 <servico versao="1.00" token="tkn-vinhasoft-001" id_empresa="1" id_usuario="60"/>
Exemplo de retorno
<agenda_compromissos versao="1.00"> <compromisso> <id>761</id> <tipo>0</tipo> <data_inicio>2016-07-15T00:00:00-03:00</data_inicio> <data_fim>2016-07-15T00:00:00-03:00</data_fim> <opcoes>6</opcoes> <assunto>Implantação de cliente</assunto> <mensagem>Mensagem da agenda de teste</mensagem> <local>Locas de testes vinhasoft</local> <status>0</status> <id_usuario>1</id_usuario> </compromisso> </agenda_compromissos>