| Table of Contents | ||
|---|---|---|
|
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)
...
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
...
(mandatory)
...
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
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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
...
(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
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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
(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
...
(mandatory)
...
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 | ||||||
|---|---|---|---|---|---|---|
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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":
[
{
"from_installed_item":{"installed_item_identifier":{"serial_number":"sc1000000017"},},
"to_installed_item":{"installed_item_identifier":{"serial_number":"sc1000000002"},}
}
]
} |
Response:
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
| name | blue |
|---|
| Child pages (Children Display) | ||||
|---|---|---|---|---|
|