sgrAtualizarDocumentoAE
Atualiza os campos dos documentos vinculados à Autorização de Embarque.
PARÂMETROS
Campo | Tipo | Requerido? | Descrição |
---|---|---|---|
chaveacesso | string | Sim | Chave retornada pelo método sgrLogin. |
cdpas | inteiro | Sim | Código do PAS, retornado pelo método sgrListaPASUsuario |
cdclienteopentech | inteiro | Sim | Código do cliente, retornado pelo método sgrListaEmpresasPASUsuario. |
cdviagem | inteiro | Sim | Número da autorização de embarque a qual o documento foi vinculado. |
tpdoc | inteiro | Sim | Código do tipo do documento. Este código é retornado pelo sgrListaTipoDocumento. |
nrdoc | string | Sim | Número do documento a ser alterado. |
cdcampo | inteiro | Sim | Define o campo do documento a ser atualizado. Informar o valor: 1-Campo nrcontrolecliente1 do sgrDocumentoAE 2-Campo nrcontrolecliente2 do sgrDocumentoAE 3-Campo nrcontrolecliente3 do sgrDocumentoAE 4-Campo nrcontrolecliente4 do sgrDocumentoAE 5-Campo nrcontrolecliente5 do sgrDocumentoAE 6-Campo nrcontrolecliente6 do sgrDocumentoAE 7-Início do carregamento/descarregamento 8-Fim do carregamento/descarregamento 9-Chegada no local de entrega/coleta 10-Data de previsão de saída 12- Data Prevista 13-Define se é permitida a troca de nota fiscal (documento substituto) 14-Número do Documento substituto 15-Editar o número do documento 16-Disponivel para novas implementações 17-Alterar docscliente.nrcontrole7 18-Alterar docscliente.nrcontrole8 19-Alterar docscliente.nrcontrole9 20-Alterar docscliente.nrcontrole10 |
conteudo | string | Sim | Valor a ser inserido no campo especificado. Para os códigos de campo 1 a 6, o campo permite uma string de até 20 caracteres. Ao utilizar os códigos de campo 7, 8 e 9, o valor deste campo deve obrigatoriamente ser uma data válida no padrão "AAAA-MM-DD HH:MM". Se for 13, informar 1 se permite substituir documento, ou 0 se não permite). E se no cdcampo for informado 14, o parâmetro conteudo recebe o número do documento substituto. |
nrProgramacao | string | Não | Número da programação a qual o documento foi vinculado, para possibilitar a alteração da data de início e fim de carregamento. |
EXEMPLO:
@nrDoc = 1234
@cdCampo = 13
@conteudo = 1
Resultado: A Flag que permite troca do documento ‘1234’ será alterada para marcado;
@nrDoc = 4321
@cdCampo = 14
@conteudo = 9876
Resultado: O documento 4321 terá a informação que foi substituído pelo documento 9876;
@nrDoc = 1234
@cdCampo = 15
@conteudo = ABCD
Resultado: O número do documento ‘1234’ será alterada para ‘ABCD’;
RETORNO DO MÉTODO:
ReturnDataset: Se os parâmetros estiverem corretos, o campo desejado é alterado e a propriedade irá apresentar
Campo | Tipo | Descrição |
---|---|---|
CDALTERACAO | inteiro | Código da solicitação de alteração |
ReturnDescription: Se houver erro na execução do método, a propriedade irá apresentar:
Erro | Descrição |
---|---|
O código do campo (cdcampo) informado não é válido | Necessário informar valor entre 1 e 10 (para verificar cada valor, volte à descrição dos parâmetros desse método). |
É obrigatório informar o número da autorização de embarque. | |
Autorização de embarque/Documento não encontrado | O número da autorização de embarque não foi localizado. Devem-se verificar as informações e tentar novamente. |
Não foi possível gravar o histórico da alteração. Tente novamente. | Este erro pode ser causado por um parâmetro incorreto, o campo a ser corrigido será indicado na propriedade returnDataset. Com isso, é preciso verificar os parâmetros e executar o método novamente. Pode indicar também a ocorrência de timeout ou queda de conexão com o banco de dados. Necessário repassar os dados informados, bem como o nome do método, o horário de emissão e código do cliente para o e-mail: [email protected] para que o erro possa ser validado. |
Não foi possível efetuar a alteração. Tente novamente. | |
Data informada no campo conteudo não é válida. | A data deve ser preenchida no padrão "AAAA-MM-DD HH:MM". |
Autorização de embarque não possui monitoração ativa. | Como a viagem não é de rastreamento e nem de logística, não é possível realizar a alteração dos dados |