GET api/GetRateConfiguration?APIKey={APIKey}&FacilityNo={FacilityNo}&CarparkNo={CarparkNo}&RateNo={RateNo}

GET implementation of GetRateConfiguration

Request Information

URI Parameters

NameDescriptionTypeAdditional information
APIKey

An active API Key for the APT.MobileAPI service

string

None.

FacilityNo

The facility number of the target carpark

integer

None.

CarparkNo

integer

None.

RateNo

The rate number used for calculation

unsigned integer

None.

Body Parameters

None.

Response Information

Resource Description

GetRateConfigurationResponse
NameDescriptionTypeAdditional information
FacilityNo

The facility number of the target carpark

integer

None.

CarparkNo

integer

None.

RateNo

The rate number used for calculation

unsigned integer

None.

RateConfiguration

RateConfiguration

None.

Response Formats

application/json, text/json

Sample:
{
  "FacilityNo": 1,
  "CarparkNo": 2,
  "RateNo": 3,
  "RateConfiguration": {
    "RateName": "sample string 1",
    "RateNo": 2,
    "CarparkNo": 3,
    "IsStandard": true,
    "HasFlatRate": true,
    "FlatRate": {
      "FlatRateName": "sample string 1",
      "BeginDayOfWeek": 0,
      "BeginTime": "sample string 2",
      "EndDayOfWeek": 0,
      "EndTime": "sample string 3",
      "EntryType": 0,
      "ExitType": 0,
      "IsEveryDay": true,
      "MaxDuration": 5,
      "Rate": 6.1
    },
    "HasDailyMaximums": true,
    "DailyMaximums": [
      {
        "Days": 1,
        "MaxRate": 2.1
      },
      {
        "Days": 1,
        "MaxRate": 2.1
      }
    ],
    "RateSchemes": [
      {
        "RateSchemeName": "sample string 1",
        "RateSchemeNo": 2,
        "StartTime": "sample string 3",
        "DayOfWeek": 0,
        "IsFixedRate": true,
        "FixedRate": 5.1,
        "FixedRateRenewalMinutes": 6,
        "HasOpenEndRate": true,
        "OpenEndRate": 8.1,
        "OpenEndRateDuration": 9,
        "RateBands": [
          {
            "Duration": 1,
            "Rate": 2.1
          },
          {
            "Duration": 1,
            "Rate": 2.1
          }
        ]
      },
      {
        "RateSchemeName": "sample string 1",
        "RateSchemeNo": 2,
        "StartTime": "sample string 3",
        "DayOfWeek": 0,
        "IsFixedRate": true,
        "FixedRate": 5.1,
        "FixedRateRenewalMinutes": 6,
        "HasOpenEndRate": true,
        "OpenEndRate": 8.1,
        "OpenEndRateDuration": 9,
        "RateBands": [
          {
            "Duration": 1,
            "Rate": 2.1
          },
          {
            "Duration": 1,
            "Rate": 2.1
          }
        ]
      }
    ]
  }
}