WebAPI

<back to all web services

GetTollSchemeRules

Get the detailed list of account types, vehicle classes, time class, toll rates, registration fees for each account, tag types, tag fees, etc.

The following routes are available for this service:
GET/GetTollSchemeRulesRESTful call with no parameters

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetTollSchemeRules HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: application/xml
Content-Length: length

<GetTollSchemeRules xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel" />

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetTollSchemeRulesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <FareClasses xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebCRMV2.Data.Web.Models">
    <d2p1:FareClass>
      <d2p1:Comment>String</d2p1:Comment>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:CreatedBy>String</d2p1:CreatedBy>
      <d2p1:ExtraAxle>0</d2p1:ExtraAxle>
      <d2p1:FareClassDesc>String</d2p1:FareClassDesc>
      <d2p1:FareClassId>0</d2p1:FareClassId>
      <d2p1:LastUpd>0001-01-01T00:00:00</d2p1:LastUpd>
      <d2p1:LastUpdApp>String</d2p1:LastUpdApp>
      <d2p1:LastUpdBy>String</d2p1:LastUpdBy>
      <d2p1:Translations>String</d2p1:Translations>
      <d2p1:VehClassId>0</d2p1:VehClassId>
      <d2p1:VehTypeId>0</d2p1:VehTypeId>
    </d2p1:FareClass>
  </FareClasses>
  <PlatePlans xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebCRMV2.Data.Web.Models">
    <d2p1:Program>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:CreatedBy>String</d2p1:CreatedBy>
      <d2p1:DaysPriorRenew>0</d2p1:DaysPriorRenew>
      <d2p1:DiscountAmt>0</d2p1:DiscountAmt>
      <d2p1:DiscountPct>0</d2p1:DiscountPct>
      <d2p1:EffectiveDt>0001-01-01T00:00:00</d2p1:EffectiveDt>
      <d2p1:IsDocumentRequired>false</d2p1:IsDocumentRequired>
      <d2p1:IsInitialFeeRequired>false</d2p1:IsInitialFeeRequired>
      <d2p1:IsRenewalRequired>false</d2p1:IsRenewalRequired>
      <d2p1:LastUpd>0001-01-01T00:00:00</d2p1:LastUpd>
      <d2p1:LastUpdApp>String</d2p1:LastUpdApp>
      <d2p1:LastUpdBy>String</d2p1:LastUpdBy>
      <d2p1:LocalizationLimit>false</d2p1:LocalizationLimit>
      <d2p1:LookupSetupFee>false</d2p1:LookupSetupFee>
      <d2p1:MinPPTAmt>0</d2p1:MinPPTAmt>
      <d2p1:MinTripPeriod>0</d2p1:MinTripPeriod>
      <d2p1:MinTrips>0</d2p1:MinTrips>
      <d2p1:ProcessVisibilityMask>0</d2p1:ProcessVisibilityMask>
      <d2p1:ProgramDesc>String</d2p1:ProgramDesc>
      <d2p1:ProgramId>0</d2p1:ProgramId>
      <d2p1:ProgramShortDesc>String</d2p1:ProgramShortDesc>
      <d2p1:RegistrationFee>0</d2p1:RegistrationFee>
      <d2p1:RenewalInMonths>0</d2p1:RenewalInMonths>
      <d2p1:SetupFee>0</d2p1:SetupFee>
      <d2p1:Translations>String</d2p1:Translations>
      <d2p1:VehicleLimit>0</d2p1:VehicleLimit>
    </d2p1:Program>
  </PlatePlans>
  <ProductTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebCRMV2.Data.Web.Models">
    <d2p1:ProductType>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:CreatedBy>String</d2p1:CreatedBy>
      <d2p1:DeviceColorId>0</d2p1:DeviceColorId>
      <d2p1:DeviceMountTypeId>0</d2p1:DeviceMountTypeId>
      <d2p1:IsTransponder>false</d2p1:IsTransponder>
      <d2p1:LastUpd>0001-01-01T00:00:00</d2p1:LastUpd>
      <d2p1:LastUpdApp>String</d2p1:LastUpdApp>
      <d2p1:LastUpdBy>String</d2p1:LastUpdBy>
      <d2p1:ProductTypeDesc>String</d2p1:ProductTypeDesc>
      <d2p1:ProductTypeId>0</d2p1:ProductTypeId>
      <d2p1:Translations>String</d2p1:Translations>
    </d2p1:ProductType>
  </ProductTypes>
  <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebCRMV2.Data.Web.Models">
    <d2p1:Product>
      <d2p1:Comment>String</d2p1:Comment>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:CreatedBy>String</d2p1:CreatedBy>
      <d2p1:DeviceColorId>0</d2p1:DeviceColorId>
      <d2p1:DeviceMountTypeId>0</d2p1:DeviceMountTypeId>
      <d2p1:DeviceTypeId>0</d2p1:DeviceTypeId>
      <d2p1:IsInventory>false</d2p1:IsInventory>
      <d2p1:LastUpd>0001-01-01T00:00:00</d2p1:LastUpd>
      <d2p1:LastUpdApp>String</d2p1:LastUpdApp>
      <d2p1:LastUpdBy>String</d2p1:LastUpdBy>
      <d2p1:LowCountThreshold>0</d2p1:LowCountThreshold>
      <d2p1:ProcessVisibilityMask>0</d2p1:ProcessVisibilityMask>
      <d2p1:ProductDesc>String</d2p1:ProductDesc>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:ProductTypeId>0</d2p1:ProductTypeId>
      <d2p1:ShortDescription>String</d2p1:ShortDescription>
      <d2p1:Translations>String</d2p1:Translations>
    </d2p1:Product>
  </Products>
  <RebillSettingLimitation>
    <MaximalLBT>0</MaximalLBT>
    <MaximalRebillAmount>0</MaximalRebillAmount>
    <MinimalLBT>0</MinimalLBT>
    <MinimalRebillAmount>0</MinimalRebillAmount>
  </RebillSettingLimitation>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <VehicleClasses xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebCRMV2.Data.Web.Models">
    <d2p1:VehClass>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:CreatedBy>String</d2p1:CreatedBy>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:FareClassId>0</d2p1:FareClassId>
      <d2p1:LastUpd>0001-01-01T00:00:00</d2p1:LastUpd>
      <d2p1:LastUpdApp>String</d2p1:LastUpdApp>
      <d2p1:LastUpdBy>String</d2p1:LastUpdBy>
      <d2p1:MaxHeight>0</d2p1:MaxHeight>
      <d2p1:MaxLength>0</d2p1:MaxLength>
      <d2p1:MaxWidth>0</d2p1:MaxWidth>
      <d2p1:MinHeight>0</d2p1:MinHeight>
      <d2p1:MinLength>0</d2p1:MinLength>
      <d2p1:MinWidth>0</d2p1:MinWidth>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:ProcessVisibilityMask>0</d2p1:ProcessVisibilityMask>
      <d2p1:ShortCode>String</d2p1:ShortCode>
      <d2p1:Trailer>false</d2p1:Trailer>
      <d2p1:Translations>String</d2p1:Translations>
      <d2p1:VehClassID>0</d2p1:VehClassID>
      <d2p1:VehShortDesc>String</d2p1:VehShortDesc>
      <d2p1:VehTypeID>0</d2p1:VehTypeID>
    </d2p1:VehClass>
  </VehicleClasses>
</GetTollSchemeRulesResponse>