sgrCriarAEv4

Gera a Autorização de Embarque (nacional).

PARÂMETROS:

Campo	Tipo	Req.?	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.
nrplacacavalo	string	Sim	Placa do cavalo.
nrplacacarreta1	string	Não	Placa da primeira carreta. Enviar ‘’ (branco) quando não houver.
nrplacacarreta2	string	Não	Placa da segunda carreta. Enviar ‘’ (branco) quando não houver.
nrdocmotorista1	string	Sim	Número do documento do primeiro motorista.
nrdocmotorista2	string	Não	Número do documento do segundo motorista. Enviar ‘’ (branco) quando não existir a informação.
dtprevini	string	Sim	Data e Hora prevista para início da viagem. Enviar a data no formato “AAAA-MM-DD HH:MM”.
dtprevfim	string	Sim	Data e Hora prevista para fim da viagem. Enviar a data no formato “AAAA-MM-DD HH:MM”.
cdcidibgeorigem	inteiro	Sim	Código IBGE da cidade de origem. Este código é retornado pelo método sgrListaCidades.
cdcidibgedestino	inteiro	Sim	Código IBGE da cidade de destino. Este código é retornado pelo método sgrListaCidades.
cdrotaopentech	inteiro	Sim	Código da rota na Opentech, retornado através do método sgrListaRotas.
cdrotacliente	string	Não	Código da rota no cliente. Este código deve ser preenchido quando o campo cdrotaopentech não for informado. Enviar ‘’ (branco) quando não existir a informação. O uso deste campo implica no cadastramento dos códigos de rota do cliente na Opentech (A relação deve ser 1 código de rota do cliente para 1 código de rota Opentech).
nrcnpjcpftransportador	string	Não	CNPJ/CPF do transportador. Este campo deve ser preenchido caso não seja utilizado o campo cdtransportadorcliente. Enviar ‘’ (branco) quando não for utilizado.
cdtransportadorcliente	string	Não	Código do transportador no cliente. Este campo deve ser preenchido caso não seja utilizado o campo nrcnpjcpftransportador.
nrfonecelular	string	Sim	Número do telefone celular do motorista da viagem.
cdtipooperacao	inteiro	Sim	Código do tipo de operação, retornado pelo método sgrListaTiposOperacao.
nrcnpjcpfembarcador	string	Não	CNPJ/CPF do embarcador. Este campo deve ser preenchido caso não seja utilizado o campo cdembarcadorcliente. Enviar ‘’ (branco) quando não for utilizado.
cdembarcadorcliente	string	Não	Código do embarcador no cliente. Este campo deve ser preenchido caso não seja utilizado o campo nrcnpjcpfembarcador.
nrcontrolecarga	string	Não	Campo de livre utilização do cliente. Enviar ‘’ (branco) quando não existir.
nrfrota	string	Não	Número Frota do veículo. Enviar ‘’ (branco) quando não existir.
distanciatotal	decimal	Não	Distância total da viagem. Enviar 0 (zero) quando não existir.
pesocarga	decimal	Não	Peso da carga. Enviar 0 (zero) quando não existir a informação.
dscontroleviag(1 ao 10)	string	Não	Controles de viagem. Enviar “” (branco) quando não existir.
produtos	array	Sim	Lista de produtos da Autorização de Embarque. Para utilizar este parâmetro deve-se criar um array do tipo sgrProduto. Este array será o resumo da carga transportada. Não é permitido repetir um código de produto nesta lista.
documentos	array	Sim	Lista de documentos da Autorização de Embarque. Para utilizar este parâmetro deve-se criar um array do tipo sgrDocumentoAE.
paradas	array	Não	Lista de Pontos de Apoio, retornado pelo método sgrListaPontosRota. Para utilizar este parâmetro deve-se criar um array do tipo sgrPontoApoioViagem. Para determinados clientes, este campo pode ser exigido o preenchimento. Quando não forem informadas as paradas, enviar um array vazio.
sensorestemperatura	array	Não	Lista de Sensores de Temperatura. Para utilizar este parâmetro deve-se criar um array do tipo sgrSensorTemperatura. Quando não forem informados os parâmetros de temperatura, enviar um array vazio.
nrdddfonecelular	string	Sim	DDD do telefone do motorista
dsnomerespviag	string	Não	Nome do Responsável pela viagem. Enviar ‘’ (branco) quando não existir.
dsfone1respviag	string	Não*	Telefone do responsável pela viagem. * Será obrigatório somente se não houver telefones registrados na tela de [Contato cliente] para o tipo de contato Operacional.
dsfone2respviag	string	Não	Telefone adicional do responsável pela viagem.
iscas	list	Não*	Lista de iscas. Para utilizar este parâmetro deve-se criar um array do tipo sgrIsca. Quando não forem informados os parâmetros de isca, deve-se enviar um array vazio. * Será obrigatório somente se estiver marcada a exigência de isca na configuração da regra de GR do cliente.

Observação: Para facilitar a compreensão dos métodos secundários, que devem ser chamados para retornarem os códigos exigidos nos parâmetros listados acima, será apresentada a seguir uma analogia entre os métodos secundários e a tela de cadastro no Clipas NET. Ressaltando que, por se tratar de sistemas diferentes, o Web Service e o Clipas NET não precisam necessariamente conter os mesmos campos.

Figura 1: Tela de cadastro de AE no Clipas NET, aba Autorização de embarque. Em azul, foram escritos os nomes dos parâmetros. Em vermelho estão os métodos secundários.

Figura 2: Tela de cadastro de AE no Clipas NET, aba Documentos.

Figura 1: Tela de cadastro de AE no Clipas NET, aba Sensores de Temperatura.

RETORNO DO MÉTODO:

ReturnDataset: Se os parâmetros forem válidos, a Autorização de Embarque é criada o dataset irá apresentar:

Campo	Tipo	Descrição
CDVIAG	inteiro	Número da AE criada na execução do método

ReturnDescription: Se houver erro na execução do método, a propriedade irá apresentar:

Erro	Descrição
Data de Previsão de Início/Fim inválida	O formato da data informada de previsão de início e/ou fim é inválido. Necessário preencher no formato "AAAA-MM-DDhh:mm".
Não foi possível gerar a Autorização de Embarque.	Os erros que impossibilitaram o cadastro são listados no dataset, e podem ser vistos no Quadro 1.
Autorização de Embarque já criada!	Já existe uma autorização de embarque com os dados informados.

Já o método a seguir é mais completo, e pode ser utilizado em viagens pelo Mercosul. (sgrGerarAEv9)