Tip
Available from CRM.COM R5.0.0

Table of Contents

maxLevel	2

GET subscriptions/actions/get_scheduled

This method returns the subscription action which are scheduled to be executed and are in life cycle state Scheduled. Multiple subscription action types are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

subscription_identifier

(mandatory)

...

The identifier of the subscription related with the actions that will be retrieved. The allowed subscription identifier fields are the following:

...

behavior_code

(optional)

...

The behavior code of the subscription actions that will be retrieved. If specified then only actions having the specified behavior code will be retrieved. The supported behavior codes are the following:

ACTIVATE_SUBSCRIPTION
ADD_SERVICE
AMEND_BILLING_TERMS
CHANGE_SUBSCRIBER_ACCOUNT
CHANGE_SUBSCRIPTION_LOCATION
DEACTIVATE_SUBSCRIPTION
END_SUBSCRIPTION_RESTING
EXTEND_GRACE_PERIOD
REMOVE_SERVICE
REST_SUBSCRIPTION
START_SERVICE
STOP_SERVICE
SWAP_SERVICE
TERMINATE_SUBSCRIPTION

...

business_classification_code

(optional)

...

The business classification code of the subscription actions that will be retrieved along with the action type. If specified then only actions having the specified business classification code will be retrieved. The supported business classification codes, per behavior code are the following:

ACTIVATE_SUBSCRIPTION
ADD_SERVICE / ADD_SERVICE_AS_DRAFT
NEW_BINDING_PERIOD_TERMS / RENEWED_BINDING_PERIOD_TERMS / EXTENDED_BINDING_PERIOD_TERMS / ADJUSTED_BINDING_PERIOD_TERMS / CANCELED_BINDING_PERIOD_TERMS / NO_BINDING_PERIOD_TERM_CHANGES
CHANGE_SUBSCRIBER / CHANGE_ACCOUNTS_RECEIVABLE
CHANGE_SUBSCRIPTION_LOCATION
DEACTIVATE_SUBSCRIPTION
END_SUBSCRIPTION_RESTING
EXTEND_GRACE_PERIOD
REGRET_SERVICE / UNDO_ADD_SERVICE / REGRET_SERVICE / CANCEL_SERVICE
REST_SUBSCRIPTION
START_SERVICE
STOP_SERVICE
UPGRADE_SERVICE / DOWNGRADE_SERVICE / SWITCH_SERVICE
REGRET_SUBSCRIPTION / CANCEL_SUBSCRIPTION

...

fields_set

(optional)

...

List of Strings, comma separated

...

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "scheduled_date": "2015-03-15T15:49:59",
            "action_type":
            {
                "name": "Deactivate subscribers",
                "id": "C61522563EAEBEDC5E44114BEBFCC8AC",
                "alternative_code": "00302"
            },
            "submitted_on": "2015-03-10T18:26:43",
            "sub_action_type":
            {
                "name": "Deactivation",
                "id": "4812DDB00F0940144053FA6B67AA4080",
                "alternative_code": "00303"
            },
            "business_classification_code": "DEACTIVATE_SUBSCRIPTION",
            "number": "721",
            "executed_on": null,
            "life_cycle_state": "SCHEDULED",
            "performed_by":
            {
                "person_name": "mpadministrator",
                "username": "mpadministrator",
                "id": "1"
            },
            "behavior_code": "DEACTIVATE_SUBSCRIPTION",
            "submitted_by":
            {
                "person_name": "mpadministrator",
                "username": "mpadministrator",
                "id": "1"
            },
            "id": "66FC63054A3E43AC951A99823ACA8B6A",
            "subscription":
            {
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Kuriakou",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "company_profile": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Kakos",
                        "name": "Kakos Kuriakou",
                        "id": "0C93319EC1B536ED3A9EF3D2C21F1342",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": null,
                            "passport_issued_by_country": null,
                            "passport_number": null,
                            "social_security_number": null,
                            "country_of_residence":
                            {
                                "name": "JAPAN",
                                "id": "237"
                            },
                            "industry_sector": null,
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "id_number": null,
                            "id_issued_by_country": null,
                            "industry": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "82",
                    "name": "Kuriakou",
                    "id": "C977389E2F7BCAA0047BC6ADC2F8D2E2"
                },
                "life_cycle_state": "EFFECTIVE",
                "number": "S60058",
                "type":
                {
                    "name": "Normal Subscription",
                    "id": "6BB2B984CC9309775D06650C7493A836",
                    "description": null,
                    "alternative_code": "ST"
                },
                "id": "C8E3D014A8FAE4D352CDBDE30F7CC877"
            },
            "performed_on": "2015-03-10T18:26:43"
        }
    ]
}

