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

newProtocolPrintedCopy

Este método possibilita a criação de um novo protocolo de cópia impressa:

Classe Java
Requisiçãoweb/wwwroot/ws/java/document/NewProtocolPrintedCopyRequestType.java
Retornoweb/wwwroot/ws/java/document/NewProtocolPrintedCopyResponseType.java

Requisição:

IdentificadorRequeridoDescrição
ProtocolIDXIdentificador do protocolo.
CopytypeXTipo de cópia:
1 - controlada;
2 - não controlada.
DateData de emissão (caso não seja informada, será considerada a data atual). O formato da data deve ser "Y-M-D" (Ano-Mês-Dia).
ReasonIDIdentificador do motivo da distribuição.
ResponsibleXMatrícula do usuário emissor.
CopyStationIDIdentificador do posto de cópia.
CopystationrespMatrícula do usuário responsável do posto.
CompanyEmpresa.
CompanyrespResponsável da empresa.
ObservationObservação
StatusXSituação do protocolo:
1 - Aguardando confirmação de recebimento;
2 - Recebimento confirmado.
ReceivingrespMatrícula do usuário responsável pelo recebimento (caso não seja informada, e STATUS seja 2, será considerado o RESPONSIBLE).
ReceivingdateData de recebimento (caso não seja informada, e STATUS seja 2, será considerada a data atual). O formato da data deve ser "Y-M-D" (Ano-Mês-Dia).
DocumentsListXLista de documentos:
• Identificador do documento;
• Identificador da revisão (cópia controlada: deve ficar em branco; cópia não controlada: se não preencher será considerada a revisão atual);
• Identificador da categoria do documento (necessário quando existir mais de um documento com o mesmo identificador em categorias diferentes);
• Quantidade de cópias.
DestTypeXTipo do destinatário:
1 - Posto de cópia;
2 - Unidade organizacional;
3 - Usuário.
CtrlTeamXIdentificador da equipe de controle padrão.
CopyStationIdIdentificador do posto de cópia.
DepartmentIdIdentificador da unidade organizacional.
UserIdMatrícula do usuário.
info
  • X¹ - Requerido quando DestType for igual a 1;
  • X² - Requerido quando DestType for igual a 2;
  • X³ - Requerido quando DestType for igual a 3.

Estrutura da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
<soapenv:Header/>
<soapenv:Body>
<urn:newProtocolPrintedCopy>
<!--You may enter the following 18 items in any order-->
<urn:ProtocolID>?</urn:ProtocolID>
<urn:Copytype>?</urn:Copytype>
<urn:Date>?</urn:Date>
<urn:ReasonID>?</urn:ReasonID>
<urn:Responsible>?</urn:Responsible>
<urn:CopyStationID>?</urn:CopyStationID>
<urn:Copystationresp>?</urn:Copystationresp>
<urn:Company>?</urn:Company>
<urn:Companyresp>?</urn:Companyresp>
<urn:Observation>?</urn:Observation>
<urn:Status>?</urn:Status>
<urn:Receivingresp>?</urn:Receivingresp>
<urn:Receivingdate>?</urn:Receivingdate>
<urn:DocumentsList>
<!--Zero or more repetitions:-->
<urn:Documents>
<!--You may enter the following 4 items in any order-->
<urn:DocumentID>?</urn:DocumentID>
<urn:RevisionID>?</urn:RevisionID>
<urn:CategoryID>?</urn:CategoryID>
<urn:QtdCopy>?</urn:QtdCopy>
</urn:Documents>
</urn:DocumentsList>
<urn:DestType>?</urn:DestType>
<urn:CtrlTeam>?</urn:CtrlTeam>
<urn:DepartmentId>?</urn:DepartmentId>
<urn:UserId>?</urn:UserId>
</urn:newProtocolPrintedCopy>
</soapenv:Body>
</soapenv:Envelope>

Retorno:

IdentificadorDescrição
StatusSUCESSO: SUCCESS
FALHA: FAILURE
CodeCódigo apresentado:
• 1 - Nenhum erro (registro criado com sucesso);
• -1 - Campo requerido (nome do campo);
• -2 - Precisão do campo (nome do campo);
• -3 - Tipo de cópia inválido;
• -4 - Motivo inválido;
• -5 - Data inválida;
• -6 - Situação do protocolo inválido;
• -7 - Identificador do posto de cópias não encontrado;
• -8 - Não existe esse responsável pelo posto de cópias;
• -9 - Usuário inválido;
• -10 - Não foi possível encontrar a revisão (código da revisão informado);
• -11 - Não foi possível encontrar o documento (código do documento informado);
• -12 - Existe mais de um documento com esse identificador. Necessário especificar a categoria;
• -13 - Categoria inexistente;
• -14 - A categoria informada está inativa;
• -15 - Campo QtdCopy deve conter um valor numérico inteiro;
• -16 - A revisão do documento não deve ser informada para cópia controlada;
• -17 - Este documento não pode ser associado a um posto de cópias;
• -18 - Este usuário não possui permissão para esta operação.
DetailMensagem detalhando o erro ou sucesso na execução do método.