Disciplines

Serviço responsável pelas operações de consulta, matrícula e cancelamento de matrículas em modalidades.

GetAvailabilities

Consulta sócios e as turmas disponíveis para matrícula para um título.

POST {baseAddress}/getAvailabilities

{
  "TitleId": 0
}

Parâmetros

Nome	Tipo	Descrição
data	AvailabilitiesData	Dados para consulta de turmas disponíveis.

Retorno

[
  {
    "Member": {
      "MemberId": 0,
      "MemberName": "{{texto}}"
    },
    "AvailableClasses": [
      {
        "Capacity": 0,
        "RegisteredQuantity": 0,
        "QueuedQuantity": 0,
        "IsFull": false,
        "MaintenanceTax": 0.0,
        "ProportionalMaintenanceTax": 0.0,
        "RegisterTax": 0.0,
        "CategoryName": "{{texto}}",
        "DisciplineName": "{{texto}}",
        "ClassName": "{{texto}}",
        "ClassId": 0
      }
    ]
  }
]

Tipo	Descrição
AvailabilitiesResult[]	Retorna dados dos sócios do título e das turmas disponíveis para matrícula.

GetRegisters

Consulta os sócios de um título e suas respectivas matrículas.

POST {baseAddress}/getRegisters

{
  "TitleId": 0
}

Parâmetros

Nome	Tipo	Descrição
data	RegistersData	Dados para consulta de matrículas realizadas.

Retorno

[
  {
    "Member": {
      "MemberId": 0,
      "MemberName": "{{texto}}"
    },
    "Classes": [
      {
        "RegisterId": 0,
        "Products": [
          {
            "Product": "{{texto}}",
            "DueDate": "\/Date(1768791600000)\/",
            "Value": 0.0,
            "PaymentDate": "\/Date(1768791600000)\/",
            "PaidValue": 0.0
          }
        ],
        "CategoryName": "{{texto}}",
        "DisciplineName": "{{texto}}",
        "ClassName": "{{texto}}",
        "ClassId": 0
      }
    ]
  }
]

Tipo	Descrição
RegistersResult[]	Retorna os dados os sócios do título e as suas matrículas.

Register

Efetua a matrícula de um sócio.

POST {baseAddress}/register

{
  "MemberId": 0,
  "ClassId": 0,
  "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
    }
  }
}

Parâmetros

Nome	Tipo	Descrição
data	RegisterData	Dados para a matrícula.

Retorno

{
  "RegisterId": 0,
  "RegisterTaxesResult": {
    "MaintenanceTax": 0.0,
    "ProportionalMaintenanceTax": 0.0,
    "RegisterTax": 0.0
  }
}

Tipo	Descrição
RegisterResult	Retorna os dados da matrícula.

GetContract

Emite o contrato de matrícula ou cancelamento de matrícula de um sócio

POST {baseAddress}/getContract

{
  "RegisterId": 0,
  "ContractType": 0
}

Parâmetros

Nome	Tipo	Descrição
data	ContractData	Dados para a emissão do contrato.

Retorno

{
  "ContractBase64": "{{texto}}"
}

Tipo	Descrição
ContractResult	Retorna o arquivo PDF com o contrato.

Queue

Inserir sócio na fila de espera de uma turma.

POST {baseAddress}/queue

{
  "MemberId": 0,
  "ClassId": 0
}

Parâmetros

Nome	Tipo	Descrição
data	QueueData	Dados para a inclusão do sócio na fila de espera.

Retorno

{
  "RegisterId": 0,
  "QueuePosition": 0
}

Tipo	Descrição
QueueResult	Retorna os dados da inclusão na fila de espera.

Unregister

Desmatricula um sócio de uma turma.

POST {baseAddress}/unregister

{
  "RegisterId": 0,
  "Reason": "{{texto}}"
}

Parâmetros

Nome	Tipo	Descrição
data	UnregisterData	Dados do cancelamento da matrícula.

Retorno

{
  "UnregisterSuccess": false
}

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

Unqueue

Retira o sócio da fila de espera de uma turma.

POST {baseAddress}/unqueue

{
  "RegisterId": 0
}

Parâmetros

Nome	Tipo	Descrição
data	UnqueueData	Dados para retirar o sócio da fila de espera.

Retorno

{
  "UnqueueSuccess": false
}

Tipo	Descrição
UnqueueResult	Retorna verdadeiro se o sócio foi retirado da fila.

GetParcels

Retorna os valores por parcela

POST {baseAddress}/getParcels

{
  "ClassId": 0,
  "MemberId": 0
}

Parâmetros

Nome	Tipo	Descrição
data	ParcelData	Dados para calcular as parcelas

Retorno

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

Tipo	Descrição
ParcelResult[]	Os valores por parcela