Counting Rule

(API Version v10)

What can you do with CountingRule?

DELETE CountingRule/{id}
Delete an instance of the CountingRule object.
GET CountingRule/
Retrieve all of the CountingRule objects.
GET CountingRule/Paged
Retrieve all of the CountingRule objects in a paged fashion.
GET CountingRule/{id}
Retrieve an instance of the CountingRule object by its ID.
GET CountingRule/{id}/Detail
Retrieve deep detail of the CountingRule object by its ID.
PATCH CountingRule/{id}
Update or Add the CountingRule object and optionally make changes to any child objects.
POST CountingRule/
Create a new instance of the CountingRule object.
PUT CountingRule/{id}
Update an existing instance of the CountingRule object.

Properties

Property Details

identity READ-ONLY	"identity": 3 Type: Number This is the unique numeric identifier for the CountingRule
ownerId READ-ONLY	"ownerId": 2 Type: Number Unique identifier for the associated Owner object.
ownerName READ-ONLY	"ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property.
name	"name": "Hello World" Type: String
statusTierTypeId	"statusTierTypeId": 1 Type: Number Unique identifier for the associated StatusTierType object.
statusTierTypeName	"statusTierTypeName": "Sample Name" Type: String The name of the object associated with the statusTierTypeId property.
countingRuleTypeId	"countingRuleTypeId": 6 Type: Number Unique identifier for the associated CountingRuleType object.
countingRuleTypeName	"countingRuleTypeName": "Sample Name" Type: String The name of the object associated with the countingRuleTypeId property.
isActive	"isActive": true Type: Boolean
countIfUsage	"countIfUsage": true Type: Boolean

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call. Below you will find the child objects that can be updated as part of PATCH operations for the CountingRule object.

Standard PATCH objects:

countingRulePackage - create, update, delete
countingRuleService - create, update, delete

DataFlow PATCH objects:

countingRule - create, update, delete
countingRulePackage - create, update, delete
countingRuleService - create, update, delete

End Points

DELETE	CountingRule/{id}
Delete an instance of the CountingRule object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}	Unique identifier for the CountingRule object.
Delete an instance of the CountingRule object. DELETE CountingRule/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "delete", "results": { "totalCount": 4, "items": [ { "identity": 1, "action": "deleted", "dtoTypeKey": "countingRule" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

Retrieve all of the CountingRule objects.

GET CountingRule/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 19,
            "ownerName": "Sample Text Data",
            "name": "Sample Text Data",
            "statusTierTypeId": 19,
            "statusTierTypeName": "Sample Text Data",
            "countingRuleTypeId": 23,
            "countingRuleTypeName": "Sample Text Data",
            "isActive": true,
            "countIfUsage": true
        }
    ]
}

Retrieve all of the CountingRule objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.

Retrieve all of the CountingRule objects in a paged fashion.

GET CountingRule/Paged

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 5,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "statusTierTypeId": 18,
                "statusTierTypeName": "Sample Text Data",
                "countingRuleTypeId": 21,
                "countingRuleTypeName": "Sample Text Data",
                "isActive": true,
                "countIfUsage": true
            }
        ]
    }
}

GET	CountingRule/{id}
Retrieve an instance of the CountingRule object by its ID.
{id}	Unique identifier for the CountingRule object.
Retrieve an instance of the CountingRule object by its ID. GET CountingRule/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "ownerId": 8, "ownerName": "Sample Text Data", "name": "Sample Text Data", "statusTierTypeId": 15, "statusTierTypeName": "Sample Text Data", "countingRuleTypeId": 19, "countingRuleTypeName": "Sample Text Data", "isActive": true, "countIfUsage": true } }

GET	CountingRule/{id}/Detail
Retrieve deep detail of the CountingRule object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}	Unique identifier for the CountingRule object.
Retrieve deep detail of the CountingRule object by its ID. GET CountingRule/{id}/Detail View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "ownerId": 20, "ownerName": "Sample Text Data", "name": "Sample Text Data", "statusTierTypeId": 1, "statusTierTypeName": "Sample Text Data", "countingRuleTypeId": 13, "countingRuleTypeName": "Sample Text Data", "isActive": true, "countIfUsage": true, "details": { "countingRulePackages": [ { "identity": 90, "countingRuleId": 36, "countingRuleName": "Sample Text Data", "packageFrequencyId": 67, "packageFrequencyName": "Sample Text Data", "accountPackageStatusTypeId": 15, "accountPackageStatusTypeName": "Sample Text Data", "packageId": 92, "packageName": "Sample Text Data" } ], "countingRuleServices": [ { "identity": 12, "countingRuleId": 59, "countingRuleName": "Sample Text Data", "serviceId": 76, "serviceName": "Sample Text Data", "serviceStatusTypeId": 66, "serviceStatusTypeName": "Sample Text Data" } ] } } }

PATCH	CountingRule/{id}
Update or Add the CountingRule object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}	Unique identifier for the CountingRule object.
Update or Add the CountingRule object and optionally make changes to any child objects. PATCH CountingRule/{id} { "details": {}, "countingRules": { "items": [ { "patchType": "create", "patchClientId": 1, "name": "Sample Text Data", "statusTierTypeId": 6, "countingRuleTypeId": 19, "isActive": true, "countIfUsage": true } ] } } View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "patch", "results": { "totalCount": 1, "items": [ { "identity": 1, "action": "created", "dtoTypeKey": "countingRule", "instance": { "identity": 1, "ownerId": 16, "ownerName": "Sample Text Data", "name": "Sample Text Data", "statusTierTypeId": 7, "statusTierTypeName": "Sample Text Data", "countingRuleTypeId": 10, "countingRuleTypeName": "Sample Text Data", "isActive": true, "countIfUsage": true } } ] } }

Create a new instance of the CountingRule object.

POST CountingRule/

{
    "name": "Sample Text Data",
    "statusTierTypeId": 12,
    "countingRuleTypeId": 24,
    "isActive": true,
    "countIfUsage": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 14,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "statusTierTypeId": 24,
                "statusTierTypeName": "Sample Text Data",
                "countingRuleTypeId": 18,
                "countingRuleTypeName": "Sample Text Data",
                "isActive": true,
                "countIfUsage": true
            }
        ]
    }
}

Update an existing instance of the CountingRule object.

PUT CountingRule/{id}

{
    "identity": 1,
    "name": "Sample Text Data",
    "statusTierTypeId": 15,
    "countingRuleTypeId": 7,
    "isActive": true,
    "countIfUsage": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 13,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "statusTierTypeId": 11,
                "statusTierTypeName": "Sample Text Data",
                "countingRuleTypeId": 8,
                "countingRuleTypeName": "Sample Text Data",
                "isActive": true,
                "countIfUsage": true
            }
        ]
    }
}