WebServices Apoio Cotaes

(verso 1.2)

Objetivo
O propsito deste documento documentar a interface de servios
referente a integrao de sistemas

Referncia e padro de desenvolvimento

Os servios seguem o padro internacional W3C
(http://www.w3.org/standards/webofservices/)

WSDL e XSD
O WSDL e XSD, onde consta a descrio dos servios est
disponvel nos links:
Ambiente de homologao:
- http://homologacao.tecnologia.ws/webServices?wsdl
- http://homologacao.tecnologia.ws/webServices?
xsd=1
- http://homologacao.tecnologia.ws/webServices?
xsd=2

Ambiente de produo:
- https://seguro.apoiocotacoes.com.br/webServices?
wsdl
- https://seguro.apoiocotacoes.com.br/webServices?
xsd=1
- https://seguro.apoiocotacoes.com.br/webServices?
xsd=2

Autenticao:
Todos os servios exigem autenticao para que seja possvel usar
os servios.
Os parmetros com informaes de usurio e senha esto no
cabealho de cada servio.

No caso de falha na autenticao o retorno ser uma falha do tipo

NegocioExcepition com o cdigo (idErro) = 1 e a descrio no campo
<msgErro>

Servios:
1. ObterTodasCategorias
Descrio:
Retorna todas as categorias de produtos

Parmetros de entrada:
- No se aplica;

Retorno:
- Array contendo o id e a descrio de cada categoria;

2. CriarCotacao
Descrio:
Cria cotao com base nas informaes enviadas.
A cotao s pode ser criada se os cdigos de produtos existirem
na base de dados da Apoio Cotaes.
As cotaes so associadas a uma categoria de produto especfica.
Caso a lista de produtos enviadas existam produtos de categorias
diferentes ser aberto uma cotao para cada categoria.

Parmetros de entrada:
- titulo: Ttulo da cotao. string. Obrigatrio
- descricao: Descrio da cotao. string.
- dataVencimento: Data de vencimento da cotao. string no formato
dd/MM/yyyy HH:mm (Ex: 20/08/2012 13:50). Obrigatrio
- observacao: Observao da cotao. string.
- condicoes: Condies da cotao. string.
- ProdutoCotacaoWSVO: Array de produtos contendo o cdigo do produto
e a quantidade que deseja cotar. Obrigatrio
- necessitaRevisao: Indica se o usurio entrar no site para revisar antes
da cotao ser enviada ao mercado. boolean. Default = false (a cotao
automaticamente enviada ao mercado.

Retorno:
- Array com o nmero das cotaes geradas.

Excees:
Podero ser lanadas diversas excees durante a chamada do
servio

As falhas so do tipo NegocioExcepition, sendo o id do erro obtido

atravs do campo idErro e a descrio no campo msgErro
idErro = 2, O ttulo da cotao obrigatrio
idErro = 3, A data de vencimento deve ser maior que o horrio
atual
idErro = 4, A data de vencimento da cotao obrigatrio
idErro = 5, necessrio pelo menos um produto para criar uma
cotao
idErro = 6, Produtos sem informao de quantidade ou com
quantidade zerada
idErro = 7, Produtos que no existem no cadastro da Apoio
Cotaes

3. ConsultarCotacao
Descrio:
Obtm informaes de uma determinada cotao.

Parmetros de entrada:
- idCotacao: Cdigo da cotao. Obrigatrio

Retorno:
- Informaes gerais da cotao:
- idCotacao: Cdigo da cotao;
- titulo: Ttulo da cotao;
- categoria: Categoria de produtos;
-- id: Id da categoria;
-- desc: Descrio da categoria;
- condicoes: Condies impostas pelo comprador do hospital;
- desc: Descrio da cotao;
- dtCriacao: Data na qual a cotao foi criada (String com a
mscara no formato: dd/MM/yyyy HH:mm:ss);
- dtVencimento: Data de vencimento da cotao (String com a
mscara no formato: dd/MM/yyyy HH:mm:ss);
- obs: Observao colocada pelo comprador do hospital;
- status: Indica o status da cotao
-- id: ID do status;

-- desc: Descrio do status

- fornecedoresParticipantes: Lista dos fornecedores que
responderam a cotao:
-- cnpj: CNPJ do fornecedor no formatado;
-- contato: Nome da pessoa de contato;
-- email: E-Mail de contato;
-- fax: Fax;
-- inscricaoEstadual: Inscrio estadual da empresa
fornecedora;
-- nomeFantasia: Nome fantasia da empresa;
-- obs: Observaes da empresa;
-- razaoSocial: Razo Social da empresa;
-- site: Site da empresa
-- telefone: Telefone de contato da empresa;
-- condPagto: Condio de pagamento imposta pelo
fornecedor para essa cotao;
-- dtValidadeProposta: Validade de proposta imposta pelo
fornecedor para essa cotao (String com a mscara no formato:
dd/MM/yyyy HH:mm:ss);
-- faturamentoMinimo: Faturamento mnimo imposto pelo
fornecedor para essa cotao
-- frete: Frete imposto pelo fornecedor para essa cotao;
-- informacaoComprador: Informaes diversas descritas pelo
fornecedor;
-- prazoEntrega: Prazo de entrega estipulado pelo fornecedor
(em dias);
-- resgatado: Informa se o fornecedor aceitou o pedido de
compra (true/false);
- produtos: Lista de produtos da cotao
-- codigo: Cdigo do produto cotado;

-- confirmado: Indica se foi solicitado compra com algum

fornecedor;
-- quantidade: Quantidade de produtos solicitados para a
compra;
-- respostas: Lista de respostas dos fornecedores;
--- embalagem: Embalagem do produto;
--- fabricante: Fabricante do produto;
--- obs: Observaes diversas sobre o produto;
--- precoUnitario: Preo unitrio do produto cotado;
--- qtd: Quantidade cotada;
--- fornecedor: Fornecedor responsvel pela resposta;
---- cnpj: CNPJ do fornecedor responsvel pela
resposta
---- email: E-Mail de contato;
---- fax: Fax;
----- inscricaoEstadual: Inscrio estadual da
empresa fornecedora;
---- nomeFantasia: Nome fantasia da empresa;
---- obs: Observaes da empresa;
---- razaoSocial: Razo Social da empresa;
---- site: Site da empresa
---- telefone: Telefone de contato da empresa;
--- ganhou: Informa se o fornecedor responsvel pela
resposta foi o ganhador da cotao. O produto em questo ser
comprado do mesmo (true/false)

Excees:
Podero ser lanadas diversas excees durante a chamada do
servio

As falhas so do tipo NegocioExcepition, sendo o id do erro obtido

atravs do campo idErro e a descrio no campo msgErro
idErro = 2, Cotao no encontrada
idErro = 3, No permitido usurio logado visualizar cotao de
outro usurio