PATCH api/chargegroup/{id}

The purpopse of this API method

Error Messages
  • 409/Conflict - Charge Group does not exist - Specified ID is not assigned to a Charge Group
  • 409/Conflict - Destination must have value - Specify a Destination for his Charge Group
  • 409/Conflict - Destination name already exists - Specofy a new Destination name as this one already exists
  • 409/Conflict - Invalid parent ID - The specified ID for Parent ID does not exist
  • 409/Conflict - The current Parent selected is invalid because its type does not match the type of this Charge Group. Please select an appropriate Parent, namely one that matches the type of Charge Group (Fixed Line or Mobile)
  • 409/Conflict - Invalid Category ID - Specified Category ID is not assinged to a category
  • 409/Conflict - Invalid continent - Specify a valid continent

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id Charge Group ID- The unique identifer for the Charge Group being updated. integer

Required

Body Parameters

ChargeGroup
NameDescriptionTypeAdditional information
Destination The Charge Group destination string

String length: inclusive between 0 and 50
Summary Allows the user to select that Destination to be included on a Summary Rate Report showing key destinations boolean

None.
DontReport Indiates whether the charge group is excluded from the Rate Sheet Reports boolean

None.
Hide Indicates whether calls on his charged group are to excluded from customer reports boolean

None.
UseAccess An additional charge for using the Charge Group boolean

None.
TextMessage Indicates that the Charge Group is suitable for SMS messages boolean

None.
Continent The continent of the Charge Group string

None.
AlternativeDescription Additional information or alternative description string

String length: inclusive between 0 and 100
Mobile Indicates whether the Charge Group is Mobile Charge Group boolean

None.
CategoryId The Charge Category ID integer

None.
ParentId The ID of the parent Service Charge integer

None.
FlagIcon Which flag icon to use string

None.
UST_Id Identify the same charge group in any system, regardless of the name or id in the customers system. globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "Destination": "sample string 1",
  "Summary": true,
  "DontReport": true,
  "Hide": true,
  "UseAccess": true,
  "TextMessage": true,
  "Continent": "sample string 4",
  "AlternativeDescription": "sample string 5",
  "Mobile": true,
  "CategoryId": 1,
  "ParentId": 1,
  "FlagIcon": "sample string 7",
  "UST_Id": "266176b3-67db-4f93-88f7-f27374094291"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.