GET provisioning/services/show
- Former user (Deleted)
- Christina Georgiou (Unlicensed)
- p_demou (Deactivated)
Available from CRM.COM R11.0.0
This method returns a service which is provisioned by a specific provisioning provider, based on the identifier which is used to identify the service in the specified provisioning system. A single product is returned by by each call.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
provisioning_provider_identifier (mandatory) | Provisioning Provider Identifier | The provisioning provider related with the parameters that should be returned as a result. The allowed provisioning provider identifier fields are the following:
| ||||||||||||
provisioning_system_identifier (mandatory) | String | The provisioning system identifier used to identify the service in the specified provisioning system | ||||||||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved product |
code | String | The code of the retrieved product |
alternative_code | String | The alternative code of the retrieved product |
description | String | The description of the retrieved product |
| short_description | String | A short description of the retrieved product Available from CRM.COM R16.3.0 and onwards |
| long_description | String | A long description of the retrieved product Available from CRM.COM R12.3.0 and CRM.COM R13.1.0 onwards |
| priority_level | Integer | The priority level of the product Available from CRM.COM R12.3.0 |
| non_stockable | Boolean | The flag shoes if the retrieved product is non-stockable Available from CRM.COM R18.0.0 |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_string_9 | String | User Defined Field of type String |
udf_string_10 | String | User Defined Field of type String |
udf_string_11 | String | User Defined Field of type String |
udf_string_12 | String | User Defined Field of type String |
udf_string_13 | String | User Defined Field of type String |
udf_string_14 | String | User Defined Field of type String |
udf_string_15 | String | User Defined Field of type String |
udf_string_16 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| global_rate | Global Rate Object | The global rate of the retrieved product Available from CRM.COM R15.0.0 |
Product Type Object | The type of the retrieved product | |
Product Brand Object | The brand of the retrieved product | |
Product Family Object | The product family of the retrieved product | |
Log Information Object | The Log Information related with the retrieved product | |
| Bundle Restrictions Object | The bundle restrictions of the new product This parameter is applicable only if the product is classified as a flexible bundle Available from CRM.COM R14.0.0 | |
Set of Price Plans Object | The Price Plans containing the retrieved product | |
Set of Product Validity Object | The Product validity of the retrieved product (If is empty then the product is always valid) | |
Set of Product to Product Category Object | The Product Categories of the retrieved product | |
Set of Product Components Object | The components of the retrieved product. This is applicable only if the product type composition method is set to fixed or flexible bundle | |
| usage_service_catalogs_set | Set of Usage Service Catalogs Object | The Usage Service Catalogs containing the retrieved product. Available only when the retrieved product is a usage service. Available from CRM.COM R9.0.0 |
| tax_rate_set | Set of Tax Rate Objects | The TAX Rate of the retrieved product Available from CRM.COM R14.0.0 |
Set of Vat Rate Objects | The VAT Rate of the retrieved product Deprecate from CRM.COM R17.0.0 | |
| metadata_set | Set of Metadata Attributes | The set of metadata attributes available for the retrieved product Available from CRM.COM R15.0.0 |
| allowed_metadata_set | Set of Metadata Attributes | The allowed set of metadata attributes whose values will be set on the installed items. Available only for traceable physical goods Available from CRM.COM R15.0.0 |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data":
{
"code": "Bronze",
"alternative_code": "B",
"log_information":
{
"created_by_unit":
{
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit":
{
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-02-08T11:45:30",
"updated_date": "2016-07-19T14:34:33",
"updated_by_user":
{
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"components_set":
[
],
"price_plans_set":
[
{
"code": "MPP",
"name": "Main Price Plan",
"effective_date": "2016-02-09T00:00:00",
"description": "Main Price Plan",
"id": "FF75A943141B43528BC96B11D687380D",
"type": "BASE",
"expiration_date": "2016-06-14T00:00:00"
},
{
"code": "CPricePlan",
"name": "Currency Price Plan",
"effective_date": "2016-07-19T00:00:00",
"description": null,
"id": "FF1F2341333E4D60857D35BD0EE807C3",
"type": "BASE",
"expiration_date": null
},
{
"code": "MPP",
"name": "Main Price Plan",
"effective_date": "2016-02-09T00:00:00",
"description": "Main Price Plan",
"id": "24787B7ABE0745C2B16E4071311ACBEE",
"type": "BASE",
"expiration_date": "2016-02-09T00:00:00"
},
{
"code": "MPP",
"name": "Main Price Plan",
"effective_date": "2016-06-14T00:00:00",
"description": "Main Price Plan",
"id": "85ACEEF700A048A58F9C5581142719A8",
"type": "BASE",
"expiration_date": "2016-07-21T00:00:00"
},
{
"code": "MPP",
"name": "Main Price Plan",
"effective_date": "2016-07-21T00:00:00",
"description": "Main Price Plan",
"id": "E2858AC591A04CF58912A9636787139C",
"type": "BASE",
"expiration_date": null
}
],
"description": "Bronze",
"udf_date_2": null,
"type":
{
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"udf_string_15": null,
"categories_set":
[
],
"udf_string_16": null,
"udf_string_13": null,
"validity_set":
[
],
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "F50CC52934BD4F119B6E18E215A4FC55",
"udf_string_10": null,
"udf_float_1": null,
"udf_float_2": null,
"brand":
{
"alternative_code": "C",
"name": "CRM.COM",
"description": null,
"id": "24444B978542404192430E7B305BBB37"
},
"vat_rate":
{
"alternative_code": "VAT 9%",
"name": "VAT 9%",
"description": null,
"id": "48ADFA77916048328685049A3B7E3F64"
},
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"udf_string_6": null,
"family": null,
"udf_string_7": null,
"udf_string_8": null,
"usage_service_catalogs_set":
[
],
"udf_string_9": null
},
"status":
{
"code": "OK",
"description": "",
"message": ""
}
}
HTTP Method: GET
Request:
Response:
{
"data": {
"code": "Bronze",
"alternative_code": "B",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-02-08T11:45:30",
"updated_date": "2017-08-21T12:59:09",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "Eleni Michailidou",
"id": "9A2CF58F91D94B8B981C33275BA20880",
"email": "crm.com.tst@gmail.com",
"username": "emichailidou"
}
},
"components_set": [],
"price_plans_set": [
{
"code": "PK Main",
"name": "PK Main",
"effective_date": "2017-02-06T00:00:00",
"description": "Main Price Plan",
"id": "9B9690AFD6914EBBB4BEB7A00AA76567",
"type": "CONDITIONAL",
"expiration_date": null
},
{
"code": "PPS6",
"name": "Price Plan Storyboard 6",
"effective_date": "2016-12-19T00:00:00",
"description": null,
"id": "EC5A38FD43DC41BDB16DE033FDD12D82",
"type": "BASE",
"expiration_date": null
},
{
"code": "ETDPP",
"name": "Digits check ET",
"effective_date": "2016-12-19T00:00:00",
"description": null,
"id": "991F77149E82403BAF2FFA1B6949086B",
"type": "BASE",
"expiration_date": null
},
{
"code": "ETNDPP",
"name": "Price Plan No Extra Digits check ET",
"effective_date": "2016-12-19T00:00:00",
"description": null,
"id": "ECFBE01D724C4FC89630EDF7DDC2A2A6",
"type": "BASE",
"expiration_date": null
},
{
"code": "DP",
"name": "Daily Price",
"effective_date": "2017-02-22T00:00:00",
"description": null,
"id": "A0A511F6589741E7AA27A7068FBFC52E",
"type": "BASE",
"expiration_date": null
},
{
"code": "Test FW changes",
"name": "Test FW changes",
"effective_date": "2016-12-06T00:00:00",
"description": null,
"id": "0F91BBAA241B41EFBBF4FCB270AF94F4",
"type": "BASE",
"expiration_date": null
},
{
"code": "MPP",
"name": "Main Price Plan",
"effective_date": "2017-05-31T00:00:00",
"description": "Main Price Plan",
"id": "D48ADE1316F44DA6BBCDA7C4E654980A",
"type": "BASE",
"expiration_date": null
},
{
"code": "Price Plan Tax SK",
"name": "PPT_SK",
"effective_date": "2017-03-08T00:00:00",
"description": "Regression Testing SK",
"id": "237F2D87EFB94DE0B0A5AD3558681C6E",
"type": "BASE",
"expiration_date": null
},
{
"code": "CPricePlan",
"name": "Currency Price Plan",
"effective_date": "2016-07-19T00:00:00",
"description": null,
"id": "FF1F2341333E4D60857D35BD0EE807C3",
"type": "BASE",
"expiration_date": null
},
{
"code": "ETPP",
"name": "ET Price Plans",
"effective_date": "2016-12-19T00:00:00",
"description": null,
"id": "10395E69DDDC4FBA83D94F07327E0598",
"type": "BASE",
"expiration_date": null
}
],
"description": "Bronze",
"udf_date_2": null,
"type": {
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"udr_type": null,
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"udf_string_15": null,
"categories_set": [],
"udf_string_16": null,
"udf_string_13": null,
"validity_set": [],
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"bundle_restrictions": [
{
"number_of_product_families_restriction": 9,
"number_of_product_types_restriction": 1
}
],
"id": "F50CC52934BD4F119B6E18E215A4FC55",
"udf_string_10": null,
"udf_float_1": null,
"udf_float_2": null,
"brand": {
"alternative_code": "C",
"name": "CRM.COM",
"description": null,
"id": "24444B978542404192430E7B305BBB37"
},
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"udf_string_6": null,
"family": null,
"udf_string_7": null,
"udf_string_8": null,
"usage_service_catalogs_set": [],
"tax_rate_set": [
{
"alternative_code": "TT",
"name": "Telephony Tax",
"description": null,
"id": "DA6DD47A53DC4CBB8D0EEF698B08E94A"
},
{
"alternative_code": "STSC",
"name": "Subscription Tax Small Cities",
"description": null,
"id": "F5E66E601B154D60AD1E80B785E0292C"
},
{
"alternative_code": "ST",
"name": "Sales Tax",
"description": null,
"id": "E85BD1C608E64EB8820C2087982B303A"
},
{
"alternative_code": "STBC",
"name": "Subscription Tax Big Cities",
"description": null,
"id": "FD53532A6BA14F2680AD9D0FF9953DB9"
}
],
"vat_rate_set": [
{
"alternative_code": "S_1",
"name": "Standard(VATS)",
"description": null,
"id": "D8159982FCBE4316BEAD4F6E761FB40D"
}
],
"udf_string_9": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}