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 (semi-optional) | Subscription identifier | The subscription to be modified. The allowed subscription identifier fields are the following:
Up to CRM.COM R12.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:
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 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:
| ||||||||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||||||||
job_identifier (optional) | Job identifier | The Job for which the subscription action is performed. The allowed job identifier fields are the following:
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:
| ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
(mandatory) | Set of subscription installed item objects | The 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 Available from CRM.COM R10.0.0 |
Referred Parameter Objects Data
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":"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:
{
"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"
}
}
HTTP Method: POST
Request:
Body:
{
"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:
{
"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",
"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"
}
}
}
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 (semi-optional) | Subscription identifier | The subscription to be modified. The allowed subscription identifier fields are the following:
Up to CRM.COM R12.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:
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 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:
| ||||||||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
(optional) | Set of subscription installed item objects | The 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 Available from CRM.COM R10.0.0 |
Referred Parameter Objects Data
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":
[
{
"installed_item_identifier":{"serial_number":"SC1-000A-0006"}
}
]
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"action_type":
{
"name": "Remove Hardware",
"id": "CCAD5B2B6AB4BA8082DE3274D436DAD0",
"alternative_code": "RH"
},
"submitted_on": "2015-02-26T11:19:55",
"sub_action_type":
{
"name": "Remove Installed Item",
"id": "13",
"alternative_code": null
},
"business_classification_code": "REMOVE_INSTALLED_ITEM",
"number": "352",
"executed_on": "2015-02-26T11:19:56",
"life_cycle_state": "EXECUTED",
"performed_by":
{
"person_name": "Jack Hadjicosti",
"username": "JackH",
"id": "B8650C555C4EA8C741103961276E7773",
"email": "j_hadjicosti@crm.com"
},
"behavior_code": "REMOVE_INSTALLED_ITEM",
"submitted_by":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"id": "08C4D6B63DEB4EF988E8D6F6C5367B3B",
"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",
"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"
},
"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 (semi-optional) | Subscription identifier | The subscription to be modified. The allowed subscription identifier fields are the following:
Up to CRM.COM R12.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:
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 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:
| ||||||||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||||||||
job_identifier (optional) | Job identifier | The Job for which the subscription action is performed. The allowed job identifier fields are the following:
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:
| ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
(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 Available from CRM.COM R10.0.0 |
Referred Parameter Objects Data
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",
"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:
{
"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"
}
}
}
POST subscriptions/installed_items/move_to_another_subscription
Available from CRM.COM R9.0.0
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:
Up to CRM.COM R12.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:
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 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:
| ||||||||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
(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 Available from CRM.COM R10.0.0 |
Referred Parameter Objects Data
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":"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:
{
"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"
}
}