GET v1/Locations/{locationID}/Policies/CarrierFees

Get a list of carrier fees

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationID

Id of the location

string

Required

Body Parameters

None.

Response Information

Resource Description

List of carrier fees

Collection of UtilityCarrierFeeDTO
NameDescriptionTypeAdditional information
CarrierFeeID

Id of the carrier fee

integer

None.

CarrierFeeName

Name of the carrier fee

string

None.

DefaultAmount

Default amount

decimal number

None.

AmountIsPercent

Signifies whether the amount is percent

boolean

None.

SystemDefined

Signifies whether the fee is system defined

boolean

None.

Visible

Signifies whether the fee is visible

boolean

None.

LocationID

Id of the location

integer

None.

AppCreated

App created

string

None.

ThirdPartyAppCode

Third party app code

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CarrierFeeID": 1,
    "CarrierFeeName": "sample string 2",
    "DefaultAmount": 3.0,
    "AmountIsPercent": true,
    "SystemDefined": true,
    "Visible": true,
    "LocationID": 1,
    "AppCreated": "sample string 6",
    "ThirdPartyAppCode": "sample string 7"
  },
  {
    "CarrierFeeID": 1,
    "CarrierFeeName": "sample string 2",
    "DefaultAmount": 3.0,
    "AmountIsPercent": true,
    "SystemDefined": true,
    "Visible": true,
    "LocationID": 1,
    "AppCreated": "sample string 6",
    "ThirdPartyAppCode": "sample string 7"
  }
]

application/xml, text/xml

Sample:
<ArrayOfUtilityCarrierFeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <UtilityCarrierFeeDTO>
    <AmountIsPercent>true</AmountIsPercent>
    <AppCreated>sample string 6</AppCreated>
    <CarrierFeeID>1</CarrierFeeID>
    <CarrierFeeName>sample string 2</CarrierFeeName>
    <DefaultAmount>3</DefaultAmount>
    <LocationID>1</LocationID>
    <SystemDefined>true</SystemDefined>
    <ThirdPartyAppCode>sample string 7</ThirdPartyAppCode>
    <Visible>true</Visible>
  </UtilityCarrierFeeDTO>
  <UtilityCarrierFeeDTO>
    <AmountIsPercent>true</AmountIsPercent>
    <AppCreated>sample string 6</AppCreated>
    <CarrierFeeID>1</CarrierFeeID>
    <CarrierFeeName>sample string 2</CarrierFeeName>
    <DefaultAmount>3</DefaultAmount>
    <LocationID>1</LocationID>
    <SystemDefined>true</SystemDefined>
    <ThirdPartyAppCode>sample string 7</ThirdPartyAppCode>
    <Visible>true</Visible>
  </UtilityCarrierFeeDTO>
</ArrayOfUtilityCarrierFeeDTO>