Histórico da Página

...

Swagger: http://IP:Porta/frontofficeapi/v1/swagger/doc/html#/

Exemplo de Swagger:   http://1293.151233.33251.24789:89/frontofficeapi/v1/swagger/doc/html#/

6. Iniciando o serviço

...

Abaixo os Métodos disponíveis nos EndPoints da API. 

...

• Authenticate Authenticate

  • Estado
    colour Green title POST

    URL:

    /frontofficeapi/v1/authenticate

    Descrição: Inserir Authenticate

    Requisição

    {
        "clientId": "38629890-9CF8-46B0-ACF8-03AD46A3DCC8",
        "clientSecret": "276d56d0-77ad-11f0-8962-113d4e2eef4e",
        "app": "FRONTOFFICEAPI"
    }

    Respostas

    Código	Response
    201	OK
    400	Bad Request

• Listar cliente reservante

  • Método:

    Estado
    colour Blue title

    GET

    URL: /frontofficeapi/v1/clienteReservante

    Descrição: Listar cliente reservante

  • Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    status	string	Não	Status
    dataPassandoInicio	string	Não	Data passando inicial
    dataPassandoFim	string	Não	Data passando final
    dataChegadaInicio	string	Não	Data chegada inicial
    dataChegadaFim	string	Não	Data chegada final
    dataPartidaInicio	string	Não	Data partida inicial
    dataPartidaFim	string	Não	Data partida final
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

  • Respostas

    Código	Descrição
    200	OK

• Listar Disponibilidade

  Método:

  • Estado
    colour Blue title GET

  URL:

  • /frontofficeapi/v1/disponibilidade

    Descrição: Listar Disponibilidade

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    dataIni	string	Sim	Data inicial - padrão dd-mm-yyyy
    dataFim	string	Sim	Data final - padrão dd-mm-yyyy
    tipouh	string	Sim	Tipo UH
    idContrato	integer	Não	Identificador do contrato do cliente
    idAgrupadorUh	string	Não	Identificador do Agrupador de Uhs
    codAgrupadorUH	string	Não	Código do Agrupador de Uhs
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

    Respostas

    Código	Descrição
    200	OK

• Listar Hospedagem

  Método:

  
  

  • Estado
    colour Blue title GET

  URL:

  • /frontofficeapi/v1/hospedagem

    Descrição: Listar Hospedagem

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    dataIni	string	Sim	Data inicial
    dataFim	string	Sim	Data Final
    cancelada	integer	Não	Para incluir reservas canceladas na resposta, utilize o valor 6
    gratuidade	integer	Não	Para incluir reservas gratuitas na resposta, utilize o valor 1
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

    Respostas

    Código	Descrição
    200	OK

• Listar Hospede

  Método:

  
  

  • Estado
    colour Blue title GET

  URL:

  • /frontofficeapi/v1/hospede

    Descrição: Listar Hospede

    Parâmetros

  Nome                     

  • Nome	Tipo	Obrigatório	Descrição
    idHospede	integer	Sim	Identificador do hospede
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

    Respostas

    Código	Descrição
    200	OK

• Listar hotel

  Método:

  
  

  • Estado
    colour Blue title GET

  URL:

  • /frontofficeapi/v1/hotel

    Descrição: Listar hotel

    Parâmetros        

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Não	Identificador do hotel
    nome	string	Não	Nome do hotel

    Respostas

    Código	Descrição
    200	OK

• Listar Inventario

  Método:

  
  

  • Estado
    colour Blue title GET

  URL:

  • /frontofficeapi/v1/inventario

    Descrição: Listar Inventario

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    dataIni	string	Sim	Data inicial - padrão dd-mm-yyyy
    dataFim	string	Sim	Data final - padrão dd-mm-yyyy
    tipouh	string	Sim	Tipo UH
    idContrato	integer	Não	Identificador do contrato do cliente
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

    Respostas

    Código	Descrição
    200	OK

