Versions Compared

Old Version 5

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R5.0.0

Table of Contents
maxLevel2

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:

  1. ACTIVATESUBSCRIPTION
  2. ADDINSTALLEDITEM
  3. ADDSERVICEUSAGE
  4. ADDSERVICE
  5. AMENDBILLINGTERMS
  6. BECOMESUBSCRIBER
  7. BILLASOFDATE
  8. CHANGESUBRIBERACCOUNT
  9. CHANGESUBSCRIPTIONLOCATION
  10. DEACTIVATESUBSCRIPTION
  11. ENDSUBSCRIPTIONRESTING
  12. EXTENDGRACEPERIOD
  13. REMOVEINSTALLEDITEM
  14. REMOVESERVICE
  15. RESTSUBSCRIPTION
  16. STARTSERVICE
  17. STOPSERVICE
  18. SWAPINSTALLEDITEM
  19. SWAPSERVICE
  20. TERMINATESUBSCRIPTION

...

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:

  1. ACTIVATESUBSCRIPTION
  2.  ADDINSTALLEDITEM
  3.  ADDSERVICEUSAGE
  4.  ADDSERVICE / ADDSERVICEASDRAFT
  5.  NEWBINDINGPERIODTERMS / RENEWEDBINDINGPERIODTERMS / EXTENDEDBINDINGPERIODTERMS / ADJUSTEDBINDINGPERIODTERMS / CANCELEDBINDINGPERIODTERMS / NOBINDINGPERIODTERMCHANGES
  6. CREATEACTIVATESUBSCRIPTION / CREATEDRAFTSUBSCRIPTION
  7. NORMAL
  8. CHANGESUBSCRIBER / CHANGEACCOUNTSRECEIVABLE
  9. CHANGESUBSCRIPTIONLOCATION
  10. DEACTIVATESUBSCRIPTION
  11. ENDSUBSCRIPTIONRESTING
  12. EXTENDGRACEPERIOD
  13. REMOVEINSTALLEDITEM / UNDOADDINSTITEM
  14. REGRETSERVICE / UNDOADDSERVICE / REGRETSERVICE / CANCELSERVICE
  15. RESTSUBSCRIPTION
  16. STARTSERVICE
  17. STOPSERVICE
  18. SWAPINSTALLEDITEM

  19. UPGRADESERVICE / DOWNGRADESERVICE / SWITCHSERVICE

  20. REGRETSUBSCRIPTION / CANCELSUBSCRIPTION

...

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
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 
      {
    "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:

...

Response Data

...

Examples

 

HTTP Method: POST

 

Request:

Body:

Expand
titleExample 1
Code Block
themeConfluence
languagejavascript
linenumberstrue
 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
  Panel
nameblue

Child pages (Children Display)
alltrue
excerpttrue