POST subscriptions/actions/cancel

This method cancels a scheduled action. This web API method can be used only on actions which are in a scheduled life cycle state. A single subscription action can be cancelled by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

subscription_action_identifier

(mandatory)

...

The subscription action to be cancelled. The allowed subscription action identifier fields are the following:

...

fields_set

(optional)

...

Response Data

...

Examples

HTTP Method: POST

Request:

Body:

Expand

title	Example 1

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "token": "BAB61C7163984029A3E4877F727B145A",
  "subscription_action_identifier":{"id":"1F46975162B043F793845CF623DB30C3"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{ "status": { "message": null, "description": null, "code": "OK" }, "data": { "scheduled_date": "2015-03-06T00:00:00", "action_type": null, "submitted_on": "2015-03-05T12:15:06", "sub_action_type": null, "business_classification_code": "REST_SUBSCRIPTION", "number": "652", "executed_on": null, "life_cycle_state": "CANCELLED", "performed_by": { "person_name": "mpadministrator", "username": "mpadministrator", "id": "1" }, "behavior_code": "REST_SUBSCRIPTION", "submitted_by": { "person_name": "mpadministrator", "username": "mpadministrator", "id": "1" }, "id": "1F46975162B043F793845CF623DB30C3", "subscription": { "accounts_receivable": { "account_owner": { "last_name": "Ioannou62", "life_cycle_state": "FINANCIAL", "middle_name": null, "company_profile": null, "title": null, "type": "PERSON", "first_name": "Marios", "name": "Marios Ioannou62", "id": "ED341F6221594379885524F4881A0644", "company_name": null, "demographics": { "gender": null, "passport_issued_by_country": null, "passport_number": null, "social_security_number": null, "country_of_residence": { "name": "UNITED KINGDOM", "id": "126" }, "industry_sector": null, "date_of_birth": { "month": null, "day": null, "year": null }, "name_day": { "month": null, "day": null }, "id_number": null, "id_issued_by_country": null, "industry": null } }, "life_cycle_state": "ACTIVE", "number": "440", "name": "mar62", "id": "DF02CC62D9DE76DEB5C6B32BEBCBFDF1" }, "life_cycle_state": "NOT_EFFECTIVE", "number": "S60246", "type": { "name": "Digital", "id": "BF666FA094CA88E36BA6AE1F924C69F9", "description": null, "alternative_code": "DST" }, "id": "B4BB0997B5B62B1FAB5297E82AE14E4A" }, "performed_on": "2015-03-05T12:10:02" } } Panel

name	blue

Child pages (Children Display)

all	true
excerpt	true

Versions Compared

Old Version 9

New Version Current

Key

GET subscriptions/actions/get_scheduled

Resource URL

Parameters

Response Data

Examples

POST subscriptions/actions/cancel

Resource URL

Parameters

Response Data

Examples

Page Comparison

Versions Compared

Old Version 9

New Version Current

Key

GET subscriptions/actions/get_scheduled

Resource URL

Parameters

Response Data

Examples

POST subscriptions/actions/cancel

Resource URL

Parameters

Response Data

Examples