Page Comparison

Versions Compared

Key

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

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

...

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

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

job_identifier

(optional)

Job identifier

The Job for which the subscription action is performed. The allowed job identifier fields are the following:

Include Page

	V4:job_identifier
	V4:job_identifier

Tip
Available from CRM.COM R9.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)

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)

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.

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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "token":"FFB8A25C40DE45BCA437F01B6D2F1FAF",
    "fields_set":"submitted_by,subscription,sub_action_type,job,action_type",
    "subscription_identifier":{"number":"S60250"},
    "action_type_identifier":{"name":"Swap Installed Item"},
    "sub_action_type_identifier":{"name":"Swap Inst Item"},
    "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":"smartcard_1_01"}},
            "to_installed_item":{"installed_item_identifier":{"serial_number":"IS000002"}}
        }
    ]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "action_type": {
      "id": "72663ADABC6C401EADC825F2540ECD88",
      "name": "Swap Installed Item",
      "alternative_code": "SIP"
    },
    "sub_action_type": {
      "id": "55076C5A73C347CA9A678684825FCA5B",
      "name": "Swap Inst Item",
      "alternative_code": "SII"
    },
    "submitted_by": {
      "person_name": "Marios Lannister",
      "username": "MPAdministrator",
      "id": "1",
      "email": "sakkascy1986@hotmail.com"
    },
    "job": null,
    "subscription": {
      "life_cycle_state": "DRAFT",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Clark",
          "middle_name": "S.",
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": "Mrs",
          "first_name": "Kathy",
          "type": "PERSON",
          "id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
          "name": "Clark Kathy",
          "company_name": null,
          "demographics": {
            "gender": "FEMALE",
            "passport_issued_by_country": null,
            "social_security_number": "88996633",
            "passport_number": "4564455",
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": "USA",
              "two_character_code": "US",
              "id": "127",
              "name": "UNITED STATES",
              "alternative_code": null
            },
            "name_day": {
              "month": 1,
              "day": 1
            },
            "date_of_birth": {
              "month": 1,
              "day": 1,
              "year": 1980
            },
            "id_number": "87878000",
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "191",
        "id": "D64410DDAC580029C9664EAB74ACAC9C",
        "name": "Kat's Main TV Account"
      },
      "number": "S60250",
      "type": {
        "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
        "name": "London2",
        "description": null,
        "alternative_code": "LND2"
      },
      "id": "A521D332281C71FE88C58ACEC78C39BD",
      "first_activated_date": null,
      "rating_state": "PENDING"
    }
  }
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
   "token":"{{token}}",
    "subscription_identifier":{
        "number": "S0000009523"
    },
    "installed_items_swap_set":
    [
        {
            "from_installed_item":{"installed_item_identifier":{"serial_number":"Nagra70"}},
            "to_installed_item":{"installed_item_identifier":{"serial_number":"sm_8200_ind_01"}},
            "warranty_coverage_reason_identifier":{"name":"Faulty"}
        }
    ]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "data": {
        "performed_by": null,
        "action_type": {
            "alternative_code": "swap_installeditem_action",
            "name": "SWAP INSTALLED ITEM",
            "id": "B0B585AABC93494997B7FA363318DA23"
        },
        "transaction_reference_number": null,
        "submitted_by": {
            "person_name": "CRM COM",
            "id": "1",
            "username": "MPAdministrator"
        },
        "executed_on": "2018-02-13T15:43:36",
        "life_cycle_state": "EXECUTED",
        "subscription": {
            "number": "S0000009523",
            "first_activated_date": "2018-02-13T15:06:00",
            "rating_state": "PENDING",
            "accounts_receivable": {
                "number": "ACR0000013170",
                "name": "ACR0000013170 Test 8200_2",
                "id": "5838C3BFBC504394BEB200EF7DD877C7",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": "Test 8200_2",
                    "last_name": "8200_2",
                    "id": "E8116F8B8C424AC3858A236A4D46D404",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Test",
                    "demographics": {
                        "id_number": "8200_2",
                        "gender": null,
                        "country_of_residence": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "date_of_birth": {
                            "month": null,
                            "year": null,
                            "day": null
                        },
                        "industry_sector": null,
                        "industry": null,
                        "name_day": {
                            "month": null,
                            "day": null
                        },
                        "passport_number_expiration_date": null,
                        "id_number_expiration_date": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "id": "626CAFAD293C49AFAECC576F846DCBBD",
            "life_cycle_state": "EFFECTIVE",
            "type": {
                "alternative_code": "normalsub",
                "name": "Normal",
                "description": null,
                "id": "D1BAE6454A2248189EBCD7ADD3B4B65F",
                "classification": "FLEXIBLE"
            }
        },
        "scheduled_date": "2018-02-13T15:43:29",
        "performed_on": null,
        "sub_action_type": {
            "alternative_code": "swap_installeditem_sub_action",
            "name": "SWAP INSTALLED ITEM",
            "id": "51629DFD3CC64BE5BF6BE2774919C589"
        },
        "business_classification_code": "SWAP_INSTALLED_ITEM",
        "number": "27441",
        "submitted_on": "2018-02-13T15:43:29",
        "id": "F1722456021A4EE1B324E240F2AB7445",
        "job": null,
        "behavior_code": "SWAP_INSTALLED_ITEM",
        "performed_by_unit": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}