Facilities

Serviço responsável pelas operações de listar, consultar e realizar locações de dependências.

Load

Retorna a listagem de espaços, locações ativas do título, as regras de consulta e locação disponíveis para o tipo do título

POST {baseAddress}/load

{}

Parâmetros

Nome	Tipo	Descrição
data	LoadData	Identificador único do título. Obrigatório.

Retorno

{
  "Facilities": [
    {
      "Id": 0,
      "Name": "{{texto}}"
    }
  ],
  "Rules": [
    {
      "Id": 0,
      "Facilities": [
        {
          "Id": 0,
          "Name": "{{texto}}"
        }
      ],
      "FacilityRentTerm": "{{texto}}",
      "Dates": [
        "\/Date(1768791600000)\/"
      ],
      "IsRentRule": false,
      "AllowCalendarDates": false
    }
  ],
  "Rents": [
    {
      "Id": 0,
      "Purpose": "{{texto}}",
      "Facility": {
        "Id": 0,
        "Name": "{{texto}}"
      },
      "InitialDate": "\/Date(1768791600000)\/",
      "FinalDate": "\/Date(1768791600000)\/",
      "HasContract": false
    }
  ]
}

Tipo	Descrição
LoadFacilitiesResult	Retorna a listagem de espaços, locações ativas do título, as regras de consulta e locação disponíveis para o tipo do título

CheckAvailability

Retorna os espaços e as datas em que o espaço estará ocupado.

POST {baseAddress}/checkAvailability

{
  "FacilityId": 0
}

Parâmetros

Nome	Tipo	Descrição
data	CheckAvailabilityData	Dados para a consulta de disponibilidade de espaços. Opcional.

Retorno

[
  {
    "Date": "\/Date(1768791600000)\/",
    "Facilities": [
      0
    ]
  }
]

Tipo	Descrição
CheckAvailabilityResult[]	Retorna os espaços e as datas em que o espaço estará ocupado

Rent

Realiza a locação do espaço.

POST {baseAddress}/rent

{
  "TitleId": 0,
  "FacilityId": 0,
  "InitialDate": "\/Date(1768791600000)\/",
  "FinalDate": "\/Date(1768791600000)\/"
}

Parâmetros

Nome	Tipo	Descrição
data	RentData	Dados para a locação. Obrigatório.

Retorno

0

Tipo	Descrição
Int32	Retorna o Id da locação

GetFacilityRentContract

Retorna o contrato da locação.

POST {baseAddress}/getFacilityRentContract

{
  "TitleId": 0,
  "RentId": 0
}

Parâmetros

Nome	Tipo	Descrição
data	GetFacilityRentContractData	Dados para a consulta do contrato. Obrigatório.

Retorno

{
  "Contract": "AA=="
}

Tipo	Descrição
GetFacilityContractResult	Retorna o conteúdo em bytes do contrato de locação

Error codes

Códigos de erro retornados pelo serviço

Valores

Nome	Valor	Descrição
AuthenticationKeyMissing	901	Chave de autenticação não informada.
AuthenticationKeyInvalid	902	Fornecido como parâmetro uma chave de autenticação inválida. Este erro ocorre quando, a chave não é encontrada, quando a chave informada está incorreta ou quando o usuário associado a chave não possui permissão para utilizar a API.
IntegrationDisabled	903	A integração com o aplicativo está desativada. Este erro ocorre devido a configuração na administração do servidor.
IntegratedUserInvalid	904	Usuário de integração inválido.
AuthenticationKeyUserMismatch	905	O nome de usuário de integração no MultiVendas não é igual ao nome de usuário da chave no MultiClubes.