• Listar Origem Reserva

  Método:

  
  

  • Estado
    colour Blue title GET

  URL:

  •  /frontofficeapi/v1/origemReserva

    Descrição: Listar Origem Reserva

    Respostas            

    Código	Descrição
    200	OK

• Reserva

  • Cancelar Reserva

    Método:

    
    

    • Estado
      colour Yellow title PUT

    URL:

    • /frontofficeapi/v1/reserva/{numReserva}

      Descrição: Cancelar Reserva

      Parâmetros

      Nome	Tipo	Obrigatório	Descrição
      numReserva	integer	Sim	Número da reserva

      Respostas

      Código	Descrição
      201	Created
      204	No Content
      404	Not Found

  • Listar Reserva

    Método:

    
    

    • Estado
      colour Blue title GET

    URL:

    • /frontofficeapi/v1/reserva

      Descrição: Listar Reserva

      Parâmetros

      Nome	Tipo	Obrigatório	Descrição
      idhotel

    string

    • Integer

    Não

    • Sim	Identificador do hotel
      numreserva	string	Não	Numero da reserva
      numdocumento	string	Não	Documento do cliente
      dataInicial	string	Não	Data inicial do filtro. Sozinha, retorna registros a partir desta data
      dataFinal	string	Não	Data final do filtro. Usada com dataInicio para intervalo.
      status	Integer	Não	Status da reserva
      page	integer	Não	Número da página
      pageSize	integer	Não	Quantidade de registros por página

      Respostas

      Código	Descrição
      200	OK
      204	No Content

      Possíveis  status de reserva

      Código	Descrição
      0	A Confirmar
      1	Confirmada
      2	Check-In
      3	Check-Out
      4	Pendente
      5	No-Show
      6	Cancelada
      7	Waiting List
      8	Em Tentativa

• • Inserir Reserva

Método:

• • • Estado
      colour Green title POST

URL:

• • •  /frontofficeapi/v1/reserva

      Descrição: Inserir Reserva

      Parâmetros          

      Nome	Tipo	Obrigatório	Descrição
      dados		Sim

      Respostas

      Código	Descrição
      201	Created
      400	Bad Request

• Listar reserva de grupo

  Método:

  
  

  • Estado
    colour Blue title GET

  URL:

  • /frontofficeapi/v1//reservaGrupo

    Descrição: Listar reserva de grupo

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    dataEntrada	string	Sim	Data da entrada
    dataSaida	string	Sim	Data da saída
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

    Respostas

    Código	Descrição
    200	OK

• Listar Segmento

  Método:

  
  

  • Estado
    colour Blue title GET

  URL:

  • /frontofficeapi/v1/Segmento

    Descrição: Listar Segmento

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    IdHotel	string	Não	Hotel
    CodSegmento	integer	Não	Identificador do Segmento

    Respostas

    Código	Descrição
    200	OK

• Listar TipoUH

  Método:

  
  

  • Estado
    colour Blue title GET

  URL:

  • /frontofficeapi/v1/tipoUH

    Descrição: Listar TipoUH

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    IdTipoUh	integer	Não	Identificador do tipo de UH

    Respostas

    Código	Descrição
    200	OK

• Listar UH

  Método:

  
  

  • Estado
    colour Blue title GET

  URL:

  • /frontofficeapi/v1/UH

    Descrição: Listar UH

    Parâmetros         

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    tipo	string	Não	Tipo da UH
    grupo	string	Não	Grupo da UH

    Respostas

    Código	Descrição
    200	OK

• Buscar agrupador de Uh

  Método:

  
  

  • Estado
    colour Blue title GET

  URL:

  • /frontofficeapi/v1/agrupadorUh/codReduzido

    Descrição: Buscar agrupador de Uh

    Parâmetros                      

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    idAgrupadorUh	integer	Não	Identificador do agrupador de uh
    codReduzido	string	Não	Código reduzido

    Respostas

    Código	Descrição
    200	OK
    404	Not Found