Versions Compared

Key

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

Table of Contents
maxLevel2

...

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

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

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_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 objectsThe installed items that should be added on 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


...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token":"16AFA54B31AF441C8379D4AD45BF7447",
    "subscription_identifier":{"number":"S60250"},
     "action_type_identifier": {"name"  : "Add Installed Item"},
    "performed_by_user_identifier":{"username":"JackH"},
    "performed_on":"2015-03-18T05:07:41",
    "installed_items_set":[
        {
            "installed_item_identifier":{
                "serial_number":"SC1-000A-0018"
            },
            "installed_items_distribution_set":[
                {
                    "provisioning_distributor_identifier":{
                        "name":"Main"
                    }
                }
            ]
        }
    ]
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "scheduled_date": "2015-03-19T14:18:28",
        "action_type":
        {
            "name": "Add Installed Item",
            "id": "37ACD6A180B942FC96FCAC0E487C057A",
            "alternative_code": "AII"
        },
        "submitted_on": "2015-03-19T14:18:28",
        "sub_action_type": null,
        "business_classification_code": "ADD_INSTALLED_ITEM",
        "number": "756",
        "executed_on": "2015-03-19T14:18:28",
        "life_cycle_state": "EXECUTED",
        "performed_by":
        {
            "person_name": "Jack Hadjicosti",
            "username": "JackH",
            "id": "B8650C555C4EA8C741103961276E7773",
            "email": "j_hadjicosti@crm.com"
        },
        "behavior_code": "ADD_INSTALLED_ITEM",
        "submitted_by":
        {
            "person_name": "Marios Lannister",
            "username": "mpadministrator",
            "id": "1"
        },
        "id": "DFC66C7877FA4433991FA05736E69ECE",
        "subscription":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "May",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Alan",
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Michael",
                    "name": "Michael May",
                    "id": "22AD2164CE074EB60ECFD5F3F9A55E2D",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "passport_number": "123456",
                        "social_security_number": "654321",
                        "country_of_residence":
                        {
                            "name": "CYPRUS",
                            "id": "181"
                        },
                        "industry_sector":
                        {
                            "name": "FINANCIALS",
                            "id": "03EA93890F51506ABD9E994CD826EC78",
                            "alternative_code": "FIN"
                        },
                        "date_of_birth":
                        {
                            "month": 5,
                            "day": 30,
                            "year": 1983
                        },
                        "name_day":
                        {
                            "month": 11,
                            "day": 7
                        },
                        "id_number": "868561",
                        "id_issued_by_country":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry":
                        {
                            "name": "IndustryTest",
                            "id": "D65E1F283AE9FED5A572F817DE23EDD1",
                            "code": "IndTest"
                        }
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "319",
                "name": "anotherAccount",
                "id": "A41AE5E4FA9783A05B16F7BA27945B42"
            },
            "life_cycle_state": "EFFECTIVE",
            "number": "S60250",
            "type":
            {
                "name": "Normal Subscription",
                "id": "6BB2B984CC9309775D06650C7493A836",
                "description": null,
                "alternative_code": "ST"
            },
            "id": "FA648EFF99188F3C2B8343F7C03806C1"
        },
        "performed_on": "2015-03-18T05: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)

...

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

...

action_type_identifier

(optional)

...

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

...

sub_action_type_identifier

(optional)

...

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

...

performed_by_user_identifier

(optional)

...

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

...

performed_on

(optional)

...

udf_string_1 

(optional)

...

User Defined Field of type String

...

udf_string_2 

(optional)

...

User Defined Field of type String

...

udf_string_3 

(optional)

...

User Defined Field of type String

...

udf_string_4 

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6 

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

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)

...

 

Restrictions

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

Response Data

...

Examples

HTTP Method: POST

 

Request:

Body:

