Invitations

Serviço responsável pelas operações de consulta, venda e cancelamento de convites.

GetInvitations

Consulta os convites disponíveis.

POST {baseAddress}/getInvitations

{
  "TitleId": 0
}

Parâmetros

Nome	Tipo	Descrição
data	InvitationsData	Dados para consulta dos convites.

Retorno

[
  {
    "PlanId": 0,
    "Description": "{{texto}}",
    "Invitations": [
      {
        "InvitationId": 0,
        "Description": "{{texto}}",
        "Value": 0.0,
        "MapId": 0
      }
    ],
    "AvailableDates": [
      "\/Date(1768791600000)\/"
    ]
  }
]

Tipo	Descrição
PlanResult[]	Retorna os convites disponíveis.

GetMapLocations

Consulta os locais disponíveis de um mapa para uma determinada data.

POST {baseAddress}/getMapLocations

{
  "MapId": 0,
  "VisitDate": "\/Date(1768791600000)\/"
}

Parâmetros

Nome	Tipo	Descrição
data	MapLocationsData	Dados para consulta de disponibilidade dos locais do mapa.

Retorno

[
  {
    "Location": "{{texto}}",
    "Available": false
  }
]

Tipo	Descrição
MapLocationResult[]	Retorna dados dos locais do mapa para a data informada.

GetAvailableQuantity

Consulta a quantidade disponível do convite para uma determinada data.

POST {baseAddress}/getAvailableQuantity

{
  "TitleId": 0,
  "InvitationId": 0,
  "VisitDate": "\/Date(1768791600000)\/"
}

Parâmetros

Nome	Tipo	Descrição
data	AvailableQuantityData	Dados para consulta da quantidade disponível do convite para uma determinada data.

Retorno

{
  "MapAvailableQuantity": 0,
  "TitleAvailableQuantity": 0
}

Tipo	Descrição
AvailableQuantityResult	Retorna a quantidade disponível do convite. Se não houver limite de compra, retorna nulo. Se o convite estiver esgotado, retorna 0. Caso possua um ou mais convites disponíveis, retorna a quantidade disponível.

GetSales

Consulta convites comprados, com seus detalhes e código.

POST {baseAddress}/getSales

{
  "TitleId": 0,
  "StartDate": "\/Date(1768791600000)\/",
  "EndDate": "\/Date(1768791600000)\/"
}

Parâmetros

Nome	Tipo	Descrição
data	SalesData	Dados para consulta de convites comprados.

Retorno

[
  {
    "SaleId": 0,
    "VoucherCode": "{{texto}}",
    "SaleDate": "\/Date(1768791600000)\/",
    "VisitDate": "\/Date(1768791600000)\/",
    "Invitations": [
      {
        "AccessCode": "{{texto}}",
        "Value": 0.0,
        "EntranceDate": "\/Date(1768791600000)\/",
        "Visitor": {
          "Name": "{{texto}}",
          "Document": "{{texto}}",
          "Email": "{{texto}}",
          "PhoneNumber": "{{texto}}",
          "Address": "{{texto}}"
        },
        "MapLocation": "{{texto}}",
        "Description": "{{texto}}",
        "PlanId": 0
      }
    ],
    "Payment": {
      "Value": 0.0
    }
  }
]

Tipo	Descrição
SaleResult[]	Retorna os dados dos convites comprados.

Sell

Realiza vendas de convites.

POST {baseAddress}/sell

{
  "TitleId": 0,
  "VisitDate": "\/Date(1768791600000)\/",
  "Invitations": [
    {
      "InvitationId": 0,
      "Quantity": 0,
      "AccessCode": "{{texto}}",
      "SourceEid": "{{texto}}",
      "Values": {
        "DueValue": 0.0,
        "PaidValue": 0.0
      },
      "Visitor": {
        "Name": "{{texto}}",
        "Document": "{{texto}}",
        "Email": "{{texto}}",
        "PhoneNumber": "{{texto}}",
        "Address": {
          "Number": "{{texto}}",
          "Street": "{{texto}}",
          "Burgh": "{{texto}}",
          "City": "{{texto}}",
          "PostalCode": "{{texto}}",
          "State": "{{texto}}",
          "Country": "{{texto}}"
        }
      },
      "MapLocation": "{{texto}}"
    }
  ],
  "Payment": {
    "CloudAccountEid": 0,
    "Value": 0.0,
    "Parcels": 0,
    "ExistingCard": {
      "Eid": 0,
      "SecurityCode": "{{texto}}"
    },
    "NewCard": {
      "CardType": 0,
      "CardHolderName": "{{texto}}",
      "CardNumber": "{{texto}}",
      "ExpiryMonth": 0,
      "ExpiryYear": 0,
      "SecurityCode": "{{texto}}",
      "StoreCard": false
    }
  },
  "Values": {
    "DueValue": 0.0,
    "PaidValue": 0.0
  }
}

Parâmetros

Nome	Tipo	Descrição
data	SellData	Dados para a realizar a venda.

Retorno

{
  "SaleId": 0,
  "Invitations": [
    {
      "InvitationId": 0,
      "AccessCode": "{{texto}}"
    }
  ],
  "NotAvailableMapLocations": [
    {
      "InvitationId": 0,
      "MapLocation": "{{texto}}"
    }
  ],
  "Success": false
}

Tipo	Descrição
SellResult	Retorna dados dos convites adquiridos.

CancelSale

Cancela uma venda de convite efetuada.

POST {baseAddress}/cancelSale

{
  "SaleId": 0
}

Parâmetros

Nome	Tipo	Descrição
data	CancelData	Dados do cancelamento da venda.

Retorno

false

Tipo	Descrição
Boolean	Retorna verdadeiro se o cancelamento ocorreu com sucesso.

GetInvitationPrint

Imprime convites comprados.

POST {baseAddress}/getInvitationPrint

{
  "SaleId": 0
}

Parâmetros

Nome	Tipo	Descrição
data	InvitationPrintData	Dados para impressão do convite.

Retorno

[
  {
    "FileData": "AA==",
    "FileName": "{{texto}}"
  }
]

Tipo	Descrição
InvitationPrintResult[]	Retorna o conteúdo em bytes do PDF da impressão do convite.

GetParcels

Retorna as parcelas possíveis para venda

POST {baseAddress}/getParcels

{
  "Invitations": [
    {
      "InvitationId": 0,
      "Quantity": 0
    }
  ],
  "TitleId": 0
}

Parâmetros

Nome	Tipo	Descrição
data	ParcelData	Dados para receber o parcelamento

Retorno

[
  {
    "Parcel": 0,
    "Value": 0.0
  }
]

Tipo	Descrição
ParcelResult[]	Os parcelamentos possíveis para venda