GET api/chargegroup/{id}

The purpose of this method is search for a Charge Group by its ID

Error Messages
  • 404/Not Found - Charge Group with ID x not found - Specified ID is not assigned to any Charge Groups

Request Information

URI Parameters

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

Required

Body Parameters

None.

Response Information

Resource Description

ChargeGroupView
NameDescriptionTypeAdditional information
Id The ID of the Charge Group integer

None.

CategoryName The Charge Category name string

None.

ParentName The parent Service Charge name. For cities, the parent is usually the country the city is in string

None.

LastUpdated The date/time that the charge group was last updated date

None.

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.