Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Maria Clerides

Saved on

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Excerpt

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

Tip
Available from CRM.COM R5.0.0

Resource URL

Parameters

http://host_name/crmapi/rest/$version/subscriptions/actions/get_scheduled

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(mandatory)

Subscription Identifier

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

Include Page
V4:subscription_identifier
V4:subscription_identifier

behavior_code

(optional)

StringADD

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
    1. ADD_SERVICE
    2. START_SERVICE
    3. STOP_SERVICE
    AMEND
    1. SWAP_
    BILLING
    1. SERVICE
    2. REMOVE_
    TERMS
    1. SERVICE
    CHANGE
    1. ADD_
    SUBSCRIBER
    1. SERVICE_
    ACCOUNT
    1. USAGE 
    CHANGE
    1. AMEND_
    SUBSCRIPTION
    1. BUNDLED_
    LOCATION
    1. SERVICE
    DEACTIVATE
    1. ACTIVATE_SUBSCRIPTION
    END
    1. DEACTIVATE_SUBSCRIPTION
    _RESTING
    EXTEND
    1. SHORT_
    GRACE_PERIODREMOVE_SERVICE
    1. TERM_ACTIVATION
    2. SHORT_TERM_DEACTIVATION
    3. AMEND_BILLING_TERMS
    4. AMEND_SERVICES_INSTALLED_ITEMS
    5. REST_SUBSCRIPTION
    START
    1. TERMINATE_
    SERVICE
    1. SUBSCRIPTION
    STOP
    1. REPLACE_
    SERVICE
    1. SUBSCRIPTION
    2. SWAP_
    SERVICETERMINATE_SUBSCRIPTION
    1. PACKAGE
    Tip

    Behavior codes REPLACE_SUBSCRIPTION and SWAP_PACKAGE deprecated from CRM.COM R17.0.0


    business_classification_code

    (optional)

    		String

    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
    1. ADD_
    SUBSCRIPTION
    1. SERVICE
     ADD_SERVICE /
    1. ADD_SERVICE_AS_DRAFT
     NEW
    1. START_
    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

    • number_of_results

    (optional)

    		Number
    1. SERVICE
    2. STOP_SERVICE
    3. ADD_SERVICE_USAGE 
    4. AMEND_BUNDLED_SERVICE
    5. UPGRADE_SERVICE
    6. DOWNGRADE_SERVICE
    7. SWITCH_SERVICE
    8. REGRET_SERVICE
    9. UNDO_ADD_SERVICE
    10. CANCEL_SERVICE
    11. ACTIVATE_SUBSCRIPTION
    12. DEACTIVATE_SUBSCRIPTION
    13. SHORT_TERM_ACTIVATION
    14. SHORT_TERM_DEACTIVATION
    15. 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
    16. REST_SUBSCRIPTION
    17. REGRET_SUBSCRIPTION
    18. CANCEL_SUBSCRIPTION
    19. REPLACE_SUB_PACK_TO_FLEX
    20. REPLACE_SUB_FLEX_TO_PACK
    21. UPGRADE_PACKAGE
    22. DOWNGRADE_PACKAGE
    23. SWITCH_PACKAGE
    Tip

    Business classification codes REPLACE_SUB_PACK_TO_FLEX, REPLACE_SUB_FLEX_TO_PACK, UPGRADE_PACKAGE, DOWNGRADE_PACKAGE and SWITCH_PACKAGE deprecated from CRM.COM R17.0.0


    number_of_results

    (optional)

    		Number

    The number of results that can be retrieved through each call

    Tip

    Available from CRM.COM R13.0.0


    offset

    (optional)

    		Number

    Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

    Tip

    Available from CRM.COM R13.0.0


    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

    ...

    Expand
    titleExample 1

    HTTP Method: GET


    Request:

     Request:http://hostname/crmapi/rest/v2/subscriptions/actions/get_scheduled?token=B8B3C5245F7A4EFF8C4A39DD5D41E3E4&subscription_identifier=number=S60058&behavior_code=DEACTIVATE_SUBSCRIPTION&business_classification_code=DEACTIVATE_SUBSCRIPTION

    Response:


    Code Block
     code
    language
    javascript
    themeConfluencelanguagejavascript
    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"
        }
    ]
}


    ...