Table of Contents

maxLevel	2

POST subscriptions/installed_items/add

It adds one or multiple installed items on a specific subscription

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(mandatory)

Subscription identifier

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

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

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

sub_action_type_identifier

(optional)

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:subscription_sub_action_type_identifier
	V4:subscription_sub_action_type_identifier

perfomerd_by_user_identifier

(optional)

User identifier

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

Include Page

	V4:user_identifier
	V4:user_identifier

performed_on

(optional)

Date

The date that the action was actually performed

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

installed_items_set

(mandatory)

Set of subscription installed item objects

The installed items that should be added on the subscription

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

Include Page

	V4:new_subscription_installed_item_parameter
	V4:new_subscription_installed_item_parameter

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:subscription_action_short
	V4:subscription_action_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "token":"09CB68CC0E00A93FC936274CC7A7D0F8",
    "subscription_identifier":{"number":"S60250"},
       "action_type_identifier": {"name"  : "Add Installed Item"},
    "performed_by_user_identifier":{"username":"JackH"},
    "performed_on":"2014-07-17T05:07:41",
    "installed_items_set":[
        {
            "installed_item_identifier":{
                "serial_number":"001100110015"
            },
            "installed_items_distribution_set":[
                {
                    "provisioning_distributor_identifier":{
                        "name":"Main"
                    }
                }
            ]
        }
    ]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "action_type":
        {
            "name": "Add Installed Item",
            "id": "37392FB25A01774C691058C76BC01719",
            "alternative_code": "ADDITEM"
        },
        "submitted_on": "2014-11-25T19:02:11",
        "sub_action_type": null,
        "business_classification_code": "ADD_INSTALLED_ITEM",
        "number": "297",
        "executed_on": "2014-11-25T19:02:11",
        "life_cycle_state": "EXECUTED",
        "performed_by":
        {
            "person_name": "Jack Hadjicosti2",
            "username": "JackH",
            "id": "B8650C555C4EA8C741103961276E7773",
            "email": "j_hadjicosti@crm.com"
        },
        "behavior_code": "ADD_INSTALLED_ITEM",
        "submitted_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1",
            "email": null
        },
        "id": "DB29234F5FAE478CAC5582E7E4DF9D4A",
        "subscription":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Clark",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "S.",
                    "company_profile": null,
                    "title": "Mrs",
                    "type": "PERSON",
                    "first_name": "Kathy",
                    "name": "Clark Kathy",
                    "id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country": null,
                        "passport_number": "4564455",
                        "social_security_number": "88996633",
                        "country_of_residence":
                        {
                            "name": "UNITED STATES",
                            "id": "127"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": 1,
                            "day": 1,
                            "year": 1980
                        },
                        "name_day":
                        {
                            "month": 1,
                            "day": 1
                        },
                        "id_number": "87878000",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "191",
                "name": "Kat's Main TV Account",
                "id": "D64410DDAC580029C9664EAB74ACAC9C"
            },
            "life_cycle_state": "DRAFT",
            "number": "S60250",
            "type":
            {
                "name": "London",
                "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                "description": null,
                "alternative_code": "LND"
            },
            "id": "A521D332281C71FE88C58ACEC78C39BD"
        },
        "performed_on": "2014-07-17T05:07:41"
    }
}

POST subscriptions/installed_items/remove

It removes one or multiple subscription installed items from a specific subscription

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(mandatory)

Subscription identifier

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

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

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

sub_action_type_identifier

(optional)

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:subscription_sub_action_type_identifier
	V4:subscription_sub_action_type_identifier

perfomerd_by_user_identifier

(optional)

User identifier

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

Include Page

	V4:user_identifier
	V4:user_identifier

performed_on

(optional)

Date

The date that the action was actually performed

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

installed_items_set

(optional)

Set of subscription installed item objects

The installed items that should be added on the subscription

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

Include Page

	V4:existing_subscription_installed_item_parameter
	V4:existing_subscription_installed_item_parameter

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:subscription_action_short
	V4:subscription_action_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "token":"827646F7058139B66EA59CBA46D46FF3",
    "subscription_identifier":{"number":"S60263"},
    "performed_by_user_identifier":{"username":"JackH"},
    "performed_on":"2014-07-16T05:07:41",
    "installed_items_set":
    [
        {
            "installed_item_identifier":{"serial_number":"300000000000"}
        }
    ]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "action_type": null,
        "submitted_on": "2014-12-03T12:26:47",
        "sub_action_type": null,
        "business_classification_code": "REMOVE_INSTALLED_ITEM",
        "number": "383",
        "executed_on": "2014-12-03T12:26:48",
        "life_cycle_state": "EXECUTED",
        "performed_by":
        {
            "person_name": "Jack Hadjicosti2",
            "username": "JackH",
            "id": "B8650C555C4EA8C741103961276E7773",
            "email": "j_hadjicosti@crm.com"
        },
        "behavior_code": "REMOVE_INSTALLED_ITEM",
        "submitted_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1",
            "email": null
        },
        "id": "663906B64853475F50741F7F04AAA1AE",
        "subscription":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Mixail",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Tassoula",
                    "name": "Mixail Tassoula",
                    "id": "11745776A3EDF5190503D534AFD67904",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence":
                        {
                            "name": "UNITED STATES",
                            "id": "127"
                        },
                        "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": "ACR000321",
                "name": "Mixail",
                "id": "FEC5360EC9A891129DEC09B74C46F155"
            },
            "life_cycle_state": "NOT_EFFECTIVE",
            "number": "S60263",
            "type":
            {
                "name": "United Kingdom",
                "id": "1C81FBB1E5D90040F440ECE98D6A368D",
                "description": "United Kingdom",
                "alternative_code": "UK"
            },
            "id": "E71E9FB201233F338F451A28967634BC"
        },
        "performed_on": "2014-07-16T05:07:41"
    }
}

