Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

It removes one or multiple draft subscription services from a specific subscription

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

subscription_identifier

(semi-optional)

...


Excerpt

It removes one or multiple draft subscription services from a specific subscription

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

Subscription identifier

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

Include Page
V4:subscription_identifier
V4:subscription_identifier

Tip

For releases prior to CRM.COM R13.0.0 the subscription_identifier is mandatory


accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

Note

The ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription


Tip

Available from CRM.COM R13.0.0


action_type_identifier

(optional)

Subscription action type identifier

The action type that should be used. The allowed subscription action type identifier fields are the following:

Include Page
V4:subscription_action_type_identifier
V4:subscription_action_type_identifier

Tip
For releases prior to

Deprecated from CRM.COM

R13

R15.0.0

the subscription_identifier is mandatoryaccounts_receivable


sub_action_type_identifier

(

semi-

optional)

Accounts Receivable IdentifierThe accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable
Subscription sub action type identifier

The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:

Include Page
V4:

accounts_receivable

subscription_sub_action_type_identifier

_post

V4:

accounts

subscription_

receivable

sub_

identifier_post NoteThe ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription

action_type_identifier

Tip
Available

Deprecated from CRM.COM

R13

R15.0.0

action


classification_

type_

identifier

(optional)

Subscription
action type identifier
Action Classification Identifier

The

action type that should be used

subscription action's classification. The allowed subscription action

type

classification identifier fields are the following:

Include Page
V4:subscription_action_

type

classification_identifier
V4:subscription_action_

type

classification_identifier

sub_action_type
Tip

Available from CRM.COM R18.0.0


transaction_reference_number

(optional)

String

The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions.

Tip

Available from CRM.COM R13.0.0


performed_by_user_identifier

(optional)

Subscription sub action type
User identifier

The

sub action type that should be used

user that actually performed the action. The allowed

subscription sub action type

user identifier fields are the following:

Include Page
V4:

subscription_sub_action_type_

user_identifier
V4:

subscription

user_

sub

identifier

performed_

action

by_

type

unit_identifier

transaction_reference_number

(optional)

String
Unit Identifier

The

transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions.

 

TipAvailable

unit that performed the action. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

Tip

Available from CRM.COM R14.0.0

Deprecated from CRM.COM

R13

R18.0.0


performed_by_

user

business_unit_identifier

(optional)

User identifier The user that actually
Business Unit Identifier

The business unit that performed the action. The allowed

user

business unit identifier fields are the following:

Include Page
V4:

user

business_unit_identifier
V4

:user_identifier

:business_unit_identifier

Tip

Available from CRM.COM R18.0.0


performed_on

(optional)

Date
 The
The date that the action was actually performed

scheduled_date

(optional)

Date

The date that the action is scheduled to be executed. If not specified then the action will be executed immediately

 

The date that the action is scheduled to be executed. If not specified then the action will be executed immediately


use_proposed_scheduled_date

(optional)

Boolean

Defines whether the scheduled date automatically calculated and proposed by the system based on business rules, will be automatically set as the subscription's scheduled date or not. Applicable only if the subscription action includes a scheduled date and only if this scheduled date does not meet the business rules.

Tip

Available from CRM.COM R15.0.0


udf_string_1 

(optional)

String

User Defined Field of type String

udf_string_2 

(optional)

String

User Defined Field of type String

udf_string_3 

(optional)

String

User Defined Field of type String

udf_string_4 

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6 

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1 

(optional)

Date

User Defined Field of type Date

udf_date_2 

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

services_set

(mandatory)

Set of subscription service objectsThe services that will be removed from the 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

Tip

Available from CRM.COM R10.0.0


Anchor
services_remove_draft referred objects parameters
services_remove_draft referred objects parameters
Referred Parameter Objects Data

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
	"token":"4B19B26D35A24CD7AD8836575D6CD92A",
	"subscription_identifier":{"number":"S60147"},
	"action_type_identifier": {"alternative_code":"RS"},
	"sub_action_type_identifier": {"alternative_code":"UAS"},
	"performed_by_user_identifier":{"username":"JackH"},
	"performed_on":"2014-07-15T05:07:41",
	"services_set": 
	[
		{
			"service_identifier":{"code":"Local + Documentaries + Int."}
		}
	]
}


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "action_type":
        {
            "name": "remove service",
            "id": "9D9999EAF79FDFB2C0AD91AC17474215",
            "alternative_code": "RS"
        },
        "submitted_on": "2014-07-16T10:58:02",
        "sub_action_type":
        {
            "name": "Undo add Service",
            "id": "D90DFCD309A12DCDDD5E46501D8DB51F",
            "alternative_code": "UAS"
        },
        "business_classification_code": "UNDO_ADD_SERVICE",
        "number": "415",
        "executed_on": "2014-07-16T10:58:03",
        "life_cycle_state": "EXECUTED",
        "performed_by":
        {
            "person_name": "Jack Hadjicosti",
            "username": "JackH",
            "id": "B8650C555C4EA8C741103961276E7773",
            "email": "j_hadjicosti@crm.com"
        },
        "behavior_code": "REMOVE_SERVICE",
        "submitted_by":
        {
            "person_name": "Jack Hadjicosti",
            "username": "JackH",
            "id": "B8650C555C4EA8C741103961276E7773",
            "email": null
        },
        "id": "2C128CEC2628C3528903BB21856C824D",
        "subscription":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Johnson",
                    "middle_name": null,
                    "company_profile": null,
                    "type": "PERSON",
                    "first_name": "Peter",
                    "name": "Peter Johnson",
                    "id": "C73D1572FEA76C37A08945ECE4DECC98",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": "7839023",
                        "social_security_number": "98374",
                        "country_of_residence":
                        {
                            "name": "CYPRUS",
                            "id": "181"
                        },
                        "industry_sector":
                        {
                            "name": "GOVERNMENTAL",
                            "id": "A9BDEBD4D8FAEDB0BACE40C041156D12"
                        },
                        "date_of_birth":
                        {
                            "month": 4,
                            "day": 6,
                            "year": 1985
                        },
                        "name_day":
                        {
                            "month": 6,
                            "day": 29
                        },
                        "id_number": "984783",
                        "id_issued_by_country":
                        {
                            "name": "CYPRUS",
                            "id": "181"
                        },
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "192",
                "name": "Peter Johnson Premium",
                "id": "2C5FC6F615FA9E798487AC0C293ECCE6"
            },
            "life_cycle_state": "DRAFT",
            "number": "S60147",
            "type":
            {
                "name": "Anniversary Subscription",
                "id": "0A5316647B8BD6364168BB897B3C828B",
                "description": null,
                "alternative_code": "ANSUB"
            },
            "id": "374DBEB9E269C1C810375C4266ACAAAF"
        },
        "performed_on": "2014-07-15T05:07:41"
    }
}


...