Especificações do Web Service CMNet
Transcrição
Especificações do Web Service CMNet
Especificações do Web Service CMNet Versão: 3.3 Data: 20 de março de 2012 Especificações do Web Service CMNet – versão 3.3 Índice 1. Introdução ................................................................................................................................ 5 1.1. Objetivo ...............................................................................................................................6 1.2. Conexão ..............................................................................................................................6 1.3. Atualizações ........................................................................................................................6 1.4. Suporte ..............................................................................................................................13 2. Serviços ................................................................................................................................. 13 2.1. Consulta de hotéis (xmlConsultaHoteis) ............................................................................13 2.1.1. Descrição ...............................................................................................................13 2.1.2. Requisição (OTA_HotelSearchRQ.xml) .................................................................14 2.1.3. Exemplo de xml de requisição ...............................................................................15 2.1.4. Resposta (OTA_HotelSearchRS.xml) ....................................................................15 2.1.5. Exemplo de xml de resposta ..................................................................................17 2.1.6. Erros ......................................................................................................................17 2.2. Consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia) .....................18 2.2.1. Descrição ...............................................................................................................18 2.2.2. Requisição (OTA_HotelAvailRQ.xml) .....................................................................18 2.2.3. Exemplo de xml de requisição ...............................................................................20 2.2.4. Resposta (OTA_HotelAvailRS.xml) ........................................................................21 2.2.5. Exemplo de xml de resposta ..................................................................................25 2.2.6. Erros ......................................................................................................................29 2.3. Revisão da reserva (xmlRevisaoDispHotel) .......................................................................30 2.3.1. Descrição ...............................................................................................................30 2.3.2. Requisição (OTA_HotelAvailRQ.xml) .....................................................................30 2.3.3. Exemplo de xml de requisição ...............................................................................32 2.3.4. Resposta (OTA_HotelAvailRS.xml) ........................................................................32 2.3.5. Exemplo de xml de resposta ..................................................................................38 2.3.6. Erros ......................................................................................................................41 2.4. Inclusão ou alteração de reservas (xmlIncluiAlteraReserva) ..............................................42 2.4.1. Descrição ...............................................................................................................42 2.4.2. Requisição (OTA_HotelResRQ.xml) ......................................................................42 2.4.3. Exemplo de xml de requisição ...............................................................................45 2.4.4. Resposta (OTA_HotelResRS.xml) .........................................................................46 2.4.5. Exemplo de xml de resposta ..................................................................................53 2.4.6. Erros ......................................................................................................................57 2.5. Consulta de reservas (xmlConsultaReservasHoteis) .........................................................58 2.5.1. Descrição ...............................................................................................................58 2.5.2. Requisição (OTA_ReadRQ.xml) ............................................................................58 2.5.3. Exemplo de xml de requisição ...............................................................................60 2.5.4. Resposta (OTA_HotelResRS.xml) .........................................................................61 2.5.5. Exemplo de xml de resposta ..................................................................................68 2.5.6. Erros ......................................................................................................................71 2.6. Cancelamento de reservas (xmlCancelaReservaHotel) .....................................................72 2.6.1. Descrição ...............................................................................................................72 2.6.2. Requisição (OTA_CancelRQ.xml)..........................................................................72 2.6.3. Exemplo de xml de requisição ...............................................................................73 2 Especificações do Web Service CMNet – versão 3.3 2.6.4 Resposta (OTA_CancelRS.xml)..............................................................................73 2.6.5. Exemplo de xml de resposta ..................................................................................74 2.6.6. Erros ......................................................................................................................74 2.7. Cartões aceitos pelo hotel (xmlCartoesAceitosHotel).........................................................75 2.7.1. Descrição ...............................................................................................................75 2.7.2. Requisição (OTA_HotelDescriptiveInfoRQ.xml) .....................................................75 2.7.3. Exemplo de xml de requisição ...............................................................................76 2.7.4. Resposta (OTA_HotelDescriptiveInfoRS.xml) ........................................................76 2.7.5. Exemplo de xml de resposta ..................................................................................78 2.7.6. Erros ......................................................................................................................78 2.8. Consulta do cadastro de uma agência ou empresa (xmlCadastroAgEmp) .........................79 2.8.1. Descrição ...............................................................................................................79 2.8.2. Requisição (OTA_ReadRQ.xml) ............................................................................79 2.8.3. Exemplo de xml de requisição ...............................................................................80 2.8.4. Resposta (OTA_ProfileReadRS.xml) .....................................................................80 2.8.5. Exemplo de xml de resposta ..................................................................................81 2.8.6. Erros ......................................................................................................................82 2.9. Consulta de pontos de interesse (xmlConsultaRefPoints) ..................................................82 2.9.1. Descrição ...............................................................................................................82 2.9.2. Requisição (CMNET_RefPointRQ.xml) ..................................................................83 2.9.3. Exemplo de xml de requisição ...............................................................................83 2.9.4. Resposta (CMNET_RefPointRS.xml) .....................................................................84 2.9.5. Exemplo de xml de resposta ..................................................................................85 2.9.6. Erros ......................................................................................................................86 2.10. Consulta de informações de hotéis (xmlRetornaInfoHotel)...............................................86 2.10.1. Descrição .............................................................................................................86 2.10.2. Requisição (CMNET_HotelInfoRQ.xml) ...............................................................86 2.10.3. Exemplo de xml de requisição .............................................................................88 2.10.4. Resposta (CMNET_HotelInfoRS.xml) ..................................................................88 2.10.5. Exemplo de xml de resposta ................................................................................98 2.10.6. Erros ..................................................................................................................102 2.11. Consulta de redes e marcas (xmlConsultaRedesMarcas) ..............................................102 2.11.1. Descrição ...........................................................................................................102 2.11.2. Requisição (CMNET_RedesRQ.xml) .................................................................103 2.11.3. Exemplo de xml de requisição ...........................................................................103 2.11.4. Resposta (CMNET_RedesRS.xml) ....................................................................103 2.11.5. Exemplo de xml de resposta ..............................................................................105 2.11.6. Erros ..................................................................................................................105 2.12. Autenticação de funcionários (xmlAutenticaFuncionario) ...............................................106 2.12.1. Descrição ...........................................................................................................106 2.12.2. Requisição (CMNET_AutenticaFuncionarioRQ.xml) .......................................... 106 2.12.3. Exemplo de xml de requisição ...........................................................................107 2.12.4. Resposta (CMNET_AutenticaFuncionarioRS.xml) ............................................. 107 2.12.5. Exemplo de xml de resposta ..............................................................................108 2.12.6. Erros .................................................................................................................. 108 2.13. Consultar as políticas de um produto (xmlConsultaPoliticasProduto) ............................. 109 2.13.1. Descrição ...........................................................................................................109 2.13.2. Requisição (CMNET_HotelPoliciesRQ.xml) .......................................................109 3 Especificações do Web Service CMNet – versão 3.3 2.13.3. Exemplo de xml de requisição ...........................................................................110 2.13.4. Resposta (CMNET_HotelPoliciesRS.xml) ..........................................................110 2.13.5. Exemplo de xml de resposta ..............................................................................113 2.13.6. Erros ..................................................................................................................113 4 Especificações do Web Service CMNet – versão 3.3 1. Introdução Web services são identificados por uma URI (Unique Resource Identifier), e são descritos e definidos usando o formato XML. Um dos motivos que tornam os web services tão atrativos é o fato deste modelo ser baseado em tecnologias standard, em particular XML e HTTP. Web services são utilizados para disponibilizar serviços interativos na web que podem ser acessados por outras aplicações. O protocolo SOAP (Simple Object Access Protocol) está se tornando um padrão para a troca de mensagens entre aplicações e web services, já que é uma tecnologia construída com base em XML e HTTP. SOAP é um protocolo projetado para invocar aplicações remotas através de RPC (Remote Procedure Calls - Chamadas Remotas de Procedimento) ou trocas de mensagens, em um ambiente independente de plataforma e linguagem de programação. SOAP é, portanto, um padrão normalmente aceito para utilizar-se com web services. Desta forma pretende-se garantir a interoperabilidade e intercomunicação entre diferentes sistemas, através da utilização de uma linguagem (XML) e mecanismo de transporte (HTTP) padrões. O web service CMNet trabalha com as seguintes características: 1. Camada de transporte – Através de HTTPS 2. Camada de mensagem – Envelope SOAP 3. Camada de negócio – O formato XML das mensagens obedece os padrões OTA (especificação 2004B) e CMNet Abaixo temos um exemplo de uma chamada SOAP de requisição e resposta para o serviço de consulta de hotéis. Observe que no elemento Header existe um elemento (PayloadInfo) que está presente no web service para autenticar o parceiro na base de dados do CMNet. Requisição: POST OTA_Reservas.asmx HTTP/1.1 Host: localhost Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.cmnet/xmlwebservices2/xmlConsultaHoteis" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <PayloadInfo Username="string" Password="string" IDParceiro="int" xmlns="http://www.cmnet/xmlwebservices2/" /> </soap:Header> <soap:Body> <xmlConsultaHoteis xmlns="http://www.cmnet/xmlwebservices2/"> <Xml>xml</Xml> </xmlConsultaHoteis> </soap:Body> </soap:Envelope> Resposta: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> 5 Especificações do Web Service CMNet – versão 3.3 <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <xmlConsultaHoteisResponse xmlns="http://www.cmnet/xmlwebservices2/"> <xmlConsultaHoteisResult>xml</xmlConsultaHoteisResult> </xmlConsultaHoteisResponse> </soap:Body> </soap:Envelope> Ao acessar o web service CMNet o parceiro obrigatoriamente deverá enviar seus dados de autenticação (entregues pela CMNet Soluções), caso contrário a solicitação será rejeitada com o retorno de um exception: - IDParceiro Username Password 1.1. Objetivo O objetivo deste documento é descrever os serviços providos pelo web service CMNet. 1.2. Conexão O web service está disponível na url: https://webservices3.cmnet.com.br:440/v3/ota/reservas/OTA_Reservas.asmx?WSDL. A versão mais atualizada desta documentação, exemplos de arquivos xml e outras informações podem ser acessados em https://webservices3.cmnet.com.br:440/v3/ota/reservas/exemplos/. Nesse site também é possível efetuar testes de requisição e resposta em cada um dos serviços existentes. Para conectar-se ao web service em ambiente de teste, é necessário configurar o elemento root do arquivo xml em cada requisição enviada, modificando a propriedade Target para “Test”, como no exemplo: <OTA_RQPackage Version="1.003" EchoToken="1234" TimeStamp="2004-01-01T08:00:00" Target="Test" PrimaryLangID="pt-BR" xmlns="http://www.opentravel.org/OTA/2003/05"> Para conectar-se ao web service em ambiente de produção, é necessário configurar o elemento root do arquivo xml em cada requisição enviada, modificando a propriedade Target para “Production”, como no exemplo: <OTA_RQPackage Version="1.003" EchoToken="1234" TimeStamp="2004-01-01T08:00:00" Target="Production" PrimaryLangID="pt-BR" xmlns="http://www.opentravel.org/OTA/2003/05"> 1.3. Atualizações ** ATENÇÃO ** Abaixo descrevemos as alterações, exclusões e inclusões de novos atributos, novas funcionalidades e conceitos. Leiam com muita atenção, para que possam fazer estas implementações e alterações no seus sistemas, de forma consistente. • 14/06/2007 – Versão 3.0 6 Especificações do Web Service CMNet – versão 3.3 o A consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia) pode ser filtrada pelo número de uma reserva, nesse caso sendo obrigatório o envio do atributo HotelCode: - o A consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia) pode ser filtrada pela posição (latitude e longitude) de um ponto de interesse, retornado pela chamada do método xmlConsultaRefPoints: - o Inclusão de um novo elemento TPA_Extensions na resposta do método A consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia) retorna uma descrição mais detalhada da acomodação: - o Inclusão de um novo elemento na requisição do método: Position Inclusão de um novo elemento na resposta do método: RelativePosition A consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia) retorna o código IATA dos hotéis: - o Inclusão de um novo elemento na requisição do método: HotelReservationIDs Adição do atributo Code ao elemento AdditionalDetail na resposta do método Inclusão de um novo elemento AdditionalDetail na resposta do método Implementação do cupom de desconto no método de revisão da reserva (xmlRevisaoDispHotel): - Adição do atributo PromotionCode ao elemento RoomStayCandidate na requisição do método Inclusão de um novo elemento na resposta do método: Discount Adição do atributo PromotionCode ao elemento RoomStay na resposta do método Obs.: Por modificar o valor final da reserva, o cupom de desconto deve ser enviado no método de inclusão e alteração (xmlIncluiAlteraReserva) para que o mesmo seja aplicado. o Implementação do valor médio da tarifa na revisão da reserva (xmlRevisaoDispHotel): - o A revisão de reserva (xmlRevisaoDispHotel) pode ser filtrada pelo número de uma reserva: - o Inclusão de um novo elemento Rate na resposta do método Inclusão de um novo elemento na requisição do método: HotelReservationIDs Novo formato para o retorno de políticas e restrições da acomodação na revisão de reserva (xmlRevisaoDispHotel): Adição do atributo Code ao elemento AdditionalDetail na resposta do método Inclusão de novos elementos AdditionalDetail na resposta do método É IMPORTANTE RESSALTAR QUE ESTAS POLÍTICAS E RESTRIÇÕES DEVEM SER INFORMADAS AO USUÁRIO ATRAVÉS DE SEU SISTEMA. o O nome do método que inclui e altera uma reserva foi modificado nessa versão de xmlIncluiAlteraHotel para xmlIncluiAlteraReserva. o Implementação do valor médio da tarifa na inclusão/alteração de reserva (xmlIncluiAlteraReserva): - Inclusão de um novo elemento Rate na resposta do método 7 Especificações do Web Service CMNet – versão 3.3 o Implementação do cupom de desconto no método de inclusão/alteração de reserva (xmlIncluiAlteraReserva): - Adição do atributo PromotionCode ao elemento RoomStay na requisição do método Adição do atributo PromotionCode ao elemento RoomStay na resposta do método Inclusão de um novo elemento na resposta do método: Discount Obs.: Por modificar o valor final da reserva, o cupom de desconto deve ser enviado no método de inclusão e alteração (xmlIncluiAlteraReserva) para que o mesmo seja aplicado. o Novo formato para o retorno de políticas e restrições da acomodação na inclusão/alteração de reserva (xmlIncluiAlteraReserva): - Inclusão de um novo elemento na resposta do método: AdditionalDetails É IMPORTANTE RESSALTAR QUE ESTAS POLÍTICAS E RESTRIÇÕES DEVEM SER INFORMADAS AO USUÁRIO ATRAVÉS DE SEU SISTEMA. o Implementação do cupom de desconto no método de consulta de reserva (xmlConsultaReservasHoteis): - o Adição do atributo PromotionCode ao elemento RoomStay na resposta do método Inclusão de um novo elemento na resposta do método: Discount Novo formato para o retorno de políticas e restrições da acomodação na consulta de reserva (xmlConsultaReservasHoteis): - Inclusão de um novo elemento na resposta do método: AdditionalDetails É IMPORTANTE RESSALTAR QUE ESTAS POLÍTICAS E RESTRIÇÕES DEVEM SER INFORMADAS AO USUÁRIO ATRAVÉS DE SEU SISTEMA. o Implementação do valor médio da tarifa na consulta de reserva (xmlConsultaReservasHoteis): - o Inclusão de um novo elemento Rate na resposta do método Criação de um novo método para consulta de pontos de interesse (xmlConsultaRefPoints) IMPORTANTE: ALGUMAS DESTAS NOVAS POLÍTICAS E RESTRIÇÕES POSSUEM PENALIDADES (COBRANÇAS DE TAXAS EXTRAS, MULTAS, ETC) PORTANTO ESTAS DEVEM SER INFORMADAS AO USUÁRIO ATRAVÉS DE SEU SISTEMA. POIS AO RECEBERMOS ESTES PEDIDOS DE RESERVAS (ALTERAÇÕES OU CANCELAMENTOS) ESTAREMOS ASSUMINDO A CONCORDÂNCIA POR PARTE DO USUÁRIO DESTAS PENALIDADES. • 26/09/2007 – Versão 3.0.1 o A consulta de hotéis (xmlConsultaHoteis) retorna o código da cadeia hoteleira, caso o hotel pertença a uma: - Adição do atributo ChainCode ao elemento Property na resposta do método o Implementação da data máxima de cancelamento da reserva na resposta dos métodos de revisão da reserva (xmlRevisaoDispHotel), inclusão/alteração de reserva (xmlIncluiAlteraReserva) e consulta de reserva (xmlConsultaReservasHoteis), utilizando o formato de data "yyyy-MM-ddTHH:mm:ss": 8 Especificações do Web Service CMNet – versão 3.3 - • 23/10/2007 – Versão 3.0.2 o Implementação do tipo de pensão na resposta dos métodos de revisão da reserva (xmlRevisaoDispHotel), consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia), inclusão/alteração de reserva (xmlIncluiAlteraReserva) e consulta de reserva (xmlConsultaReservasHoteis). Esta informação será retornada através do elemento AdditionalDetail com os atributos Type=”14” e Code=”PNS”. Segue abaixo a lista dos códigos e descrições aceitos hoje pelo CMNet: - • 4: “Com café incluído na diária” 10: “Pensão completa incluída na diária” 12: “Meia pensão incluída na diária” 14: “Sem café incluído na diária” 29/10/2007 – Versão 3.0.3 o • Inclusão do elemento CancelPenalties na resposta do método Criação de um novo método para consulta de redes e marcas de hotéis (xmlConsultaRedesMarcas) 05/05/2008 – Versão 3.0.4 o Cartão Virtual - Implementação do pagamento através de cartão virtual na requisição do método de inclusão/alteração de reserva (xmlIncluiAlteraReserva): Para efetuar o pagamento de uma reserva com um cartão virtual, é necessário utilizar a forma de pagamento do tipo “cartão de crédito” e preencher o(s) campo(s) de faturamento para empresa. Além destes campos, já existentes nas versões anteriores, é necessário também o preenchimento dos novos campos, abaixo descriminados. Esses campos adicionais devem ser enviados no elemento VirtualCard: CentroCusto Matricula Departamento RequisicaoViagem AutorizacaoViagem ControleAgencia Desconto TextoLivre - o Implementação da consulta pelo serviço de cartão virtual da operadora VISA: - o Implementação da informação de pagamento com cartão virtual na resposta dos métodos de inclusão/alteração de reserva (xmlIncluiAlteraReserva) e consulta de reserva (xmlConsultaReservasHoteis). Essa informação será retornada através do elemento VirtualCard. Para saber se o hotel possui o serviço, o parceiro deverá verificar o atributo VirtualCardVISA do elemento CMNET, na resposta do método de consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia). Implementação de um novo filtro na requisição do método de consulta de reserva (xmlConsultaReservasHoteis) para trazer somente reservas de uma cadeia hoteleira específica: - Adição do atributo ChainCode ao elemento HotelReadRequest na requisição do método 9 Especificações do Web Service CMNet – versão 3.3 o Implementação de um novo filtro na requisição dos métodos de consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia) e revisão da reserva (xmlRevisaoDispHotel), para trazer somente produtos de um país específico: - • Adição do atributo ISOCountry ao elemento Source na requisição do método 27/06/2008 – Versão 3.0.5 o Esta implementação tem como finalidade disponibilizar o serviço de reservas para o mercado B2B, ou seja, permitir que uma agência / empresa, possa se logar no site do parceiro e fazer todos os procedimentos de reservas. Esta nova funcionalidade foi implementada através de um serviço de autenticação dos funcionários de uma agência cadastrada no sistema CMNet. Desta forma poderemos buscar as tarifas acordo específicas da agência / empresa em questão, bem como registrar o funcionário que efetuou a reserva (incluisão, alteração e cancelamento). O parceiro envia a solicitação, e caso seja válida o sistema retorna a identificação do funcionário e da agência para ser utilizado nas requisições futuras quando necessário. - Criação de um novo método para autenticação de funcionários (xmlAutenticaFuncionario). Este método tem como intuito, autenticar a agência e o funcionário que está operando o sistema. Se a autenticação ocorrer com sucesso será retornado a identificação da agência e do funcionário para serem utilizadas nas futuras requisições (inclusão de reserva, alteração de reserva, consulta de reserva). - Para gerar uma reserva com a identificação do funcionário da agência é necessário o envio do elemento ProfileInfo tendo o atributo ProfileType com o valor “15” (OTA Code List Profile Type - PRT). O Id do funcionário é informado no atributo EmployeeId, segue abaixo um exemplo do elemento que deverá ser enviado na requisição da reserva: <ProfileInfo> <Profile ProfileType="15"> <Customer> <EmployeeInfo EmployeeId="3"/> </Customer> </Profile> </ProfileInfo> - No voucher das reservas efetuadas com a identificação do funcionário, será retornado os dados do mesmo, como no exemplo abaixo: <ProfileInfo> <Profile ProfileType="15"> <Customer> <PersonName> <GivenName>João</GivenName> <Surname>da silva</Surname> </PersonName> <Email EmailType="2">[email protected]</Email> <EmployeeInfo EmployeeId="3"/> </Customer> </Profile> </ProfileInfo> - Implementação de um novo filtro na requisição do método de consulta de reserva (xmlConsultaReservasHoteis) para trazer somente reservas efetuadas por um determinado funcionário: i. Adição do atributoID ao elemento UserID na requisição do método, segue abaixo um exemplo: <UserID Type="15" ID="3"/> 10 Especificações do Web Service CMNet – versão 3.3 o Implementação das coordenadas geodésica do hotel (latitude e longitude) no retorno do método de consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia) e no retorno da consulta de informações de hotéis (xmlRetornaInfoHotel). o Implementação da informação da qualidade de quarto na consulta de disponibilidade dos hotéis: - • • 28/07/2008 – Versão 3.0.6 o Implementação do cupom de desconto no método de consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia): Adição do atributo PromotionCode ao elemento RoomStayCandidate na requisição do método Inclusão de um novo elemento na resposta do método: Discount o Criação de um novo método para consulta das políticas de um produto (xmlConsultaPoliticasProduto) - Este método retorna as informações das políticas de cancelamento, No Show e das políticas de modificação de um produto de forma parametrizada. 9/11/2009 – Versão 3.0.7 o Inclusão de mais três opções de tipo de pensão na resposta dos métodos de revisão da reserva (xmlRevisaoDispHotel), consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia), inclusão/alteração de reserva (xmlIncluiAlteraReserva) e consulta de reserva (xmlConsultaReservasHoteis). Esta informação será retornada através do elemento AdditionalDetail com os atributos Type=”14” e Code=”PNS”: - • Adição do atributo Code ao elemento RoomQuality na retorno da consulta, segue abaixo a descrição e os códigos aceitos pelo CMNet: - EXE: “Executivo” - LUX: “Luxo” - MOD: “Moderado” - REA: “Real” - STD: “Standard” - SLX: “Super Luxo” - SUP: “Superior” 1: “Tudo incluído na diária” 19: “Meia pensão (almoço) incluída na diária” 20: “Meia pensão (jantar) incluída na diária” 19/01/2010 – Versão 3.0.8 o Transferência Eletrônica de Fundos: - Identificação da forma de pagamento aceita pela acomodação na resposta dos métodos de consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia) e revisão da reserva (xmlRevisaoDispHotel): - - Inclusão do atributo PaymentCode no elemento RequiredPayment: - 4: “PrePay” (TEF) - 31: “Guarantee” Descrição das políticas de pagamento via TEF na resposta dos métodos de revisão da reserva (xmlRevisaoDispHotel), inclusão/alteração de reserva (xmlIncluiAlteraReserva) e consulta de reservas (xmlConsultaReservasHoteis): - Elemento AdditionalDetail com os atributos Type=”5” e Code=”TTEF”. 11 Especificações do Web Service CMNet – versão 3.3 - Descrição do tipo de garantia da reserva na resposta dos métodos de inclusão/alteração de reserva (xmlIncluiAlteraReserva) e consulta de reservas (xmlConsultaReservasHoteis): - • 21/09/2010 – Versão 3.0.9 o • Inclusão do atributo GuaranteeType no elemento Guarantee: - “PrePay” (TEF) - “CC/DC/Voucher” Implementação do envio de mensagens SMS (Short Message Service – Serviço de Mensagens Curtas) para o celular do hóspede, notificando o mesmo sobre as reservas incluídas, modificadas e canceladas. Mesmo que o parceiro não envie na requisição o atributo com o celular do hóspede, o sistema CMNet Reservas verificará se o hotel possui integração SMS e buscará pelo celular do hóspede cadastrado em sua base de dados para que o SMS seja enviado. - Para saber se o hotel possui integração SMS, o parceiro deverá verificar o atributo EnvioSMS do elemento CMNET na resposta do método de consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia). - Na requisição do método de inclusão/alteração de reserva (xmlIncluiAlteraReserva) o parceiro deverá enviar o número do celular do hóspede no atributo Telephone do elemento WrittenConfInst. O número do celular deve obedecer o seguinte formato: (DDI+DDD+Celular), exemplo: “552188776655”. Segue abaixo um exemplo do elemento XML: <WrittenConfInst Telephone="552188776655"/> - Na requisição do método de cancelamento da reserva (xmlCancelaReservaHotel), o parceiro deverá enviar o número do celular do hóspede no atributo Telephone do elemento WrittenConfInst. O número do celular deve obedecer o seguinte formato: (DDI+DDD+Celular), exemplo: “552188776655”. Segue abaixo um exemplo do elemento XML: <TPA_Extensions> <WrittenConfInst Telephone="552188776655"/> </TPA_Extensions> 11/05/2011 – Versão 3.1 o Implementação do parcelamento do valor da reserva quando do pagamento por Transferência Eletrônica de Fundos (TEF). - Caso o produto possa ser pago com parcelamento via TEF, a resposta do método de revisão da reserva (xmlRevisaoDispHotel) agora retornará também o elemento TEFInstallmentPayment, por exemplo: <TPA_Extensions> <TEFInstallmentPayment> <Cards> <Card Code="VI"> <InstallmentPaymentOptions> <InstallmentPaymentOption PaymentsInstallments="1" Amount="120,00" InterestRate="0" /> <InstallmentPaymentOption PaymentsInstallments="2" Amount="60,72" InterestRate="1,2" /> <InstallmentPaymentOption PaymentsInstallments="3" Amount="40,52" InterestRate="1,3" /> <InstallmentPaymentOption PaymentsInstallments="4" Amount="30,42" InterestRate="1,4" /> </InstallmentPaymentOptions> </Card> 12 Especificações do Web Service CMNet – versão 3.3 <Cards> </TEFInstallmentPayment> </TPA_Extensions> O código acima informa que o produto deverá ser pago com cartão de crédido VISA (“VI”) e seu valor poderá ser parcelado em até 4 vezes. - • 20/07/2011 – Versão 3.2 o • Para efetuar o pagamento parcelado via TEF é necessário incluir na requisição do método de inclusão/alteração da reserva (xmlIncluiAlteraReserva) o elemento Comments com a quantidade de parcelas desejadas, respeitando a quantidade de parcelas aceitas pelo hotel (informação disponível na resposta do método de revisão da reserva). <Guarantee> <Comments> <Comment CommentOriginatorCode="PARCELAS"> <Text>1</Text> </Comment> </Comments> </Guarantee> Implementação do valor total da reserva na resposta do método de consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia), já com os valores de taxas incluídos: <Rate> <Base AmountBeforeTax="60" CurrencyCode="BRL"/> <PaymentPolicies> <RequiredPayment PaymentCode="31"> <AcceptedPayments> <AcceptedPayment> <PaymentCard CardCode="VI" CardType="1"/> </AcceptedPayment> </AcceptedPayments> </RequiredPayment> </PaymentPolicies> <Total AmountAfterTax="78.33"/> </Rate> 20/03/2012 – Versão 3.3 o Modificação da sigla que identifica o cartão Diners Club: de "DN" para "DC". 1.4. Suporte Em caso de dúvidas em relação a esta documentação ou ao funcionamento do web service, encaminhe sua mensagem para [email protected]. 2. Serviços 2.1. Consulta de hotéis (xmlConsultaHoteis) 2.1.1. Descrição 13 Especificações do Web Service CMNet – versão 3.3 O objetivo deste método é disponibilizar uma lista com todos os hotéis disponíveis, de acordo com os critérios informados pelo cliente. A disponibilidade de acomodações dos hotéis não é avaliada neste método. 2.1.2. Requisição (OTA_HotelSearchRQ.xml) Nível Elemento 0 OTA_HotelSearchRQ Atributo Obrigatório Descrição X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do cliente solicitante. EchoToken Target PrimaryLangID 1 POS X 2 Source X 3 RequestorID X Type ID X Identificação do tipo de cliente na OTA Code List (UIT). Opções: “4” – Parceiro ou empresa “5” – Agência de viagens X Identificação do cliente no CMNet. Se o parceiro quiser trabalhar com agências ou empresas associadas ao CMNet, é necessário colocar aqui o id da agência ou empresa, caso contrário, o id do próprio parceiro. URL Url do cliente. 1 Criteria X Critérios da consulta. 2 Criterion X Só é aceito um elemento deste tipo. ImportanceType 3 O nível de importância dos critérios de busca. O valor utilizado será sempre “Mandatory”. Informações necessárias para a consulta. Pelo menos um dos atributos é obrigatório. HotelRef HotelCityCode Filtra a consulta pelo código ISO da cidade. Para buscar por todos os hotéis existentes em determinada cidade basta informar o código da cidade e omitir os atributos HotelCode e ChainCode. Exemplo: “RIO” HotelCode Filtra a consulta pela identificação do hotel no CMNet. Para buscar por um hotel específico basta informar o código do hotel e omitir os atributos HotelCityCode e ChainCode. Exemplo: “37456” 14 Especificações do Web Service CMNet – versão 3.3 ChainCode Filtra a consulta pela identificação da cadeia de hotéis no CMNet. Para buscar por todos os hotéis de uma determinada cadeia basta informar o código da cadeia e omitir os atributos HotelCode e HotelCityCode. Exemplo: “114” 2.1.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <OTA_HotelSearchRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 http://www.opentravel.org/2004B/OTA_HotelSearchRQ.xsd" Version="1.0" EchoToken="1234" TimeStamp="2004-01-01T08:00:00" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="4" ID="59982" URL="http://www.site_do_parceiro.com.br"/> </Source> </POS> <Criteria> <Criterion ImportanceType="Mandatory"> <HotelRef HotelCityCode="RIO"/> </Criterion> </Criteria> </OTA_HotelSearchRQ> 2.1.4. Resposta (OTA_HotelSearchRS.xml) Nível Elemento 0 OTA_HotelSearchRS 1 POS 2 Source 3 RequestorID Atributo Descrição Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do web service CMNet. Type Tipo de provedor do serviço na OTA Code List. O valor retornado será sempre “22” – ERSP (Electronic reservation service provider) 15 Especificações do Web Service CMNet – versão 3.3 3 ID Identificação do provedor do serviço. O valor retornado será sempre “CMNET”. URL Url do provedor do serviço. O valor retornado será sempre “http://www.cmnet.com.br” BookingChannel Informações sobre o canal de distribuição. Type 4 CompanyName Tipo do canal de distribuição na OTA Code List (BCT). O valor retornado será sempre “7” – Internet Identificação da empresa que disponibiliza o serviço. CompanyShortName O valor retornado será sempre “CMNET”. TravelSector Identificação do setor de atuação da empresa na OTA Code List (TVS). O valor retornado será sempre “3” – Hotel 1 Success Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. 1 Properties Informações dos hotéis. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors). 2 Property 3 3 HotelName Nome Fantasia do hotel. Exemplo: “Hotel de Teste TUCM” HotelCode Identificação do hotel no CMNet. Exemplo: “37456” ChainCode Identificação da cadeia de hotéis no CMNet. Caso o hotel não pertença a uma cadeia este atributo não será retornado. Exemplo: “114” Position Informações geográficas do hotel. Altitude Exemplo: “2” Latitude Exemplo: “-82838” Longitude Exemplo: “156168” Address Endereço do hotel. Type Identificação do tipo de endereço na OTA Code List (CLT). O valor retornado será sempre “1” – Home 4 AddressLine Endereço. Exemplo: “Campos Sales” 4 AddressLine Bairro, caso se aplique. Exemplo: “Tijuca” 4 CityName Nome da cidade. Exemplo: “Rio de Janeiro” 4 PostalCode CEP. Exemplo: “20270210” 4 StateProv Informação do estado. StateCode 4 Informação do país. Exemplo: “Brasil” CountryName Code 3 ContactNumbers 4 ContactNumber Código do estado. Exemplo: “RJ” Código ISO do país. Exemplo: “BR” Números para contato. PhoneUseType Identificação do tipo de uso na OTA Code List (PUT). O valor retornado será sempre “5” – Contact PhoneTechType Identificação do tipo de tecnologia na OTA Code List (PTT). Opções: “1” – Voice “3” – Fax PhoneNumber Número para contato. Exemplo: “2345678” 16 Especificações do Web Service CMNet – versão 3.3 1 Warnings 2 Warning 1 Errors 2 Error Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 2.1.5. Exemplo de xml de resposta <?xml version="1.0" encoding="UTF-8"?> <OTA_HotelSearchRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 http://www.opentravel.org/2004B/OTA_HotelSearchRS.xsd" Version="1.0" EchoToken="1234" TimeStamp="2004-01-01T08:00:00" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="22" ID="CMNET" URL="http://www.cmnet.com.br"/> <BookingChannel Type="7"> <CompanyName CompanyShortName="CMNET" TravelSector="3"/> </BookingChannel> </Source> </POS> <Success/> <Properties> <Property HotelName="Hotel de Teste TUCM" HotelCode="37456" ChainCode=”114”> <Position Altitude="2" Latitude="-82838" Longitude="156168"></Position> <Address Type="1"> <AddressLine>Campos Sales</AddressLine> <AddressLine>TIJUCA</AddressLine> <CityName>Rio de Janeiro</CityName> <PostalCode>20510-270</PostalCode> <StateProv StateCode="RJ"></StateProv> <CountryName Code="BR">Brasil</CountryName> </Address> <ContactNumbers> <ContactNumber PhoneNumber="12345678" AreaCityCode="21" CountryAccessCode="55" PhoneTechType="1"/> <ContactNumber PhoneNumber="12345678" AreaCityCode="21" CountryAccessCode="55" PhoneTechType="3"/> </ContactNumbers> </Property> </Properties> </OTA_HotelSearchRS> 2.1.6. Erros 17 Especificações do Web Service CMNet – versão 3.3 Código Descrição 173 Código de agência requerido 175 Senha inválida 321 Faltando campo requerido 405 Retorna Erro de parceiro não reconhecido 424 Indisponibilidade de hotéis condizentes com esta entrada de dados 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 914 Conexão Inválida 915 Time Out limite da chave de conexão 2.2. Consulta de disponibilidade dos hotéis (xmlConsultaDispHotelValorDiaDia) 2.2.1. Descrição O objetivo deste método é disponibilizar uma lista com acomodações disponíveis e suas respectivas tarifas, de acordo com os critérios informados pelo cliente. 2.2.2. Requisição (OTA_HotelAvailRQ.xml) Nível 0 Elemento Atributo OTA_HotelAvailRQ Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal X Identificação do cliente solicitante. PrimaryLangID POS Descrição X Target 1 Obrigatório 18 Especificações do Web Service CMNet – versão 3.3 2 Source X Código ISO do país (ISO 3166 - de dois dígitos), utilizado para filtrar os produtos retornados por um país específico. Exemplo: “BR” ISOCountry 3 RequestorID X Type ID X Identificação do tipo de cliente na OTA Code List (UIT). Opções: “4” – Parceiro ou empresa “5” – Agência de viagens X Identificação do cliente no CMNet. Se o parceiro quiser trabalhar com agências ou empresas associadas ao CMNet, é necessário colocar aqui o id da agência ou empresa, caso contrário, o id do próprio parceiro. URL Url do cliente. 1 AvailRequestSegments X 2 AvailRequestSegment X Determina se a requisição é para uma acomodação ou outro tipo de produto. O valor utilizado será sempre “Room”. AvailReqType 3 3 Informações necessárias para a consulta de disponibilidade. X Período de disponibilidade solicitado. O período máximo permitido pelo web service CMNet é de 60 dias. Start X Data de chegada. Exemplo: “2004-10-01” End X Data de partida. Exemplo: “2004-10-02” StayDateRange RateRange Informações referentes ao valor da tarifa. Código ISO da moeda. Exemplo: “BRL“ CurrencyCode 3 RoomStayCandidates X 4 RoomStayCandidate X Informações sobre as acomodações consultadas. Quantity Quantidade de unidades desejadas com essa configuração. Atenção: o valor da tarifa retornada sempre vai referir-se a somente 1 (uma) unidade, independente da quantidade informada neste atributo. PromotionCode Informação do cupom de desconto. Exemplo: “WS_01” 5 GuestCounts X 6 GuestCount X Informações sobre o(s) hóspede(s). AgeQualifyingCode X Identificação do tipo de hóspede na OTA Code List (AQC). Opções: “10” – Adulto “8” – Criança Atenção: O web service CMNet aceita consultas de acomodações para até 6 (seis) crianças. Para efetuar este tipo de consulta devem ser incluídos na requisição um máximo de 6 (seis) elementos GuestCount com o atributo Count igual a “1” e o atributo AgeQualifyingCode igual a “8”, além da idade de cada criança no atributo Age. Exemplo: <GuestCount AgeQualifyingCode="8" Age="1" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="2" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="3" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="4" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="5" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="6" Count="1"/> Age X Idade do hóspede. Válido somente para crianças. Exemplo: “8” 19 Especificações do Web Service CMNet – versão 3.3 Count X Quantidade de adultos ou crianças. Exemplo: “1” 3 HotelSearchCriteria X Critério para a consulta. 4 Criterion X Só é aceito um elemento deste tipo. 5 Position 5 Informações geográficas do hotel. Latitude Exemplo: “-82838” Longitude Exemplo: “156168” HotelRef 1 HotelReservationIDs 2 HotelReservationID X Informações necessárias para a consulta. É obrigatório informar pelo menos um dos dois atributos: HotelCityCode ou HotelCode. HotelCityCode Filtra a consulta pelo código ISO da cidade. Para buscar por todos os hotéis existentes em determinada cidade basta informar o código da cidade e omitir os atributos HotelCode, ChainCode e HotelName. Exemplo: “RIO” HotelCode Filtra a consulta pela identificação do hotel no CMNet. Para buscar por um hotel específico basta informar o código do hotel e omitir os atributos HotelCityCode, ChainCode e HotelName. Exemplo: “37456” ChainCode Filtra a consulta pela identificação da cadeia hoteleira no CMNet. Exemplo: “114” HotelName Filtra a consulta pelo Nome Fantasia do hotel (ou parte dele). Exemplo: “Hotel Modelo” Identificação da reserva. Este elemento só deve ser incluído para a consulta de uma reserva já efetuada. Nesse caso também é obrigatório informar o código do hotel, por meio do atributo HotelCode do elemento HotelRef. ResID_Type Identificação do tipo de objeto definido pelo elemento HotelReservationID na OTA Code List (UIT). O valor utilizado será sempre “14” – Reservation ResID_Value Número da reserva. Exemplo: “7268618” 2.2.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailRQ Version="1.003" EchoToken="1234" TimeStamp="2006-03-21T08:00:00" Target="Test" PrimaryLangID="pt-BR" xmlns="http://www.opentravel.org/OTA/2003/05"> <POS> <Source> <RequestorID Type="4" ID="60227" URL="http://www.site_do_parceiro.com.br"/> </Source> </POS> <AvailRequestSegments> <AvailRequestSegment AvailReqType="Room"> <StayDateRange Start="2007-08-01" End="2007-08-02"/> <RateRange/> <RoomStayCandidates> <RoomStayCandidate> <GuestCounts> <GuestCount AgeQualifyingCode="10" Count="1"/> </GuestCounts> </RoomStayCandidate> </RoomStayCandidates> <HotelSearchCriteria> <Criterion> <Position Latitude="-82838" Longitude="156168"/> 20 Especificações do Web Service CMNet – versão 3.3 <HotelRef HotelCode="2125"/> </Criterion> </HotelSearchCriteria> </AvailRequestSegment> </AvailRequestSegments> <HotelReservationIDs> <HotelReservationID ResID_Type="14" ResID_Value="12345678"/> </HotelReservationIDs> </OTA_HotelAvailRQ> 2.2.4. Resposta (OTA_HotelAvailRS.xml) Nível 0 Elemento OTA_HotelAvailRS 1 POS 2 Source 3 RequestorID 3 Atributo Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do web service CMNet. Type Tipo de provedor do serviço na OTA Code List. O valor retornado será sempre “22” – ERSP (Electronic reservation service provider) ID Identificação do provedor do serviço. O valor retornado será sempre “CMNET”. URL Url do provedor do serviço. O valor retornado será sempre “http://www.cmnet.com.br” BookingChannel Informações sobre o canal de distribuição. Type 4 Descrição CompanyName Tipo do canal de distribuição na OTA Code List (BCT). O valor retornado será sempre “7” – Internet Identificação da empresa que disponibiliza o serviço. CompanyShortName O valor retornado será sempre “CMNET”. TravelSector Identificação do setor de atuação da empresa na OTA Code List (TVS). O valor retornado será sempre “3” – Hotel 1 Success Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. 1 RoomStays Informação das acomodações retornadas. 2 RoomStay 3 RoomTypes 21 Especificações do Web Service CMNet – versão 3.3 4 RoomType NumberOfUnits Número de unidades retornadas. O valor retornado será sempre “1”. RoomTypeCode Código da acomodação. Exemplo: “N01ST” 5 RoomDescription 6 Text Descrição da acomodação. Exemplo: “SUITE EXECUTIVA” 5 AdditionalDetails Informações adicionais sobre a acomodação. 6 AdditionalDetail Descrição da acomodação. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “4” – Room Information Code Identificação da informação. O valor retornado será sempre “TRMD”. 7 DetailDescription Detalhes da informação. 8 Text Exemplo: “Quarto de luxo com cama de casal ou duas camas de solteiro, tv a cabo, minibar, mesa de trabalho, ar condicionado, vista lateral para o mar.” 6 AdditionalDetail Informações referentes à comissão. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “13” – Commission Information Code Identificação da informação. O valor retornado será sempre “TCMM”. Amount Valor percentual da comissão. Exemplo: “10” 5 TPA_Extensions Informações adicionais não descritas no padrão OTA, mas que são necessárias ao web service CMNet. 6 Occupants Descreve o máximo de ocupantes aceitos na acomodação. 6 MaxOccupants Quantidade máxima de ocupantes aceitos. MaxAdults Quantidade máxima de adultos aceitos. O retorno desta informação depende do preenchimento dela por parte do hotel escolhido. MaxChildren Quantidade máxima de crianças aceitas. O retorno desta informação depende do preenchimento dela por parte do hotel escolhido. RoomQuality Informação referente a qualidade do quarto. Code 3 RoomRates 4 RoomRate Informações dos valores das acomodações. RoomTypeCode 5 Rates 6 Rate 7 Base 7 PaymentPolicies 8 RequiredPayment Código da qualidade do quarto. Opções: “EXE” – Executivo “LUX” – Luxo “MOD” – Moderado “REA” – Real “STD” – Standard “SLX” - Super Luxo “SUP” - Superior Código da acomodação. Exemplo: “N01ST” Valor médio da tarifa. AmountBeforeTax Valor médio das tarifas (sem as taxas). Exemplo: “270” CurrencyCode Código ISO da moeda. Exemplo: “BRL” Políticas de pagamento da reserva. 22 Especificações do Web Service CMNet – versão 3.3 PaymentCode 9 AcceptedPayments 10 AcceptedPayment 11 PaymentCard 10 AcceptedPayment 11 Voucher Define o tipo de pagamento a ser efetuado: “4” – PrePay “31” – Guarantee Formas de pagamento aceitas pelo hotel para esta acomodação. A reserva pode ser paga com cartão de crédito. Caso seja aceito mais de um tipo de cartão de crédito, um novo elemento AcceptedPayment deverá ser criado para cada tipo. CardCode Código do cartão de crédito (padrão OTA). Opções: “AX” – American Express “BC” – Bank Card “BL” – Carte Bleu “CB” – Carte Blanche “DC” – Diners Club “DS” – Discover Card “EC” – Eurocard “JC” – JCB Credit Card “MC” – Master Card “TP” – Universal Air Travel Card “VI” – Visa CardType Identificação do tipo de cartão na OTA Code List (CDT). O valor retornado será sempre “1” – Credit A reserva pode ser paga via faturamento para a empresa. SeriesCode Códigos dos tipos de faturamento para a empresa. Opções: “NA” – Alimentação e bebidas não alcoólicas “DI” – Diária “LV” – Lavanderia “TL” – Telefonemas “TT” – Todas as despesas (se estiver marcado, só ele pode ser selecionado) “TU” – Taxa de turismo “CF” – Café da manhã “TY” – Tudo sem bebidas alcoólicas (se estiver marcado, só ele pode ser selecionado) Exemplo: “AN-DI-LV-TL-TU” 10 AcceptedPayment 11 DirectBill A reserva pode ser paga diretamente no hotel. Discount Informações sobre o desconto no valor da reserva referente ao cupom de desconto enviado na requisição do método. Este elemento só será retornado nos produtos em que o cupom de desconto se aplica. 7 8 DiscountReason 9 Text 7 Total 6 AmountBeforeTax Valor do desconto. Exemplo: “-100” CurrencyCode Código ISO da moeda. Exemplo: “BRL” DiscountCode Cupom de desconto para a reserva. Exemplo: “WS_01” AmountAfterTax Valor total da reserva, já com os valores de taxas incluídos. Exemplo: "78.33" Valor da tarifa agrupado por período de datas. Caso o valor varie dentro do período escolhido, um novo elemento Rate será criado para cada novo valor. Rate EffectiveDate Data inicial do valor da tarifa. Exemplo: “2006-03-25” 23 Especificações do Web Service CMNet – versão 3.3 7 ExpireDate Data final do valor da tarifa. Exemplo: “2006-03-28” AmountBeforeTax Valor da tarifa (sem as taxas). CurrencyCode Código ISO da moeda. Exemplo: “BRL” Base 5 RoomRateDescription 6 Text Descrição da acomodação. Exemplo: “TRF BALCAO” 3 BasicPropertyInfo Informações básicas sobre o hotel. 4 HotelCode Identificação do hotel no CMNet. Exemplo: “37456” HotelName Nome Fantasia do hotel. Exemplo: “Hotel Modelo” ChainCode Identificação da cadeia de hotéis no CMNet. Caso o hotel não pertença a uma cadeia este atributo não será retornado. Exemplo: “114” Position Coodenadas geodésica do hotel. Latitude Latitude do hotel. Exemplo: “-82507,28” Longitude Longitude do hotel. Exemplo: “-155582,26” 4 Address Endereço do hotel. 5 AddressLine Endereço. Exemplo: “Campos Sales” 5 AddressLine Bairro, caso se aplique. Exemplo: “Tijuca” 5 CityName Nome da cidade. Exemplo: “Rio de Janeiro” 5 PostalCode CEP. Exemplo: “20270210” 5 StateProv Informação do estado. StateCode Código do estado. Exemplo: “RJ” 5 CountryName Informação do país. Exemplo: “Brasil” 4 RelativePosition Informações geográficas do hotel. 3 TPA_Extensions 4 CMNET Distance Distância do hotel até um ponto de interesse (definido pelo elemento Position no xml de requisição). Exemplo: “5463,77” DistanceUnitName Unidade de distância. O valor retornado será sempre “km”. Informações adicionais não descritas no padrão OTA, mas que são necessárias ao web service CMNet. IATACode Código IATA do hotel. Exemplo: “57165893” VirtualCardVISA Informa se o hotel possui o serviço de cartão virtual da operadora VISA. Opções: “True” – Possui o serviço “False” – Não possui o serviço EnvioSMS Indica se o hotel em questão possui integração para o envio de mensagens SMS. Opções: “True” – Possui integração “False” – Não possui integração 24 Especificações do Web Service CMNet – versão 3.3 1 Warnings 2 Warning 1 Errors 2 Error Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing RecordID Código do hotel. Todo alerta que contiver esse atributo será referente à informação da disponibilidade de produtos do mesmo. Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 2.2.5. Exemplo de xml de resposta <?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.003" EchoToken="1234" TimeStamp="2007-06-11T13:08:32" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="22" ID="CMNET" URL="http://www.cmnet.com.br"/> <BookingChannel Type="7"> <CompanyName CompanyShortName="CMNET" TravelSector="3"/> </BookingChannel> </Source> </POS> <Success/> <RoomStays> <RoomStay> <RoomTypes> <RoomType NumberOfUnits="1" RoomTypeCode="R01M1"> <RoomDescription> <Text>STANDARD</Text> </RoomDescription> <AdditionalDetails> <AdditionalDetail Type="4" Code="TRMD"> <DetailDescription> <Text>QUARTO STANDARD COM BANHEIRO PRIVATIVO, MINIBAR, TV A CABO, AR CONDICIONADO.</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="13" Code="TCMM" Amount="10"/> </AdditionalDetails> <TPA_Extensions> <Occupants MaxOccupants="9"/> </TPA_Extensions> </RoomType> <RoomType NumberOfUnits="1" RoomTypeCode="R01M2"> <RoomDescription> <Text>SUPERIOR</Text> </RoomDescription> <AdditionalDetails> <AdditionalDetail Type="4" Code="TRMD"> <DetailDescription> <Text>QUARTO SUPERIOR, CAMA CASAL, MINIBAR, TV A CABO, MESA DE TRABALHO, AR CONDICIONADO</Text> </DetailDescription> 25 Especificações do Web Service CMNet – versão 3.3 </AdditionalDetail> <AdditionalDetail Type="13" Code="TCMM" Amount="10"/> <AdditionalDetail Type="14" Code="PNS"> <DetailDescription> <Text>4</Text> </DetailDescription> </AdditionalDetail> </AdditionalDetails> <TPA_Extensions> <Occupants MaxOccupants="3"/> </TPA_Extensions> </RoomType> <RoomType NumberOfUnits="1" RoomTypeCode="R01M3"> <RoomDescription> <Text>LUXO</Text> </RoomDescription> <AdditionalDetails> <AdditionalDetail Type="4" Code="TRMD"> <DetailDescription> <Text>QUARTO DE LUXO COM CAMA CASAL OU 2 SOLTEIROS, TV A CABO, MINIBAR, MESA DE TRABALHO, AR CONDICIONADO, VISTA LATERAL MAR</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="13" Code="TCMM" Amount="10"/> </AdditionalDetails> <TPA_Extensions> <Occupants MaxOccupants="3"/> </TPA_Extensions> </RoomType> <RoomType NumberOfUnits="1" RoomTypeCode="R01PR"> <RoomDescription> <Text>SUITE PRESIDENCIAL</Text> </RoomDescription> <AdditionalDetails> <AdditionalDetail Type="4" Code="TRMD"> <DetailDescription> <Text>.</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="13" Code="TCMM" Amount="10"/> </AdditionalDetails> <TPA_Extensions> <Occupants MaxOccupants="2"/> </TPA_Extensions> </RoomType> </RoomTypes> <RoomRates> <RoomRate RoomTypeCode="R01M1"> <Rates> <Rate> <Base AmountBeforeTax="500" CurrencyCode="BRL"/> <PaymentPolicies> <RequiredPayment PaymentCode=”4”> <AcceptedPayments> <AcceptedPayment> <PaymentCard CardCode="VI" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="MC" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="DC" CardType="1"/> 26 Especificações do Web Service CMNet – versão 3.3 </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="AX" CardType="1"/> </AcceptedPayment> </AcceptedPayments> </RequiredPayment> </PaymentPolicies> <Total AmountAfterTax="78.33"/> </Rate> <Rate EffectiveDate="2007-08-01" ExpireDate="2007-08-01"> <Base AmountBeforeTax="500" CurrencyCode="BRL"/> </Rate> </Rates> <RoomRateDescription> <Text>TRF BALCAO</Text> </RoomRateDescription> </RoomRate> <RoomRate RoomTypeCode="R01M2"> <Rates> <Rate> <Base AmountBeforeTax="1000" CurrencyCode="BRL"/> <PaymentPolicies> <RequiredPayment PaymentCode=”4”> <AcceptedPayments> <AcceptedPayment> <PaymentCard CardCode="VI" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="MC" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="DC" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="AX" CardType="1"/> </AcceptedPayment> </AcceptedPayments> </RequiredPayment> </PaymentPolicies> </Rate> <Rate EffectiveDate="2007-08-01" ExpireDate="2007-08-01"> <Base AmountBeforeTax="1000" CurrencyCode="BRL"/> </Rate> </Rates> <RoomRateDescription> <Text>TRF BALCAO</Text> </RoomRateDescription> </RoomRate> <RoomRate RoomTypeCode="R01M3"> <Rates> <Rate> 27 Especificações do Web Service CMNet – versão 3.3 <Base AmountBeforeTax="2000" CurrencyCode="BRL"/> <PaymentPolicies> <RequiredPayment PaymentCode=”4”> <AcceptedPayments> <AcceptedPayment> <PaymentCard CardCode="VI" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="MC" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="DC" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="AX" CardType="1"/> </AcceptedPayment> </AcceptedPayments> </RequiredPayment> </PaymentPolicies> </Rate> <Rate EffectiveDate="2007-08-01" ExpireDate="2007-08-01"> <Base AmountBeforeTax="2000" CurrencyCode="BRL"/> </Rate> </Rates> <RoomRateDescription> <Text>TRF BALCAO</Text> </RoomRateDescription> </RoomRate> <RoomRate RoomTypeCode="R01PR"> <Rates> <Rate> <Base AmountBeforeTax="10000" CurrencyCode="BRL"/> <PaymentPolicies> <RequiredPayment PaymentCode=”4”> <AcceptedPayments> <AcceptedPayment> <PaymentCard CardCode="VI" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="MC" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="DC" CardType="1"/> </AcceptedPayment> <AcceptedPayment> 28 Especificações do Web Service CMNet – versão 3.3 <PaymentCard CardCode="AX" CardType="1"/> </AcceptedPayment> </AcceptedPayments> </RequiredPayment> </PaymentPolicies> </Rate> <Rate EffectiveDate="2007-08-01" ExpireDate="2007-08-01"> <Base AmountBeforeTax="10000" CurrencyCode="BRL"/> </Rate> </Rates> <RoomRateDescription> <Text>TRF BALCAO</Text> </RoomRateDescription> </RoomRate> </RoomRates> <BasicPropertyInfo HotelCode="2125" HotelName="HOTEL MODELO TUCM" ChainCode="114"> <Address> <AddressLine>RUA CAMPO SALES, 55</AddressLine> <AddressLine>TIJUCA</AddressLine> <CityName>Cidade De Teste</CityName> <PostalCode>20270210</PostalCode> <StateProv StateCode="RJ"/> <CountryName>Brasil</CountryName> </Address> <RelativePosition Distance="5463,77" DistanceUnitName="Km"/> </BasicPropertyInfo> <TPA_Extensions> <CMNET IATACode="" EnvioSMS=”True” /> </TPA_Extensions> </RoomStay> </RoomStays> </OTA_HotelAvailRS> 2.2.6. Erros Código Descrição 136 Data inicial inválida 148 Data de chegada requerida 158 Data de partida requerida 173 Código de agência requerido 175 Senha inválida 321 Faltando campo requerido 357 Cidade inválida 377 Inválido - ultrapassado número máximo de noites 392 Código de hotel inválido 397 Número inválido de adultos 404 Combinação inválida de data inicial/final 405 Retorna Erro de parceiro não reconhecido 424 Indisponibilidade de hotéis condizentes com esta entrada de dados 427 Indisponibilidade de quartos para datas solicitadas 431 Data de saída ultrapassa data final 29 Especificações do Web Service CMNet – versão 3.3 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 914 Conexão Inválida 915 Time Out limite da chave de conexão 2.3. Revisão da reserva (xmlRevisaoDispHotel) 2.3.1. Descrição O objetivo deste método é retornar informações completas sobre a acomodação selecionada pelo cliente para reservar, tais como políticas e restrições, formas de pagamento e valores de taxas e tarifas. 2.3.2. Requisição (OTA_HotelAvailRQ.xml) Nível 0 Elemento Atributo OTA_HotelAvailRQ Obrigatório X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do cliente solicitante. EchoToken Target PrimaryLangID 1 POS X 2 Source X Código ISO do país (ISO 3166 - de dois dígitos), utilizado para filtrar os produtos retornados por um país específico. Exemplo: “BR” ISOCountry 3 Descrição RequestorID X Type X Identificação do tipo de cliente na OTA Code List (UIT). Opções: “4” – Parceiro ou empresa 30 Especificações do Web Service CMNet – versão 3.3 “5” – Agência de viagens ID X URL Url do cliente. 1 AvailRequestSegments X 2 AvailRequestSegment X Informações necessárias para a consulta de disponibilidade. Determina se a requisição é para uma acomodação ou outro tipo de produto. O valor utilizado será sempre “Room”. AvailReqType 3 Identificação do cliente no CMNet. Se o parceiro quiser trabalhar com agências ou empresas associadas ao CMNet, é necessário colocar aqui o id da agência ou empresa, caso contrário, o id do próprio parceiro. X Período de disponibilidade solicitado. O período máximo permitido no web service CMNet é de 60 dias. Start X Data de chegada. Exemplo: “2004-10-01” End X Data de partida. Exemplo: “2004-10-02” Informações sobre as acomodações consultadas. StayDateRange 3 RoomStayCandidates X 4 RoomStayCandidate X RoomTypeCode X Código da acomodação. Exemplo: “N01ST” Cupom de desconto para a reserva. Exemplo: “WS_01” PromotionCode 5 GuestCounts X 6 GuestCount X Informações sobre o(s) hóspede(s). AgeQualifyingCode X Identificação do tipo de hóspede na OTA Code List (AQC). Opções: “10” – Adulto “8” – Criança Atenção: O web service CMNet aceita consultas de acomodações para até 6 (seis) crianças. Para efetuar este tipo de consulta devem ser incluídos na requisição um máximo de 6 (seis) elementos GuestCount com o atributo Count igual a “1” e o atributo AgeQualifyingCode igual a “8”, além da idade de cada criança no atributo Age. Exemplo: <GuestCount AgeQualifyingCode="8" Age="1" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="2" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="3" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="4" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="5" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="6" Count="1"/> Age X Idade do hóspede. Válido somente para crianças. Exemplo: “8” Count X Quantidade de adultos ou crianças. Exemplo: “1” 3 HotelSearchCriteria X Critério para a consulta. 4 Criterion X Só é aceito um elemento deste tipo. 5 HotelRef X Informações necessárias para a consulta. X Identificação do hotel no CMNet. Exemplo: “37456” HotelCode 1 HotelReservationIDs 2 HotelReservationID Identificação da reserva. Este elemento só deve ser incluído na requisição de alteração. ResID_Type Identificação do tipo de objeto definido pelo elemento HotelReservationID na OTA Code List (UIT). O valor utilizado será sempre “14” – Reservation 31 Especificações do Web Service CMNet – versão 3.3 ResID_Value Número da reserva. Exemplo: “7268618” 2.3.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailRQ Version="1.003" EchoToken="1234" TimeStamp="2006-03-21T08:00:00" Target="Test" PrimaryLangID="pt-BR" xmlns="http://www.opentravel.org/OTA/2003/05"> <POS> <Source> <RequestorID Type="4" ID="60227" URL="http://www.site_do_parceiro.com.br"/> </Source> </POS> <AvailRequestSegments> <AvailRequestSegment AvailReqType="Room"> <StayDateRange Start="2007-08-01" End="2007-08-02"/> <RateRange/> <RoomStayCandidates> <RoomStayCandidate RoomTypeCode="R01M1" PromotionCode="WS_01"> <GuestCounts> <GuestCount AgeQualifyingCode="10" Count="1"/> </GuestCounts> </RoomStayCandidate> </RoomStayCandidates> <HotelSearchCriteria> <Criterion> <HotelRef HotelCode="2125"/> </Criterion> </HotelSearchCriteria> </AvailRequestSegment> </AvailRequestSegments> <HotelReservationIDs> <HotelReservationID ResID_Type="14" ResID_Value="12345678"/> </HotelReservationIDs> </OTA_HotelAvailRQ> 2.3.4. Resposta (OTA_HotelAvailRS.xml) Nível 0 Elemento Atributo OTA_HotelAvailRS Descrição Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano 32 Especificações do Web Service CMNet – versão 3.3 “de-DE” – Alemão “pt-PT” – Português de Portugal 1 POS 2 Source 3 RequestorID 3 Identificação do web service CMNet. Type Tipo de provedor do serviço na OTA Code List. O valor retornado será sempre “22” – ERSP (Electronic reservation service provider) ID Identificação do provedor do serviço. O valor retornado será sempre “CMNET”. URL Url do provedor do serviço. O valor retornado será sempre “http://www.cmnet.com.br” BookingChannel Informações sobre o canal de distribuição. Type 4 CompanyName Tipo do canal de distribuição na OTA Code List (BCT). O valor retornado será sempre “7” – Internet Identificação da empresa que disponibiliza o serviço. CompanyShortName O valor será sempre “CMNET”. TravelSector Identificação do setor de atuação da empresa na OTA Code List (TVS). O valor retornado será sempre “3” – Hotel 1 Success Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. 1 RoomStays Informação das acomodações retornadas. 2 RoomStay 3 RoomTypes 4 RoomType PromotionCode Cupom de desconto para a reserva. Exemplo: “WS_01” NumberOfUnits Número de unidades retornadas. O valor retornado será sempre “1”. RoomTypeCode Código da acomodação. Exemplo: “N01ST” IsRoom Indica se a acomodação é um quarto de dormir. Opções: “true” ou “false” 5 RoomDescription 6 Text Descrição da acomodação. Exemplo: “SUITE EXECUTIVA” 5 AdditionalDetails Informações adicionais sobre a acomodação. 6 AdditionalDetail Descrição da acomodação. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “4” – Room Information Code Identificação da informação. O valor retornado será sempre “TRMD”. 7 DetailDescription Detalhes da informação. 8 Text Exemplo: “Quarto de luxo com cama de casal ou duas camas de solteiro, tv a cabo, minibar, mesa de trabalho, ar condicionado, vista lateral para o mar.” 6 AdditionalDetail Políticas de cancelamento. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “7” – Cancellation Information Code Identificação da informação. O valor retornado será sempre “TCNC”. 7 DetailDescription Detalhes da informação. 8 Text Exemplo: “Até 24 horas antes da chegada.” 6 AdditionalDetail Políticas de modificação. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “14” – Miscellaneous Information 33 Especificações do Web Service CMNet – versão 3.3 Code Identificação da informação. O valor retornado será sempre “TMDF”. 7 DetailDescription Detalhes da informação. 8 Text Exemplo: “x.” 6 AdditionalDetail Políticas de garantia. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “5” – Guarantee Information Code Identificação da informação. O valor retornado será sempre “TGRN”. 7 DetailDescription Detalhes da informação. 8 Text Exemplo: “Depósito bancário de 70% do valor das diárias 10 dias antes do check-in. Cartão de crédito ou garantia de agência de viagens.” 6 AdditionalDetail Políticas de pré-pagamento. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “6” – Deposit Information Code Identificação da informação. O valor retornado será sempre “TPRE”. 7 DetailDescription Detalhes da informação. 8 Text Exemplo: “x.” 6 AdditionalDetail Políticas de check-in. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “8” – Check in check out Information Code Identificação da informação. O valor retornado será sempre “CHKIN”. 7 DetailDescription Detalhes da informação. 8 Text Exemplo: “Só é permitido efetuar check-in após as 15:00 hs.” 6 AdditionalDetail Políticas de check-out. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “8” – Check in check out Information Code Identificação da informação. O valor retornado será sempre “CHKOUT”. 7 DetailDescription Detalhes da informação. 8 Text Exemplo: “O check-out deverá ser efetuado no máximo até as 18:00 hs.” 6 AdditionalDetail Políticas para crianças. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “14” – Miscellaneous Information Code Identificação da informação. O valor retornado será sempre “TCHIL”. 7 DetailDescription Detalhes da informação. 8 Text Exemplo: “x.” 6 AdditionalDetail Outras políticas. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “14” – Miscellaneous Information Code Identificação da informação. O valor retornado será sempre “TOPOL”. 7 DetailDescription Detalhes da informação. 8 Text Exemplo: “x.” 6 AdditionalDetail Informações referentes à comissão. 6 AdditionalDetail Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “13” – Commission Information Code Identificação da informação. O valor retornado será sempre “TCMM”. Amount Valor percentual da comissão. Exemplo: “10” Políticas de TEF. 34 Especificações do Web Service CMNet – versão 3.3 Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “5” – Guarantee information Code Identificação da informação. O valor retornado será sempre “TTEF”. 7 DetailDescription Detalhes da informação. 8 Text Exemplo: “x.” 5 TPA_Extensions Informações adicionais não descritas no padrão OTA, mas que são necessárias ao web service CMNet. 6 Occupants Descreve o máximo de ocupantes aceitos na acomodação. MaxOccupants Quantidade máxima de ocupantes aceitos. MaxAdults Quantidade máxima de adultos aceitos. O retorno desta informação depende do preenchimento dela por parte do hotel escolhido. MaxChildren Quantidade máxima de crianças aceitas. O retorno desta informação depende do preenchimento dela por parte do hotel escolhido. 6 TEFInstallmentPayment Define as opções de parcelamento em TEF disponíveis para a acomodação em questão. 7 Cards Informações sobre os cartões aceitos para pagamento. 8 Card Code 9 InstallmentPaymentOptions 10 InstallmentPaymentOption 3 RoomRates 4 RoomRate 5 Rates 6 Rate 7 Base 6 Rate Código do cartão de crédito (padrão OTA). Opções: “AX” – American Express “BC” – Bank Card “BL” – Carte Bleu “CB” – Carte Blanche “DC” – Diners Club “DS” – Discover Card “EC” – Eurocard “JC” – JCB Credit Card “MC” – Master Card “TP” – Universal Air Travel Card “VI” – Visa Informações sobre as opções de parcelamento. PaymentsInstallments Quantidade de parcelas a serem pagas. Exemplo: “2” Amount Valor de cada parcela. Este valor está na mesma moeda que a do valor total da reserva. Exemplo: “100” InterestRate Percentual de juros a serem pagos (já incluídos nos valores das parcelas). “0” significa “sem juros”. Informações dos valores das acomodações. RoomTypeCode Código da acomodação. Exemplo: “N01ST” PromotionCode Cupom de desconto para a reserva. Exemplo: “WS_01” Valor médio da tarifa. AmountBeforeTax Valor médio das tarifas (sem as taxas). Exemplo: “270” CurrencyCode Código ISO da moeda. Exemplo: “BRL” Valor da tarifa agrupado por período de datas. Caso o valor varie dentro do período escolhido, um novo elemento Rate será criado para cada novo 35 Especificações do Web Service CMNet – versão 3.3 valor. 7 EffectiveDate Data inicial do valor da tarifa. Exemplo: “2006-03-25” ExpireDate Data final do valor da tarifa. Exemplo: “2006-03-28” AmountBeforeTax Valor da tarifa (sem as taxas). CurrencyCode Código ISO da moeda. Exemplo: “BRL” Base 5 RoomRateDescription 6 Text Descrição da acomodação. Exemplo: “TRF BALCAO” 3 GuestCounts Informações sobre o(s) hóspede(s). 4 GuestCount 3 AgeQualifyingCode Identificação do tipo de hóspede na OTA Code List (AQC). Opções: “10” – Adulto “8” – Criança Count Quantidade de adultos ou crianças. Exemplo: “1” Age Idade do hóspede. Este atributo somente será retornado se o hóspede for uma criança. Exemplo: “8” TimeSpan 3 DepositPayments 4 RequiredPayment Informações sobre o período da reserva. Duration O período da reserva. Exemplo: “P1D”, onde o valor “1” é referente a quantidade, e o valor “D” é referente a tipo (dias). Start Data de chegada. Exemplo: “2004-12-01” End Data de partida. Exemplo: “2004-12-04” Políticas de pagamento da reserva. PaymentCode 5 AcceptedPayments 6 AcceptedPayment 7 PaymentCard Define o tipo de pagamento a ser efetuado: “4” – PrePay “31” – Guarantee Formas de pagamento aceitas. A reserva pode ser paga com cartão de crédito. Caso seja aceito mais de um tipo de cartão de crédito, um novo elemento AcceptedPayment deverá ser criado para cada tipo. CardCode Código do cartão de crédito (padrão OTA). Opções: “AX” – American Express “BC” – Bank Card “BL” – Carte Bleu “CB” – Carte Blanche “DC” – Diners Club “DS” – Discover Card “EC” – Eurocard “JC” – JCB Credit Card “MC” – Master Card “TP” – Universal Air Travel Card “VI” – Visa CardType Identificação do tipo de cartão na OTA Code List (CDT). O valor retornado será sempre “1” – Credit 36 Especificações do Web Service CMNet – versão 3.3 6 AcceptedPayment 7 Voucher A reserva pode ser paga via faturamento para a empresa. SeriesCode Códigos dos tipos de faturamento para a empresa. Opções: “NA” – Alimentação e bebidas não alcoólicas “DI” – Diária “LV” – Lavanderia “TL” – Telefonemas “TT” – Todas as despesas (se estiver marcado, só ele pode ser selecionado) “TU” – Taxa de turismo “CF” – Café da manhã “TY” – Tudo sem bebidas alcoólicas (se estiver marcado, só ele pode ser selecionado) Exemplo: “AN-DI-LV-TL-TU” 6 AcceptedPayment 7 DirectBill A reserva pode ser paga diretamente no hotel. 3 CancelPenalties Retorna a data máxima do cancelamento. 4 CancelPenalty 5 Deadline AbsoluteDeadline 3 Discount 4 DiscountReason 5 Text 3 Total 4 5 3 Valor da data máxima do cancelamento. Exemplo: “2004-12-01T18:00:00”. Informações sobre o desconto no valor da reserva. AmountBeforeTax Valor do desconto. Exemplo: “-100” CurrencyCode Código ISO da moeda. Exemplo: “BRL” DiscountCode Cupom de desconto para a reserva. Exemplo: “WS_01” Valores da reserva e de taxas de serviço, caso exista alguma. AmountAfterTax Valor da tarifa com taxas. CurrencyCode Código ISO da moeda. Exemplo: “BRL” Taxes Descrição das taxas existentes. Amount Valor total das taxas. Exemplo: “57.10” CurrencyCode Código ISO da moeda. Exemplo: “BRL” Amount Valor da taxa. Exemplo: “38.10” Type Tipo da taxa. Opções: “Inclusive” – Inclusivo “Exclusive” – Exclusivo “Cumulative” – Acumulativo CurrencyCode Código ISO da moeda. Exemplo: “BRL” Code Identificação da taxa na OTA Code List (FTT). Exemplo: “14” – Service charge Tax BasicPropertyInfo Informações básicas sobre o hotel. HotelCode Identificação do hotel no CMNet. 37 Especificações do Web Service CMNet – versão 3.3 Exemplo: “37456” HotelName Nome Fantasia do hotel. Exemplo: “Hotel Modelo” 4 Address Endereço do hotel. 5 AddressLine Endereço. Exemplo: “Campos Sales” 5 AddressLine Bairro, caso se aplique. Exemplo: “Tijuca” 5 CityName Nome da cidade. Exemplo: “Rio de Janeiro” 5 PostalCode CEP. Exemplo: “20270210” 5 StateProv Informação do estado. StateCode Código do estado. Exemplo: “RJ” CountryName Informação do país. Exemplo: “Brasil” 1 Warnings Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” 2 Warning 5 1 Errors 2 Error Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 2.3.5. Exemplo de xml de resposta <?xml version="1.0" encoding="utf-8"?> <OTA_HotelAvailRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.003" EchoToken="1234" TimeStamp="2007-06-11T13:13:26" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="22" ID="CMNET" URL="http://www.cmnet.com.br"/> <BookingChannel Type="7"> <CompanyName CompanyShortName="CMNET" TravelSector="3"/> </BookingChannel> </Source> </POS> <Success/> <RoomStays> <RoomStay PromotionCode="WS_01"> <RoomTypes> <RoomType NumberOfUnits="1" RoomTypeCode="R01M1" IsRoom="true"> <RoomDescription> <Text>STANDARD</Text> </RoomDescription> <AdditionalDetails> 38 Especificações do Web Service CMNet – versão 3.3 <AdditionalDetail Type="4" Code="TRMD"> <DetailDescription> <Text>QUARTO STANDARD COM BANHEIRO PRIVATIVO, MINIBAR, TV A CABO, AR CONDICIONADO.</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="7" Code="TCNC"> <DetailDescription> <Text>Até 24 Horas antes da chegada</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="14" Code="TMDF"> <DetailDescription> <Text>POLITICA DE MODIFICAÇÃO.</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="5" Code="TGRN"> <DetailDescription> <Text>Depósito bancário de 70% do valor das diárias 10 dias antes do check-in. Cartao de credito ou garantia de agencia de viagens</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="6" Code="TPRE"> <DetailDescription> <Text>x</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="8" Code="CHKIN"> <DetailDescription> <Text>Só é permitido efetuar check-in após as 15:00 horas</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="8" Code="CHKOUT"> <DetailDescription> <Text>O check-out deverá ser efetuado no máximo até as 18:00 horas</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="14" Code="TCHIL"> <DetailDescription> <Text>POLITICA DE CRIANÇA</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="14" Code="TOPOL"> <DetailDescription> <Text>x</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="13" Code="TCMM" Amount="10"/> <AdditionalDetail Type="14" Code="PNS"> <DetailDescription> <Text>4</Text> </DetailDescription> </AdditionalDetail> </AdditionalDetails> <TPA_Extensions> <Occupants MaxOccupants="9"/> <TEFInstallmentPayment> <Cards> <Card Code="VI"> <InstallmentPaymentOptions> <InstallmentPaymentOption PaymentsInstallments="1" Amount="120,00" InterestRate="0" /> <InstallmentPaymentOption PaymentsInstallments="2" Amount="60,72" InterestRate="1,2" /> 39 Especificações do Web Service CMNet – versão 3.3 <InstallmentPaymentOption PaymentsInstallments="3" Amount="40,52" InterestRate="1,3" /> <InstallmentPaymentOption PaymentsInstallments="4" Amount="30,42" InterestRate="1,4" /> </InstallmentPaymentOptions> </Card> <Cards> </TEFInstallmentPayment> </TPA_Extensions> </RoomType> </RoomTypes> <RoomRates> <RoomRate RoomTypeCode="R01M1" PromotionCode="WS_01"> <Rates> <Rate> <Base AmountBeforeTax="500" CurrencyCode="BRL"/> </Rate> <Rate EffectiveDate="2007-08-01" ExpireDate="2007-08-01"> <Base AmountBeforeTax="500" CurrencyCode="BRL"/> </Rate> </Rates> <RoomRateDescription> <Text>TRF BALCAO</Text> </RoomRateDescription> </RoomRate> </RoomRates> <GuestCounts> <GuestCount AgeQualifyingCode="10" Count="1"/> </GuestCounts> <TimeSpan Duration="P1D" Start="2007-08-01" End="2007-08-02"/> <DepositPayments> <RequiredPayment PaymentCode=”4”> <AcceptedPayments> <AcceptedPayment> <PaymentCard CardCode="VI" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="MC" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="DC" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="AX" CardType="1"/> </AcceptedPayment> </AcceptedPayments> </RequiredPayment> </DepositPayments> <CancelPenalties> <CancelPenalty> <Deadline AbsoluteDeadline="2004-1201T18:00:00"/> </CancelPenalty> </CancelPenalties> <Discount AmountBeforeTax="-100" CurrencyCode="BRL" DiscountCode="WS_01"> <DiscountReason> <Text/> </DiscountReason> </Discount> <Total AmountAfterTax="509.30" CurrencyCode="BRL"> <Taxes Amount="109.30" CurrencyCode="BRL"> <Tax Amount="40" Type="Exclusive" CurrencyCode="BRL" Code="14"/> <Tax Amount="20" Type="Exclusive" CurrencyCode="BRL" Code="3"/> <Tax Amount="3" Type="Exclusive" CurrencyCode="BRL" Code="18"/> 40 Especificações do Web Service CMNet – versão 3.3 <Tax Amount="46.30" Type="Cumulative" CurrencyCode="BRL" Code="18"/> </Taxes> </Total> <BasicPropertyInfo HotelCode="2125" HotelName="HOTEL MODELO TUCM"> <Address> <AddressLine>RUA CAMPO SALES, 55</AddressLine> <AddressLine>TIJUCA</AddressLine> <CityName>Cidade De Teste</CityName> <PostalCode>20270210</PostalCode> <StateProv StateCode="RJ"/> <CountryName>Brasil</CountryName> </Address> </BasicPropertyInfo> </RoomStay> </RoomStays> </OTA_HotelAvailRS> 2.3.6. Erros Código Descrição 119 Pessoas em demasia no quarto/unidade 136 Data inicial inválida 148 Data de chegada requerida 158 Data de partida requerida 173 Código de agência requerido 175 Senha inválida 321 Faltando campo requerido 377 Inválido - ultrapassado número máximo de noites 392 Código de hotel inválido 397 Número inválido de adultos 404 Combinação inválida de data inicial/final 405 Retorna Erro de parceiro não reconhecido 424 Indisponibilidade de hotéis condizentes com esta entrada de dados 427 Indisponibilidade de quartos para datas solicitadas 431 Data de saída ultrapassa data final 441 Tarifa solicitada indisponível para toda a estada 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 914 Conexão Inválida 915 Time Out limite da chave de conexão 41 Especificações do Web Service CMNet – versão 3.3 2.4. Inclusão ou alteração de reservas (xmlIncluiAlteraReserva) 2.4.1. Descrição O objetivo deste método é efetuar a inclusão ou alteração de uma reserva. Lembrando que no caso de alteração deve ser informado na requisição o número da reserva a ser alterada. 2.4.2. Requisição (OTA_HotelResRQ.xml) Nível 0 Elemento Atributo OTA_HotelResRQ Obrigat ório Descrição X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do cliente solicitante. EchoToken Target PrimaryLangID 1 POS X 2 Source X 3 RequestorID X Type ID X Identificação do tipo de cliente na OTA Code List (UIT). Opções: “4” – Parceiro ou empresa “5” – Agência de viagens X Identificação do cliente no CMNet. Se o parceiro quiser trabalhar com agências ou empresas associadas ao CMNet, é necessário colocar aqui o id da agência ou empresa, caso contrário, o id do próprio parceiro. URL Url do cliente. 1 HotelReservations X 2 HotelReservation X 3 UniqueID Informações sobre a reserva sendo incluída ou alterada. Somente uma reserva é aceita por requisição. Identificação da reserva a ser alterada. Este elemento só deve ser incluído na requisição de alteração. Type Identificação do tipo de objeto definido pelo elemento UniqueID na OTA Code List (UIT). O valor utilizado será sempre “14” – Reservation ID Número da reserva a ser alterada. Exemplo: “7268618” 42 Especificações do Web Service CMNet – versão 3.3 3 RoomStays X 4 RoomStay X Cupom de desconto para a reserva. Exemplo: “WS_01” PromotionCode 5 RoomTypes X 6 RoomType X RoomTypeCode X Código da acomodação. Exemplo: “N01ST” Informações dos valores da acomodação. 5 RoomRates X 6 RoomRate X 7 Rates X 8 Rate X 9 Base X 5 Informações da acomodação retornada. Valor médio da tarifa. AmountBeforeTax X Valor médio da tarifa (sem as taxas). Exemplo: “270” CurrencyCode X Código ISO da moeda. Exemplo: “BRL” X Informações básicas sobre o hotel. X Identificação do hotel no CMNet. Exemplo: “37456” BasicPropertyInfo HotelCode 3 ResGlobalInfo X Informações gerais sobre a reserva. 4 GuestCounts X Informações sobre o(s) hóspede(s). Indica se a quantidade de hóspedes se aplica a todas as acomodações informadas. Sempre será enviada somente uma acomodação por requisição. Opções: “true” ou “false” IsPerRoom 5 4 4 GuestCount X AgeQualifyingCode X Identificação do tipo de hóspede na OTA Code List (AQC). Opções: “10” – Adulto “8” – Criança Atenção: O web service CMNet aceita consultas de acomodações para até 6 (seis) crianças. Para efetuar este tipo de consulta devem ser incluídos na requisição um máximo de 6 (seis) elementos GuestCount com o atributo Count igual a “1” e o atributo AgeQualifyingCode igual a “8”, além da idade de cada criança no atributo Age. Exemplo: <GuestCount AgeQualifyingCode="8" Age="1" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="2" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="3" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="4" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="5" Count="1"/> <GuestCount AgeQualifyingCode="8" Age="6" Count="1"/> Count X Quantidade de adultos ou crianças. Exemplo: “1” Age X Idade do hóspede. Válido somente para crianças. Exemplo: “8” X Informações sobre o período da reserva. Start X Data de chegada. Exemplo: “2004-12-01” End X Data de partida. Exemplo: “2004-12-04” TimeSpan Comments Comentários do(s) hóspede(s). Máximo de 1.400 caracteres aceitos. 43 Especificações do Web Service CMNet – versão 3.3 5 Comment 6 Text 4 Guarantee X 5 GuaranteesAccepted X 6 GuaranteeAccepted 7 PaymentCard 8 CardHolderName 7 Voucher Descrição do comentário Exemplo: “Xpto.” Descreve a forma de pagamento da reserva. Opções: - Cartão de crédito - Faturar para empresa - Pagamento direto no hotel A reserva será paga com cartão de crédito. CardCode X Código do cartão de crédito (padrão OTA). Opções: “AX” – American Express “BC” – Bank Card “BL” – Carte Bleu “CB” – Carte Blanche “DC” – Diners Club “DS” – Discover Card “EC” – Eurocard “JC” – JCB Credit Card “MC” – Master Card “TP” – Universal Air Travel Card “VI” – Visa CardNumber X Número do cartão de crédito. Exemplo: “1234567897” ExpireDate X Data de vencimento. Exemplo: “0208” SeriesCode X Código de segurança. Exemplo: “1234” X Nome impresso no cartão de crédito. Exemplo: “José da Silva” A reserva será paga via faturamento para a empresa. SeriesCode 7 Garantia da reserva. X Códigos dos tipos de faturamento para a empresa. Opções: “NA” – Alimentação e bebidas não alcoólicas “DI” – Diária “LV” – Lavanderia “TL” – Telefonemas “TT” – Todas as despesas (se estiver marcado, só ele pode ser selecionado) “TU” – Taxa de turismo “CF” – Café da manhã “TY” – Tudo sem bebidas alcoólicas (se estiver marcado, só ele pode ser selecionado) Exemplo: “AN-DI-LV-TL-TU” DirectBill A reserva será paga diretamente no hotel. 5 Comments Seção para informações adicionais sobre o pagamento parcelado em TEF. Essa seção não é obrigatória, e seu preenchimento somente se faz necessário caso o usuário deseje efetuar o pagamento em mais de uma parcela. 6 Comment CommentOriginatorCode 7 Text Define o tipo de informação sendo enviada. Opções: “PARCELAS” – Quantidade de parcelas para pagamento via TEF. O conteúdo deste elemento vai variar de acordo com o conteúdo informado no atributo CommentOriginatorCode. Caso o atributo CommentOriginatorCode seja preenchido com o valor “PARCELAS”, o conteúdo do elemento Text deve definir a 44 Especificações do Web Service CMNet – versão 3.3 quantidade de parcelas nas quais o hóspede deseja efetuar o pagamento da reserva. Exemplo: “1” 4 Profiles X 5 ProfileInfo X 6 Profile X Dados do(s) hóspede(s). Identificação do tipo de hóspede na OTA Code List (PRT). O valor utilizado será sempre “1” – Customer ProfileType 7 Customer X 8 PersonName X 9 GivenName X Nome. Exemplo: “José” 9 Surname X Sobrenome. Exemplo: “da Silva” 8 Email E-mail do hóspede. EmailType 3 TPA_Extensions 4 VirtualCard Identificação do tipo de e-mail na OTA Code List (EAT). O valor utilizado será sempre “1” – Personal Dados do cartão virtual. A reserva deverá ser paga com cartão de crédito e o(s) campo(s) de faturamento para empresa deverão ser informados. CentroCusto Centro de custo do hóspede em sua empresa. Matricula Matrícula do hóspede em sua empresa. Departamento Departamento do hóspede em sua empresa. RequisicaoViagem Número da requisição de viagem, feita pela empresa do hóspede. AutorizacaoViagem Código de autorização da viagem. ControleAgencia Código de controle da agência reservante. Desconto Valor do desconto praticado pela agência. TextoLivre 2 WrittenConfInst Telephone Número do celular do hóspede para o envio do SMS com a confirmação de inclusão/alteração da reserva. O número do celular deve obedecer o seguinte formato: “DDI+DDD+Celular”. Exempo: “552188776655” 2.4.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <OTA_HotelResRQ Version="1.003" EchoToken="123456" Target="Test" TimeStamp="2004-01-01T08:00:00-05:00" PrimaryLangID="pt-BR" xmlns="http://www.opentravel.org/OTA/2003/05"> <POS> <Source> <RequestorID Type="4" ID="60227" URL="http://www.site_do_parceiro.com.br"/> </Source> </POS> <HotelReservations> <HotelReservation> <RoomStays> <RoomStay PromotionCode="WS_01"> <RoomTypes> <RoomType RoomTypeCode="R01M1"/> </RoomTypes> <RoomRates> <RoomRate> <Rates> 45 Especificações do Web Service CMNet – versão 3.3 <Rate> <Base AmountBeforeTax="2000" CurrencyCode="BRL"/> </Rate> </Rates> </RoomRate> </RoomRates> <BasicPropertyInfo HotelCode="2125"/> </RoomStay> </RoomStays> <ResGlobalInfo> <GuestCounts IsPerRoom="true"> <GuestCount AgeQualifyingCode="10" Count="1"/> </GuestCounts> <TimeSpan Start="2007-08-10" End="2007-08-11"/> <Comments> <Comment> <Text>TESTE DE RESERVA</Text> </Comment> </Comments> <Guarantee> <GuaranteesAccepted> <GuaranteeAccepted> <PaymentCard CardCode="VI" CardNumber="4013713930408799" ExpireDate="0208" SeriesCode="1234"> <CardHolderName>Jose da Silva</CardHolderName> </PaymentCard> </GuaranteeAccepted> </GuaranteesAccepted> <Comments> <Comment CommentOriginatorCode="PARCELAS"> <Text>1</Text> </Comment> </Comments> </Guarantee> <Profiles> <ProfileInfo> <Profile ProfileType="1"> <Customer> <PersonName> <GivenName>Jose</GivenName> <Surname>da Silva</Surname> </PersonName> <Email EmailType="1">[email protected]</Email> </Customer> </Profile> </ProfileInfo> </Profiles> </ResGlobalInfo> </HotelReservation> < WrittenConfInst Telephone=”552188776655” /> </HotelReservations> </OTA_HotelResRQ> 2.4.4. Resposta (OTA_HotelResRS.xml) Nível 0 Elemento Atributo OTA_HotelResRS Descrição Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. 46 Especificações do Web Service CMNet – versão 3.3 Exemplo: “12346578” 1 POS 2 Source 3 RequestorID 3 Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do web service CMNet. Type Tipo de provedor do serviço na OTA Code List. O valor retornado será sempre “22” – ERSP (Electronic reservation service provider) ID Identificação do provedor do serviço. O valor retornado será sempre “CMNET”. URL Url do provedor do serviço. O valor retornado será sempre “http://www.cmnet.com.br” BookingChannel Informações sobre o canal de distribuição. Type 4 CompanyName 1 Success 1 HotelReservations 2 HotelReservation 3 Identificação da empresa que disponibiliza o serviço. CompanyShortName O valor utilizado será sempre “CMNET”. TravelSector Identificação do setor de atuação da empresa na OTA Code List (TVS). O valor retornado será sempre “3” – Hotel Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. Informações sobre a reserva sendo incluída ou alterada. RoomStayReservation Indica se a reserva é para acomodações. A reserva sempre será deste tipo. Opções: “true” ou “false” CreatorID Identificação do sistema responsável pela criação da reserva. Exemplo: “CORPORA” – site Reservas Corporativas CreateDateTime Data de criação. Exemplo: “2004-01-01T08:00:00” LastModifyDateTime Data de modificação. Caso a reserva nunca tenha sido modificada este atributo não será retornado. Exemplo: “2004-01-01T08:00:00” UniqueID 3 RoomStays 4 RoomStay Identificação da reserva. Type Identificação do tipo de objeto definido pelo elemento UniqueID na OTA Code List (UIT). O valor retornado será sempre “14” – Reservation ID Número da reserva no CMNet. Exemplo: “7268618” Informações da acomodação retornada. PromotionCode 5 RoomTypes 6 RoomType Tipo do canal de distribuição na OTA Code List (BCT). O valor retornado será sempre “7” – Internet Cupom de desconto para a reserva. Exemplo: “WS_01” 47 Especificações do Web Service CMNet – versão 3.3 NumberOfUnits Número de unidades retornadas. O valor retornado será sempre “1”. RoomTypeCode Código da acomodação. Exemplo: “N01ST” IsRoom Indica se a acomodação é um quarto de dormir. Opções: “true” ou “false” 7 RoomDescription 8 Text Descrição da acomodação. Exemplo: “SUITE EXECUTIVA” 7 AdditionalDetails Informações adicionais sobre a acomodação. 8 AdditionalDetail Descrição da acomodação. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “4” – Room Information Code Identificação da informação. O valor retornado será sempre “TRMD”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “Quarto de luxo com cama de casal ou duas camas de solteiro, tv a cabo, minibar, mesa de trabalho, ar condicionado, vista lateral para o mar.” 8 AdditionalDetail Políticas de cancelamento. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “7” – Cancellation Information Code Identificação da informação. O valor retornado será sempre “TCNC”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “Até 24 horas antes da chegada.” 8 AdditionalDetail Políticas de modificação. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “14” – Miscellaneous Information Code Identificação da informação. O valor retornado será sempre “TMDF”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “x.” 8 AdditionalDetail Políticas de garantia. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “5” – Guarantee Information Code Identificação da informação. O valor retornado será sempre “TGRN”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “Depósito bancário de 70% do valor das diárias 10 dias antes do check-in. Cartão de crédito ou garantia de agência de viagens.” 8 AdditionalDetail Políticas de pré-pagamento. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “6” – Deposit Information Code Identificação da informação. O valor retornado será sempre “TPRE”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “x.” 8 AdditionalDetail Políticas de check-in. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “8” – Check in check out Information Code Identificação da informação. O valor retornado será sempre “CHKIN”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “Só é permitido efetuar check-in após as 15:00 hs.” 8 AdditionalDetail Políticas de check-out. 48 Especificações do Web Service CMNet – versão 3.3 Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “8” – Check in check out Information Code Identificação da informação. O valor retornado será sempre “CHKOUT”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “O check-out deverá ser efetuado no máximo até as 18:00 hs.” 8 AdditionalDetail Políticas para crianças. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “14” – Miscellaneous Information Code Identificação da informação. O valor retornado será sempre “TCHIL”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “x.” 8 AdditionalDetail Outras políticas. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “14” – Miscellaneous Information Code Identificação da informação. O valor retornado será sempre “TOPOL”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “x.” 8 AdditionalDetail Políticas de TEF. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “5” – Guarantee information Code Identificação da informação. O valor retornado será sempre “TTEF”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “x.” 5 RoomRates Informações dos valores da acomodação. 6 RoomRate Só será retornado um elemento deste tipo. RoomTypeCode 7 Rates 8 Rate 9 Base 8 9 Código da acomodação. Exemplo: “N01ST” Valor médio da tarifa. AmountBeforeTax Valor médio das tarifas (sem as taxas). Exemplo: “270” CurrencyCode Código ISO da moeda. Exemplo: “BRL” Valor da tarifa agrupado por período de datas. Caso o valor varie dentro do período escolhido, um novo elemento Rate será criado para cada novo valor. Rate EffectiveDate Data inicial do valor da tarifa. Exemplo: “2006-03-25” ExpireDate Data final do valor da tarifa. Exemplo: “2006-03-28” AmountBeforeTax Valor da tarifa (sem as taxas). CurrencyCode Código ISO da moeda. Exemplo: “BRL” Base 7 RoomRateDescription 8 Text Descrição da acomodação. Exemplo: “TRF BALCAO” 5 CancelPenalties Retorna a data máxima do cancelamento. 49 Especificações do Web Service CMNet – versão 3.3 6 CancelPenalty 7 Deadline AbsoluteDeadline 5 Discount 6 DiscountReason 7 Text 5 Total 6 7 5 Valor da data máxima do cancelamento. Exemplo: “2004-12-01T18:00:00”. Informações sobre o desconto no valor da reserva. AmountBeforeTax Valor do desconto. Exemplo: “-100” CurrencyCode Código ISO da moeda. Exemplo: “BRL” DiscountCode Cupom de desconto para a reserva. Exemplo: “WS_01” Valores da reserva e de taxas de serviço, caso exista alguma. AmountAfterTax Valor da tarifa com taxas. CurrencyCode Código ISO da moeda. Exemplo: “BRL” Taxes Descrição das taxas existentes. Amount Valor total das taxas. Exemplo: “57.10” CurrencyCode Código ISO da moeda. Exemplo: “BRL” Amount Valor da taxa. Exemplo: “38.10” Type Tipo da taxa. Opções: “Inclusive” – Inclusivo “Exclusive” – Exclusivo “Cumulative” – Acumulativo CurrencyCode Código ISO da moeda. Exemplo: “BRL” Code Identificação da taxa na OTA Code List (FTT). Exemplo: “14” – Service charge Tax BasicPropertyInfo Informações básicas sobre o hotel. HotelCode Identificação do hotel no CMNet. Exemplo: “37456” HotelName Nome Fantasia do hotel. Exemplo: “Hotel Modelo” 6 Address Endereço do hotel. 7 AddressLine Endereço. Exemplo: “Campos Sales” 7 AddressLine Bairro, caso se aplique. Exemplo: “Tijuca” 7 CityName Nome da cidade. Exemplo: “Rio de Janeiro” 7 PostalCode CEP. Exemplo: “20270210” 7 StateProv Informação do estado. StateCode 7 CountryName Código do estado. Exemplo: “RJ” Informação do país. Code Código ISO do país. Exemplo: “BR” 50 Especificações do Web Service CMNet – versão 3.3 6 ContactNumbers 7 ContactNumber Números para contato. PhoneUseType Identificação do tipo de uso na OTA Code List (PUT). O valor retornado será sempre “5” – Contact PhoneTechType Identificação do tipo de tecnologia na OTA Code List (PTT). Opções: “1” – Voice “3” – Fax PhoneNumber Número para contato. Exemplo: “2345678” 3 ResGlobalInfo Informações gerais sobre a reserva. 4 GuestCounts Informações sobre o(s) hóspede(s). 5 4 IsPerRoom Indica se a quantidade de hóspedes se aplica a todas as acomodações informadas. Sempre será enviada somente uma acomodação por requisição. Opções: “true” ou “false” AgeQualifyingCode Identificação do tipo de hóspede na OTA Code List (AQC). Opções: “10” – Adulto “8” – Criança Count Quantidade de adultos ou crianças. Exemplo: “1” Age Idade do hóspede. Este atributo somente será retornado se o hóspede for uma criança. Exemplo: “8” GuestCount TimeSpan Informações sobre o período da reserva. Duration O período da reserva. Exemplo: “P1D”, onde o valor “1” é referente a quantidade, e o valor “D” é referente a tipo (dias). Start Data de chegada. Exemplo: “2004-12-01” End Data de partida. Exemplo: “2004-12-04” 4 Comments Comentários do(s) hóspede(s). 5 Comment 6 Text Descrição do comentário Exemplo: “Xpto.” 4 Guarantee Garantia da reserva. GuaranteeType 5 Define o tipo de garantia da reserva: - “PrePay” - “CC/DC/Voucher” GuaranteesAccepted 6 GuaranteeAccepted Descreve a forma de pagamento da reserva. Opções: - Cartão de crédito - Faturar para empresa - Pagamento direto no hotel 7 PaymentCard A reserva será paga com cartão de crédito. CardCode Código do cartão de crédito (padrão OTA). Opções: “AX” – American Express “BC” – Bank Card “BL” – Carte Bleu “CB” – Carte Blanche “DC” – Diners Club “DS” – Discover Card 51 Especificações do Web Service CMNet – versão 3.3 “EC” – Eurocard “JC” – JCB Credit Card “MC” – Master Card “TP” – Universal Air Travel Card “VI” – Visa CardNumber Número do cartão de crédito. Exemplo: “1234567897” ExpireDate Data de vencimento. Exemplo: “0208” SeriesCode Código de segurança. Exemplo: “1234” 8 CardHolderName Nome impresso no cartão de crédito. Exemplo: “José da Silva” 7 Voucher A reserva será paga via faturamento para a empresa. SeriesCode Códigos dos tipos de faturamento para a empresa. Opções: “NA” – Alimentação e bebidas não alcoólicas “DI” – Diária “LV” – Lavanderia “TL” – Telefonemas “TT” – Todas as despesas (se estiver marcado, só ele pode ser selecionado) “TU” – Taxa de turismo “CF” – Café da manhã “TY” – Tudo sem bebidas alcoólicas (se estiver marcado, só ele pode ser selecionado) Exemplo: “AN-DI-LV-TL-TU” 7 DirectBill A reserva será paga diretamente no hotel. 4 HotelReservationIDs Coleção de chaves (confirmação e cancelamento) referentes à reserva retornada. 5 HotelReservationID 4 Profiles 5 ProfileInfo 6 Profile ResID_Type Identificação do tipo de chave na OTA Code List (UIT). Opções: “14” – Reservation “15” – Cancellation ResID_Value Número da chave. Exemplo: “7268618” ResID_Date Data de criação da chave. Exemplo: “2004-08-01T08:00:00” ProfileType Identificação do tipo de perfil na OTA Code List (PRT). O valor retornado será sempre “1” – Customer 7 Customer 8 PersonName 9 GivenName Nome. Exemplo: “José” 9 Surname Sobrenome. Exemplo: “da Silva” 8 Email E-mail. EmailType Identificação do tipo de e-mail na OTA Code List (EAT). O valor retornado será sempre “1” – Personal 3 TPA_Extensions Informações adicionais não descritas no padrão OTA, mas que são necessárias ao web service CMNet. 4 Distribuidores Canais de distribuição do hotel. 52 Especificações do Web Service CMNet – versão 3.3 5 4 Distribuidor Code Identificação do hotel no canal de distribuição. Exemplo: “1234” Type Identificação do distribuidor. Exemplo: “SABRE” ChainCode Identificação da cadeia do hotel no canal de distribuição. Exemplo: “BZ” Dados do cartão virtual. Esse elemento só será retornado se a forma de pagamento utilizada tiver sido “cartão virtual”. VirtualCard CentroCusto Centro de custo do hóspede em sua empresa. Matricula Matrícula do hóspede em sua empresa. Departamento Departamento do hóspede em sua empresa. RequisicaoViagem Número da requisição de viagem, feita pela empresa do hóspede. AutorizacaoViagem Código de autorização da viagem. ControleAgencia Código de controle da agência reservante. Desconto Valor do desconto praticado pela agência. TextoLivre 1 Warnings 2 Warning 1 Errors 2 Error Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 2.4.5. Exemplo de xml de resposta <?xml version="1.0" encoding="UTF-8"?> <OTA_HotelResRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.003" EchoToken="123456" TimeStamp="2007-0611T13:24:33" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="22" ID="CMNET" URL="http://www.cmnet.com.br"/> <BookingChannel Type="7"> <CompanyName CompanyShortName="CMNET" TravelSector="3"/> </BookingChannel> </Source> </POS> <Success/> <HotelReservations> <HotelReservation RoomStayReservation="true" CreatorID="WEBSERV" CreateDateTime="2007-06-11T13:36:32"> <UniqueID Type="14" ID="20862022"/> <RoomStays> <RoomStay PromotionCode="WS_01"> 53 Especificações do Web Service CMNet – versão 3.3 <RoomTypes> <RoomType NumberOfUnits="1" RoomTypeCode="R01M1" IsRoom="true"> <RoomDescription> <Text>STANDARD</Text> </RoomDescription> <AdditionalDetails> <AdditionalDetail Type="4" Code="TRMD"> <DetailDescription> <Text>QUARTO STANDARD COM BANHEIRO PRIVATIVO, MINIBAR, TV A CABO, AR CONDICIONADO.</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="7" Code="TCNC"> <DetailDescription> <Text>Até 24 Horas antes da chegada</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="14" Code="TMDF"> <DetailDescription> <Text>POLITICA DE MODIFICAÇÃO.</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="5" Code="TGRN"> <DetailDescription> <Text>Depósito bancário de 70% do valor das diárias 10 dias antes do check-in. Cartao de credito ou garantia de agencia de viagens</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="6" Code="TPRE"> <DetailDescription> <Text>x</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="8" Code="CHKIN"> <DetailDescription> <Text>Só é permitido efetuar check-in após as 15:00 horas</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="8" Code="CHKOUT"> <DetailDescription> <Text>O check-out deverá ser efetuado no máximo até as 18:00 horas</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="14" Code="TCHIL"> <DetailDescription> 54 Especificações do Web Service CMNet – versão 3.3 <Text>POLITICA DE CRIANÇA</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="14" Code="TOPOL"> <DetailDescription> <Text>x</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="14" Code="PNS"> <DetailDescription> <Text>4</Text> </DetailDescription> </AdditionalDetail> </AdditionalDetails> </RoomType> </RoomTypes> <RoomRates> <RoomRate RoomTypeCode="R01M1"> <Rates> <Rate> <Base AmountBeforeTax="500" CurrencyCode="BRL"/> </Rate> <Rate EffectiveDate="2007-08-10" ExpireDate="2007-08-10"> <Base AmountBeforeTax="500" CurrencyCode="BRL"/> </Rate> </Rates> <RoomRateDescription> <Text>TRF BALCAO</Text> </RoomRateDescription> </RoomRate> </RoomRates> <CancelPenalties> <CancelPenalty> <Deadline AbsoluteDeadline="2004-1201T18:00:00"/> </CancelPenalty> </CancelPenalties> <Discount AmountBeforeTax="-100" CurrencyCode="BRL" DiscountCode="WS_01"> <DiscountReason> <Text/> </DiscountReason> </Discount> <Total AmountAfterTax="509.30" CurrencyCode="BRL"> <Taxes Amount="109.30" CurrencyCode="BRL"> <Tax Amount="40" Type="Exclusive" CurrencyCode="BRL" Code="14"/> <Tax Amount="20" Type="Exclusive" CurrencyCode="BRL" Code="3"/> <Tax Amount="3" Type="Exclusive" CurrencyCode="BRL" Code="18"/> <Tax Amount="46.30" Type="Cumulative" CurrencyCode="BRL" Code="18"/> </Taxes> </Total> <BasicPropertyInfo HotelCode="2125" HotelName="HOTEL MODELO - TUCM"> <Address> <AddressLine>RUA CAMPO SALES, 55</AddressLine> 55 Especificações do Web Service CMNet – versão 3.3 <AddressLine>TIJUCA</AddressLine> <CityName>Cidade De Teste</CityName> <PostalCode>20270210</PostalCode> <StateProv StateCode="RJ"/> <CountryName Code="BR">Brasil</CountryName> </Address> <ContactNumbers> <ContactNumber PhoneUseType="5" PhoneTechType="1" PhoneNumber="21-39786320"/> <ContactNumber PhoneUseType="5" PhoneTechType="3" PhoneNumber="21-22840882"/> </ContactNumbers> </BasicPropertyInfo> </RoomStay> </RoomStays> <ResGlobalInfo> <GuestCounts IsPerRoom="true"> <GuestCount AgeQualifyingCode="10" Count="1"/> </GuestCounts> <TimeSpan Duration="P1D" Start="2007-08-10" End="2007-0811"/> <Comments> <Comment> <Text>TESTE DE RESERVA CÓD.SEG.CARTÃO 1234 [email protected]</Text> </Comment> </Comments> <Guarantee GuaranteeType=”CC/DC/Voucher”> <GuaranteesAccepted> <GuaranteeAccepted> <PaymentCard CardCode="VI" CardNumber="4013713930408799" ExpireDate="0208" SeriesCode="1234"> <CardHolderName>Jose da Silva</CardHolderName> </PaymentCard> </GuaranteeAccepted> </GuaranteesAccepted> </Guarantee> <HotelReservationIDs> <HotelReservationID ResID_Type="14" ResID_Value="20862022" ResID_Date="2007-06-11T13:36:32"/> </HotelReservationIDs> <Profiles> <ProfileInfo> <Profile ProfileType="1"> <Customer> <PersonName> <GivenName>Jose</GivenName> <Surname>da Silva</Surname> </PersonName> <Email EmailType="1">[email protected]</Email> </Customer> </Profile> </ProfileInfo> </Profiles> </ResGlobalInfo> <TPA_Extensions> <Distribuidores> <Distribuidor Code="RIOUCM" Type="AMADEUS" ChainCode="BZ"/> <Distribuidor Code="41361" Type="SABRE" ChainCode="BZ"/> <Distribuidor Code="654321" Type="SABRE" ChainCode="CT"/> <Distribuidor Code="41361" Type="WORLDSP" ChainCode="BZ"/> <Distribuidor Code="12123" Type="GALILEO" ChainCode="AS"/> 56 Especificações do Web Service CMNet – versão 3.3 <Distribuidor Code="2125" Type="CMNET" ChainCode="CM"/> </Distribuidores> </TPA_Extensions> </HotelReservation> </HotelReservations> </OTA_HotelResRS> 2.4.6. Erros Código Descrição 19 Nome faltando ou incompleto 119 Pessoas em demasia no quarto/unidade 136 Data inicial inválida 148 Data de chegada requerida 158 Data de partida requerida 173 Código de agência requerido 175 Senha inválida 242 Número do cartão de crédito inválido ou faltando 244 Endereço de e-mail inválido 281 Reserva requer dados do cartão de crédito 285 Primeiro nome inválido 287 Último nome inválido 313 Faltando dados requeridos: tipo de cartão de crédito 317 Número de telefone inválido 321 Faltando campo requerido 365 Erro no cartão de crédito 389 Tipo inválido de garantia 392 Código de hotel inválido 395 Mensagem inválida de texto 397 Número inválido de adultos 404 Combinação inválida de data inicial/final 405 Retorna Erro de parceiro não reconhecido 431 Data de saída ultrapassa data final 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 906 Se for escolhido o código (TT) - (Todas as Despesas) nenhum outro código pode ser incluido 907 Escolhendo o código (TY) - (Tudo menos bebidas alcoólicas) não pode ser incluido outro código 908 O código do Voucher não existe 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 57 Especificações do Web Service CMNet – versão 3.3 914 Conexão Inválida 915 Time Out limite da chave de conexão 916 Chave de identificação do cliente necessária para a transação 993 A transação de compra através de cartão de crédito não pôde ser efetuada neste momento. Verifique seus dados ou tente mais tarde. 994 Bandeira não inclusa na condição de TEF para este produto. 995 Modificação e cancelamento não permitido para produto com forma de pagamento TEF. 996 Bandeira de cartão não é válida para o produto. 2.5. Consulta de reservas (xmlConsultaReservasHoteis) 2.5.1. Descrição O objetivo deste método é consultar as reservas efetuadas pelo parceiro, cadastradas na base de dados do CMNet. 2.5.2. Requisição (OTA_ReadRQ.xml) Requisição para a consulta de uma reserva: Nível 0 Elemento Atributo OTA_ReadRQ Obrigatório Descrição X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do cliente solicitante. Target PrimaryLangID 1 POS X 2 Source X 3 RequestorID X Type X Identificação do tipo de cliente na OTA Code List (UIT). Opções: “4” – Parceiro ou empresa “5” – Agência de viagens 58 Especificações do Web Service CMNet – versão 3.3 ID X URL Identificação do cliente no CMNet. Se o parceiro quiser trabalhar com agências ou empresas associadas ao CMNet, é necessário colocar aqui o id da agência ou empresa, caso contrário, o id do próprio parceiro. Url do cliente. 1 ReadRequests X 2 ReadRequest X 3 UniqueID Informações sobre a reserva a ser consultada. Identificação da reserva. Type X Identificação do tipo de objeto definido pelo elemento UniqueID na OTA Code List (UIT). O valor utilizado será sempre “14” – Reservation ID X Número da reserva no CMNet. Exemplo: “7901420” Requisição para a consulta de várias reservas: Nível 0 Elemento Atributo OTA_ReadRQ Obrigatório Descrição X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do cliente solicitante. EchoToken Target PrimaryLangID 1 POS X 2 Source X 3 RequestorID X Type ID X Identificação do tipo de cliente na OTA Code List (UIT). Opções: “4” – Parceiro ou empresa “5” – Agência de viagens X Identificação do cliente no CMNet. Se o parceiro quiser trabalhar com agências ou empresas associadas ao CMNet, é necessário colocar aqui o id da agência ou empresa, caso contrário, o id do próprio parceiro. URL Url do cliente. 1 ReadRequests X 2 HotelReadRequest X Informações do hotel onde a reserva foi efetuada. Também é possível realizar a consulta por todas as reservas cadastradas, independente do hotel. Para isso basta omitir os atributos 59 Especificações do Web Service CMNet – versão 3.3 HotelCode e HotelName. HotelCode Filtra a consulta pela identificação do hotel no CMNet. Exemplo: “37456” HotelName Filtra a consulta pelo Nome Fantasia do hotel (ou parte dele). Exemplo: “Hotel Modelo” ChainCode Filtra a consulta pelo código da cadeia hoteleira. Exemplo:”114” 3 CityName Filtra a consulta pelo nome da cidade (ou parte dele). Exemplo: “Rio de Janeiro” 3 UserID Filtra a consulta pelo funcionário que efetuou a reserva. Type Identificação do tipo de perfil na OTA Code List (PRT). Exemplo: “15” - Employee ID Identificação do funcionário no CMNet. Exemplo: “1000” 3 Verification X 4 PersonName 5 GivenName Nome. Exemplo: “José” 5 Surname Sobrenome. Exemplo: “da Silva” 4 ReservationTimeSpan Start End 4 TPA_Extensions 5 CMNET X Informações sobre o período da reserva. X Data de chegada. Exemplo: “2004-12-01” Data de partida. Exemplo: “2004-12-04” Informações adicionais não descritas no padrão OTA, mas que são necessárias ao web service CMNet. StatusRes Identificação do status da reserva. Opções: “0” – Traz todas as reservas “1” – Traz somente as reservas confirmadas “2” – Traz somente as reservas canceladas TypeSearch Identificação do tipo de consulta. Opções: “0” – Consulta pela data de chegada (default) “1” – Consulta pela data de inclusão da reserva 2.5.3. Exemplo de xml de requisição Requisição para a consulta de uma reserva: <?xml version="1.0" encoding="UTF-8"?> <OTA_ReadRQ Version="1.003" EchoToken="1234" TimeStamp="2004-01-01T08:00:00" Target="Test" PrimaryLangID="pt-BR" xmlns="http://www.opentravel.org/OTA/2003/05"> <POS> <Source> <RequestorID Type="4" ID="60227" URL="http://www.site_do_parceiro.com.br"/> </Source> </POS> <ReadRequests> <ReadRequest> <UniqueID Type="14" ID="20862022"/> </ReadRequest> </ReadRequests> </OTA_ReadRQ> 60 Especificações do Web Service CMNet – versão 3.3 Requisição para a consulta de várias reservas: <?xml version="1.0" encoding="UTF-8"?> <OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.003" EchoToken="1234" TimeStamp="2004-01-01T08:00:00" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="4" ID="59982" URL="http://www.site_do_parceiro.com.br"/> </Source> </POS> <ReadRequests> <HotelReadRequest HotelCode="37456" HotelName="Hotel"> <CityName>Cidade de</CityName> <Verification> <PersonName> <GivenName>Jose</GivenName> <Surname>da Silva</Surname> </PersonName> <ReservationTimeSpan Start="2004-12-01" End="2004-12-05"/> <TPA_Extensions> <CMNET StatusRes="1" TypeSearch="0" /> </TPA_Extensions> </Verification> </HotelReadRequest> </ReadRequests> </OTA_ReadRQ> 2.5.4. Resposta (OTA_HotelResRS.xml) Nível 0 Elemento Atributo OTA_HotelResRS 1 POS 2 Source 3 RequestorID Descrição Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do web service CMNet. Type Tipo de provedor do serviço na OTA Code List. O valor retornado será sempre “22” – ERSP (Electronic reservation service provider) 61 Especificações do Web Service CMNet – versão 3.3 3 ID Identificação do provedor do serviço. O valor retornado será sempre “CMNET”. URL Url do provedor do serviço. O valor retornado será sempre “http://www.cmnet.com.br” BookingChannel Informações sobre o canal de distribuição. Type 4 CompanyName 1 Success 1 HotelReservations 2 HotelReservation 3 Identificação da empresa que disponibiliza o serviço. CompanyShortName O valor retornado será sempre “CMNET”. TravelSector Identificação do setor de atuação da empresa na OTA Code List (TVS). O valor retornado será sempre “3” – Hotel Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. Informações sobre a reserva. RoomStayReservation Indica se a reserva é para acomodações. O valor retornado será sempre deste tipo. Opções: “true” ou “false” CreatorID Identificação do sistema responsável pela criação da reserva. Exemplo: “CORPORA” – site Reservas Corporativas CreateDateTime Data de criação. Exemplo: “2004-01-01T08:00:00” LastModifyDateTime Data de modificação. Caso a reserva nunca tenha sido modificada este atributo não será retornado. Exemplo: “2004-01-01T08:00:00” UniqueID 3 RoomStays 4 RoomStay 5 RoomTypes 6 RoomType Tipo do canal de distribuição na OTA Code List (BCT). O valor retornado será sempre “7” – Internet Identificação da reserva. Type Identificação do tipo de objeto definido pelo elemento UniqueID na OTA Code List (UIT). O valor retornado será sempre “14” – Reservation ID Número da reserva no CMNet. Exemplo: “7268618” Informações da acomodação retornada. PromotionCode Cupom de desconto para a reserva. Exemplo: “WS_01” NumberOfUnits Número de unidades retornadas. O valor retornado será sempre “1”. RoomTypeCode Código da acomodação. Exemplo: “N01ST” IsRoom Indica se a acomodação é um quarto de dormir. Opções: “true” ou “false” 7 RoomDescription 8 Text Descrição da acomodação. Exemplo: “SUITE EXECUTIVA” 7 AdditionalDetails Informações adicionais sobre a acomodação. 8 AdditionalDetail Descrição da acomodação. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “4” – Room Information Code Identificação da informação. O valor retornado será sempre “TRMD”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “Quarto de luxo com cama de casal ou duas camas de solteiro, tv a cabo, minibar, mesa de trabalho, ar condicionado, vista lateral para o mar.” 8 AdditionalDetail Políticas de cancelamento. 62 Especificações do Web Service CMNet – versão 3.3 Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “7” – Cancellation Information Code Identificação da informação. O valor retornado será sempre “TCNC”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “Até 24 horas antes da chegada.” 8 AdditionalDetail Políticas de modificação. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “14” – Miscellaneous Information Code Identificação da informação. O valor retornado será sempre “TMDF”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “x.” 8 AdditionalDetail Políticas de garantia. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “5” – Guarantee Information Code Identificação da informação. O valor retornado será sempre “TGRN”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “Depósito bancário de 70% do valor das diárias 10 dias antes do check-in. Cartão de crédito ou garantia de agência de viagens.” 8 AdditionalDetail Políticas de pré-pagamento. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “6” – Deposit Information Code Identificação da informação. O valor retornado será sempre “TPRE”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “x.” 8 AdditionalDetail Políticas de check-in. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “8” – Check in check out Information Code Identificação da informação. O valor retornado será sempre “CHKIN”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “Só é permitido efetuar check-in após as 15:00 hs.” 8 AdditionalDetail Políticas de check-out. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “8” – Check in check out Information Code Identificação da informação. O valor retornado será sempre “CHKOUT”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “O check-out deverá ser efetuado no máximo até as 18:00 hs.” 8 AdditionalDetail Políticas para crianças. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “14” – Miscellaneous Information Code Identificação da informação. O valor retornado será sempre “TCHIL”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “x.” 8 AdditionalDetail Outras políticas. 9 DetailDescription Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “14” – Miscellaneous Information Code Identificação da informação. O valor retornado será sempre “TOPOL”. Detalhes da informação. 63 Especificações do Web Service CMNet – versão 3.3 10 Text Exemplo: “x.” 8 AdditionalDetail Políticas de TEF. Type Identificação do tipo de informação na OTA Code List (ADT). O valor retornado será sempre “5” – Guarantee information Code Identificação da informação. O valor retornado será sempre “TTEF”. 9 DetailDescription Detalhes da informação. 10 Text Exemplo: “x.” 5 RoomRates Informações dos valores da acomodação. 6 RoomRate Só será retornado um elemento deste tipo. RoomTypeCode 7 Rates 8 Rate 9 Base 8 9 Código da acomodação. Exemplo: “N01ST” Valor médio da tarifa. AmountBeforeTax Valor médio das tarifas (sem as taxas). Exemplo: “270” CurrencyCode Código ISO da moeda. Exemplo: “BRL” Valor da tarifa agrupado por período de datas. Caso o valor varie dentro do período escolhido, um novo elemento Rate será criado para cada novo valor. Rate EffectiveDate Data inicial do valor da tarifa. Exemplo: “2006-03-25” ExpireDate Data final do valor da tarifa. Exemplo: “2006-03-28” AmountBeforeTax Valor da tarifa (sem as taxas). CurrencyCode Código ISO da moeda. Exemplo: “BRL” Base 7 RoomRateDescription 8 Text Descrição da acomodação. Exemplo: “TRF BALCAO” 5 CancelPenalties Retorna a data máxima do cancelamento. 6 CancelPenalty 7 Deadline AbsoluteDeadline 5 Discount 6 DiscountReason 7 Text 5 Total Valor da data máxima do cancelamento. Exemplo: “2004-12-01T18:00:00”. Informações sobre o desconto no valor da reserva. AmountBeforeTax Valor do desconto. Exemplo: “-100” CurrencyCode Código ISO da moeda. Exemplo: “BRL” DiscountCode Cupom de desconto para a reserva. Exemplo: “WS_01” Valores da reserva e de taxas de serviço, caso exista alguma. AmountAfterTax Valor da tarifa com taxas. CurrencyCode Código ISO da moeda. Exemplo: “BRL” 64 Especificações do Web Service CMNet – versão 3.3 6 7 5 Taxes Descrição das taxas existentes. Amount Valor total das taxas. Exemplo: “57.10” CurrencyCode Código ISO da moeda. Exemplo: “BRL” Amount Valor da taxa. Exemplo: “38.10” Type Tipo da taxa. Opções: “Inclusive” – Inclusivo “Exclusive” – Exclusivo “Cumulative” – Acumulativo CurrencyCode Código ISO da moeda. Exemplo: “BRL” Code Identificação da taxa na OTA Code List (FTT). Exemplo: “14” – Service charge Tax BasicPropertyInfo Informações básicas sobre o hotel. HotelCode Identificação do hotel no CMNet. Exemplo: “37456” HotelName Nome Fantasia do hotel. Exemplo: “Hotel Modelo” 6 Address Endereço do hotel. 7 AddressLine Endereço. Exemplo: “Campos Sales” 7 AddressLine Bairro, caso se aplique. Exemplo: “Tijuca” 7 CityName Nome da cidade. Exemplo: “Rio de Janeiro” 7 PostalCode CEP. Exemplo: “20270210” 7 StateProv Informação do estado. StateCode 7 CountryName Informação do país. Code 6 ContactNumbers 7 ContactNumber Código do estado. Exemplo: “RJ” Código ISO do país. Exemplo: “BR” Números para contato. PhoneUseType Identificação do tipo de uso na OTA Code List (PUT). O valor retornado será sempre “5” – Contact PhoneTechType Identificação do tipo de tecnologia na OTA Code List (PTT). Opções: “1” – Voice “3” – Fax PhoneNumber Número para contato. Exemplo: “2345678” 3 ResGlobalInfo Informações gerais sobre a reserva. 4 GuestCounts Informações sobre o(s) hóspede(s). 5 IsPerRoom Indica se a quantidade de hóspedes se aplica a todas as acomodações informadas. Sempre será enviada somente uma acomodação por requisição. Opções: “true” ou “false” AgeQualifyingCode Identificação do tipo de hóspede na OTA Code List (AQC). Opções: GuestCount 65 Especificações do Web Service CMNet – versão 3.3 “10” – Adulto “8” – Criança 4 Count Quantidade de adultos ou crianças. Exemplo: “1” Age Idade do hóspede. Este atributo somente será retornado se o hóspede for uma criança. Exemplo: “8” TimeSpan Informações sobre o período da reserva. Duration O período da reserva. Exemplo: “P1D”, onde o valor “1” é referente a quantidade, e o valor “D” é referente a tipo (dias). Start Data de chegada. Exemplo: “2004-12-01” End Data de partida. Exemplo: “2004-12-04” 4 Comments Comentários do(s) hóspede(s). 5 Comment 6 Text Descrição do comentário Exemplo: “Xpto.” 4 Guarantee Garantia da reserva. GuaranteeType 5 Define o tipo de garantia da reserva: - “PrePay” - “CC/DC/Voucher” GuaranteesAccepted 6 GuaranteeAccepted 7 PaymentCard Descreve a forma de pagamento da reserva. Opções: - Cartão de crédito - Faturar para empresa - Pagamento direto no hotel A reserva será paga com cartão de crédito. CardCode Código do cartão de crédito (padrão OTA). Opções: “AX” – American Express “BC” – Bank Card “BL” – Carte Bleu “CB” – Carte Blanche “DC” – Diners Club “DS” – Discover Card “EC” – Eurocard “JC” – JCB Credit Card “MC” – Master Card “TP” – Universal Air Travel Card “VI” – Visa CardNumber Número do cartão de crédito. Exemplo: “1234567897” ExpireDate Data de vencimento. Exemplo: “0208” SeriesCode Código de segurança. Exemplo: “1234” 8 CardHolderName Nome impresso no cartão de crédito. Exemplo: “José da Silva” 7 Voucher A reserva será paga via faturamento para a empresa. SeriesCode Códigos dos tipos de faturamento para a empresa. Opções: “NA” – Alimentação e bebidas não alcoólicas “DI” – Diária “LV” – Lavanderia 66 Especificações do Web Service CMNet – versão 3.3 “TL” – Telefonemas “TT” – Todas as despesas (se estiver marcado, só ele pode ser selecionado) “TU” – Taxa de turismo “CF” – Café da manhã “TY” – Tudo sem bebidas alcoólicas (se estiver marcado, só ele pode ser selecionado) Exemplo: “AN-DI-LV-TL-TU” 7 DirectBill A reserva será paga diretamente no hotel. 4 HotelReservationIDs Coleção de chaves (confirmação e cancelamento) referentes à reserva retornada. 5 HotelReservationID 4 Profiles 5 ProfileInfo 6 Profile ResID_Type Identificação do tipo de chave na OTA Code List (UIT). Opções: “14” – Reservation “15” – Cancellation ResID_Value Número da chave. Exemplo: “7268618” ResID_Date Data de criação da chave. Exemplo: “2004-08-01T08:00:00” ProfileType Identificação do tipo de perfil na OTA Code List (PRT). O valor retornado será sempre “1” – Customer 7 Customer 8 PersonName 9 GivenName Nome. Exemplo: “José” 9 Surname Sobrenome. Exemplo: “da Silva” 8 Email E-mail. EmailType 3 TPA_Extensions 4 TPA_Extension 5 Parameters 6 Identificação do tipo de e-mail na OTA Code List (EAT). O valor retornado será sempre “1” – Personal Informações adicionais não descritas no padrão OTA, mas que são necessárias ao web service CMNet. Parâmetros adicionais da reserva. StatusResHotel Status da reserva no sistema do hotel. Opções: “Cancelamento” “Check-in” “Check-out” “No Show sem cobrança” “No Show com cobrança” DataStatusResHotel Data e hora em que a reserva recebeu o status definido no atributo StatusResHotel. Exemplo: “2004-01-01T08:00:00” Dados do cartão virtual. Esse elemento só será retornado se a forma de pagamento utilizada tiver sido “cartão virtual”. VirtualCard CentroCusto Centro de custo do hóspede em sua empresa. Matricula Matrícula do hóspede em sua empresa. Departamento Departamento do hóspede em sua empresa. RequisicaoViagem Número da requisição de viagem, feita pela empresa do hóspede. AutorizacaoViagem Código de autorização da viagem. 67 Especificações do Web Service CMNet – versão 3.3 ControleAgencia Código de controle da agência reservante. Desconto Valor do desconto praticado pela agência. TextoLivre 1 Warnings 2 Warning 1 Errors 2 Error Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 2.5.5. Exemplo de xml de resposta <?xml version="1.0" encoding="UTF-8"?> <OTA_HotelResRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.003" EchoToken="1234" TimeStamp="2007-06-11T15:20:58" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="22" ID="CMNET" URL="http://www.cmnet.com.br"/> <BookingChannel Type="7"> <CompanyName CompanyShortName="CMNET" TravelSector="3"/> </BookingChannel> </Source> </POS> <Success/> <HotelReservations> <HotelReservation RoomStayReservation="true" CreatorID="WEBSERV" CreateDateTime="2007-06-11T13:36:32"> <UniqueID Type="14" ID="20862022"/> <RoomStays> <RoomStay PromotionCode="WS_01"> <RoomTypes> <RoomType NumberOfUnits="1" RoomTypeCode="R01M1" IsRoom="true"> <RoomDescription> <Text>STANDARD</Text> </RoomDescription> <AdditionalDetails> <AdditionalDetail Type="4" Code="TRMD"> <DetailDescription> <Text>QUARTO STANDARD COM BANHEIRO PRIVATIVO, MINIBAR, TV A CABO, AR CONDICIONADO.</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="7" Code="TCNC"> <DetailDescription> 68 Especificações do Web Service CMNet – versão 3.3 <Text>Até 24 Horas antes da chegada</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="14" Code="TMDF"> <DetailDescription> <Text>POLITICA DE MODIFICAÇÃO.</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="5" Code="TGRN"> <DetailDescription> <Text>Depósito bancário de 70% do valor das diárias 10 dias antes do check-in. Cartao de credito ou garantia de agencia de viagens</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="6" Code="TPRE"> <DetailDescription> <Text>x</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="8" Code="CHKIN"> <DetailDescription> <Text>Só é permitido efetuar check-in após as 15:00 horas</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="8" Code="CHKOUT"> <DetailDescription> <Text>O check-out deverá ser efetuado no máximo até as 18:00 horas</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="14" Code="TCHIL"> <DetailDescription> <Text>POLITICA DE CRIANÇA</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="14" Code="TOPOL"> <DetailDescription> <Text>x</Text> </DetailDescription> </AdditionalDetail> <AdditionalDetail Type="13" Code="TCMM" Amount="10"/> <AdditionalDetail Type="14" Code="PNS"> <DetailDescription> 69 Especificações do Web Service CMNet – versão 3.3 <Text>4</Text> </DetailDescription> </AdditionalDetail> </AdditionalDetails> </RoomType> </RoomTypes> <RoomRates> <RoomRate RoomTypeCode="R01M1"> <Rates> <Rate> <Base AmountBeforeTax="500" CurrencyCode="BRL"/> </Rate> <Rate EffectiveDate="2007-08-10" ExpireDate="2007-08-10"> <Base AmountBeforeTax="500" CurrencyCode="BRL"/> </Rate> </Rates> <RoomRateDescription> <Text>TRF BALCAO</Text> </RoomRateDescription> </RoomRate> </RoomRates> <CancelPenalties> <CancelPenalty> <Deadline AbsoluteDeadline="2004-1201T18:00:00"/> </CancelPenalty> </CancelPenalties> <Discount AmountBeforeTax="-100" CurrencyCode="BRL" DiscountCode="WS_01"> <DiscountReason> <Text/> </DiscountReason> </Discount> <Total AmountAfterTax="509.30" CurrencyCode="BRL"> <Taxes Amount="109.30" CurrencyCode="BRL"> <Tax Amount="40" Type="Exclusive" CurrencyCode="BRL" Code="14"/> <Tax Amount="20" Type="Exclusive" CurrencyCode="BRL" Code="3"/> <Tax Amount="3" Type="Exclusive" CurrencyCode="BRL" Code="18"/> <Tax Amount="46.30" Type="Cumulative" CurrencyCode="BRL" Code="18"/> </Taxes> </Total> <BasicPropertyInfo HotelCode="2125" HotelName="HOTEL MODELO - TUCM"> <Address> <AddressLine>RUA CAMPO SALES, 55</AddressLine> <AddressLine>TIJUCA</AddressLine> <CityName>Cidade De Teste</CityName> <PostalCode>20270210</PostalCode> <StateProv StateCode="RJ"/> <CountryName Code="BR">Brasil</CountryName> </Address> <ContactNumbers> <ContactNumber PhoneUseType="5" PhoneTechType="1" PhoneNumber="21-39786320"/> <ContactNumber PhoneUseType="5" PhoneTechType="3" PhoneNumber="21-22840882"/> </ContactNumbers> </BasicPropertyInfo> </RoomStay> 70 Especificações do Web Service CMNet – versão 3.3 </RoomStays> <ResGlobalInfo> <GuestCounts IsPerRoom="true"> <GuestCount AgeQualifyingCode="10" Count="1"/> </GuestCounts> <TimeSpan Duration="P1D" Start="2007-08-10" End="2007-0811"/> <Comments> <Comment> <Text>TESTE DE RESERVA CÓD.SEG.CARTÃO 1234 [email protected]</Text> </Comment> </Comments> <Guarantee GuaranteeType=”CC/DC/Voucher”> <GuaranteesAccepted> <GuaranteeAccepted> <PaymentCard CardCode="VI" CardNumber="4013713930408799" ExpireDate="0208" SeriesCode="1234"> <CardHolderName>Jose da Silva</CardHolderName> </PaymentCard> </GuaranteeAccepted> </GuaranteesAccepted> </Guarantee> <HotelReservationIDs> <HotelReservationID ResID_Type="14" ResID_Value="20862022" ResID_Date="2007-06-11T13:36:32"/> </HotelReservationIDs> <Profiles> <ProfileInfo> <Profile ProfileType="1"> <Customer> <PersonName> <GivenName>Jose</GivenName> <Surname>da Silva</Surname> </PersonName> <Email EmailType="1">[email protected]</Email> </Customer> </Profile> </ProfileInfo> </Profiles> </ResGlobalInfo> <TPA_Extensions> <TPA_Extension> <Parameters/> </TPA_Extension> </TPA_Extensions> </HotelReservation> </HotelReservations> </OTA_HotelResRS> 2.5.6. Erros Código Descrição 148 Data de chegada requerida 173 Código de agência requerido 175 Senha inválida 284 Reservas não localizadas nos critérios de busca 321 Faltando campo requerido 404 Combinação inválida de data inicial/final 405 Retorna Erro de parceiro não reconhecido 448 Retorna Erro de problema no sistema 71 Especificações do Web Service CMNet – versão 3.3 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 914 Conexão Inválida 915 Time Out limite da chave de conexão 916 Chave de identificação do cliente necessária para a transação 2.6. Cancelamento de reservas (xmlCancelaReservaHotel) 2.6.1. Descrição O objetivo deste método é efetuar o cancelamento de reservas (uma reserva por requisição). 2.6.2. Requisição (OTA_CancelRQ.xml) Nível Elemento 0 OTA_CancelRQ Atributo Obrigatório Descrição X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção CancelType X Identificação do tipo de ação requisitada. O valor utilizado será sempre “Initiate”. X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do cliente solicitante. EchoToken PrimaryLangID 1 POS X 2 Source X 3 RequestorID X Type X Identificação do tipo de cliente na OTA Code List (UIT). Opções: “4” – Parceiro ou empresa “5” – Agência de viagens 72 Especificações do Web Service CMNet – versão 3.3 ID X URL 1 Url do cliente. UniqueID 1 TPA_Extensions 2 WrittenConfInst Identificação do cliente no CMNet. Se o parceiro quiser trabalhar com agências ou empresas associadas ao CMNet, é necessário colocar aqui o id da agência ou empresa, caso contrário, o id do próprio parceiro. X Identificação da reserva. Type X Identificação do tipo de objeto definido pelo elemento UniqueID na OTA Code List (UIT). O valor utilizado será sempre “14” – Reservation ID X Número da reserva no CMNet. Exemplo: “7268618” Número do celular do hóspede para o envio do SMS com a confirmação de cancelamento da reserva. O número do celular deve obedecer o seguinte formato: “DDI+DDD+Celular”. Exempo: “552188776655” Telephone 2.6.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <OTA_CancelRQ xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" EchoToken="12345678" TimeStamp="2004-01-01T08:00:00" Target="Test" CancelType="Initiate" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="4" ID="59982" URL="http://www.site_do_parceiro.com.br"/> </Source> </POS> <UniqueID Type="14" ID="6891196"/> <TPA_Extensions> <WrittenConfInst Telephone=”552188776655” /> </TPA_Extensions> </OTA_CancelRQ> 2.6.4 Resposta (OTA_CancelRS.xml) Nível 0 Elemento Atributo OTA_CancelRS Descrição Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção Status Status do cancelamento solicitado. Opções: “Cancelled” – A reserva foi cancelada com sucesso. “Ignored” – O número da reserva informado não existe no CMNet ou ocorreu um erro durante o cancelamento. “Pending” – Não foi possível cancelar a reserva. Será retornado um alerta (elemento Warnings) com a descrição do problema. 73 Especificações do Web Service CMNet – versão 3.3 PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal 1 Success Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. 1 UniqueID Identificação do cancelamento da reserva. Este elemento só será retornado caso a reserva tenha sido cancelada com sucesso. 1 Type Identificação do tipo de objeto definido pelo elemento UniqueID na OTA Code List (UIT). O valor retornado será sempre “15” – Cancellation ID Número do cancelamento da reserva no CMNet. Exemplo: “7268618” UniqueID 1 Warnings 2 Warning 1 Errors 2 Error Identificação da confirmação de recebimento da requisição. Type Identificação do tipo de objeto definido pelo elemento UniqueID na OTA Code List (UIT). O valor retornado será sempre “14” – Reservation ID Número da reserva no CMNet. Exemplo: “7268618” Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 2.6.5. Exemplo de xml de resposta <?xml version="1.0" encoding="UTF-8"?> <OTA_CancelRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" EchoToken="12345678" TimeStamp="2004-01-01T80:00:00" Target="Test" Status="Cancelled" PrimaryLangID="pt-BR"> <Success/> <UniqueID Type="15" ID="12345678"/> <UniqueID Type="14" ID="87654321"/> </OTA_CancelRS> 2.6.6. Erros Código 173 Descrição Código de agência requerido 74 Especificações do Web Service CMNet – versão 3.3 175 Senha inválida 317 Número de telefone inválido 321 Faltando campo requerido 385 Número de confirmação ou cancelamento inválido 405 Retorna Erro de parceiro não reconhecido 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 914 Conexão Inválida 915 Time Out limite da chave de conexão 916 Chave de identificação do cliente necessária para a transação 2.7. Cartões aceitos pelo hotel (xmlCartoesAceitosHotel) 2.7.1. Descrição O objetivo deste método é trazer os cartões de crédito aceitos por um hotel específico. 2.7.2. Requisição (OTA_HotelDescriptiveInfoRQ.xml) Nível Elemento 0 OTA_HotelDescriptiveInfoRQ Atributo Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal X Identificação do cliente solicitante. PrimaryLangID POS Descrição X Target 1 Obrigatório 75 Especificações do Web Service CMNet – versão 3.3 2 Source X 3 RequestorID X Type ID X Identificação do tipo de cliente na OTA Code List (UIT). Opções: “4” – Parceiro ou empresa “5” – Agência de viagens X Identificação do cliente no CMNet. Se o parceiro quiser trabalhar com agências ou empresas associadas ao CMNet, é necessário colocar aqui o id da agência ou empresa, caso contrário, o id do próprio parceiro. URL Url do cliente. 1 HotelDescriptiveInfos X 2 HotelDescriptiveInfo X Informações do hotel. Só poderá haver um elemento deste tipo na requisição. X Identificação do hotel no CMNet. Exemplo: “37456” X Indica se informações estão sendo requsitadas. X Opções: “true” ou “false” HotelCode 3 Policies SendPolicies 2.7.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <OTA_HotelDescriptiveInfoRQ xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" EchoToken="1234" TimeStamp="2004-0101T08:00:00" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="4" ID="59982" URL="http://www.site_do_parceiro.com.br"/> </Source> </POS> <HotelDescriptiveInfos> <HotelDescriptiveInfo HotelCode="37456"> <Policies SendPolicies="true"/> </HotelDescriptiveInfo> </HotelDescriptiveInfos> </OTA_HotelDescriptiveInfoRQ> 2.7.4. Resposta (OTA_HotelDescriptiveInfoRS.xml) Nível Elemento 0 OTA_HotelDescriptiveInfoRS Atributo Descrição Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. 76 Especificações do Web Service CMNet – versão 3.3 Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal 1 Success 1 HotelDescriptiveContents 2 HotelDescriptiveContent Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. HotelCode 3 Policies 4 Policy 5 PaymentPolicy 6 RequiredPayment Identificação do hotel no CMNet. Exemplo: “37456” Políticas do hotel. Políticas de pagamento do hotel. PaymentCode Identificação da forma de pagamento na OTA Code List (PMT). O valor retornado será sempre “5” – Credit card 7 AcceptedPayments Descreve os cartões de créditos aceitos pelo hotel. 8 AcceptedPayment Será retornado um elemento AcceptedPayment para cada cartão de crédito aceito pelo hotel. 9 PaymentCard Informações do cartão. 1 Warnings 2 Warning 1 Errors 2 Error CardCode Código do cartão de crédito (padrão OTA). Opções: “AX” – American Express “BC” – Bank Card “BL” – Carte Bleu “CB” – Carte Blanche “DC” – Diners Club “DS” – Discover Card “EC” – Eurocard “JC” – JCB Credit Card “MC” – Master Card “TP” – Universal Air Travel Card “VI” – Visa CardType Identificação do tipo de cartão na OTA Code List (CDT). O valor retornado será sempre “1” – Credit Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 77 Especificações do Web Service CMNet – versão 3.3 2.7.5. Exemplo de xml de resposta <?xml version="1.0" encoding="UTF-8"?> <OTA_HotelDescriptiveInfoRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 http://www.opentravel.org/2004B/OTA_HotelDescriptiveInfoRS.xsd" Version="1.0" EchoToken="1234" TimeStamp="2004-01-01T08:00:00" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="22" ID="CMNET" URL="http://www.cmnet.com.br"/> <BookingChannel Type="7"> <CompanyName CompanyShortName="CMNET" TravelSector="3"/> </BookingChannel> </Source> </POS> <Success/> <HotelDescriptiveContents> <HotelDescriptiveContent HotelCode="37456"> <Policies> <Policy> <PaymentPolicy> <RequiredPayment PaymentCode="5"> <AcceptedPayments> <AcceptedPayment> <PaymentCard CardCode="VI" CardType="1"/> </AcceptedPayment> <AcceptedPayment> <PaymentCard CardCode="MC" CardType="1"/> </AcceptedPayment> </AcceptedPayments> </RequiredPayment> </PaymentPolicy> </Policy> </Policies> </HotelDescriptiveContent> </HotelDescriptiveContents> </OTA_HotelDescriptiveInfoRS> 2.7.6. Erros Código Descrição 173 Código de agência requerido 175 Senha inválida 321 Faltando campo requerido 392 Código de hotel inválido 405 Retorna Erro de parceiro não reconhecido 425 Combinação não localizada 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 78 Especificações do Web Service CMNet – versão 3.3 914 Conexão Inválida 915 Time Out limite da chave de conexão 2.8. Consulta do cadastro de uma agência ou empresa (xmlCadastroAgEmp) 2.8.1. Descrição O objetivo deste método é trazer as informações cadastrais de uma agência de viagens ou empresa no CMNet. 2.8.2. Requisição (OTA_ReadRQ.xml) Nível 0 Elemento Atributo OTA_ReadRQ Obrigatório X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do cliente solicitante. Target PrimaryLangID 1 POS X 2 Source X 3 RequestorID X Type ID X Identificação do tipo de cliente na OTA Code List (UIT). Opções: “4” – Parceiro ou empresa “5” – Agência de viagens X Identificação do cliente no CMNet. Se o parceiro quiser trabalhar com agências ou empresas associadas ao CMNet, é necessário colocar aqui o id da agência ou empresa, caso contrário, o id do próprio parceiro. URL 1 Descrição UniqueID Url do cliente. X Type X Identificação do tipo de objeto definido pelo elemento UniqueID na OTA Code List (UIT). O valor utilizado será sempre “21” – Profile 79 Especificações do Web Service CMNet – versão 3.3 ID X Identificação da agência de viagens ou empresa no CMNet. Exemplo: “12345678901234” Id_Context X Identificação do tipo de valor fornecido no atributo ID. O valor utilizado será sempre “CNPJ” 2.8.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 http://www.opentravel.org/2004B/OTA_ReadRQ.xsd" Version="1.003" EchoToken="1234" TimeStamp="2005-07-07T08:00:00" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="4" ID="59982" URL="http://www.site_do_parceiro.com.br"/> </Source> </POS> <UniqueID Type="21" ID="12345678" ID_Context="CNPJ"/> </OTA_ReadRQ> 2.8.4. Resposta (OTA_ProfileReadRS.xml) Nível Elemento 0 OTA_ProfileReadRS Atributo Descrição Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal 1 Success Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. 1 Profiles Informações sobre a agência de viagens ou empresa retornada. 2 ProfileInfo 3 UniqueID Type Tipo de perfil na OTA Code List (UIT). Opções: “4” – Company “5” – Travel agency “18” – Other ID Identificação no CMNet. Exemplo: “12345678” 80 Especificações do Web Service CMNet – versão 3.3 3 Profile 4 CompanyInfo 5 CompanyName 5 AddressInfo 6 AddressLine Endereço. Exemplo: “Campos Sales” 6 AddressLine Bairro, caso se aplique. Exemplo: “Tijuca” 6 CityName Nome da cidade. Exemplo: “Rio de Janeiro” 6 PostalCode CEP. Exemplo: “20270210” 6 StateProv Informação do estado. StateCode 6 5 Código do estado. Exemplo: “RJ” Informação do país. Exemplo: “Brasil” CountryName Code Código ISO do país. Exemplo: “BR” PhoneTechType Identificação do tipo de tecnologia na OTA Code List (PTT). Opções: “1” – Voice “3” – Fax PhoneUseType Identificação do tipo de uso na OTA Code List (PUT). O valor retornado será sempre “5” – Contact CountryAccessCode DDI. Este atributo só será retornado caso o DDI tenha sido cadastrado no CMNet. Exemplo: “55” AreaCityCode DDD. Este atributo só será retornado caso o DDD tenha sido cadastrado no CMNet. Exemplo: “21” PhoneNumber Número para contato. Exemplo: “2345678” TelephoneInfo 1 Warnings 2 Warning 1 Errors 2 Error Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 2.8.5. Exemplo de xml de resposta <?xml version="1.0" encoding="UTF-8"?> 81 Especificações do Web Service CMNet – versão 3.3 <OTA_ProfileReadRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 http://www.opentravel.org/2004B/OTA_ProfileReadRS.xsd" Version="1.003"> <Success/> <Profiles> <ProfileInfo> <UniqueID Type="5" ID="12345678"/> <Profile> <CompanyInfo> <CompanyName>CM SOLUCOES INFORMATICA LTDA</CompanyName> <AddressInfo> <AddressLine>Campos Sales</AddressLine> <AddressLine>TIJUCA</AddressLine> <CityName>Rio de Janeiro</CityName> <PostalCode>20510-270</PostalCode> <StateProv StateCode="RJ">Rio de Janeiro</StateProv> <CountryName Code="BR">Brasil</CountryName> </AddressInfo> <TelephoneInfo PhoneNumber="12345678" AreaCityCode="21" CountryAccessCode="55" PhoneTechType="1"/> <TelephoneInfo PhoneNumber="12345678" AreaCityCode="21" CountryAccessCode="55" PhoneTechType="3"/> </CompanyInfo> </Profile> </ProfileInfo> </Profiles> </OTA_ProfileReadRS> 2.8.6. Erros Código Descrição 173 Código de agência requerido 175 Senha inválida 367 Formato inválido 405 Retorna Erro de parceiro não reconhecido 425 Combinação não localizada 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 914 Conexão Inválida 915 Time Out limite da chave de conexão 2.9. Consulta de pontos de interesse (xmlConsultaRefPoints) 2.9.1. Descrição 82 Especificações do Web Service CMNet – versão 3.3 O objetivo deste método é disponibilizar uma lista de posições (latitude e longitude) dos pontos de interesse disponíveis no CMNet, de acordo com os critérios informados pelo cliente. A posição de um ponto de interesse pode ser utilizada na consulta de disponibilidade de hotéis (xmlConsultaDispHotelValorDiaDia). 2.9.2. Requisição (CMNET_RefPointRQ.xml) Nível 0 Elemento Atributo CMNET_RefPointRQ Obrigatório Descrição X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Target PrimaryLangID 1 Criteria X Critérios da consulta. 2 Criterion X Só é aceito um elemento deste tipo. 3 RefPoint X Descrição do tipo de ponto de interesse a ser pesquisado. Exemplo: “Praia” ChainCode Filtra a consulta pela identificação da cadeia de hotéis no CMNet. Para buscar por pontos de interesse localizados nas mesmas cidades de hotéis pertencentes a determinada cadeia basta informar o código da cadeia e omitir o atributo CityCode. Exemplo: “114” CityCode Filtra a consulta pelo código ISO da cidade. Para buscar por pontos de interesse em uma determinada cidade basta informar o código da cidade e omitir o atributo ChainCode. Exemplo: “RIO” 2.9.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <CMNET_RefPointRQ Version="1.0" EchoToken="12345678" Target="Test" TimeStamp="2004-01-01T80:00:00" PrimaryLangID="pt-BR" xmlns="http://www.cmnet/xmlwebservices2/"> <Criteria> <Criterion> <RefPoint ChainCode="338" CityCode="RIO">Praia</RefPoint> </Criterion> </Criteria> </CMNET_RefPointRQ> 83 Especificações do Web Service CMNet – versão 3.3 2.9.4. Resposta (CMNET_RefPointRS.xml) Nível Elemento 0 CMNET_RefPointRS 1 POS 2 Source 3 RequestorID 3 Atributo Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do web service CMNet. Type Tipo de provedor do serviço na OTA Code List. O valor retornado será sempre “22” – ERSP (Electronic reservation service provider) ID Identificação do provedor do serviço. O valor retornado será sempre “CMNET”. URL Url do provedor do serviço. O valor retornado será sempre “http://www.cmnet.com.br” BookingChannel Informações sobre o canal de distribuição. Type 4 Descrição CompanyName Tipo do canal de distribuição na OTA Code List (BCT). O valor retornado será sempre “7” – Internet Identificação da empresa que disponibiliza o serviço. CompanyShortName O valor retornado será sempre “CMNET”. TravelSector Identificação do setor de atuação da empresa na OTA Code List (TVS). O valor retornado será sempre “3” – Hotel 1 Success Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. 1 RefPoints Pontos de interesse. 2 RefPoint Será retornado um novo elemento RefPoint para cada ponto de interesse disponível. Exemplo: “Praia da Joaquina” CityCode Código ISO da cidade. Exemplo: “FLN” CityName Nome da cidade. Exemplo: “Florianópolis” Latitude Exemplo: “-100221” Longitude Exemplo: “175145” Country Nome do país. Exemplo: “Brasil” CountryCode Código ISO do país. 84 Especificações do Web Service CMNet – versão 3.3 Exemplo: “BR” 1 Warnings 2 Warning 1 Errors 2 Error Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 2.9.5. Exemplo de xml de resposta <?xml version="1.0" encoding="UTF-8"?> <CMNET_RefPointRS xmlns="http://www.cmnet/xmlwebservices2/" Version="1.0" EchoToken="12345678" TimeStamp="2007-05-30T15:35:01" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="22" ID="CMNET" URL="http://www.cmnet.com.br"/> <BookingChannel Type="7"> <CompanyName CompanyShortName="CMNET" TravelSector="3"/> </BookingChannel> </Source> </POS> <Success/> <RefPoints> <RefPoint CityCode="FLN" CityName="Florianopolis" Latitude="-100221" Longitude="175145" Country="Brasil" CountryCode="BR">Praia da Joaquina</RefPoint> <RefPoint CityCode="FLN" CityName="Florianopolis" Latitude="-99090" Longitude="175522" Country="Brasil" CountryCode="BR">Praia do Jurere</RefPoint> <RefPoint CityCode="FLN" CityName="Florianopolis" Latitude="-99468" Longitude="174449" Country="Brasil" CountryCode="BR">Praia Mole</RefPoint> <RefPoint CityCode="FLN" CityName="Florianopolis" Latitude="-99617" Longitude="174761" Country="Brasil" CountryCode="BR">Praia Forte</RefPoint> <RefPoint CityCode="FLN" CityName="Florianopolis" Latitude="-100836" Longitude="174826" Country="Brasil" CountryCode="BR">Praia da Armacao</RefPoint> <RefPoint CityCode="FLN" CityName="Florianopolis" Latitude="-98868" Longitude="174975" Country="Brasil" CountryCode="BR">Praia Brava</RefPoint> <RefPoint CityCode="FLN" CityName="Florianopolis" Latitude="-98943" Longitude="174774" Country="Brasil" CountryCode="BR">Praia dos Ingleses</RefPoint> <RefPoint CityCode="GRU" CityName="Guaruja" Latitude="-86958" Longitude="166987" Country="Brasil" CountryCode="BR">Praia Asturias</RefPoint> <RefPoint CityCode="SSA" CityName="Salvador" Latitude="-46696" Longitude="138639" Country="Brasil" CountryCode="BR">Praia do Forte</RefPoint> <RefPoint CityCode="JPA" CityName="Joao Pessoa" Latitude="-25614" Longitude="-125497" Country="Brasil" CountryCode="BR">Praia do Jacaré</RefPoint> <RefPoint CityCode="JPA" CityName="Joao Pessoa" Latitude="-25614" Longitude="-125497" Country="Brasil" CountryCode="BR">Praia de Jacaré</RefPoint> <RefPoint CityCode="JPA" CityName="Joao Pessoa" Latitude="-25614" Longitude="125507" Country="Brasil" CountryCode="BR">Praia de Tambaba</RefPoint> <RefPoint CityCode="FOR" CityName="Fortaleza" Latitude="-13382" Longitude="138755" Country="Brasil" CountryCode="BR">Praia Canoa Quebrada</RefPoint> <RefPoint CityCode="FOR" CityName="Fortaleza" Latitude="-13382" Longitude="138755" Country="Brasil" CountryCode="BR">Praia do Meireles</RefPoint> <RefPoint CityCode="FOR" CityName="Fortaleza" Latitude="-13382" Longitude="138755" Country="Brasil" CountryCode="BR">Praia do Futuro</RefPoint> 85 Especificações do Web Service CMNet – versão 3.3 <RefPoint CityCode="FOR" CityName="Fortaleza" Latitude="-13382" Longitude="138755" Country="Brasil" CountryCode="BR">Praia de Iracema</RefPoint> <RefPoint CityCode="MRG" CityName="Maragogi" Latitude="-32100" Longitude="126540" Country="Brasil" CountryCode="BR">Praia do Peroba</RefPoint> <RefPoint CityCode="MRG" CityName="Maragogi" Latitude="-32100" Longitude="126540" Country="Brasil" CountryCode="BR">Praia de Burgalhau</RefPoint> <RefPoint CityCode="IPO" CityName="Ipojuca" Latitude="-31472" Longitude="130802" Country="Brasil" CountryCode="BR">Praia de Porto de Galinhas</RefPoint> <RefPoint CityCode="MRG" CityName="Maragogi" Latitude="-32100" Longitude="126540" Country="Brasil" CountryCode="BR">Praia de São Bento</RefPoint> <RefPoint CityCode="MRG" CityName="Maragogi" Latitude="-32100" Longitude="126540" Country="Brasil" CountryCode="BR">Praia de Japaratinga</RefPoint> <RefPoint CityCode="MRG" CityName="Maragogi" Latitude="-32100" Longitude="126540" Country="Brasil" CountryCode="BR">Praia de Barreiras do Boqueirão</RefPoint> </RefPoints> </CMNET_RefPointRS> 2.9.6. Erros Código Descrição 175 Senha inválida 321 Faltando campo requerido 405 Retorna Erro de parceiro não reconhecido 425 Combinação não localizada 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 914 Conexão Inválida 915 Time Out limite da chave de conexão 2.10. Consulta de informações de hotéis (xmlRetornaInfoHotel) 2.10.1. Descrição O objetivo deste método é consultar as informações dos hotéis cadastrados na base de dados do CMNet. 2.10.2. Requisição (CMNET_HotelInfoRQ.xml) Nível Elemento 0 CMNET_HotelInfoRQ Atributo Obrigatório Descrição X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml. Exemplo: “1.0” EchoToken X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. 86 Especificações do Web Service CMNet – versão 3.3 Exemplo: “12346578” Target PrimaryLangID X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal 1 HotelInfos X 2 HotelInfo X Para cada hotel a ser consultado é necessário criar um novo elemento HotelInfo. X Identificação do hotel no CMNet. Exemplo: “37456” HotelCodeID 3 3 3 InfoHotel Informações gerais do hotel. SendEndereco Indica se as informações referentes ao endereço devem ser retornadas. Opções: “true” ou “false” (default) SendInfoPropriedade Indica se as informações referentes à propriedade devem ser retornadas. Opções: “true” ou “false” (default) SendServicos Indica se as informações referentes à serviços oferecidos devem ser retornadas. Opções: “true” ou “false” (default) InfoFacilidades Facilidades do hotel. SendSalaReuniao Indica se as informações referentes à salas de reunião devem ser retornadas. Opções: “true” ou “false” (default) SendRestaurantes Indica se as informações referentes à restaurantes devem ser retornadas. Opções: “true” ou “false” (default) InfoPoliticas Políticas do hotel. SendPoliticas 3 3 InfoAreas Indica se as informações referentes à políticas devem ser retornadas. Opções: “true” ou “false” (default) Localizações próximas ao hotel. SendPontosProximos Indica se as informações referentes à pontos próximos devem ser retornadas. Opções: “true” ou “false” (default) SendTransportes Indica se as informações referentes à transportes devem ser retornadas. Opções: “true” ou “false” (default) SendDirecoesCaminhos Indica se as informações referentes à percursos de pontos específicos até o hotel devem ser retornadas. Opções: “true” ou “false” (default) InfoAfiliacoes Todo tipo de afiliação existente. SendSistemaDistribuicao Indica se as informações referentes à sistemas de distribuição com os quais o hotel trabalha devem ser retornadas. Opções: “true” ou “false” (default) SendMarcasAfiliadas Indica se as informações referentes à marcas afiliadas ao hotel devem ser retornadas. Opções: “true” ou “false” (default) 87 Especificações do Web Service CMNet – versão 3.3 3 SendProgramaFidelidade Indica se as informações referentes à programas de fidelidade com os quais o hotel trabalha devem ser retornadas. Opções: “true” ou “false” (default) SendPremios Indica se as informações referentes à prêmios ganhos pelo hotel devem ser retornadas. Opções: “true” ou “false” (default) InfoMultimidia Todo tipo de mídia do hotel. Indica se as imagens e fotos do hotel devem ser retornadas. Opções: “true” ou “false” (default) SendGaleriaFotos 2.10.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <CMNET_HotelInfoRQ Version="1.0" EchoToken="12345678" Target="Test" TimeStamp="2005-06-20T80:00:00" PrimaryLangID="pt-BR" xmlns="http://www.cmnet/xmlwebservices2/"> <HotelInfos> <HotelInfo HotelCodeID="37456"> <InfoHotel SendEndereco="true" SendInfoPropriedade="true" SendServicos="true"/> <InfoFacilidades SendSalaReuniao="true" SendRestaurantes="true"/> <InfoPoliticas SendPoliticas="true"/> <InfoAreas SendPontosProximos="true" SendTransportes="true" SendDirecoesCaminhos="true"/> <InfoAfiliacoes SendSistemaDistribuicao="false" SendMarcasAfiliadas="false" SendProgramaFidelidade="false" SendPremios="false"/> <InfoMultimidia SendGaleriaFotos="true"/> </HotelInfo> </HotelInfos> </CMNET_HotelInfoRQ> 2.10.4. Resposta (CMNET_HotelInfoRS.xml) Nível 0 1 Elemento Atributo CMNET_HotelInfoRS POS Descrição Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do web service CMNet. 88 Especificações do Web Service CMNet – versão 3.3 2 Source 3 RequestorID 3 Type Tipo de provedor do serviço na OTA Code List. O valor retornado será sempre “22” – ERSP (Electronic reservation service provider) ID Identificação do provedor do serviço. O valor retornado será sempre “CMNET”. URL Url do provedor do serviço. O valor retornado será sempre “http://www.cmnet.com.br” BookingChannel Informações sobre o canal de distribuição. Type 4 CompanyName 1 Success 1 HotelInfos 2 HotelInfo Tipo do canal de distribuição na OTA Code List (BCT). O valor retornado será sempre “7” – Internet Identificação da empresa que disponibiliza o serviço. CompanyShortName O valor retornado será sempre “CMNET”. TravelSector Identificação do setor de atuação da empresa na OTA Code List (TVS). O valor retornado será sempre “3” – Hotel Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. Nome Nome Fantasia do hotel. Exemplo: “HOTEL DE TESTE CMNET” IDHotel Identificação do hotel no CMNet. Exemplo: “37456” CodHotel Código identificador do hotel no CMNet. Exemplo: “CMH3” CNPJ CNPJ do hotel caso tenha sido cadastrado. 3 InfoHotel Informações gerais do hotel. 4 Endereco 5 Logradouro Exemplo: “Campos Sales” 5 Bairro Exemplo: “Tijuca” 5 Cep Exemplo: “20270210” 5 Cidade Exemplo: “Rio de Janeiro” 5 Estado Exemplo: “RJ” 5 Pais Exemplo: “Brasil” 5 Telefone Exemplo: “21-39786300” 5 Fax Exemplo: “21-22840882” 5 Urlfachada Url para foto da fachada do hotel. Exemplo: “http://www.cmnet.com.br/images2/37456_FACH_Fachada Noite.jpg” 5 DescricaoDoHotel Exemplo: “O MELHOR 5 ESTRELAS DA CIDADE.” 4 InformacoesDaPropriedade 5 Localizacao Descrição da localização do hotel. Exemplo: “Aeroporto” 5 Latitude Latitude do hotel. Exemplo: “-82507,28” 5 Longitude Longitude do hotel. Exemplo: “-155582,26” 5 EstiloArquitetonico Exemplo: “Moderno” 89 Especificações do Web Service CMNet – versão 3.3 5 Categoria Exemplo: “Luxo” 5 Estrelas Exemplo: “5” 5 PropriedadePrimaria Propriedade primária na qual o hotel se enquadra. Exemplo: “HOTEL” 5 PropriedadeSecundaria Propriedade secundária na qual o hotel se enquadra. Exemplo: “HOTEL DE CHARME” 5 AnoConstrucao Exemplo: “2004” 5 AnoUltimaReforma Exemplo: “2005” 5 TotalUH Total de acomodações Exemplo: “300” 5 Pavimentos Total de pavimentos. Exemplo: “3” 5 UHADA Quantidade de acomodações que estão de acordo com a ADA (Americans with Disabilities Act). Exemplo: “300” 5 PossuiSuites Indica se o hotel possui suítes. Opções: “true” ou “false” 5 QtdSuites Quantidade de suítes. Exemplo: “10” 5 QtdUnidadesSeparadas Quantidade de unidades separadas do hotel. Exemplo: “50” 5 QtdElevadores Quantidade de elevadores. Exemplo: ”10” 5 QtdRestaurantes Quantidade de restaurantes. Exemplo: “4” 5 AlugCarros Indica se o hotel oferece aluguel de carros. Opções: “true” ou “false” 5 PrecisaReservarCarro Indica se é necessário fazer reserva do carro. Opções: “true” ou “false” 5 Estacionamento Indica se o hotel possui estacionamento. Opções: “true” ou “false” 5 EstacionamentoPago Indica se o estacionamento é pago. Opções: “true” ou “false” 5 ValorDoEstacionamento Exemplo: “45” 5 Moeda Exemplo: “Real” 5 AceitaAnimaisDeEstimacao Indica se o hotel aceita animais de estimação. Opções: “true” ou “false” 5 AcomSepAnimais Indica se existem acomodações separadas para animais de estimação. Opções: “true” ou “false” 5 AnimaisMedAviso Indica se o hotel aceita animais de estimação mediante aviso e acordo antecipado. Opções: “true” ou “false” 5 ExisteCobrancaPorAnimal Indica se o hotel possui cobrança extra para permitir animais de estimação. Opções: “true” ou “false” 5 PossuiCaoGuia Indica se o hotel possui cão guia (ou outro animal) que permita prover assistência. Opções: “true” ou “false” 5 PensaoCompleta Indica se o hotel oferece pensão completa. Opções: “true” ou “false” 5 ExisteAndarParaDeficente Indica se o hotel possui andar para deficientes físicos. Opções: “true” ou “false” 5 ExisteAndarParaFumante Indica se o hotel possui andar para fumantes. Opções: “true” ou “false” 5 ServicosPrestados Descrição dos serviços prestados. Exemplo: “ROOM SERVICE E MASSAGEM 24HS.” 90 Especificações do Web Service CMNet – versão 3.3 Descrição das facilidades. Exemplo: “TRANSLADO AEROPORTO, CENTO COMERCIAL E LAZER.” 5 FacilidadesDoHotel 4 Servicos 5 Hotel Serviços do hotel. 6 ItemHotel Será retornado um novo elemento ItemHotel para cada serviço disponível. Nome Exemplo: “Aluguel de carro” UrlIcone Url para ícone do serviço. Exemplo: “http://www.cmnet.com.br/images2/37456_FACH_Fachada Noite.jpg” DisponivelParaHospede Indica se o serviço está disponível para todos os hóspedes. Opções: “true” ou “false” ExisteCobranca Indica se existe algum tipo de cobrança. Opções: “true” ou “false” PeriodoDisponivel Período em que o serviço está disponível ou uma observação. 5 Quartos Características e confortos das acomodações. 6 ItemQuarto Será retornado um novo elemento ItemQuarto para cada serviço disponível. Nome Exemplo: “Banheira grande” UrlIcone Url para ícone do serviço. Exemplo: “http://www.cmnet.com.br/images2/37456_FACH_Fachada Noite.jpg” DisponivelTodaUHAlguma Indica se o serviço está disponível para todas as acomodações ou somente para algumas. Opções: “Alguma” ou “Todas” ExisteCobranca Indica se existe algum tipo de cobrança. Opções: “true” ou “false” 5 DeficientesFisicos Serviços para deficientes físicos. 6 ItemDeficienteFisico Será retornado um novo elemento ItemDeficienteFisico para cada serviço disponível. 5 6 5 6 Nome Exemplo: “Acento para banheira” UrlIcone Url para ícone do serviço. Exemplo: “http://www.cmnet.com.br/images2/37456_FACH_Fachada Noite.jpg” ExisteTaxaParaEsteServico Indica se existe algum tipo de cobrança. Opções: “true” ou “false” Seguranca Serviços para segurança. ItemSeguranca Será retornado um novo elemento ItemSeguranca para cada serviço disponível. Nome Exemplo: “Alarme de fumaça com isolamento reforçado” UrlIcone Url para ícone do serviço. Exemplo: “http://www.cmnet.com.br/images2/37456_FACH_Fachada Noite.jpg” Recreacao Serviços para recreação. ItemRecreacao Será retornado um novo elemento ItemRecreacao para cada serviço disponível. Nome Exemplo: “Piscina” UrlIcone Url para ícone do serviço. Exemplo: “http://www.cmnet.com.br/images2/37456_FACH_Fachada Noite.jpg” 91 Especificações do Web Service CMNet – versão 3.3 DentroHotel Indica se o serviço é oferecido dentro do hotel. Opções: “true” ou “false” ExisteCobranca Indica se existe algum tipo de cobrança. Opções: “true” ou “false” DisponivelParaHospede Indica se o serviço está disponível para todos os hóspedes. Opções: “true” ou “false” 5 Negocios Serviços para negócios. 6 ItemNegocio Será retornado um novo elemento ItemNegocio para cada serviço disponível. Nome Exemplo: “Aluguel de equipamento áudio-visual” UrlIcone Url para ícone do serviço. Exemplo: “http://www.cmnet.com.br/images2/37456_FACH_Fachada Noite.jpg” DisponivelNaPropriedade Indica se o serviço está disponível dentro da propriedade. Opções: “true” ou “false” DisponivelParaHospede Indica se o serviço está disponível para todos os hóspedes. Opções: “true” ou “false” ExisteCobranca Indica se existe algum tipo de cobrança. Opções: “true” ou “false” 5 Pessoais Serviços pessoais. 6 ItemPessoal Será retornado um novo elemento ItemPessoal para cada serviço disponível. Nome Exemplo: “Casa de Câmbio / Banco” UrlIcone Url para ícone do serviço. Exemplo: “http://www.cmnet.com.br/images2/37456_FACH_Fachada Noite.jpg” DisponivelNaPropriedade Indica se o serviço está disponível dentro da propriedade. Opções: “true” ou “false” DisponivelParaHospede Indica se o serviço está disponível para todos os hóspedes. Opções: “true” ou “false” AlgumaTaxaParaEsteServico Indica se existe algum tipo de cobrança. Opções: “true” ou “false” 5 Reuniao Serviços para reuniões. 6 ItemReuniao Será retornado um novo elemento ItemReuniao para cada serviço disponível. Nome Exemplo: “Espaço para conferência” 3 InfoFacilidades Facilidades do hotel. 4 SalaReuniao Salas de reunião / Salões. 5 ItemSalaReuniao Será retornado um novo elemento ItemSalaReuniao para cada sala disponível. Nome Exemplo: “Sala Azul” Descricao Exemplo: “Equipada para todos os tipos de eventos.” TamanhoMaximo Exemplo: “600m²” AlturaSalao Exemplo: “4,8m” CapacidadeMaximaDeAssentos Exemplo: “250” MinimoPessoasParaAluguel Quantidade mínima de pessoas exigidas para o aluguel. Exemplo: “30” EquipamentoAudioVisual Indica se a sala dispõe de equipamento áudio-visual. Opções: “true” ou “false” 6 Formatos Formatos que a sala de reunião / salão comporta. 7 Formato Será retornado um novo elemento Formato para cada formato disponível. 92 Especificações do Web Service CMNet – versão 3.3 Nome Exemplo: “Banquete” MaximoDeAssentos Exemplo: “65” 4 Restaurantes Restaurantes do hotel. 5 Restaurante Será retornado um novo elemento Restaurante para cada formato disponível. Nome Exemplo: ”Juanita” TipoRestaurante Exemplo: “Bar / Lounge” Descricao Exemplo: “Lobby bar aberto 24 horas” CapacidadeMaximaDeAssentos Exemplo: “100” TipoDeCozinha Exemplo: “Americana” TipoDeCozinhaSecundaria Exemplo: “Nacional” ServeRefeicao Tipo de refeição oferecida. Exemplo: “Almoço” TipoRefeicao Tipo de comida oferecida. Exemplo: “Vegetariana” TipoBebida Tipo de bebida oferecida. Exemplo: “Refrigerante” Iguarias Tipo de iguaria / especiaria oferecida pelo hotel. Exemplo: “Comida caseira” LocalizadoDetroDaPropriedade Indica se o restaurante está localizado dentro da propriedade. Opções: “true” ou “false” AtendeSomenteHospedes Indica se o restaurante atende somente a hóspedes. Opções: “true” ou “false” PermiteDebitarContaHospede Indica se o restaurante permite debitar na conta do hóspede. Opções: “true” ou “false” NecessarioFazerReserva Indica se é necessário fazer reserva. Opções: “true” ou “false” AreaFumante Indica se o restaurante possui área para fumantes. Opções: “true” ou “false” ServeCrianca Indica se o restaurante serve refeições para crianças. Opções: “true” ou “false” GuardaRoupaOuVolume Indica se o restaurante possui guarda-roupas ou guardavolumes. Opções: “true” ou “false” 3 InfoPoliticas Políticas do hotel. 4 Politicas 5 Reservas Políticas para reservas. 6 MaximoUHPorReservaIndividual Quantidade máxima de acomodações por reserva individual. Exemplo: “1” 6 MaximoUHPorReservaGrupo Quantidade máxima de acomodações por reserva de grupo. Exemplo: “1” 6 MinimoPernoite Quantidade mínima de pernoites para efetuar uma reserva. Caso o valor retornado seja “0”, não existirá exigência de quantidade mínima. 6 MaximoPernoite Quantidade máxima de pernoites para efetuar uma reserva. Exemplo: “30” 6 ComissaoAgencia Percentual de comissão para agências de viagens. Exemplo: “10” 5 Check-inCheck-out Políticas de check-in e check-out. 6 HorarioMinimoParaCheck-in Horário mínimo para check-in. 93 Especificações do Web Service CMNet – versão 3.3 Exemplo: “13:00” 6 HorarioMinimoParaCheck-out Horário mínimo para check-out. Exemplo: “12:00” 6 DescricaoCheckin Descrição do check-in. Exemplo: “Check-in efetuado após as 13hs.” 6 DescricaoCheckout Descrição do check-out. Exemplo: “Check-out efetuado até as 12h.” 5 TarifarioParaCriancas Políticas tarifárias para crianças. 6 PermiteCriancaNoHotel Indica se o hotel aceita crianças. Opções: “true” ou “false” 6 OfereceCriancaGratis Indica se o hotel aceita crianças grátis. Opções: “true” ou “false” 6 IdadeMaximaCrianca1 Idade máxima para considerar uma criança na faixa 1. Exemplo: “4” 6 IdadeMaximaCrianca2 Idade máxima para considerar uma criança na faixa 2. Exemplo: “4” 6 Descricao Descrição do tarifário. Exemplo: “1 criança grátis por apto com até 7 anos de idade.” 5 DepositoHotel Políticas de depósito. 6 ValorDeposito Valor do depósito. Exemplo: “10” 6 Descricao Descrição do depósito. Exemplo: “Só serão mantidas as reservas que depositarem o valor de 70% das diárias até 10 dias antes da chegada. Somente para reservas de grupos.” 5 TaxasImpostos Políticas de taxas e impostos. 6 TaxaImposto Será retornado um novo elemento TaxaImposto para cada taxa ou imposto disponível. Nome Exemplo: “Taxa de serviço” Imposto Percentual da taxa / imposto. Exemplo: “10” 5 EarlyCheck-inLateCheck-out Políticas de early check-in / late check-out. 6 PermiteEarly Indica se o hotel permite early check-in. Opções: “true” ou “false” 6 CobraEarly Indica se o hotel cobra alguma taxa. Opções: “true” ou “false” 6 PermiteLate Indica se o hotel permite late check-out. Opções: “true” ou “false” 6 CobraLate Indica se o hotel cobra alguma taxa. Opções: “true” ou “false” 6 DescEarly Descrição do early check-in. Exemplo: “Não aceitamos early check-in.” 6 DescLate Descrição do late check-out. Exemplo: “Não aceitamos late check-out.” 5 Camcelamento Políticas de cancelamento. 6 TipoCancelamento Tipo de cancelamento. Exemplo: “Aceita cancelamento até 24 horas antes da chegada.” 6 Descricao Exemplo: “Só serão aceitos cancelamentos com até 24 horas antes da data do check-in.” 5 Garantias Garantias do hotel. 6 Descricao Exemplo: “Depósito bancário de 70% do valor das diárias 10 dias antes do check-in.” 5 TiposPagamentos Tipos de pagamentos aceitos pelo hotel. 94 Especificações do Web Service CMNet – versão 3.3 6 Será retornado um novo elemento Pagamento para cada pagamento disponível. Pagamento Forma Forma de pagamento. Exemplo: “American Express” Garantia Indica se a forma de pagamento é aceita para garantia. Opções: “true” ou “false” Deposito Indica se a forma de pagamento é aceita para depósito. Opções: “true” ou “false” Pagamento Indica se a forma de pagamento é aceita para pagamento. Opções: “true” ou “false” 3 InfoAreas Localizações próximas ao hotel. 4 PontosProximos Informações sobre os pontos próximos ao hotel. 5 PontoProximo Será retornado um novo elemento PontoProximo para cada ponto disponível. Nome Exemplo: “Pão de Açúcar” Descricao Exemplo: “Uma das mais belas vistas do mundo.” DistanciaKM Distância em km. Exemplo: “18,60” DistanciaMI Distância em milhas. Exemplo: “11,50” Transporte Indica se existe serviço de transporte. Opções: “true” ou “false” TransporteGratis Indica se o transporte é gratuito. Opções: “true” ou “false” Valortaxi Custo médio de um táxi do hotel até o ponto. Exemplo: “20” Sigla Sigla da moeda. Exemplo: “R$” Direcao Direção do hotel em relação ao ponto. Exemplo: “SU” DescricaoCaminhoHotelPP Descrição do caminho percorrido do hotel até o ponto. Exemplo: “Seguir pela Av. Presidente Vargas até o final, chegando ao aeroporto Santos Dumont. Seguir as placas de trânsito indicativas para o Pão de Açúcar.” DescricaoCaminhoPPHotel Descrição do caminho percorrido do ponto até o hotel. Exemplo: “Seguir as placas de trânsito indicativas até o aeroporto Santos Dumont e depois pegar a Av. Presidente Vargas até o final.” 4 Transportes Informações sobre os transportes. 5 Transporte Será retornado um novo elemento Transporte para cada transporte disponível. Nome Exemplo: “Táxi” ReservaTransporte Indica se é necessário reservar o transporte. Opções: “true” ou “false” TransportePago Indica se o transporte é pago. Opções: “true” ou “false” ValorDoTransporte Exemplo: “20” Sigla Sigla da moeda. Exemplo: “R$” Moeda Exemplo: “Brazilian Real” 4 DirecoesCaminhos Informações sobre direções e caminhos para o hotel. 5 DirecaoCaminho Será retornado um novo elemento DirecaoCaminho para cada direção ou caminho disponível. DeOnde Opções: “A1” – Aeroporto “A2” – Segundo aeroporto 95 Especificações do Web Service CMNet – versão 3.3 “C” – Centro da cidade “R” – Rodoviária “T” – Trem IATA Código IATA. Exemplo: “SDU” Distancia Distância em quilômetros até o hotel. Exemplo: “7km” Direcao Direção em que o hotel está localizado. Exemplo: “SU” Descricao Exemplo: “Seguir pela Av. Presidente Vargas até o final e dobrar à esquerda na R. Paulo de Frontin. Logo depois dobrar à direita na R. João Paulo I. Seguir em frente até a Pç. Afonso Pena e lá está o nosso hotel.” 3 InfoAfiliacoes Todo tipo de afiliação existente. 4 MarcasAfiliadas Informações sobre as marcas afiliadas ao hotel. 5 MarcaAfiliada Será retornado um novo elemento MarcaAfiliada para cada marca disponível. Nome Exemplo: “CMNet Special 2” TipoAfiliacao Tipo de afiliação. Exemplo: “CMNet Special Member 2” UrlEmpresaAfiliada Url da empresa afiliada. Exemplo: “http://www.cmnet.com.br” MostraLogo Indica se o hotel deseja mostrar o logo da marca afiliada. Opções: “true” ou “false” UrlLogo Url do logo da marca afiliada. Exemplo: “http://www.cmnet.com.br/imagens/logo.gif” 4 SistemaDistribuicao Informações sobre os sistemas de distribuição. 5 ItemSistemaDistribuicao Será retornado um novo elemento ItemSistemaDistribuicao para cada sistema disponível. Nome Exemplo: “Sabre” IdPropriedade Identificação do hotel no sistema de distribuição. Exemplo: “27254” ChainCode Código da rede ou cadeia no sistema de distribuição. Exemplo: “BZ” 4 ProgramaFidelidade Informações sobre os programas de fidelidade do hotel. 5 ItemProgramaFidelidade Será retornado um novo elemento ItemProgramaFidelidade para cada programa disponível. Nome Exemplo: “TAM” ProgramaAfiliado Nome do programa afiliado. Exemplo: “TAM” DescricaoDoPrograma Exemplo: “A cada duas diárias ganhe dois pontos no cartão de fidelidade TAM.” PoliticasRestricoes Políticas e restrições para o programa de fidelidade. Exemplo: “Basta hospedar-se por duas noites consecutivas e o hóspede já possui o direito de receber os pontos no seu cartão TAM.” 4 PremiosClassificacoes Informações sobre prêmios e classificações ganhas pelo hotel. 5 PremioClassificacao Será retornado um novo elemento PremioClassificacao para cada prêmio disponível. 3 InfoMultimidia Nome Exemplo: “Prêmio de Qualidade” Descricao “Prêmio de qualidade pelos serviços do hotel.” Provedor Nome do provedor do prêmio. Exemplo: “Prêmio de Qualidade” AnoRecebimento Exemplo: “2004” Todo tipo de mídia do hotel. 96 Especificações do Web Service CMNet – versão 3.3 4 GaleriaFotos Lista de fotos do hotel. 5 Fachadas Fotos da fachada do hotel. 6 Fachada Será retornado um novo elemento Fachada para cada foto disponível. UrlImagem Url para a imagem. Exemplo: “http://www.cmnet.com.br/images2/foto.jpg” Copyright Exemplo: “CM Soluções Informática Ltda.” TituloImagem Exemplo: “Fachada de dia” Descricao Exemplo: “Fachada do hotel durante o dia.” 5 Acomodacoes Fotos das acomodações do hotel. 6 Acomodacao Será retornado um novo elemento Acomodacao para cada foto disponível. UrlImagem Url para a imagem. Exemplo: “http://www.cmnet.com.br/images2/foto.jpg” Copyright Exemplo: “CM Soluções Informática Ltda.” TituloImagem Exemplo: “Executivo” Descricao Exemplo: “Cama de casal, banheiro privativo com banheira, tv a cabo, mesa de trabalho e todo o conforto da Rede Teste CMNet.” 5 Saloes Fotos das salas de reunião ou salões do hotel. 6 Salao Será retornado um novo elemento Salao para cada foto disponível. UrlImagem Url para a imagem. Exemplo: “http://www.cmnet.com.br/images2/foto.jpg” Copyright Exemplo: “CM Soluções Informática Ltda.” TituloImagem Exemplo: “Salão Azul” Descricao Exemplo: “Sala decorada com móveis de bom gosto e com capacidade para 75 pessoas, totalmente equipada para todo tipo de evento.” 5 Recepcao Fotos da recepção do hotel. 6 ItemRecepcao Será retornado um novo elemento ItemRecepcao para cada foto disponível. UrlImagem Url para a imagem. Exemplo: “http://www.cmnet.com.br/images2/foto.jpg” Copyright Exemplo: “CM Soluções Informática Ltda.” TituloImagem Exemplo: “Recepção” Descricao Exemplo: “Vista detalhada da recepção.” 5 Alimentacao Fotos dos restaurantes do hotel. 6 ItemAlimentacao Será retornado um novo elemento ItemAlimentacao para cada foto disponível. UrlImagem Url para a imagem. Exemplo: “http://www.cmnet.com.br/images2/foto.jpg” Copyright Exemplo: “CM Soluções Informática Ltda.” TituloImagem Exemplo: “Restaurante” Descricao Exemplo: “O melhor restaurante da região, oferecendo serviços diferenciados e cozinha internacional.” 5 Lazer Fotos dos locais de lazer do hotel. 6 ItemLazer Será retornado um novo elemento ItemLazer para cada foto disponível. UrlImagem Url para a imagem. Exemplo: “http://www.cmnet.com.br/images2/foto.jpg” 97 Especificações do Web Service CMNet – versão 3.3 5 Copyright Exemplo: “CM Soluções Informática Ltda.” TituloImagem Exemplo: “Piscina” Descricao Exemplo: “Vista da piscina.” Localizacoes 1 Errors 2 Error Imagens de mapas / localização do hotel. UrlImagem Url para a imagem. Exemplo: “http://www.cmnet.com.br/images2/foto.jpg” Copyright Exemplo: “CM Soluções Informática Ltda.” TituloImagem Exemplo: “Mapa” Descricao Exemplo: “Mapa da região.” Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 2.10.5. Exemplo de xml de resposta <?xml version="1.0" encoding="utf-16"?> <CMNET_HotelInfoRS xmlns="http://www.cmnet/xmlwebservices2/" Version="1.0" EchoToken="12345678" TimeStamp="2005-0620T08:02:00" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="22" ID="CMNET" URL="http://www.cmnet.com.br"/> <BookingChannel Type="7"> <CompanyName CompanyShortName="CMNET" TravelSector="3"/> </BookingChannel> </Source> </POS> <Success/> <HotelInfos> <HotelInfo Nome="HOTEL DE TESTE CM CMNET - CMH3" IDHotel="37456" CodHotel="CMH3"> <InfoHotel> <Endereco> <Logradouro>RUA DR SATAMINI, 710</Logradouro> <Bairro>TIJUCA</Bairro> <Cep>20270210</Cep> <Cidade>Cidade de Teste</Cidade> <Estado>RJ</Estado> <Pais>Brasil</Pais> <Telefone>21-39786300</Telefone> <Fax>21-22840882</Fax> <Urlfachada>http://www.cmnet.com.br/images2/37456_FACH_Fachada Noite.jpg</Urlfachada> <DescricaoDoHotel>MELHOR 5 ESTRELAS DA CIDADE</DescricaoDoHotel> </Endereco> <InformacoesDaPropriedade> <Localizacao>Cidade</Localizacao> <EstiloArquitetonico>Moderno</EstiloArquitetonico> <Categoria>Luxo</Categoria> <PropriedadePrimaria>HOTEL</PropriedadePrimaria> <PropriedadeSecundaria>HOTEL DE CHARME</PropriedadeSecundaria> <AnoConstrucao>2004</AnoConstrucao> <AnoUltimaReforma>2004</AnoUltimaReforma> 98 Especificações do Web Service CMNet – versão 3.3 <TotalUH>300</TotalUH> <Pavimentos>300</Pavimentos> <UHADA>300</UHADA> <PossuiSuites>True</PossuiSuites> <QtdSuites>300</QtdSuites> <QtdUnidadesSeparadas>300</QtdUnidadesSeparadas> <QtdElevadores>6</QtdElevadores> <QtdRestaurantes>2</QtdRestaurantes> <AlugCarros>True</AlugCarros> <PrecisaReservarCarro>True</PrecisaReservarCarro> <Estacionamento>True</Estacionamento> <EstacionamentoPago>True</EstacionamentoPago> <ValorDoEstacionamento>45</ValorDoEstacionamento> <Moeda>Bolivar</Moeda> <AceitaAnimaisDeEstimacao>False</AceitaAnimaisDeEstimacao> <AcomSepAnimais>False</AcomSepAnimais> <AnimaisMedAviso>False</AnimaisMedAviso> <ExisteCobrancaPorAnimal>False</ExisteCobrancaPorAnimal> <PossuiCaoGuia>False</PossuiCaoGuia> <PensaoCompleta>False</PensaoCompleta> <ExisteAndarParaDeficente>True</ExisteAndarParaDeficente> <ExisteAndarParaFumante>True</ExisteAndarParaFumante> <ServicosPrestados>ROOM SERVICE,E MASSAGEM 24HS</ServicosPrestados> <FacilidadesDoHotel>TRASLADO AEROPORTO, CENTRO COMERCIAL, E LAZER.</FacilidadesDoHotel> </InformacoesDaPropriedade> <Servicos> <Hotel> <ItemHotel Nome="Aluguel de Carro" UrlIcone="http://www.cmnet.com.br/hotv/imagens/icones/aluguel_carro.gif" DisponivelParaHospede="True" ExisteCobranca="True" PeriodoDisponivel=""/> </Hotel> <Quartos> <ItemQuarto Nome="Banheira grande" UrlIcone="http://www.cmnet.com.br/hotv/imagens/icones/bathtubovers.gif" DisponivelTodaUHAlguma="Alguma" ExisteCobranca="False"/> </Quartos> <DeficientesFisicos> <ItemDeficienteFisico Nome="Acento para banheira" UrlIcone="http://www.cmnet.com.br/hotv/imagens/icones/bathtubseat.gif" ExisteTaxaParaEsteServico="False"/> </DeficientesFisicos> <Seguranca> <ItemSeguranca Nome="Alarme de fumaça c/ isolamento reforçado" UrlIcone="http://www.cmnet.com.br/hotv/imagens/icones/smokhardwired.gif"/> </Seguranca> <Recreacao> <ItemRecreacao Nome="Piscina" UrlIcone="http://www.cmnet.com.br/hotv/imagens/icones/Piscina.gif" DentroHotel="True" ExisteCobranca="False" DisponivelParaHospede="False"/> </Recreacao> <Negocios> <ItemNegocio Nome="Aluguel de equipamento audio-visual" UrlIcone="http://www.cmnet.com.br/hotv/imagens/icones/avequiprental.gif" DisponivelNaPropriedade="False" DisponivelParaHospede="True" ExisteCobranca="True"/> </Negocios> <Pessoais> <ItemPessoal Nome="Casa de Câmbio/Banco" UrlIcone="http://www.cmnet.com.br/hotv/imagens/icones/Caixas_automáticos.gif" DisponivelNaPropriedade="False" DisponivelParaHospede="False" AlgumaTaxaParaEsteServico="False"/> </Pessoais> <Reuniao> <ItemReuniao Nome="4 salas"/> <ItemReuniao Nome="200 assentos da maior sala"/> <ItemReuniao Nome="900m² o tamanho máximo do maior salão"/> <ItemReuniao Nome="Formato da maior sala: "Forma de U""/> <ItemReuniao Nome="80 assentos da menor sala"/> 99 Especificações do Web Service CMNet – versão 3.3 <ItemReuniao Nome="400m² o tamanho máximo do menor salão"/> <ItemReuniao Nome="2500m² o tamanho total de todos os salões"/> <ItemReuniao Nome="Equipamento audio-visual disponível"/> <ItemReuniao Nome="Vídeo conferência"/> <ItemReuniao Nome="Espaço para exibição"/> <ItemReuniao Nome="Espaço para conferência"/> <ItemReuniao Nome="Espaço para evento"/> <ItemReuniao Nome="Serviço de Buffet"/> </Reuniao> </Servicos> </InfoHotel> <InfoFacilidades> <SalaReuniao> <ItemSalaReuniao Nome="Salão Azul" Descricao="Salão totalmente equipado" TamanhoMaximo="200 m²" AlturaSalao="15 m" CapacidadeMaximaDeAssentos="85" MinimoPessoasParaAluguel="30" EquipamentoAudiovisual="true"> <Formatos> <Formato Nome="Banquete" MaximoDeAssentos="65"/> <Formato Nome="Buffet" MaximoDeAssentos="70"/> </Formatos> </ItemSalaReuniao> </SalaReuniao> <Restaurantes> <Restaurante Nome="Juanita" TipoRestaurante="Bar/Lounge" Descricao="Lobby bar aberto 24 horas" CapacidadeMaximaDeAssentos="100" TipoDeCozinha="Americana" TipoDeCozinhaSecundaria="Nacional" ServeRefeicao="Todas as Refeições" TipoRefeicao="Diversos Tipos" TipoBebida="Todos os Tipos" Iguarias="" LocalizadoDetroDaPropriedade="true" AtendeSomenteHospedes="false" PermiteDebitarContaHospede="true" NecessarioFazerReserva="false" AreaFumante="false" ServeCrianca="true" GuardaRoupaOuVolume="true"/> </Restaurantes> </InfoFacilidades> <InfoPoliticas> <Politicas> <Reservas> <MaximoUHPorReservaIndividual>10</MaximoUHPorReservaIndividual> <MaximoUHPorReservaGrupo>30</MaximoUHPorReservaGrupo> <MinimoPernoite>Sem exigência de mínimo de pernoites para efetuar uma reserva</MinimoPernoite> <MaximoPernoite>90</MaximoPernoite> <ComissaoAgencia>10% de comissão para agências de viagem</ComissaoAgencia> </Reservas> <Check-inCheck-out> <HorarioMinimoParaCheck-in>13:00</HorarioMinimoParaCheck-in> <HorarioMinimoParaCheck-out>12:00</HorarioMinimoParaCheck-out> <DescricaoCheckin>Check-in efetuado após as 13Hs</DescricaoCheckin> <DescricaoCheckout>Check-out efetuado até das 12h</DescricaoCheckout> </Check-inCheck-out> <TarifarioParaCriancas> <PermiteCriancaNoHotel>Permite crianças no hotel</PermiteCriancaNoHotel> <OfereceCriancaGratis>Oferece crianças grátis</OfereceCriancaGratis> <IdadeMaximaCrianca1>4</IdadeMaximaCrianca1> <IdadeMaximaCrianca2>0</IdadeMaximaCrianca2> <Descricao>1 CRIANÇAS GRÁTIS POR APTO COM ATÉ 7 ANOS DE IDADE.PPP</Descricao> </TarifarioParaCriancas> <DepositoHotel> <ValorDeposito>0</ValorDeposito> <Descricao>Só serão mantidas as reservas que depositarem o valor de 70% das diárias até 10 dias antes da chegada . Somente para reservas de grupos</Descricao> </DepositoHotel> <TaxasImpostos> <TaxaImposto Nome="Taxa de serviço" Imposto="10 %"/> <TaxaImposto Nome="Imposto sobre serviços" Imposto="5 %"/> </TaxasImpostos> <EarlyCheck-inLateCheck-out> 100 Especificações do Web Service CMNet – versão 3.3 <PermiteEarly>Não permite early check-in</PermiteEarly> <CobraEarly>Não cobra alguma taxa</CobraEarly> <PermiteLate>Não permite late check-out</PermiteLate> <CobraLate>Não cobra taxa late</CobraLate> <DescEarly>Não aceitamos early check-in</DescEarly> <DescLate>Não aceitamentos late check-out</DescLate> </EarlyCheck-inLateCheck-out> <Camcelamento> <TipoCancelamento>Aceita cancelamento até 24 Horas antes da chegada</TipoCancelamento> <Descricao>SÓ SERÃO ACEITOS CANCELAMENTOS COM ATÉ 24 HORAS ANTES DA DATA DO CHECK-IN.</Descricao> </Camcelamento> <Garantias> <Descricao>Depósito bancário de 70% do valor das diárias 10 dias antes do checkin.</Descricao> </Garantias> <TiposPagamentos> <Pagamento Forma="American Express" Garantia="True" Deposito="True" Pagamento="True"/> </TiposPagamentos> </Politicas> </InfoPoliticas> <InfoAreas> <PontosProximos> <PontoProximo Nome="Pão de Açúcar" Descricao="descricao" DistanciaKM="18,60" DistanciaMI="11,50" Transporte="True" TransporteGratis="True" Valortaxi="20" Sigla="R$" Direcao="SU" DescricaoCaminhoHotelPP="SEGUE PELA AV. PRESIDENTE VARGAS ATÉ O FINAL CHEGANDO AO AEROPORTO SANTOS DUMONT. SEGUE AS PLACAS DE TRANSITO INDICATIVAS PARA O PÃO DE AÇÚCAR." DescricaoCaminhoPPHotel="SEGUE AS PLACAS DE TRANSITO INDICATIVAS ATÉ O AEROPORTO SANTOS DUMONT E DEPOIS PEGA A AV. PRESIDENTE VARGAS ATÉ O FINAL."/> </PontosProximos> <Transportes> <Transporte Nome="0" ReservaTransporte="True" TransportePago="False" ValorDoTransporte="" Sigla="" Moeda=""/> </Transportes> <DirecoesCaminhos> <DirecaoCaminho DeOnde="A1" IATA="SDU" Distancia="7 Km" Direcao="SU" Descricao="SEGUE PELA AV. PRESIDENTE VARGAS ATÉ O FINAL E DOBRA A ESQUERDA NA RUA PAULO DE FRONTIN. LOGO DEPOIS DOBRA A DIREITA NA RUA JOAO PAULO I. SEGUE EM FRENTE ATÉ A PRAÇA AFONSO PENA E LÁ ESTÁ O NOSSO HOTEL."/> </DirecoesCaminhos> </InfoAreas> <InfoAfiliacoes> <MarcasAfiliadas> <MarcaAfiliada Nome="CMNet Special 2" TipoAfiliacao="CMNet Special Member 2" UrlEmpresaAfiliada="www.cmnet.com.br" MostraLogo="False" UrlLogo="NULLNULL"/> </MarcasAfiliadas> <SistemaDistribuicao> <ItemSistemaDistribuicao Nome="Sabre" IdPropriedade="27254" ChainCode="BZ"/> </SistemaDistribuicao> <ProgramaFidelidade> <ItemProgramaFidelidade Nome="TAM" ProgramaAfiliado="TAM" DescricaoDoPrograma="A CADA DUAS DIÁRIAS GANHE DOIS PONTOS NO CARTÃO DE FIDELIDADE TAM." PoliticasRestricoes="BASTA SE HOSPEDAR POR DUAS NOITES CONSECUTIVAS QUE O HÓSPEDE JÁ POSSUI O DIREITO DE RECEBER OS PONTOS NO SEU CARTÃO TAM."/> </ProgramaFidelidade> <PremiosClassificacoes> <PremioClassificacao Nome="PRÊMIO DE QUALIDADE" Descricao="PRÊMIO DE QUALIDADE PELOS SEUS SERVIÇOS" Provedor="PRÊMIO DE QUALIDADE" AnoRecebimento="2003"/> </PremiosClassificacoes> </InfoAfiliacoes> <InfoMultimidia> <GaleriaFotos> <Fachadas> <Fachada UrlImagem="http://www.cmnet.com.br/images2/37456_FACH_Fachada Dia Aerea (2).jpg" Copyright="CM Soluções Informática Ltda." TituloImagem="Fachada de dia" Descricao="Vista da fachada durante o dia"/> </Fachadas> 101 Especificações do Web Service CMNet – versão 3.3 <Acomodacoes> <Acomodacao UrlImagem="http://www.cmnet.com.br/images2/37456_ACOM_Apart 204 copy.jpg" Copyright="CM Soluções Informática Ltda." TituloImagem="Executivo" Descricao="Cama casal, banheiro privativo com banheira, tv a cabo, mesa de trabalho e todo o conforto da Rede Teste CMNet"/> </Acomodacoes> <Saloes> <Salao UrlImagem="http://www.cmnet.com.br/images2/37456_SASR_Salãoazul.jpg" Copyright="CM Soluções Informática Ltda." TituloImagem="Salão Azul" Descricao="Sala decorada com móveis de bom gosto e com capacidade para 75 pessoas, totalmente equipada para todo tipo de evento"/> </Saloes> <Recepcao> <ItemRecepcao UrlImagem="http://www.cmnet.com.br/images2/37456_RECP_lobby.jpg" Copyright="CM Soluções Informática Ltda." TituloImagem="Recepção" Descricao="Vista detalhada da recepção"/> </Recepcao> <Alimentacao> <ItemAlimentacao UrlImagem="http://www.cmnet.com.br/images2/37456_ALIM_Ciprian1.jpg" Copyright="CM Soluções Informática Ltda." TituloImagem="Thereza de Albuquerque Restaurante" Descricao="O melhor restaurante da região, oferendo serviços diferenciados e cozinha internacional"/> </Alimentacao> <Lazer> <ItemLazer UrlImagem="http://www.cmnet.com.br/images2/37456_LAZE_Piscina.jpg" Copyright="CM Soluções Informática Ltda." TituloImagem="Piscina" Descricao="Vista da piscina , a única da cidade que mantém o Clube da Piscina"/> </Lazer> <Localizacoes> <Localizacao UrlImagem="http://www.cmnet.com.br/images2/37456_MAPA_mapa Ipanema.jpg" Copyright="CM Soluções Informática Ltda." TituloImagem="Mapa" Descricao="Mapa da Região"/> </Localizacoes> </GaleriaFotos> </InfoMultimidia> </HotelInfo> </HotelInfos> </CMNET_HotelInfoRS> 2.10.6. Erros Código Descrição 173 Código de agência requerido 175 Senha inválida 321 Faltando campo requerido 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 914 Conexão Inválida 915 Time Out limite da chave de conexão 2.11. Consulta de redes e marcas (xmlConsultaRedesMarcas) 2.11.1. Descrição 102 Especificações do Web Service CMNet – versão 3.3 O objetivo deste método é disponibilizar uma lista de redes e marcas disponíveis no CMNet, de acordo com os critérios informados pelo cliente. 2.11.2. Requisição (CMNET_RedesRQ.xml) Nível 0 Elemento Atributo CMNET_RedesRQ Obrigatório Descrição X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Target PrimaryLangID 1 Criteria X Critérios da consulta. 2 Criterion X Só é aceito um elemento deste tipo. 3 Rede X Filtra a consulta pela identificação da rede de hotéis no CMNet. Exemplo: “114” ChainCode CountryCode CityCode X Filtra a consulta pelo código ISO do país. Exemplo: “BR” Filtra a consulta pelo código ISO da cidade. Exemplo: “RIO” 2.11.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <CMNET_RedesRQ Version="1.0" EchoToken="12345678" Target="Test" TimeStamp="2004-01-01T80:00:00" PrimaryLangID="pt-BR" xmlns="http://www.cmnet/xmlwebservices2/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Criteria> <Criterion> <Rede ChainCode="114" CountryCode="BR" CityCode="FSG"/> </Criterion> </Criteria> </CMNET_RedesRQ> 2.11.4. Resposta (CMNET_RedesRS.xml) 103 Especificações do Web Service CMNet – versão 3.3 Nível 0 Elemento CMNET_RedesRS 1 POS 2 Source 3 RequestorID 3 Atributo Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do web service CMNet. Type Tipo de provedor do serviço na OTA Code List. O valor retornado será sempre “22” – ERSP (Electronic reservation service provider) ID Identificação do provedor do serviço. O valor retornado será sempre “CMNET”. URL Url do provedor do serviço. O valor retornado será sempre “http://www.cmnet.com.br” BookingChannel Informações sobre o canal de distribuição. Type 4 Descrição CompanyName Tipo do canal de distribuição na OTA Code List (BCT). O valor retornado será sempre “7” – Internet Identificação da empresa que disponibiliza o serviço. CompanyShortName O valor retornado será sempre “CMNET”. TravelSector Identificação do setor de atuação da empresa na OTA Code List (TVS). O valor retornado será sempre “3” – Hotel 1 Success Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. 1 Redes Redes de hotéis. 2 Rede Será retornado um novo elemento Rede para cada rede disponível. 3 Marcas 4 Marca 1 Warnings ChainCode Identificação da rede de hotéis no CMNet. Exemplo: “114” ChainName Nome da rede. Exemplo: “Rede de Teste” Será retornado um novo elemento Marca para cada marca disponível. Code Exemplo: “50” Name Exemplo: “Marca de Teste” Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” 104 Especificações do Web Service CMNet – versão 3.3 2 Warning 1 Errors 2 Error Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 2.11.5. Exemplo de xml de resposta <?xml version="1.0" encoding="UTF-8"?> <CMNET_RedesRS xmlns="http://www.cmnet/xmlwebservices2/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="1.0" EchoToken="12345678" TimeStamp="2007-05-30T15:35:01" Target="Test" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="22" ID="CMNET" URL="http://www.cmnet.com.br"/> <BookingChannel Type="7"> <CompanyName CompanyShortName="CMNET" TravelSector="3"/> </BookingChannel> </Source> </POS> <Success/> <Redes> <Rede ChainCode="127" ChainName="Rede de Teste"> <Marcas> <Marca Code="50" Name="Marca de Teste 1"/> <Marca Code="148" Name="Marca de Teste 2"/> <Marca Code="157" Name=" Marca de Teste 3"/> </Marcas> </Rede> <Rede ChainCode="338" ChainName="Rede de Teste 2"> <Marcas> <Marca Code="440" Name=" Marca de Teste 4"/> <Marca Code="867" Name=" Marca de Teste 5"/> <Marca Code="436" Name=" Marca de Teste 6"/> <Marca Code="438" Name=" Marca de Teste 7"/> <Marca Code="21" Name=" Marca de Teste 8"/> <Marca Code="439" Name=" Marca de Teste 9"/> <Marca Code="437" Name=" Marca de Teste 10"/> <Marca Code="441" Name=" Marca de Teste 11"/> </Marcas> </Rede> </Redes> </CMNET_RedesRS> 2.11.6. Erros Código Descrição 175 Senha inválida 181 Código inválido de país 321 Faltando campo requerido 383 Código da cidade inválido 405 Retorna Erro de parceiro não reconhecido 105 Especificações do Web Service CMNet – versão 3.3 425 Combinação não localizada 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 914 Conexão Inválida 915 Time Out limite da chave de conexão 2.12. Autenticação de funcionários (xmlAutenticaFuncionario) 2.12.1. Descrição O objetivo deste método é autenticar os funcionários de agências de viagens, operadoras ou empresas com acesso ao sistema CMNet, visando permitir a venda para o mercado B2B, com suas respectivas tarifas acordo. 2.12.2. Requisição (CMNET_AutenticaFuncionarioRQ.xml) Nível Elemento 0 CMNET_AutenticaFuncionarioRQ Atributo Descrição X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2004-08-01T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal X Dados do funcionário a ser autenticado. Username X Exemplo: “jsilva” Password X Exemplo: “jose123” CompanyCode X Código da agência de viagens ou operadora. Exemplo: “AGENCTESTE” EchoToken Target PrimaryLangID 1 Obrigatório SecurityInfo 106 Especificações do Web Service CMNet – versão 3.3 2.12.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <CMNET_AutenticaFuncionarioRQ Version="1.0" EchoToken="12345678" Target="Test" TimeStamp="2004-01-01T80:00:00" PrimaryLangID="pt-BR" xmlns="http://www.cmnet/xmlwebservices2/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SecurityInfo Username="jsilva" Password="jose123" CompanyCode="AGENCTESTE"/> </CMNET_AutenticaFuncionarioRQ> 2.12.4. Resposta (CMNET_AutenticaFuncionarioRS.xml) Nível 0 Elemento CMNET_AutenticaFuncionarioRS 1 POS 2 Source 3 RequestorID 3 4 Atributo Descrição Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2004-08-01T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do web service CMNet. Type Tipo de provedor do serviço na OTA Code List. O valor retornado será sempre “22” – ERSP (Electronic reservation service provider) ID Identificação do provedor do serviço. O valor retornado será sempre “CMNET”. URL Url do provedor do serviço. O valor retornado será sempre “http://www.cmnet.com.br” Type Tipo do canal de distribuição na OTA Code List (BCT). O valor retornado será sempre “7” – Internet BookingChannel Informações sobre o canal de distribuição. CompanyName Identificação da empresa que disponibiliza o serviço. CompanyShortName O valor retornado será sempre “CMNET”. TravelSector Identificação do setor de atuação da empresa na OTA Code List (TVS). O valor retornado será sempre “3” – Hotel 1 Success Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. 1 Company Dados da agência de viagens ou operadora. Name Exemplo: “AGENCIA DE TESTE” Code Identificação da agência ou empresa. ATENÇÃO: o valor retornado aqui deve ser passado como parâmetro no atributo @ID do elemento RequestorID nas requisições do web service. 107 Especificações do Web Service CMNet – versão 3.3 Exemplo: “99999” 1 EmployeeInfo Dados do funcionário autenticado. EmployeeId Identificação do funcionário. Exemplo: “1234” 2 GivenName Nome do funcionário. Exemplo: “Jose” 2 Surname Sobrenome do funcionário. Exemplo: “da Silva” 2 Email Exemplo: “[email protected]” 1 Warnings Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” 2 Warning 1 Errors 2 Error Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 2.12.5. Exemplo de xml de resposta <?xml version="1.0" encoding="utf-8"?> <CMNET_AutenticaFuncionarioRS Version="1.0" EchoToken="12345678" Target="Test" TimeStamp="2004-01-01T80:00:00" PrimaryLangID="pt-BR" xmlns="http://www.cmnet/xmlwebservices2/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <POS> <Source> <RequestorID Type="22" ID="CMNET" URL="http://www.cmnet.com.br"/> <BookingChannel Type="7"> <CompanyName CompanyShortName="CMNET" TravelSector="3"/> </BookingChannel> </Source> </POS> <Success/> <Company Name="AGENCIA DE TESTE" Code="99999"/> <EmployeeInfo EmployeeId="1234"> <GivenName>Jose</GivenName> <Surname>da Silva</Surname> <Email>[email protected]</Email> </EmployeeInfo> </CMNET_AutenticaFuncionarioRS> 2.12.6. Erros Código Descrição 169 Código de agente inválido 175 Senha inválida 108 Especificações do Web Service CMNet – versão 3.3 321 Faltando campo requerido 405 Retorna Erro de parceiro não reconhecido 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 913 Login e/ou senha do usuário estão incorretos 914 Conexão Inválida 2.13. Consultar as políticas de um produto (xmlConsultaPoliticasProduto) 2.13.1. Descrição O objetivo deste método é consultar as políticas de cancelamento, no show e modificação de um produto específico. 2.13.2. Requisição (CMNET_HotelPoliciesRQ.xml) Nível 0 Elemento Atributo CMNET_HotelPoliciesRQ Obrigatório Descrição X Elemento root do arquivo xml. TimeStamp X Data e hora do envio da requisição. Exemplo: “2008-07-28T08:00:00” Version X Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” X Identificação para a requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” X Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção X Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão “pt-PT” – Português de Portugal Identificação do cliente solicitante. EchoToken Target PrimaryLangID 1 POS X 2 Source X 3 RequestorID X Type X Identificação do tipo de cliente na OTA Code List (UIT). Opções: 109 Especificações do Web Service CMNet – versão 3.3 “4” – Parceiro ou empresa “5” – Agência de viagens ID X URL 1 Url do cliente. HotelPolity X HotelCode 2 Identificação do cliente no CMNet. Se o parceiro quiser trabalhar com agências ou empresas associadas ao CMNet, é necessário colocar aqui o id da agência ou empresa, caso contrário, o id do próprio parceiro. RoomType X Identificação do hotel no CMNet. Exemplo: “37456” X RoomTypeCode X Código da acomodação. Exemplo: “N01ST” CheckIn X Data de chegada. Exemplo: “2008-08-01” 2.13.3. Exemplo de xml de requisição <?xml version="1.0" encoding="UTF-8"?> <CMNET_HotelPoliciesRQ Version="1.0" EchoToken="12345678" Target="Production" TimeStamp="2008-07-28T80:00:00" PrimaryLangID="pt-BR" xmlns="http://www.cmnet/xmlwebservices2/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <POS> <Source> <RequestorID Type="4" ID="60227" URL="http://www.site_do_parceiro.com.br"/> </Source> </POS> <HotelPolity HotelCode="37456"> <RoomType RoomTypeCode="R00ST" CheckIn="2008-08-01"/> </HotelPolity> </CMNET_HotelPoliciesRQ> 2.13.4. Resposta (CMNET_HotelPoliciesRS.xml) Nível 0 Elemento Atributo CMNET_HotelPoliciesRS Descrição Elemento root do arquivo xml. TimeStamp Data e hora do envio da resposta. Exemplo: “2008-07-28T08:00:00” Version Versão do arquivo xml, de acordo com o padrão OTA utilizado. Exemplo: “1.0” EchoToken Identificação da requisição enviada pelo cliente. Se a requisição contiver este atributo, a resposta correspondente conterá o atributo com o mesmo valor. Exemplo: “12346578” Target Identificação do ambiente utilizado pelo web service CMNet para gerar a resposta. Opções: ”Test” – Ambiente de teste ”Production” – Ambiente de produção PrimaryLangID Identificação do idioma utilizado. Opções: “pt-BR” – Português “es-ES” – Espanhol “en-US” – Inglês “fr-FR” – Francês “it-IT” – Italiano “de-DE” – Alemão 110 Especificações do Web Service CMNet – versão 3.3 “pt-PT” – Português de Portugal 1 POS 2 Source 3 RequestorID 3 Identificação do web service CMNet. Type Tipo de provedor do serviço na OTA Code List. O valor retornado será sempre “22” – ERSP (Electronic reservation service provider) ID Identificação do provedor do serviço. O valor retornado será sempre “CMNET”. URL Url do provedor do serviço. O valor retornado será sempre “http://www.cmnet.com.br” BookingChannel Informações sobre o canal de distribuição. Type 4 CompanyName 1 Success 1 HotelPolity 2 CancelPenalties 4 CancelPenalty 5 Identificação da empresa que disponibiliza o serviço. CompanyShortName O valor retornado será sempre “CMNET”. TravelSector Identificação do setor de atuação da empresa na OTA Code List (TVS). O valor retornado será sempre “3” – Hotel Este elemento será retornado caso não haja nenhum erro (elemento Errors) na resposta do web service CMNet. HotelCode Identificação do hotel no CMNet. Exemplo: “37456” RoomTypeCode Código da acomodação. Exemplo: “N01ST” CheckIn Data de chegada. Exemplo: “2008-08-01” RoomType 3 5 Tipo do canal de distribuição na OTA Code List (BCT). O valor retornado será sempre “7” – Internet Políticas de cancelamento. Code Código que identifica o tipo de política de cancelamento. Opções: “CNC” – Cancelamento “NSH” – No Show OffsetTimeUnit Unidade de medida de tempo. Opções: "Year" "Month" "Week" "Day" "Hour” OffsetUnitMultiplier Valor do Deadline. Exemplo: “10” OffsetDropTime Evento de ocorrência na linha de tempo. Valor fixo: "BeforeArrival" Amount Valor cobrado como penalidade. Exemplo: “10058” Percent Percentagem relativa a reserva que será paga como penalidade. Exemplo: “10.00” DecimalPlace Valor das casas decimais. Exemplo: “2” CurrencyCode Código ISO da moeda. Exemplo: “BRL“ NmbrOfNights Número de diárias a serem cobradas na penalidade. Deadline AmountPercent 111 Especificações do Web Service CMNet – versão 3.3 Exemplo: “1“ BasisType 3 ModifyPenalties 4 ModifyPenalty 5 Deadline 5 Tipo de base para o calculo da penalidade. Opções: "Amount" “Percent” "Nights" "FirstLast" “FullStay” Políticas de modifição. OffsetTimeUnit Unidade de medida de tempo. Opções: "Year" "Month" "Week" "Day" "Hour” OffsetUnitMultiplier Valor do Deadline. Exemplo: “10” OffsetDropTime Evento de ocorrência na linha de tempo. Valor fixo: "BeforeArrival" Amount Valor cobrado como penalidade. Exemplo: “10058” Percent Percentagem relativa a reserva que será paga como penalidade. Exemplo: “10.00” DecimalPlace Valor das casas decimais. Exemplo: “2” CurrencyCode Código ISO da moeda. Exemplo: “BRL“ NmbrOfNights Número de diárias a serem cobradas na penalidade. Exemplo: “1“ BasisType Tipo de base para o calculo da penalidade. Opções: "Amount" “Percent” "Nights" "FirstLast" “FullStay” AmountPercent 1 Warnings 2 Warning 1 Errors 2 Error Lista de possíveis alertas gerados durante o processamento, mas que não interferem no sucesso da operação solicitada. Este elemento só será retornado caso não haja nenhum erro na resposta do web service CMNet (elemento Errors), e nos casos em que se aplique. Exemplo: “Indisponibilidade de hotéis condizentes com esta entrada de dados” Type Identificação do tipo de alerta na OTA Code List (EWT). O valor retornado será sempre “1” – Unknown Code Identificação do alerta encontrado na OTA Code List (ERR). Exemplo: “321” – Required field missing Lista de possíveis erros gerados durante o processamento. Se este elemento for retornado não será retornada nenhuma mensagem de sucesso (elemento Success) ou alerta (elemento Warnings). Exemplo: “Invalid vendor” Type Identificação do tipo de erro na OTA Code List (EWT). Exemplo: “1” – Unknown Code Identificação do erro encontrato na OTA Code List (ERR). Exemplo: “450” – Unable to process 112 Especificações do Web Service CMNet – versão 3.3 2.13.5. Exemplo de xml de resposta <?xml version="1.0" encoding="utf-8"?> <CMNET_HotelPoliciesRS xmlns="http://www.cmnet/xmlwebservices2/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="1.0" EchoToken="12345678" TimeStamp="2008-07-21T15:33:09" Target="Production" PrimaryLangID="pt-BR"> <POS> <Source> <RequestorID Type="22" ID="CMNET" URL="http://www.cmnet.com.br"/> <BookingChannel Type="7"> <CompanyName CompanyShortName="CMNET" TravelSector="3"/> </BookingChannel> </Source> </POS> <Success/> <HotelPolity HotelCode="37456"> <RoomType RoomTypeCode="R00ST" CheckIn="2008-08-01"> <CancelPenalties> <CancelPenalty Code="CNC"> <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="11" OffsetDropTime="BeforeArrival"/> <AmountPercent Percent="15.05" BasisType="Percent"/> </CancelPenalty> <CancelPenalty Code="CNC"> <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="21" OffsetDropTime="BeforeArrival"/> <AmountPercent Percent="5.08" BasisType="Percent"/> </CancelPenalty> <CancelPenalty Code="NSH"> <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="1" OffsetDropTime="BeforeArrival"/> <AmountPercent NmbrOfNights="1" BasisType="Nights"/> </CancelPenalty> </CancelPenalties> <ModifyPenalties> <ModifyPenalty> <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="10" OffsetDropTime="BeforeArrival"/> <AmountPercent Percent="10.00" BasisType="Percent"/> </ModifyPenalty> <ModifyPenalty> <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="21" OffsetDropTime="BeforeArrival"/> <AmountPercent Amount="10058" DecimalPlace="2" CurrencyCode="BRL" BasisType="Amount"/> </ModifyPenalty> </ModifyPenalties> </RoomType> </HotelPolity> </CMNET_HotelPoliciesRS> 2.13.6. Erros Código Descrição 116 Acomodação inválida 148 Data de chegada requerida 173 Código de agência requerido 175 Senha inválida 321 Faltando campo requerido 392 Código de hotel inválido 405 Retorna Erro de parceiro não reconhecido 113 Especificações do Web Service CMNet – versão 3.3 425 Combinação não localizada 448 Retorna Erro de problema no sistema 450 Incapaz de processar 904 Parceiro Bloqueado no CMNet 909 Cliente bloqueado para conexão 910 Retorna Erro XML não cadastrado 911 Retorna Erro de parceiro não autorizado para este XML 913 Login e/ou senha do usuário estão incorretos 914 Conexão Inválida 114