CustomerServiceGroup

  • 15.5
This article is may not be up to date with the latest stable release of M4.

Description

The CustomerServiceGroup endpoint provides the API consumer with access to methods pertaining to customer service groups and related data objects. The methods allow consumers to pull data and add, update, and delete customer service groups.

Methods

URL base/Billing/CustomerServiceGroup/Specification
Action GET
Description Returns a data dictionary that details the available web service methods related to the CustomerServiceGroup endpoint.
Parameters None
 Returns  A JSON object with method descriptions
Sample Return Object 
[
    {
        "HttpAction": "Post",
        "MethodName": "AddCustomerServiceGroup",
        "Description": "Adds a new CustomerServiceGroup. Optional list of Services.",
        "Format": {
            "Description": "Test",
            "CustomerID": 999,
            "CustomerServiceIDs": [
                1,
                2,
                3
            ]
        }
    },
    {
        "HttpAction": "Get",
        "MethodName": "GetCustomerServiceGroup",
        "Description": "Returns the record for a single CustomerServiceGroup given the passed in ID value (see Path).",
        "Path": "/CustomerServiceGroup/GetCustomerServiceGroup/25032"
    },
    {
        "HttpAction": "Get",
        "MethodName": "GetCustomerServiceGroupsByCustomer",
        "Description": "Returns the record for a single GetCustomerServiceGroup given the passed in Customer ID value (see Path).",
        "Path": "/CustomerServiceGroup/GetCustomerServiceGroupsByCustomer/25032"
    },
    {
        "HttpAction": "Post",
        "MethodName": "UpdateCustomerServiceGroup",
        "Description": "Allows for the updating of the CustomerServiceGroup Description ONLY.",
        "Format": {
            "ID": 1,
            "Description": "description of customer service group"
        }
    },
    {
        "HttpAction": "Post",
        "MethodName": "AddCustomerServicesToGroup",
        "Description": "Allows for the addition of multiple services to a CustomerServiceGroup.",
        "Format": {
            "ID": 1,
            "CustomerServiceIDs": [
                1,
                2,
                3
            ]
        }
    },
    {
        "HttpAction": "Post",
        "MethodName": "RemoveCustomerServicesFromGroup",
        "Description": "Allows for the removal multiple services from a CustomerServiceGroup.",
        "Format": {
            "ID": 1,
            "CustomerServiceIDs": [
                1,
                2,
                3
            ]
        }
    },
    {
        "HttpAction": "Get",
        "MethodName": "DeleteCustomerServiceGroup",
        "Description": "Deletes a single CustomerServiceGroup given the passed in ID value (see Path). Deleting the CustomerServiceGroup will also delete the linked customer service and customer feature records.",
        "Path": "/CustomerServiceGroup/DeleteCustomerServiceGroup/25032"
    }
]
URL base/Billing/CustomerServiceGroup/AddCustomerServiceGroup
Action POST
Description This method allows for create a Customer Service Group. The newly created object is returned. The Description and Customer ID are required fields.
Parameters
Name Required? Type Description
Description Yes String Description of the Customer Service Group unique to the Customer.
CustomerID Yes Integer The Customer that owns this group.
CustomerServiceIDs No List of integers The Customer Service IDs that belong in this group.
Sample JSON Package 
{
            "Description": "Test",
            "CustomerID": 999,
            "CustomerServiceIDs": [
                1,
                2,
                3
            ]
        }
Returns A JSON CustomerServiceGroup data object
Sample Return Object 
{
	"ID": 16131,
	"Description": "Sample Group",
	"CustomerID": 2,
	"CustomerServiceIDs": [
		1,
		2,
		3
	]
}
Business Rules
Any violations of these business rules result in an appropriate error message being returned to the API consumer.
 
Description
  • The Description must be unique to the Customer.
CustomerID:
  • The Customer ID must exist in the M4 Database.
URL base/Billing/CustomerServiceGroup/GetCustomerServiceGroup/ID
Action GET
Description Returns a CustomerServiceGroup object when given an ID of a valid CustomerServiceGroup in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a CustomerServiceGroup in the M4 database.
Returns A JSON CustomerServiceGroup data object
Sample Return Object 
{
	"ID": 16131,
	"Description": "Sample Group",
	"CustomerID": 2,
	"CustomerServiceIDs": [
		1,
		2,
		3
	]
}
URL base/Billing/CustomerServiceGroup/GetCustomerServiceGroupsByCustomer/ID
Action GET
Description Returns a list of CustomerServiceGroup objects when given an ID of a valid Customer in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a Customer in the M4 database.
Returns A JSON CustomerServiceGroup data object list
Sample Return Object 
[{
	"ID": 16131,
	"Description": "Sample Group 1",
	"CustomerID": 2,
	"CustomerServiceIDs": [
		1,
		2,
		3
	]
},
{
	"ID": 16132,
	"Description": "Sample Group 2",
	"CustomerID": 2,
	"CustomerServiceIDs": [
		1,
		2,
		3
	]
}]
URL base/Billing/CustomerServiceGroup/UpdateCustomerServiceGroup
Action POST
Description This method allows for the update of a Customer Service Group. The Description and ID are required fields.
Parameters
Name Required? Type Description
ID Yes Integer The CustomerServiceGroup to be updated.
Description Yes String Description of the Customer Service Group unique to the Customer.
Sample JSON Package 
{
  "ID": 16131,
  "Description": "Sample Group Updated"
}
Returns A JSON CustomerServiceGroup data object
Sample Return Object 
{
	"ID": 16131,
	"Description": "Sample Group Updated",
	"CustomerID": 2,
	"CustomerServiceIDs": [
		1,
		2,
		3
	]
}
Business Rules
Any violations of these business rules result in an appropriate error message being returned to the API consumer.
 
Description
  • The Description must be unique to the Customer.
URL base/Billing/CustomerServiceGroup/AddCustomerServicesToGroup
Action POST
Description This method allows for addition of CustomerServices to an existing Customer Service Group.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a CustomerServiceGroup in the M4 database.
CustomerServiceIDs Yes Collection of Integers A list of Integers containing the Customer Service IDs.
Sample JSON Package 
{
            "ID": 1,
            "CustomerServiceIDs": [
                1,
                2,
                3
            ]
        }
Returns A JSON message data object
Sample Return Object 
{ 
     "Message":"CustomerServices [111,222] added to CustomerServiceGroup [2]"
}
Business Rules
Any violations of these business rules result in an appropriate error message being returned to the API consumer.
CustomerID:
  • The Customer Services to be added MUST be have the same Customer ID as the CustomerServiceGroup.
URL base/Billing/CustomerServiceGroup/RemoveCustomerServiceFromGroup
Action POST
Description This method allows for removal of a CustomerService from an existing Customer Service Group.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a CustomerServiceGroup in the M4 database.
CustomerServiceIDs Yes Integer A list of integer values representing the Customer Service IDs in the M4 database.
Sample JSON Package 
{
            "ID": 1,
            "CustomerServiceIDs": [
                1,
                2,
                3
            ]
        }
Returns A JSON message data object
Sample Return Object 
{
     "Message":"CustomerService [111] removed from CustomerServiceGroup [123]."
}
URL base/Billing/CustomerServiceGroup/DeleteCustomerServiceGroup/ID
Action GET
Description Returns a string confirming the deletion of the CustomerServiceGroup from the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a CustomerServiceGroup in the M4 database.
Returns A JSON message data object
Sample Return Object 
{
    "Message":"CustomerServiceGroup [222] Deleted."
}

Was this article helpful?

Yes No

Related Articles