{ "token":"FFB8A25C40DE45BCA437F01B6D2F1FAF", "subscription_identifier":{"number":"S60225"}, "action_type_identifier":{"name":"Remove Hardware"}, "sub_action_type_identifier":{"name":"Remove Installed Item"}, "performed_by_user_identifier":{"username":"JackH"}, "performed_on":"2014-07-16T05:07:41", "installed_items_set": [ {
Expand
titleExample 1
Code Block
themeConfluence
languagejavascript
linenumberstrue
Expand
titleExample 2

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token":"16AFA54B31AF441C8379D4AD45BF7447",
    "fields_set":"submitted_by,subscription,sub_action_type,job,action_type",
    "subscription_identifier":{"number":"S60250"},
     "action_type_identifier": {"name"  : "Add Installed Item"},
     "sub_action_type_identifier":{"name"  : "Add Installed Item"},
    "performed_by_user_identifier":{"username":"JackH"},
    "performed_on":"2015-03-18T05:07:41",
    "installed_items_set":[
        {
            "installed_item_identifier":{
                "serial_number":"smartcard_1_01"
            },
            "installed_items_distribution_set":[
                {
                    "provisioning_distributor_identifier":{
                        "name":"New"
                    }
                }
            ]
        }
    ]
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "action_type": {
      "id": "32DE4AD093334F80BDABE93507E12A30",
      "name": "Add Installed Item",
      "alternative_code": "AII"
    },
    "sub_action_type": {
      "id": "E3DD837DA6AF4F90904A17EFB650AAEB",
      "name": "Add Installed Item",
      "alternative_code": "AII"
    },
    "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",
            "installed_item_identifier":{"serial_passport_number": "SC1-000A-0006"}4564455",
        }     ]
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{"industry_sector": null,
            "statuscountry_of_residence": {
   {           "messagethree_character_code": null"USA",
        "description      "two_character_code": null"US",
              "codeid": "OK127",
    },          "dataname": "UNITED STATES",
    {          "actionalternative_typecode": null
          {  },
            "name_day": {
"Remove Hardware",             "idmonth": "CCAD5B2B6AB4BA8082DE3274D436DAD0"1,
              "alternative_codeday": "RH"1
            },
        "submitted_on": "2015-02-26T11:19:55",         "sub_action_type"date_of_birth":      {
  {             "namemonth": "Remove1,
Installed Item",             "idday": "13"1,
              "alternative_codeyear": null1980
        },      },
  "business_classification_code": "REMOVE_INSTALLED_ITEM",         "id_number": "35287878000",
        "executed_on    "industry": "2015-02-26T11:19:56"null,
        "life_cycle_state    "id_issued_by_country": "EXECUTED",null
        "performed_by":  }
      {    },
        "personlife_namecycle_state": "Jack HadjicostiACTIVE",
  
         "usernamenumber": "JackH191",
 
          "id": "B8650C555C4EA8C741103961276E7773D64410DDAC580029C9664EAB74ACAC9C",
            "emailname": "j_hadjicosti@crm.com"
 Kat's Main TV Account"
      },
 
      "behavior_codenumber": "REMOVE_INSTALLED_ITEMS60250",
        "submitted_bytype": {
       {    "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
        "person_name": "Marios LannisterLondon2",
  
         "usernamedescription": "MPAdministrator"null,
            "id"alternative_code": "1LND2"
        },
 
      "id": "08C4D6B63DEB4EF988E8D6F6C5367B3BA521D332281C71FE88C58ACEC78C39BD",
 
      "subscriptionfirst_activated_date":   null,
     {             "accounts_receivable"rating_state": "PENDING"
    }
      {
                "account_owner":
                {
                    "last_name": "Xenofontos ",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Iatrou",
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Kyriacos",
                    "name": "Kyriacos Xenofontos",
                    "id": "31260911295E70BB660EBEB0C4F941AC",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "passport_number": "3463463",
                        "social_security_number": "73473567",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector": null,
  }
}

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

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_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 objectsThe 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
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token":"FFB8A25C40DE45BCA437F01B6D2F1FAF",
    "subscription_identifier":{"number":"S60225"},
    "action_type_identifier":{"name":"Remove Hardware"},
    "sub_action_type_identifier":{"name":"Remove Installed Item"},
    "performed_by_user_identifier":{"username":"JackH"},
    "performed_on":"2014-07-16T05:07:41",
    "installed_items_set":
    [
        {
            "date_of_birth":installed_item_identifier":{"serial_number":"SC1-000A-0006"}
        }
    ]
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "monthcode": 5,"OK"
    },
    "data":
    {
        "action_type":
    "day": 6,
    {
            "name": "Remove Hardware",
            "yearid": 1988"CCAD5B2B6AB4BA8082DE3274D436DAD0",
            "alternative_code": "RH"
          },
             "submitted_on": "2015-02-26T11:19:55",
          "namesub_action_daytype":
        {
            "name": "Remove Installed {Item",
            "id": "13",
              "monthalternative_code": 5,null
        },
          "business_classification_code": "REMOVE_INSTALLED_ITEM",
        "daynumber": 3"352",
        "executed_on": "2015-02-26T11:19:56",
        "life_cycle_state": "EXECUTED",
     },   "performed_by":
        {
            "idperson_numbername": "87878000Jack Hadjicosti",
            "username": "JackH",
            "id_issued_by_country": "B8650C555C4EA8C741103961276E7773",
            "email": "j_hadjicosti@crm.com"
        },
        "behavior_code": "REMOVE_INSTALLED_ITEM",
 {       "submitted_by":
        {
            "person_name": "UNITEDMarios KINGDOMLannister",
            "username": "MPAdministrator",
              "id": "1261"
        },
          "id": "08C4D6B63DEB4EF988E8D6F6C5367B3B",
     },   "subscription":
        {
            "industryaccounts_receivable":
null            {
                "account_owner":
   }             {
   },                 "lifelast_cycle_statename": "ACTIVEXenofontos ",
                 "number   "life_cycle_state": "195FINANCIAL",
                    "middle_name": "XenofontosIatrou",
                "id": "5B51429862A7BCBAD60CC81982BBD45B"   "company_profile": null,
        },             "life_cycle_statetitle": "EFFECTIVEMr",
                    "numbertype": "S60225PERSON",
            "type":        "first_name": "Kyriacos",
   {                 "name": "LondonKyriacos Xenofontos",
                    "id": "3100B0D56E7C7EADF073C34BCE1E42AF31260911295E70BB660EBEB0C4F941AC",
                "description": "For Subscribers residing in London
",   "company_name": null,
                    "alternative_codedemographics": "LND"

                    {
           },             "idgender": "681905183544B0E30834B67A1AC8F634MALE",
         },               "performed_on": "2014-07-16T05:07:41"passport_issued_by_country":
                        {
                            "name": "UNITED KINGDOM",
    }
}

 

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)

