PUT v1/Locations/{locationID}/Policies/CarrierFees/{carrierFeeID}
Update a carrier fee
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
locationID |
Id of the location |
string |
Required |
carrierFeeID |
Id of the carrier fee to be updated |
string |
Required |
Body Parameters
Carrier fee
UtilityCarrierFeeDTOName | Description | Type | Additional information |
---|---|---|---|
CarrierFeeID | integer |
None. |
|
CarrierFeeName | string |
None. |
|
DefaultAmount | decimal number |
None. |
|
AmountIsPercent | boolean |
None. |
|
SystemDefined | boolean |
None. |
|
Visible | boolean |
None. |
|
LocationID | integer |
None. |
|
AppCreated | string |
None. |
|
ThirdPartyAppCode | string |
None. |
Request 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" }
application/xml, text/xml
Sample:
<UtilityCarrierFeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies"> <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>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Updated carrier fee
ActionResultDTOOfUtilityCarrierFeeDTOName | Description | Type | Additional information |
---|---|---|---|
Result | UtilityCarrierFeeDTO |
None. |
|
CreatedBy | string |
None. |
|
EntityID | integer |
None. |
|
RowSource | string |
None. |
|
PolicyID | integer |
None. |
|
IsSuccess | boolean |
None. |
|
ErrorCode | string |
None. |
|
ErrorMessage | string |
None. |
|
InfoMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Result": { "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" }, "CreatedBy": "sample string 1", "EntityID": 2, "RowSource": "sample string 3", "PolicyID": 4, "IsSuccess": true, "ErrorCode": "sample string 6", "ErrorMessage": "sample string 7", "InfoMessage": "sample string 8" }
application/xml, text/xml
Sample:
<ActionResultOfUtilityCarrierFeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects"> <ErrorCode>sample string 6</ErrorCode> <ErrorMessage>sample string 7</ErrorMessage> <InfoMessage>sample string 8</InfoMessage> <IsSuccess>true</IsSuccess> <CreatedBy>sample string 1</CreatedBy> <EntityID>2</EntityID> <PolicyID>4</PolicyID> <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies"> <d2p1:AmountIsPercent>true</d2p1:AmountIsPercent> <d2p1:AppCreated>sample string 6</d2p1:AppCreated> <d2p1:CarrierFeeID>1</d2p1:CarrierFeeID> <d2p1:CarrierFeeName>sample string 2</d2p1:CarrierFeeName> <d2p1:DefaultAmount>3</d2p1:DefaultAmount> <d2p1:LocationID>1</d2p1:LocationID> <d2p1:SystemDefined>true</d2p1:SystemDefined> <d2p1:ThirdPartyAppCode>sample string 7</d2p1:ThirdPartyAppCode> <d2p1:Visible>true</d2p1:Visible> </Result> <RowSource>sample string 3</RowSource> </ActionResultOfUtilityCarrierFeeDTO>