POST v1/Locations/{locationID}/Policies/AgencyFees

Upsert and agency fee

Request Information

URI Parameters

Name	Description	Type	Additional information
locationID	Id of the location	string	Required

Body Parameters

Agency fee to be upserted

UtilityAgencyFeeDTO

Name	Description	Type	Additional information
DefaultAmount	Default amount	decimal number	None.
AmountIsPercent	Signifies whether the amount is percent	boolean	None.
Visible	Signifies whether the fee is visible	boolean	None.
LocationID	Id of the location	integer	None.
ShowInInvoice	Signifies whether the fee is shown in invoice	boolean	None.
FeeType	Type of the fee	integer	None.
AgencyFeeID	Id of the agency fee	integer	None.
AgencyFeeName	Name of the agency fee	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DefaultAmount": 1.0,
  "AmountIsPercent": true,
  "Visible": true,
  "LocationID": 1,
  "ShowInInvoice": true,
  "FeeType": 1,
  "AgencyFeeID": 3,
  "AgencyFeeName": "sample string 4"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UtilityAgencyFeeDTO'.

application/xml, text/xml

Sample:

<UtilityAgencyFeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <AgencyFeeID>3</AgencyFeeID>
  <AgencyFeeName>sample string 4</AgencyFeeName>
  <AmountIsPercent>true</AmountIsPercent>
  <DefaultAmount>1</DefaultAmount>
  <FeeType>1</FeeType>
  <LocationID>1</LocationID>
  <ShowInInvoice>true</ShowInInvoice>
  <Visible>true</Visible>
</UtilityAgencyFeeDTO>

Response Information

Resource Description

Upserted agency fee

ActionResultDTOOfUtilityAgencyFeeDTO

Name	Description	Type	Additional information
Result		UtilityAgencyFeeDTO	None.
CreatedBy		string	None.
EntityID		integer	None.
RowSource		string	None.
PolicyID		integer	None.
IsSuccess	Signifies whether action is successful	boolean	None.
ErrorCode	Error code	string	None.
ErrorMessage	Error message	string	None.
InfoMessage	Information message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "DefaultAmount": 1.0,
    "AmountIsPercent": true,
    "Visible": true,
    "LocationID": 1,
    "ShowInInvoice": true,
    "FeeType": 1,
    "AgencyFeeID": 3,
    "AgencyFeeName": "sample string 4"
  },
  "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:

<ActionResultOfUtilityAgencyFeeDTO 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:AgencyFeeID>3</d2p1:AgencyFeeID>
    <d2p1:AgencyFeeName>sample string 4</d2p1:AgencyFeeName>
    <d2p1:AmountIsPercent>true</d2p1:AmountIsPercent>
    <d2p1:DefaultAmount>1</d2p1:DefaultAmount>
    <d2p1:FeeType>1</d2p1:FeeType>
    <d2p1:LocationID>1</d2p1:LocationID>
    <d2p1:ShowInInvoice>true</d2p1:ShowInInvoice>
    <d2p1:Visible>true</d2p1:Visible>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfUtilityAgencyFeeDTO>