Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R9.0.0


Excerpt

It moves one or multiple installed items belonging to a specific subscription to another subscription belonging to the same accounts receivable owner.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

Source Subscription identifier

The source subscription of the installed item (i.e the subscription from which the installed item will be removed from). 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

_identifier is mandatory


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

Deprecated from CRM.COM R15.0.0


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

Tip

Deprecated from CRM.COM R15.0.0

sub_action_type


classification_identifier

(optional)

Subscription
sub action type identifier
Action Classification Identifier

The

sub action type that should be used

subscription action's classification. The allowed subscription

sub

action

type

classification identifier fields are the following:

Include Page
V4:subscription_

sub_

action_

type

classification_identifier
V4:subscription

_sub

_action_

type

classification_identifier

Tip
Deprecated

Available from CRM.COM

R15

R18.0.0


payment_gateway_card_identifier

(optional)

Payment Gateway Card Identifier

The payment gateway card that will be used to post a payment against the accounts receivable of the subscription. Applicable and required only for Subscriptions following the "Pay before bill" payment model. The applicable payment gateway card identifier fields are the following:

Include Page
V4:payment_gateway_card_identifier
V4:payment_gateway_card_identifier

Tip

Available from CRM.COM R14.3.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)

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_by_unit_identifier

(optional)

Unit Identifier

The 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


performed_on

(optional)

DateThe 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 objectsA set of installed item pairs that should be swapped.

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
installed_items_swapping referred objects parameters
installed_items_swapping referred objects parameters
Referred Parameter Objects Data

Include Page
V4:subscription_installed_items_move_parameter
V4:subscription_installed_items_move_parameter
 


Restrictions

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

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 {
    "token":"482293FF78614B54A8DA0B3AD932E4ED",
    "subscription_identifier":{"number":"S60647"},
    "performed_by_user_identifier":{"username":"JackH"},
    "performed_on":"2014-07-16T05:07:41",
    "installed_items_swap_set":
     [
        {
         "to_subscription":{"subscription_identifier":{"number":"S60646"}},
         "installed_item":
            {
               "installed_item_identifier":{"serial_number":"sc000012126"},
               "installed_items_distribution_set":
                [
                    {"provisioning_distributor_identifier":{"name":"Conax Main 22"}},
                    {"provisioning_distributor_identifier":{"name":"PA Main"}} 
                ]
            }
        }
     ]
}


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "scheduled_date": "2016-01-11T13:24:28",
    "submitted_on": "2016-01-11T13:24:28",
    "action_type": null,
    "sub_action_type": null,
    "business_classification_code": "MOVE_ITEM_TO_OTHER_SUBSCRIPTION",
    "number": "2635",
    "executed_on": "2016-01-11T13:24:30",
    "life_cycle_state": "EXECUTED",
    "performed_by": {
      "person_name": "Jack Hadjicosti2",
      "username": "JackH",
      "id": "B8650C555C4EA8C741103961276E7773",
      "email": "j_hadjicosti@crm.com"
    },
    "behavior_code": "MOVE_INSTALLED_ITEM",
    "id": "4A161CAE7C2E4F18827CD06E7BFDB80A",
    "submitted_by": {
      "person_name": "Marios Lannister",
      "username": "MPAdministrator",
      "id": "1"
    },
    "subscription": {
      "life_cycle_state": "EFFECTIVE",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Smith",
          "middle_name": null,
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": null,
          "first_name": "Mary",
          "type": "PERSON",
          "id": "EEF4B599C62D4051903CC6A15F0EC2F6",
          "name": "Smith Mary",
          "company_name": null,
          "demographics": {
            "gender": null,
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": null,
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": "CYP",
              "two_character_code": "CY",
              "id": "181",
              "name": "CYPRUS",
              "alternative_code": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "id_number": "123213",
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR000930",
        "id": "505D6565E194498EA207ED5ACF2A81F5",
        "name": "ACR000930"
      },
      "number": "S60647",
      "type": {
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_date_1": null,
        "udf_float_3": null,
        "udf_date_2": null,
        "udf_float_4": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "name": "United Kingdom",
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "log_information": {
          "updated_date": "2015-12-30T13:39:38",
          "created_date": "2014-06-25T15:44:04",
          "created_by_unit": {
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "name": "Admin Unit",
            "group_name": "Main Group",
            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
            "alternative_code": "MG"
          },
          "updated_by_unit": {
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "name": "Admin Unit",
            "group_name": "Main Group",
            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
            "alternative_code": "MG"
          },
          "updated_by_user": {
            "person_name": "MPAdministrator",
            "username": "MPAdministrator",
            "id": "1"
          }
        },
        "udf_string_8": null,
        "id": "1C81FBB1E5D90040F440ECE98D6A368D",
        "description": "United Kingdom",
        "alternative_code": "UK"
      },
      "id": "77D5DF0656B141FD8D15DA5EFAF33C1C"
    },
    "performed_on": "2014-07-16T05:07:41"
  }
}


...