...

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

...

action_type_identifier

(optional)

...

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

...

sub_action_type_identifier

(optional)

...

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

...

job_identifier

(optional)

...

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

...

Tip

Available from CRM.COM R9.0.0

...

performed_by_user_identifier

(optional)

...

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

...

performed_on

(optional)

...

udf_string_1 

(optional)

...

User Defined Field of type String

...

udf_string_2 

(optional)

...

User Defined Field of type String

...

udf_string_3 

(optional)

...

User Defined Field of type String

...

udf_string_4 

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6 

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

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)

...

fields_set

(optional)

...

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

...

 

Restrictions

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

Response Data

...

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token":"FFB8A25C40DE45BCA437F01B6D2F1FAF",
    "subscription_identifier":{"number":"S60225"},
    "action_type_identifier":{"name":"Swap hardware"},
    "sub_action_type_identifier":{"name":"Swap Hardware"},
    "performed_by_user_identifier":{"username":"JackH"},
    "performed_on":"2014-07-16T05:07:41",
    "installed_items_swap_set":
    [
        {
                           "id": "126"
                        },
                        "passport_number": "3463463",
                        "social_security_number": "73473567",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": 5,
                            "day": 6,
                            "year": 1988
                        },
                        "name_day":
                        {
                            "month": 5,
                            "day": 3
                        },
                        "id_number": "87878000",
                        "id_issued_by_country":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "195",
                "name": "Xenofontos",
                "id": "5B51429862A7BCBAD60CC81982BBD45B"
            },
            "life_cycle_state": "EFFECTIVE",
            "number": "S60225",
            "type":
            {
                "name": "London",
                "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                "description": "For Subscribers residing in London
",
                "alternative_code": "LND"
            },
            "id": "681905183544B0E30834B67A1AC8F634"
        },
        "fromperformed_installed_itemon":{"installed_item_identifier":{"serial_number":"sc1000000017"},}, "2014-07-16T05:07:41"
            "to_installed_item":{"installed_item_identifier":{"serial_number":"sc1000000002"},}
        }
    ]
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "action_type":
        {
            "name": "Swap hardware",
            "id": "AB18911ECF5B31AB59EF236A0C6344B5",
            "alternative_code": "SH"
        },
        "submitted_on": "2015-02-26T11:28:15",
        "sub_action_type":
        {
            "name": "Swap Hardware",
            "id": "148B3B21FE6E814059CA1F7FB6DD09E9",
            "alternative_code": "SHS"
        },
        "business_classification_code": "SWAP_INSTALLED_ITEM",
        "number": "355",
        "executed_on": "2015-02-26T11:28:15",
        "life_cycle_state": "EXECUTED",
        "performed_by":
        {
            "person_name": "Jack Hadjicosti",
            "username": "JackH",
            "id": "B8650C555C4EA8C741103961276E7773",
            "email": "j_hadjicosti@crm.com"
        },
        "behavior_code": "SWAP_INSTALLED_ITEM",
        "submitted_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1"
        },
        "id": "2E67B76DB94E41BF8E0D7FF60FF4D664",
        "subscription":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Xenofontos ",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Iatrou",
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Kyriacos",
                    "name": "Kyriacos Xenofontos",
                    "id": "31260911295E70BB660EBEB0C4F941AC",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "passport_number": "3463463",
  }
}

 

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

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

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_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 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_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
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "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":
    [
        {
            "social_security"from_installed_item":{"installed_item_identifier":{"serial_number": "73473567"smartcard_1_01"}},
                        "country_of_residence":"to_installed_item":{"installed_item_identifier":{"serial_number":"IS000002"}}
        }
    ]
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": "",
  {  "description": "",
    "code": "OK"
  },
  "data": {
    "action_type": {
      "nameid": "UNITED KINGDOM72663ADABC6C401EADC825F2540ECD88",
      "name": "Swap Installed Item",
      "alternative_code": "SIP"
    },
     "idsub_action_type": "126"{
      "id": "55076C5A73C347CA9A678684825FCA5B",
      "name": "Swap Inst Item",
      },
"alternative_code": "SII"
         },
      "submitted_by": {
      "industryperson_sectorname": null"Marios Lannister",
      "username": "MPAdministrator",
      "id": "1",
      "email":  "date_of_birth":"sakkascy1986@hotmail.com"
    },
    "job": null,
    "subscription": {
       {"life_cycle_state": "DRAFT",
      "accounts_receivable": {
        "account_owner": {
          "monthlast_name": 5"Clark",
          "middle_name": "S.",
                "day"life_cycle_state": 6"FINANCIAL",
          "company_profile": null,
                "year"title": 1988 "Mrs",
          "first_name": "Kathy",
           }"type": "PERSON",
             "id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
          "name_day": "Clark Kathy",
          "company_name": null,
          "demographics": {
            "gender": "FEMALE",
              "month"passport_issued_by_country": 5null,
               "social_security_number": "88996633",
            "daypassport_number": 3"4564455",
              "industry_sector": null,
         },   "country_of_residence": {
                    "id_number"three_character_code": "87878000",
        USA",
               "idtwo_issuedcharacter_by_countrycode": "US",
              "id": "127",
       {       "name": "UNITED STATES",
              "alternative_code": null
   "name": "UNITED KINGDOM",       },
            "name_day": {
       "id": "126"      "month": 1,
              "day": 1
 },            },
            "industrydate_of_birth": {
null              "month": 1,
     }         "day": 1,
      },        "year": 1980
       "life_cycle_state": "ACTIVE",    },
            "id_number": "19587878000",
                "nameindustry": "Xenofontos",
   null,
            "id_issued_by_country": null
 "5B51429862A7BCBAD60CC81982BBD45B"         }
   },     },
        "life_cycle_state": "EFFECTIVEACTIVE",
            "number": "S60225191",
            "typeid": "D64410DDAC580029C9664EAB74ACAC9C",
        "name": "Kat's Main {TV Account"
      },
        "namenumber": "LondonS60250",
      "type": {
        "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
       
        "descriptionname": "ForLondon2",
Subscribers residing in London ",    "description": null,
           "alternative_code": "LNDLND2"
 
          },
     
      "id": "681905183544B0E30834B67A1AC8F634A521D332281C71FE88C58ACEC78C39BD",
        },
 "first_activated_date": null,
      "performedrating_onstate": "2014-07-16T05:07:41"PENDING"
    }
  }
}

POST subscriptions/installed_items/move_to_another_subscription

...

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(mandatory)

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

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

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

...