newAction
Este método possibilita o cadastro de ações associadas em um plano de ação. Para utilizá-lo, é necessário seguir o padrão abaixo documentado:
Classe Java | |
---|---|
Requisição | web/wwwroot/ws/java/timecontrol/NewActionRequestType.java |
Retorno | web/wwwroot/ws/java/timecontrol/NewActionResponseType.java |
Requisição:
Identificador | Requerido | Descrição |
---|---|---|
ActionPlanID | X | Identificador do plano de ação que a ação pertence. |
ActionID | Identificador da ação. | |
ActionTitle | X | Título da ação (O que?). |
CatID | X¹ | Identificador da categoria da ação. |
FgTypeAction | X | Tipo de execução da ação. 1 - Imediata; 2 - Planejada. Obs: Só estará habilitada a configuração Imediata caso esteja configurado na categoria do plano de ação. |
TeamID | Identificador da equipe da ação. | |
RespID | X | Matrícula do responsável pela execução (Quem?). |
DtPlanStart | X | Data de início planejado (Quando?), no formato YYYY-MM-DD. |
TmPlanStart | Hora de início planejado (Quando?), no formato HH:MM. Se não for preenchida, o sistema considerará a hora atual. | |
DtPlanEnd | X | Data de término planejado (Quando?), no formato YYYY-MM-DD. |
TmPlanEnd | Hora de término planejado (Quando?), no formato HH:MM. Se não for preenchida, o sistema considerará a hora atual. | |
VlPlanCost | Custo planejado (Quanto?), no formato 10000.00, onde o "." é o separador decimal. Não se usa separador de milhar. | |
DsWhy | Por quê? | |
DsWhere | Onde? | |
DsHow | Como? | |
DsResult | X² | Resultado. |
info
- ¹ - Será requerido apenas se na categoria do plano de ação estiver configurada uma lista de categorias permitidas.
- ² - Será requerido apenas ao incluir uma ação imediata e se na categoria do plano estiver configurada obrigatoriedade para o resultado.
Estrutura de requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:timecontrol">
<soapenv:Header/>
<soapenv:Body>
<urn:newAction>
<!--You may enter the following 16 items in any order-->
<urn:ActionplanID>?</urn:ActionplanID>
<urn:ActionID>?</urn:ActionID>
<urn:ActionTitle>?</urn:ActionTitle>
<urn:CatID>?</urn:CatID>
<urn:FgTypeAction>?</urn:FgTypeAction>
<urn:TeamID>?</urn:TeamID>
<urn:RespID>?</urn:RespID>
<urn:DtPlanStart>?</urn:DtPlanStart>
<urn:TmPlanStart>?</urn:TmPlanStart>
<urn:DtPlanEnd>?</urn:DtPlanEnd>
<urn:TmPlanEnd>?</urn:TmPlanEnd>
<urn:VlPlanCost>?</urn:VlPlanCost>
<urn:DsWhy>?</urn:DsWhy>
<urn:DsWhere>?</urn:DsWhere>
<urn:DsHow>?</urn:DsHow>
<urn:DsResult>?</urn:DsResult>
</urn:newAction>
</soapenv:Body>
</soapenv:Envelope>
Retorno:
Identificador | Descrição |
---|---|
RecordID | SUCESSO: Identificador da ação cadastrada. |
Status | Retorna o status da execução. SUCCESS em caso de sucesso e FAILURE em caso de falha. |
Code | Retorna o código de execução: ▪ 1 - Método executado com sucesso; ▪ -1 - Erro na configuração dos parâmetros de entrada; ▪ -2 - Identificador do plano ou ação se encontra duplicado na base de dados; ▪ -3 - O usuário de autenticação não possui a permissão necessária para executar este método. Verifique se o usuário possui acesso ao menu PL025. ▪ -12 - O identificador informado já existe. Por favor, altere-o; ▪ -13 - Plano de ação não encontrado; ▪ -14 - Usuário inexistente; ▪ -15 - Usuário inativo; ▪ -16 - Equipe inexistente; ▪ -17 - Equipe inativa; ▪ -18 - Categoria não encontrada; ▪ -19 - Categoria inativa; ▪ -20 - Data término anterior à data início; ▪ -21 - Plano já finalizado; ▪ -22 - Usuário não tem permissão na categoria informada; ▪ -23 - Usuário não tem permissão no plano informado; ▪ -24 - A configuração da categoria não permite incluir ação imediata; ▪ -25 - A categoria informada não está na lista restrita de categorias; ▪ -26 - Não é permitido o cadastro de datas retroativas; ▪ -27 - Erro desconhecido ao processar a requisição; ▪ -29 - Plano de ação teve o valor máximo do campo Quanto? ultrapassado; ▪ -30 - Plano de ação já foi finalizado; ▪ -32 - Plano de ação não pode ser alterado por causa da sua situação; |
Detail | SUCCESSO: Método executado com sucesso FALHA: Descrição do erro ocorrido. |
Estrutura de retorno:
<newActionResponse>
<RecordID>?</RecordID>
<Status>?</Status>
<Code>?</Code>
<Detail>?</Detail>
</newActionResponse>