POST subscriptions/installed_items/swap

It swaps one or multiple installed items belonging to a specific subscription with other installed items

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(mandatory)

Subscription identifier

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

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

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

sub_action_type_identifier

(optional)

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:subscription_sub_action_type_identifier
	V4:subscription_sub_action_type_identifier

perfomerd_by_user_identifier

(optional)

User identifier

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

Include Page

	V4:user_identifier
	V4:user_identifier

performed_on

(optional)

Date

The date that the action was actually performed

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

installed_items_swap_set

(mandatory)

Set of subscription installed items swap objects

A set of installed item pairs that should be swapped.

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

Include Page

	V4:subscription_installed_items_swap_parameter
	V4:subscription_installed_items_swap_parameter

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:subscription_action_short
	V4:subscription_action_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "token":"827646F7058139B66EA59CBA46D46FF3",
    "subscription_identifier":{"number":"S60263"},
    "performed_by_user_identifier":{"username":"JackH"},
    "performed_on":"2014-07-16T05:07:41",
    "installed_items_swap_set": 
    [
        {
            "from_installed_item":{"installed_item_identifier":{"serial_number":"001100110011"},},
            "to_installed_item":{"installed_item_identifier":{"serial_number":"001100110017"},}
        }
    ]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "action_type": null,
        "submitted_on": "2014-12-03T12:30:42",
        "sub_action_type": null,
        "business_classification_code": "SWAP_INSTALLED_ITEM",
        "number": "384",
        "executed_on": "2014-12-03T12:30:42",
        "life_cycle_state": "EXECUTED",
        "performed_by":
        {
            "person_name": "Jack Hadjicosti2",
            "username": "JackH",
            "id": "B8650C555C4EA8C741103961276E7773",
            "email": "j_hadjicosti@crm.com"
        },
        "behavior_code": "SWAP_INSTALLED_ITEM",
        "submitted_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1",
            "email": null
        },
        "id": "F758A7203E4BDBC26ED8A68A5C3F3A9E",
        "subscription":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Mixail",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Tassoula",
                    "name": "Mixail Tassoula",
                    "id": "11745776A3EDF5190503D534AFD67904",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence":
                        {
                            "name": "UNITED STATES",
                            "id": "127"
                        },
                        "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": "ACR000321",
                "name": "Mixail",
                "id": "FEC5360EC9A891129DEC09B74C46F155"
            },
            "life_cycle_state": "NOT_EFFECTIVE",
            "number": "S60263",
            "type":
            {
                "name": "United Kingdom",
                "id": "1C81FBB1E5D90040F440ECE98D6A368D",
                "description": "United Kingdom",
                "alternative_code": "UK"
            },
            "id": "E71E9FB201233F338F451A28967634BC"
        },
        "performed_on": "2014-07-16T05:07:41"
    }
}

Version	Old Version 1	New Version 2
Changes made by	George Rossides (Unlicensed)	George Rossides (Unlicensed)
Saved on	Dec 16, 2014	Dec 16, 2014

Versions Compared

Key

POST subscriptions/installed_items/add

Resource URL

Parameters

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

Restrictions

Response Data

Examples

POST subscriptions/installed_items/remove

Resource URL

Parameters

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

Restrictions

Response Data

Examples

POST subscriptions/installed_items/swap

Resource URL

Parameters

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

Restrictions

Response Data

Examples

Page Comparison

Versions Compared

Key

POST subscriptions/installed_items/add

Resource URL

Parameters

Anchorinstalled_items_add referred objects parametersinstalled_items_add referred objects parametersReferred Parameter Objects Data

Restrictions

Response Data

Examples

POST subscriptions/installed_items/remove

Resource URL

Parameters

Anchorinstalled_items_add referred objects parametersinstalled_items_add referred objects parametersReferred Parameter Objects Data

Restrictions

Response Data

Examples

POST subscriptions/installed_items/swap

Resource URL

Parameters

Anchorinstalled_items_swapping referred objects parametersinstalled_items_swapping referred objects parametersReferred Parameter Objects Data

Restrictions

Response Data

Examples

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

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

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