Pular para o conteúdo principal
Versão: 2.2.2

newKeyWordRequest

Este método possibilita inserir e editar:

  • Dados de uma solicitação;

Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.

Requisição:

IdentificadorRequeridoDescrição
IDREQUESTXIdentificador da solicitação
NMREQUESTXNome da solicitação
IDREQUESTTYPEXIdentificador do tipo de solicitação. O Tipo de objeto do tipo de solicitação deverá ser Documento e a Operação deverá estar em branco ou com a opção Palavra-chave selecionada.
IDUSEREMITXMatrícula do usuário emissor da solicitação
DSREQUESTXDescrição da solicitação
DSREASONXJustificativa da solicitação. Caso o tipo da solicitação necessite que seja preenchida uma justificativa, o parâmetro DSREASON se torna requerido
DTREQUESTENDDATEXData de conclusão da solicitação. O formato da data deve ser "Y-M-D" (Ano-Mês-Dia).
ATTRIBUTESXAtributos da solicitação.
Exemplo: IDENTIFICADOR_DO_ATRIBUTO1=VALOR_DO_ATRIBUTO1; IDENTIFICADOR_DO_ATRIBUTO2=VALOR_DO_ATRIBUTO2; IDENTIFICADOR_DO_ATRIBUTO3=VALOR_DO_ATRIBUTO3.

Exemplo com atributo multivalorado. Observe que o separador para os valores dos atributos multivalorados é uma "," (vírgula): IDENTIFICADOR_DO_ATRIBUTO1=VALOR1_DO_ATRIBUTO1, VALOR2_DO_ATRIBUTO1, VALOR3_DO_ATRIBUTO1.

Obs.: Para atributos com valor numérico, o separador de casas decimais deve ser o "." (ponto). Para campos de data, o valor deve ter o formato "Y-M-D" (Ano-Mês-Dia).
IDAPPROVALROUTEXIdentificador do roteiro de aprovação. Requerido para solicitações que possuem aprovação.

Estrutura da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:srequest">
<soapenv:Header/>
<soapenv:Body>
<urn:newKeyWordRequest>
<!--You may enter the following 9 items in any order-->
<urn:idrequest>?</urn:idrequest>
<urn:nmrequest>?</urn:nmrequest>
<urn:idrequesttype>?</urn:idrequesttype>
<urn:iduseremit>?</urn:iduseremit>
<urn:dsrequest>?</urn:dsrequest>
<urn:dsreason>?</urn:dsreason>
<urn:dtrequestenddate>?</urn:dtrequestenddate>
<urn:attributes>?</urn:attributes>
<urn:idapprovalroute>?</urn:idapprovalroute>
</urn:newKeyWordRequest>
</soapenv:Body>
</soapenv:Envelope>

Retorno:

IdentificadorDescrição
returnSUCESSO: Retorna uma mensagem de "Operação realizada com sucesso"
FALHA: Retorna uma mensagem com o erro ocorrido.