| 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:
...
perfomerd_by_user_identifier
(optional)
...
The user that actually performed the action. The allowed user identifier fields are the following:
...
performed_on
(optional)
...
scheduled_date
(optional)
...
The date that the action is scheduled to be executed. If not specified then the action will be executed immediately
| Tip |
|---|
...
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":"09CB68CC0E00A93FC936274CC7A7D0F8",
"subscription_identifier":{"number":"S60250"},
"action_type_identifier": {"name" : "Add Installed Item"},
"performed_by_user_identifier":{"username":"JackH"},
"performed_on":"2014-07-17T05:07:41",
"installed_items_set":[
{
"installed_item_identifier":{
"serial_number":"001100110015"
},
"installed_items_distribution_set":[
{
"provisioning_distributor_identifier":{
"name":"Main"
}
}
]
}
]
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"action_type":
{
"name": "Add Installed Item",
"id": "37392FB25A01774C691058C76BC01719",
"alternative_code": "ADDITEM"
},
"submitted_on": "2014-11-25T19:02:11",
"sub_action_type": null,
"business_classification_code": "ADD_INSTALLED_ITEM",
"number": "297",
"executed_on": "2014-11-25T19:02:11",
"life_cycle_state": "EXECUTED",
"performed_by":
{
"person_name": "Jack Hadjicosti2",
"username": "JackH",
"id": "B8650C555C4EA8C741103961276E7773",
"email": "j_hadjicosti@crm.com"
},
"behavior_code": "ADD_INSTALLED_ITEM",
"submitted_by":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": null
},
"id": "DB29234F5FAE478CAC5582E7E4DF9D4A",
"subscription":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Clark",
"life_cycle_state": "FINANCIAL",
"middle_name": "S.",
"company_profile": null,
"title": "Mrs",
"type": "PERSON",
"first_name": "Kathy",
"name": "Clark Kathy",
"id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country": null,
"passport_number": "4564455",
"social_security_number": "88996633",
"country_of_residence":
{
"name": "UNITED STATES",
"id": "127"
},
"industry_sector": null,
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1980
},
"name_day":
{
"month": 1,
"day": 1
},
"id_number": "87878000",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "191",
"name": "Kat's Main TV Account",
"id": "D64410DDAC580029C9664EAB74ACAC9C"
},
"life_cycle_state": "DRAFT",
"number": "S60250",
"type":
{
"name": "London",
"id": "3100B0D56E7C7EADF073C34BCE1E42AF",
"description": null,
"alternative_code": "LND"
},
"id": "A521D332281C71FE88C58ACEC78C39BD"
},
"performed_on": "2014-07-17T05: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:
...
perfomerd_by_user_identifier
(optional)
...
The user that actually performed the action. The allowed user identifier fields are the following:
...
performed_on
(optional)
...
scheduled_date
(optional)
...
The date that the action is scheduled to be executed. If not specified then the action will be executed immediately
| Tip |
|---|
...
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:
...
perfomerd_by_user_identifier
(optional)
...
The user that actually performed the action. The allowed user identifier fields are the following:
...
performed_on
(optional)
...
scheduled_date
(optional)
...
The date that the action is scheduled to be executed. If not specified then the action will be executed immediately
| Tip |
|---|
...
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":"827646F7058139B66EA59CBA46D46FF3",
"subscription_identifier":{"number":"S60263"},
"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":"001100110011"},},
"to_installed_item":{"installed_item_identifier":{"serial_number":"001100110017"},}
}
]
} |
Response:
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
| name | blue |
|---|
| Child pages (Children Display) | ||||
|---|---|---|---|---|
|