GET usage_service_catalogs/show
This method returns a specific usage service catalog. The conditions and available usage services are not included in the results. A single usage service catalog is returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||||||||
usage_service_catalog_identifier (mandatory) | Usage Service Catalog Identifier | The identifier of the usage service catalog .The allowed usage service catalog identifier fields are the following:
| ||||||||||||
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 semi-optional parameter can be specified.
Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved usage service catalog |
| name | String | The Name of the retrieved usage service catalog |
| alternative_code | String | The Alternative Code of the retrieved usage service catalog |
| description | String | The Description of the retrieved usage service catalog |
| termed_service_requirements | String | The settings related to whether a termed service will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R13.0.0 From CRM.COM R14.0.0, DOES_NOT_REQ_TERMED_SERVICE value is not supported Deprecated from CRM.COM R15.0.0 |
| installed_item_requirements | String | The settings related to whether an installed item will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R14.0.0 Deprecated from CRM.COM R15.0.0 |
| life_cycle_state | String | The life cycle state of the retrieved usage service catalog. The supported life cycle states are the following: DRAFT, EFFECTIVE, NOT_EFFECTIVE, CANCELLED From CRM.COM R15.0.0, CANCELLED is deprecated From CRM.COM R17.0.0, DRAFT is deprecated |
| effective_date | Date | The Effective Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0 |
| expiration_date | Date | The Expiration Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.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_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 |
| provisioning_provider | Provisioning Provider Object | The provisioning provider related with the retrieved usage service catalog Deprecated from CRM.COM R15.0.0 |
| log_information | Log Information Object | The log information of the retrieved usage service catalog |
| validity_set | Set of Usage Service Catalog Validity Objects | The time periods during which the retrieved usage service catalog is available to be used. |
| validity_period_set | Set of Usage Service Catalog Validity Period Objects | The time periods during which the retrieved usage service catalog is available to be used Available from CRM.COM R17.0.0 |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"log_information":
{
"updated_date": "2015-09-17T11:57:47",
"created_date": "2015-09-17T11:47:46",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"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,
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"provisioning_provider":
{
"provisioning_protocol": "EXSET_SMS_SERVICES",
"id": "1007A2DB26CF47E396E210FE85EFF839",
"name": "Exset",
"description": "Exset
Oracle XE 10.2",
"alternative_code": "XE"
},
"validity_set":
[
{
"id": "0C8DAE72EAED47A0BB23B227CBC619C7",
"valid_from": "2015-10-01T00:00:00",
"valid_to": null
},
{
"id": "DFC0F011D12940A4A2C231A53BAEF49D",
"valid_from": "2015-09-01T00:00:00",
"valid_to": "2015-09-30T00:00:00"
}
],
"udf_string_7": null,
"udf_string_8": null,
"life_cycle_state": "DRAFT",
"name": "Exet Usage Catalog",
"id": "65407FBD15184DEAA6E5AC84EEBD558D",
"description": null,
"alternative_code": "EUC"
}
}
GET usage_service_catalogs/list
This method returns the usage service catalogs that are allowed to be used in the system. Multiple usage service catalogs are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
life_cycle_state (optional) | String | If specified then only usage service catalogs having a life cycle state equal to the specified value will be retrieved. The supported values are DRAFT, EFFECTIVE, NOT_EFFECTIVE or CANCELLED | ||||||||||||
valid_as_of_date (optional) | Date | If specified then only usage service catalogs which are valid on that date will be retrieved. | ||||||||||||
provisioning_provider_identifier (optional) | Provisioning Provider Identifier | If specified then only usage service catalogs related with the specified provisioning provider will be retrieved. The allowed provisioning provider identifier fields are the following:
| ||||||||||||
accounts_receivable_identifier (optional) | Accounts Receivable Identifier | If specified then the only usage service catalogs which can be provided to the specified accounts receivable will be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
subscription_identifier (optional) | Subscription Identifier | If specified then the only usage service catalogs which can be provided to the specified subscription will be retrieved. The allowed subscription identifier fields are the following:
| ||||||||||||
termed_service_identifier (optional) | Product Identifier | If specified then the only usage service catalogs which can be provided to the specified termed service will be retrieved. The allowed termed service identifier fields are the following:
| ||||||||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be using the usage service catalog. The group is filtered against the usage service catalog's allowed organisational units. The allowed group identifier fields are the following:
| ||||||||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be using the usage service catalog. The unit is filtered against the usage service catalog's allowed organisational units. The allowed unit identifier fields are the following:
| ||||||||||||
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 semi-optional parameter can be specified.
Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved usage service catalog |
| name | String | The Name of the retrieved usage service catalog |
| alternative_code | String | The Alternative Code of the retrieved usage service catalog |
| description | String | The Description of the retrieved usage service catalog |
| termed_service_requirements | String | The settings related to whether a termed service will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R13.0.0 From CRM.COM R14.0.0, DOES_NOT_REQ_TERMED_SERVICE value is not supported Deprecated from CRM.COM R15.0.0 |
| installed_item_requirements | String | The settings related to whether an installed item will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R14.0.0 Deprecated from CRM.COM R15.0.0 |
| life_cycle_state | String | The life cycle state of the retrieved usage service catalog. The supported life cycle states are the following: DRAFT, EFFECTIVE, NOT_EFFECTIVE, CANCELLED From CRM.COM R15.0.0, CANCELLED is deprecated From CRM.COM R17.0.0, DRAFT is deprecated |
| effective_date | Date | The Effective Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0 |
| expiration_date | Date | The Expiration Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.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_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 |
| provisioning_provider | Provisioning Provider Object | The provisioning provider related with the retrieved usage service catalog Deprecated from CRM.COM R15.0.0 |
| log_information | Log Information Object | The log information of the retrieved usage service catalog |
| validity_set | Set of Usage Service Catalog Validity Objects | The time periods during which the retrieved usage service catalog is available to be used. |
| validity_period_set | Set of Usage Service Catalog Validity Period Objects | The time periods during which the retrieved usage service catalog is available to be used Available from CRM.COM R17.0.0 |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"log_information":
{
"updated_date": "2015-09-11T10:23:52",
"created_date": "2015-09-10T09:42:40",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"provisioning_provider":
{
"provisioning_protocol": "CONAX_CONTEGO_WEB_SERVICES",
"id": "9C4930E3523BD2C8F0B513035322C423",
"name": "CONAX V5",
"description": "CONAX Contego 3.0 Web Services
connectSMS: Use to test the CA PIN update command
smsWs06: All othe",
"alternative_code": "CV5"
},
"life_cycle_state": "EFFECTIVE",
"validity_set":
[
],
"id": "560F0B98AC8A4E07A1713892B16D420E",
"name": "Conax Catalog1 ",
"description": null,
"alternative_code": "Conax_1"
},
{
"log_information":
{
"updated_date": "2015-09-17T14:43:36",
"created_date": "2015-09-11T11:38:42",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"provisioning_provider":
{
"provisioning_protocol": "CONAX_CONTEGO_WEB_SERVICES",
"id": "9C4930E3523BD2C8F0B513035322C423",
"name": "CONAX V5",
"description": "CONAX Contego 3.0 Web Services
connectSMS: Use to test the CA PIN update command
smsWs06: All othe",
"alternative_code": "CV5"
},
"life_cycle_state": "EFFECTIVE",
"validity_set":
[
],
"id": "5E5AD41E3939402085F421612C20B0A9",
"name": "test l",
"description": null,
"alternative_code": "tl"
},
{
"log_information":
{
"updated_date": "2015-09-11T14:47:56",
"created_date": "2015-09-11T14:47:49",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"provisioning_provider":
{
"provisioning_protocol": "CONAX_CONTEGO_WEB_SERVICES",
"id": "9C4930E3523BD2C8F0B513035322C423",
"name": "CONAX V5",
"description": "CONAX Contego 3.0 Web Services
connectSMS: Use to test the CA PIN update command
smsWs06: All othe",
"alternative_code": "CV5"
},
"life_cycle_state": "DRAFT",
"validity_set":
[
],
"id": "497F1FE2EB634D75A555C610B1FD0E8F",
"name": null,
"description": null,
"alternative_code": null
},
{
"log_information":
{
"updated_date": "2015-09-14T14:42:49",
"created_date": "2015-09-11T14:48:05",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"provisioning_provider":
{
"provisioning_protocol": "CONAX_CONTEGO_WEB_SERVICES",
"id": "9C4930E3523BD2C8F0B513035322C423",
"name": "CONAX V5",
"description": "CONAX Contego 3.0 Web Services
connectSMS: Use to test the CA PIN update command
smsWs06: All othe",
"alternative_code": "CV5"
},
"life_cycle_state": "EFFECTIVE",
"validity_set":
[
],
"id": "BA2F98BF66494A3584ABE9DA1747BA16",
"name": "Catalog Story board 5",
"description": null,
"alternative_code": "Catalog_SB_5"
},
{
"log_information":
{
"updated_date": "2015-09-17T11:57:47",
"created_date": "2015-09-17T11:47:46",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"provisioning_provider":
{
"provisioning_protocol": "EXSET_SMS_SERVICES",
"id": "1007A2DB26CF47E396E210FE85EFF839",
"name": "Exset",
"description": "Exset
Oracle XE 10.2",
"alternative_code": "XE"
},
"life_cycle_state": "DRAFT",
"validity_set":
[
{
"id": "0C8DAE72EAED47A0BB23B227CBC619C7",
"valid_from": "2015-10-01T00:00:00",
"valid_to": null
},
{
"id": "DFC0F011D12940A4A2C231A53BAEF49D",
"valid_from": "2015-09-01T00:00:00",
"valid_to": "2015-09-30T00:00:00"
}
],
"id": "65407FBD15184DEAA6E5AC84EEBD558D",
"name": "Exet Usage Catalog",
"description": null,
"alternative_code": "EUC"
}
]
}
GET usage_service_catalogs/get_available_services
This method returns the usage services, which are included in effective usage service catalogs and are allowed to be used by subscribers, during the specified date. Multiple usage services are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
valid_as_of_date (mandatory) | Date | If specified then only usage services included in usage service catalogs which are valid on that date will be retrieved. | ||||||||||||
usage_service_catalog_identifier (optional) | Usage Service Catalog Identifier | If specified then only usage services included in that usage service catalogs will be retrieved. The allowed usage service catalog identifier fields are the following:
| ||||||||||||
provisioning_provider_identifier (optional) | Provisioning Provider Identifier | If specified then only usage services included in usage service catalogs related with the specified provisioning provider will be retrieved. The allowed provisioning provider identifier fields are the following:
| ||||||||||||
accounts_receivable_identifier (optional) | Accounts Receivable Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified accounts receivable will be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
subscription_identifier (optional) | Subscription Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified subscription will be retrieved. The allowed subscription identifier fields are the following:
| ||||||||||||
termed_service_identifier (optional) | Product Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified termed service will be retrieved. The allowed termed service identifier fields are the following:
| ||||||||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be using the usage services. The group is filtered against the usage service catalog's allowed organisational units. The allowed group identifier fields are the following:
| ||||||||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be using the usage services. The unit is filtered against the usage service catalog's allowed organisational units. The allowed unit identifier fields are the following:
| ||||||||||||
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 semi-optional parameter can be specified.
Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved usage service catalog usage service |
| base_rate | Float | The base rate of the retrieved usage service catalog usage service Deprecated from CRM.COM R15.0.0 |
| start_date | String | The date and time during which the provisioning of the usage service catalog usage service will start Deprecated from CRM.COM R17.0.0 |
| end_date | String | The date and time during which the provisioning of the usage service catalog usage service will end Deprecated from CRM.COM R17.0.0 |
| provisioning_id | String | The ID used to provision the specified usage service. This information is applicable only if the related usage service is classified as a provisioning service Deprecated from CRM.COM R15.0.0 |
| pre_rated | Boolean | It defines if the retrieved usage service catalog usage service is a pre-rated service or not. It the value is true then it means that the service is pre-rated. It the value is false then it means that the service is post-rated Note that if the service is pre-rated then the base rate and tier rates are not applicable Available from CRM.COM R12.0.0 Deprecated from CRM.COM R15.0.0 |
| apply_additional_discount | Boolean | It defines if additional discount will be applicable on the pre-rated usage service. This option is applicable only if the usage service is classified as pre-rated Available from CRM.COM R13.0.0 Deprecated from CRM.COM R15.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_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 |
| currency | Currency Object | The currency in which the rate is returned Available from CRM.COM R14.2.0 Deprecated from CRM.COM R15.0.0 |
| tiered_rates_set | Set of Usage Service Tiered Rates Objects | The tiered rates related with the retrieved usage service catalog usage service, which are different than the specified base rate, and are applied upon meeting a set of conditions Deprecated from CRM.COM R15.0.0 |
| usage_service | Product Object | The related usage service |
| log_information | Log Information Object | The log information of the retrieved usage service catalog usage service |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data": [
{
"end_date": "2017-02-01T00:00:00",
"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-19T10:03:26",
"updated_date": "2017-03-28T18:12:07",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"username": "pdemou"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": false,
"udf_float_3": null,
"unit_of_measurement": {
"alternative_code": "A",
"name": "Amount",
"description": null,
"id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
},
"udf_float_4": null,
"id": "66CEFA0579514853BB38A431D9C9870B",
"udf_float_1": null,
"udf_float_2": null,
"start_date": "2016-02-19T00:00:00",
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"provisioning_id": "102",
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [],
"base_rate": 5,
"pre_rated": false,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
},
{
"end_date": "2017-02-01T00:00:00",
"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-19T10:03:14",
"updated_date": "2017-03-28T18:12:07",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"username": "pdemou"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": false,
"udf_float_3": null,
"unit_of_measurement": {
"alternative_code": "A",
"name": "Amount",
"description": null,
"id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
},
"udf_float_4": null,
"id": "3ACDEAF6765947B7BC22AD54C0B1A038",
"udf_float_1": null,
"udf_float_2": null,
"start_date": "2016-02-19T00:00:00",
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "MAD MAX",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "MM",
"description": "VOD: MAD MAX",
"id": "4FAF233199054FD18C181D83377FB3FD"
},
"provisioning_id": "202",
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [],
"base_rate": 5,
"pre_rated": false,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
},
{
"end_date": "2017-02-01T00:00:00",
"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-19T10:02:57",
"updated_date": "2017-03-28T18:12:07",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"username": "pdemou"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": true,
"udf_float_3": null,
"unit_of_measurement": {
"alternative_code": "A",
"name": "Amount",
"description": null,
"id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
},
"udf_float_4": null,
"id": "24EB97E8ABE04705B8408125FB439379",
"udf_float_1": null,
"udf_float_2": null,
"start_date": "2016-02-19T00:00:00",
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "CREED",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "C",
"description": "VOD: CREED",
"id": "A465D282F44C46AC834BAE50A81CA2F1"
},
"provisioning_id": "101",
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [],
"base_rate": null,
"pre_rated": true,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"log_information":
{
"updated_date": "2015-09-14T14:42:49",
"created_date": "2015-09-11T16:23:10",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"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",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"end_date": null,
"usage_service":
{
"product_type":
{
"service_type": "USAGE",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "219FBB8FBAA1433AB0A33446B61637F9",
"name": "Usage - Flat",
"description": "Usage - Flat",
"alternative_code": "U-F"
},
"id": "5F60B19CFD634F7D9B9EC401C74ACB16",
"description": "Movie 1",
"code": "Movie 1",
"alternative_code": "MOV_1"
},
"tiered_rates_set":
[
{
"rate": 2.75,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"device": null,
"usage_start_time": "null:null",
"id": "774BE3E888B440DA92F6084EC1360328",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "218FA0FCAE6C4CA4921163C8E54F083D",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "70AB25DE293148AE8EB0B40B8776D9F7",
"usage_end_time": "null:null",
"destination_category": null
}
],
"id": "42D9DEBD12C049CD91FDB5BF2797F942",
"start_date": "2015-09-01T00:00:00",
"provisioning_id": "9C4930E3523BD2C8F0B513035322C423",
"base_rate": 1.75
},
{
"log_information":
{
"updated_date": "2015-09-14T14:42:49",
"created_date": "2015-09-11T16:23:51",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"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",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"end_date": null,
"usage_service":
{
"product_type":
{
"service_type": "USAGE",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "219FBB8FBAA1433AB0A33446B61637F9",
"name": "Usage - Flat",
"description": "Usage - Flat",
"alternative_code": "U-F"
},
"id": "33F396002DE74BB8BA5439CA943E7FEF",
"description": "Movie 2",
"code": "Movie 2",
"alternative_code": "MOV_2"
},
"tiered_rates_set":
[
{
"rate": 2.65,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"device": null,
"usage_start_time": "null:null",
"id": "0FEA32908C13460292CB076F0F8B1962",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "3DF98A93ACD84D978F664D7FE8A327CD",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "C460582870974DC89437BF160D1BC097",
"usage_end_time": "null:null",
"destination_category": null
}
],
"id": "94032F7B72AA4E528AC960D73CFF027A",
"start_date": "2015-09-01T00:00:00",
"provisioning_id": "9C4930E3523BD2C8F0B513035322C423",
"base_rate": 1.65
},
{
"log_information":
{
"updated_date": "2015-09-14T14:42:49",
"created_date": "2015-09-14T08:54:11",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"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",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"end_date": null,
"usage_service":
{
"product_type":
{
"service_type": "USAGE",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "219FBB8FBAA1433AB0A33446B61637F9",
"name": "Usage - Flat",
"description": "Usage - Flat",
"alternative_code": "U-F"
},
"id": "48EF1EF8896448DE871E359454D856FF",
"description": "Movie 3",
"code": "Movie 3",
"alternative_code": "MOV_3"
},
"tiered_rates_set":
[
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "163D0E9964BE41B9AB24C04C09A8062E",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "89AF39865820492EA69A5F80E91D704F",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 2.55,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"device": null,
"usage_start_time": "null:null",
"id": "B2F571C7AB5A4B08BDDAF868C0E3A23C",
"usage_end_time": "null:null",
"destination_category": null
}
],
"id": "70C7AE56C6144B97BB2E5360F74C1947",
"start_date": "2015-09-01T00:00:00",
"provisioning_id": "9C4930E3523BD2C8F0B513035322C423",
"base_rate": 1.55
},
{
"log_information":
{
"updated_date": "2015-09-14T14:42:49",
"created_date": "2015-09-14T08:54:42",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"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",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"end_date": null,
"usage_service":
{
"product_type":
{
"service_type": "USAGE",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "219FBB8FBAA1433AB0A33446B61637F9",
"name": "Usage - Flat",
"description": "Usage - Flat",
"alternative_code": "U-F"
},
"id": "8993F9B282894DACB291AE2AC614A2CC",
"description": "Phone Calls",
"code": "Phone Calls",
"alternative_code": "PHONE_CALLS"
},
"tiered_rates_set":
[
{
"rate": 0,
"minimum_usage": null,
"maximum_usage": null,
"device": null,
"usage_start_time": "0:0",
"id": "6F67A99EAF2A467695929863701E1A45",
"usage_end_time": "7:0",
"usage_method": null
},
{
"rate": 0.06,
"minimum_usage": 1,
"maximum_usage": 10,
"device": null,
"usage_start_time": "null:null",
"id": "A75BF46E2D7B4936AFE52B1BFD361A42",
"usage_end_time": "null:null",
"usage_method": null
},
{
"rate": 0,
"minimum_usage": null,
"maximum_usage": null,
"device": null,
"usage_start_time": "22:0",
"id": "08CC891B8AC346518835AA06F0768ADC",
"usage_end_time": "0:0",
"usage_method": null
},
{
"rate": 0,
"minimum_usage": null,
"maximum_usage": null,
"device": null,
"usage_start_time": "null:null",
"id": "07107E57E2A64363B771B81D813E1566",
"usage_end_time": "null:null",
"usage_method": null
},
{
"rate": 0.05,
"minimum_usage": null,
"maximum_usage": null,
"device": null,
"usage_start_time": "19:0",
"id": "2A1B981439A041CB80C1D7B5DFD15905",
"usage_end_time": "22:0",
"usage_method": null
}
],
"id": "3B71BDF4612D426D8F097D8C6758F7AA",
"start_date": "2015-09-01T00:00:00",
"provisioning_id": "9C4930E3523BD2C8F0B513035322C423",
"base_rate": 0.07
}
]
}
GET usage_service_catalogs/get_available_rates
This method returns the rates of a specific usage service or any usage service which is included in a specific usage service catalog and are allowed to be used by subscribers, during the specified date. Multiple usage services rates are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
valid_as_of_date (mandatory) | Date | If specified then only usage services included in usage service catalogs which are valid on that date will be retrieved. | ||||||||||||
usage_service_identifier (semi-optional) | Usage Service Identifier | If specified then only usage services rates related with the specified usage service will be retrieved. The allowed usage service identifier fields are the following:
| ||||||||||||
usage_service_catalog_identifier (semi-optional) | Usage Service Catalog Identifier | If specified then only usage services included in that usage service catalogs will be retrieved. The allowed usage service catalog identifier fields are the following:
| ||||||||||||
provisioning_provider_identifier (optional) | Provisioning Provider Identifier | If specified then only usage services included in usage service catalogs related with the specified provisioning provider will be retrieved. The allowed provisioning provider identifier fields are the following:
| ||||||||||||
accounts_receivable_identifier (optional) | Accounts Receivable Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified accounts receivable will be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
subscription_identifier (optional) | Subscription Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified subscription will be retrieved. The allowed subscription identifier fields are the following:
| ||||||||||||
termed_service_identifier (optional) | Product Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified termed service will be retrieved. The allowed termed service identifier fields are the following:
| ||||||||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be using the usage services. The group is filtered against the usage service catalog's allowed organisational units. The allowed group identifier fields are the following:
| ||||||||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be using the usage services. The unit is filtered against the usage service catalog's allowed organisational units. The allowed unit identifier fields are the following:
| ||||||||||||
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 semi-optional parameter can be specified.
Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved usage service catalog usage service |
| base_rate | Float | The base rate of the retrieved usage service catalog usage service Deprecated from CRM.COM R15.0.0 |
| start_date | String | The date and time during which the provisioning of the usage service catalog usage service will start Deprecated from CRM.COM R17.0.0 |
| end_date | String | The date and time during which the provisioning of the usage service catalog usage service will end Deprecated from CRM.COM R17.0.0 |
| provisioning_id | String | The ID used to provision the specified usage service. This information is applicable only if the related usage service is classified as a provisioning service Deprecated from CRM.COM R15.0.0 |
| pre_rated | Boolean | It defines if the retrieved usage service catalog usage service is a pre-rated service or not. It the value is true then it means that the service is pre-rated. It the value is false then it means that the service is post-rated Note that if the service is pre-rated then the base rate and tier rates are not applicable Available from CRM.COM R12.0.0 Deprecated from CRM.COM R15.0.0 |
| apply_additional_discount | Boolean | It defines if additional discount will be applicable on the pre-rated usage service. This option is applicable only if the usage service is classified as pre-rated Available from CRM.COM R13.0.0 Deprecated from CRM.COM R15.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_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 |
| currency | Currency Object | The currency in which the rate is returned Available from CRM.COM R14.2.0 Deprecated from CRM.COM R15.0.0 |
| tiered_rates_set | Set of Usage Service Tiered Rates Objects | The tiered rates related with the retrieved usage service catalog usage service, which are different than the specified base rate, and are applied upon meeting a set of conditions Deprecated from CRM.COM R15.0.0 |
| usage_service | Product Object | The related usage service |
| log_information | Log Information Object | The log information of the retrieved usage service catalog usage service |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data": [
{
"end_date": null,
"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": "2017-03-28T13:39:26",
"updated_date": "2017-03-28T13:45:17",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": false,
"udf_float_3": null,
"unit_of_measurement": {
"alternative_code": "A",
"name": "Amount",
"description": null,
"id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
},
"udf_float_4": null,
"id": "01509D2E150046D991447A390398E782",
"udf_float_1": null,
"udf_float_2": null,
"start_date": null,
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "V for Vendetta",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "VS",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "VOD Service",
"description": null,
"id": "B06ACBEF10A24057902837A51BCB2B36",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "VFV",
"description": "V for Vendetta VOD",
"id": "FD50BBBFAC7245838F205F5C143F54AE"
},
"provisioning_id": "304",
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [],
"base_rate": null,
"pre_rated": true,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
},
{
"end_date": null,
"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": "2017-03-28T14:10:08",
"updated_date": "2017-03-28T14:10:19",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": false,
"udf_float_3": null,
"unit_of_measurement": {
"alternative_code": "A",
"name": "Amount",
"description": null,
"id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
},
"udf_float_4": null,
"id": "15481BBC87F44773BE8F1FEE699ACC39",
"udf_float_1": null,
"udf_float_2": null,
"start_date": null,
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "V for Vendetta",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "VS",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "VOD Service",
"description": null,
"id": "B06ACBEF10A24057902837A51BCB2B36",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "VFV",
"description": "V for Vendetta VOD",
"id": "FD50BBBFAC7245838F205F5C143F54AE"
},
"provisioning_id": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [],
"base_rate": null,
"pre_rated": true,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"rate": 26,
"minimum_usage": 1,
"maximum_usage": 15,
"source_category":
{
"name": "United Kingdom",
"id": "3107A54E4DD840DA93A452B12CEF2246",
"description": "United Kingdom",
"code": "UK"
},
"device":
{
"name": "STB",
"id": "FF9922EF7C43474AA5C6AD07A3911DA5",
"description": null,
"alternative_code": "STB"
},
"usage_start_time": "null:null",
"id": "85CD14CF5BEA427D8E0BCCF898410AAA",
"usage_end_time": "null:null",
"usage_method":
{
"name": "Rental",
"id": "250B5CB790CA4344A27299962868C57D",
"description": "rental",
"alternative_code": "rl"
},
"destination_category":
{
"name": "Voip Application",
"id": "629C2E9E7B044012B0534787974E9D7C",
"description": "VOIP APPLICATION",
"code": "VOIP"
}
},
{
"rate": 45,
"minimum_usage": null,
"maximum_usage": null,
"source_category":
{
"name": "VoiP Application",
"id": "F504F4E00C724E9AB0C412EF0C0369D4",
"description": "VoiP Application",
"code": "VOIP"
},
"device":
{
"name": "Tablet",
"id": "ACDED1DC999A4FB1AC375622CD1C6147",
"description": "Tablet",
"alternative_code": "Tablet"
},
"usage_start_time": "1:0",
"id": "78867FDE96B64725885B79F922652D93",
"usage_end_time": "9:15",
"usage_method":
{
"name": "Download",
"id": "665FCE1AF41F44CB87A74CD9E769C488",
"description": "Download",
"alternative_code": "Download"
},
"destination_category":
{
"name": "United Kingdom",
"id": "B1B639D5526A4EA0A205DA649F30077D",
"description": "UNITED KINGDOM",
"code": "UK"
}
},
{
"rate": 26,
"minimum_usage": 1,
"maximum_usage": 15,
"source_category":
{
"name": "United Kingdom",
"id": "3107A54E4DD840DA93A452B12CEF2246",
"description": "United Kingdom",
"code": "UK"
},
"device":
{
"name": "STB",
"id": "FF9922EF7C43474AA5C6AD07A3911DA5",
"description": null,
"alternative_code": "STB"
},
"usage_start_time": "null:null",
"id": "3DE50B14250E44EC947B94BFC99141C1",
"usage_end_time": "null:null",
"usage_method":
{
"name": "Rental",
"id": "250B5CB790CA4344A27299962868C57D",
"description": "rental",
"alternative_code": "rl"
},
"destination_category":
{
"name": "Voip Application",
"id": "629C2E9E7B044012B0534787974E9D7C",
"description": "VOIP APPLICATION",
"code": "VOIP"
}
}
]
}
HTTP Method: GET
Request:
Response:
{
"data": [
{
"end_date": null,
"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": "2017-05-11T15:51:30",
"updated_date": "2017-05-12T15:05:38",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": false,
"udf_float_3": null,
"udf_float_4": null,
"id": "71187B1A53904566BDABF838311BF849",
"udf_float_1": null,
"udf_float_2": null,
"start_date": null,
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"unit_of_measurement": null,
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"provisioning_id": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [
{
"minimum_usage": 101,
"maximum_usage": 200,
"usage_start_time": null,
"rate": 1.055,
"source_category": null,
"usage_end_time": null,
"usage_method": null,
"id": "E074C097CA7B47568377FD62D41B6393",
"device": null,
"destination_category": null
},
{
"minimum_usage": 1,
"maximum_usage": 100,
"usage_start_time": null,
"rate": 1.056,
"source_category": null,
"usage_end_time": null,
"usage_method": null,
"id": "A9B08C4D087E442CAD73FE955E259E04",
"device": null,
"destination_category": null
}
],
"base_rate": 5,
"pre_rated": false,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
},
{
"end_date": null,
"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": "2017-05-11T16:26:19",
"updated_date": "2017-05-11T16:32:49",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": true,
"udf_float_3": null,
"udf_float_4": null,
"id": "5668DC76868A4EEAAAA6CDEC485F7D77",
"udf_float_1": null,
"udf_float_2": null,
"start_date": null,
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "Exxon Petrol",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": false,
"alternative_code": "E",
"udr_type": {
"unit_of_measurement": {
"alternative_code": "L",
"name": "Litre",
"description": "Littres",
"id": "A588A14FFA214303BD2182BCF6E9ACCF"
},
"alternative_code": "T",
"name": "Test",
"description": null,
"id": "C72DCF90AD66467388FA0B7725A24E21"
},
"composition_method": "FLAT",
"name": "Exxon",
"description": null,
"id": "ACA2649D85044264AADC31B5DB0BC567",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "EP",
"description": "Petrol",
"id": "E1EB6B2EBFC444A1BEA9A030A5B4D56D"
},
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [],
"base_rate": 0.5,
"pre_rated": false,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
},
{
"end_date": null,
"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": "2017-05-11T16:26:50",
"updated_date": "2017-05-11T16:27:35",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": false,
"udf_float_3": null,
"udf_float_4": null,
"id": "D5C736D9C2B245029ADBC47C92822554",
"udf_float_1": null,
"udf_float_2": null,
"start_date": null,
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "Exxon Unleaded",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": false,
"alternative_code": "E",
"udr_type": {
"unit_of_measurement": {
"alternative_code": "L",
"name": "Litre",
"description": "Littres",
"id": "A588A14FFA214303BD2182BCF6E9ACCF"
},
"alternative_code": "T",
"name": "Test",
"description": null,
"id": "C72DCF90AD66467388FA0B7725A24E21"
},
"composition_method": "FLAT",
"name": "Exxon",
"description": null,
"id": "ACA2649D85044264AADC31B5DB0BC567",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "EU",
"description": "Exxon Unleaded",
"id": "3F174D8E87474A2AB115A2BFD2750FBB"
},
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [],
"base_rate": 1,
"pre_rated": false,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
},
{
"end_date": null,
"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": "2017-05-11T16:33:42",
"updated_date": "2017-05-11T16:33:48",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": true,
"udf_float_3": null,
"udf_float_4": null,
"id": "E7F1ABB30B71457C9229CC40ADE55494",
"udf_float_1": null,
"udf_float_2": null,
"start_date": null,
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "Exxon Super",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": false,
"alternative_code": "E",
"udr_type": {
"unit_of_measurement": {
"alternative_code": "L",
"name": "Litre",
"description": "Littres",
"id": "A588A14FFA214303BD2182BCF6E9ACCF"
},
"alternative_code": "T",
"name": "Test",
"description": null,
"id": "C72DCF90AD66467388FA0B7725A24E21"
},
"composition_method": "FLAT",
"name": "Exxon",
"description": null,
"id": "ACA2649D85044264AADC31B5DB0BC567",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "ES",
"description": "Exxon Super Unleaded",
"id": "056447D7931F49D49970D8753AA97688"
},
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [],
"base_rate": 0.75,
"pre_rated": false,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST usage_service_catalogs/create
This method creates a new usage service catalog. A single usage service catalog can be created by each call.
Resource URL
Parameters
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name (mandatory) | String | The Name of the usage service catalog | ||||||||||||
alternative_code (mandatory) | String | The Alternative Code of the usage service catalog. If not specified then it is generated automatically based on the specified name | ||||||||||||
description (optional) | String | The Description of the usage service catalog | ||||||||||||
termed_service_requirements (mandatory) | String | Defines the settings related to whether a termed service will be required when adding a Usage Service on a Subscription. Applicable values are:
Available from CRM.COM R13.0.0 | ||||||||||||
create_as_draft (optional) | Boolean | If set to true then the usage service catalog will be created as draft. If set to false or not specified at all, then the usage service catalog will be created as effective | ||||||||||||
provisioning_provider_identifier (optional) | Provisioning Provider Identifier | The provisioning provider related with the usage service catalog that will be created. The allowed provisioning provider identifier fields are the following:
| ||||||||||||
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 Usage Service Catalog Validity Objects | The time periods during which the usage service catalog will be available to be used. If not specified then the usage service catalog will be always be available | ||||||||||||
(mandatory) | Set of Usage Service Catalog Usage Services | The usage services offered through the usage service catalog and their rates. At least one usage service should be specified. Each usage service can be included in a usage service catalog just once. Only products classified as usage services can be specified. |
Referred Parameters Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one semi-optional parameter can be specified.
Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved usage service catalog |
| name | String | The Name of the retrieved usage service catalog |
| alternative_code | String | The Alternative Code of the retrieved usage service catalog |
| description | String | The Description of the retrieved usage service catalog |
| termed_service_requirements | String | The settings related to whether a termed service will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R13.0.0 From CRM.COM R14.0.0, DOES_NOT_REQ_TERMED_SERVICE value is not supported Deprecated from CRM.COM R15.0.0 |
| installed_item_requirements | String | The settings related to whether an installed item will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R14.0.0 Deprecated from CRM.COM R15.0.0 |
| life_cycle_state | String | The life cycle state of the retrieved usage service catalog. The supported life cycle states are the following: DRAFT, EFFECTIVE, NOT_EFFECTIVE, CANCELLED From CRM.COM R15.0.0, CANCELLED is deprecated From CRM.COM R17.0.0, DRAFT is deprecated |
| effective_date | Date | The Effective Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0 |
| expiration_date | Date | The Expiration Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.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_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 |
| provisioning_provider | Provisioning Provider Object | The provisioning provider related with the retrieved usage service catalog Deprecated from CRM.COM R15.0.0 |
| log_information | Log Information Object | The log information of the retrieved usage service catalog |
| validity_set | Set of Usage Service Catalog Validity Objects | The time periods during which the retrieved usage service catalog is available to be used. |
| validity_period_set | Set of Usage Service Catalog Validity Period Objects | The time periods during which the retrieved usage service catalog is available to be used Available from CRM.COM R17.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"8B8CEAB58DC34A1B8222943DB2CCEB72",
"name":"Api Test",
"alternative_code":"A_T",
"description":"Test From Api",
"provisioning_provider_identifier":"EXSET_SMS_SERVICES",
"validity_set":[
{
"valid_from":"2015-09-19T15:49:59",
"valid_to":"2015-09-30T15:49:59"
},
{
"valid_from":"2015-10-01T15:49:59"
}
],
"usage_services_set":[
{
"usage_service_identifier":{"code":"Serendipity"},
"base_rate":"100",
"provisioning_id":"111",
"tiered_rates_set":[
{
"rate":"12",
"usage_start_time":{
"hour":17,
"minute":30,
},
"usage_end_time":{
"hour":18,
"minute":30,
},
"usage_method_identifier":{"name":"Download"}
}
]
}
],
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2015-05-05T15:49:59",
"udf_date_2":"2015-06-05T15:49:59",
"udf_date_3":"2015-07-05T15:49:59",
"udf_date_4":"2015-08-05T15:49:59"
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"provisioning_provider":
{
"provisioning_protocol": "EXSET_SMS_SERVICES",
"id": "1007A2DB26CF47E396E210FE85EFF839",
"name": "Exset",
"description": "Exset
Oracle XE 10.2",
"alternative_code": "XE"
},
"udf_float_1": 10,
"udf_float_2": 20,
"udf_date_1": "2015-05-05T15:49:59",
"udf_float_3": 30,
"udf_date_2": "2015-06-05T15:49:59",
"udf_float_4": 40,
"udf_date_3": "2015-07-05T15:49:59",
"udf_date_4": "2015-08-05T15:49:59",
"name": "Api Test",
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_6": "udf string 6",
"log_information":
{
"updated_date": "2015-09-21T09:04:27",
"created_date": "2015-09-21T09:04:24",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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"
},
"created_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"validity_set":
[
{
"id": "B836CFB87A3845F6BB9720C4B72E325A",
"valid_from": "2015-10-01T15:49:59",
"valid_to": null
},
{
"id": "7A8893D5E50E4C58A22D81A26C941274",
"valid_from": "2015-09-19T15:49:59",
"valid_to": "2015-09-30T15:49:59"
}
],
"life_cycle_state": "DRAFT",
"id": "8107DACF6AB04E01B98ECDB1CBF82568",
"description": "Test From Api",
"alternative_code": "A_T"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"C3740ACA436D452896F10623186BC8A1",
"name":"New Usage Service Catalog",
"alternative_code":"NUSC",
"provisioning_provider_identifier":{"alternative_code":"IS"},
"usage_services_set":
[
{
"base_rate": 5.5,
"usage_service_identifier":{"code":"Serendipity"},
"provisioning_id":"305",
"pre_rated":true
},
{
"base_rate": 4,
"provisioning_id":"307",
"usage_service":
{
"code":"Central Intelligence",
"alternative_code":"C_I",
"type":{"name":"VOD Service"},
"vat_rate_identifier":{"name":"Standard"},
"description":"VOD CI"
}
},
{
"base_rate": 4,
"usage_service_identifier":{"code":"Tax Test Duplicate"},
"pre_rated":true,
"apply_additional_discount":true,
"provisioning_id":"308"
}
]
}
Response:
{
"data": {
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"alternative_code": "NUSC",
"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": "2017-03-28T19:54:20",
"updated_date": "2017-03-28T19:54:21",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
}
},
"udf_string_1": null,
"description": null,
"life_cycle_state": "EFFECTIVE",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"validity_set": [],
"name": "New Usage Service Catalog",
"provisioning_provider": {
"alternative_code": "IS",
"name": "Icareus Suite ",
"description": null,
"id": "5D71C690921F41C395DEDE486417448C",
"provisioning_protocol": "ICAREUS"
},
"id": "6018F282C0134F65B1F051B8BE5F6E25",
"udf_string_6": null,
"udf_float_1": null,
"udf_string_7": null,
"udf_float_2": null,
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST usage_service_catalogs/update
This method updates an existing usage service catalog, which is not already cancelled. A single usage service catalog can be created by each call.
Resource URL
Parameters
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
usage_service_catalog_identifier (mandatory) | Usage Service Catalog Identifier | The usage service catalog that will be updated. The allowed usage service catalog identifier fields are the following:
| ||||||||||||
name (optional) | String | The Name of the usage service catalog | ||||||||||||
alternative_code (optional) | String | The Alternative Code of the usage service catalog. If not specified then it is generated automatically based on the specified name | ||||||||||||
description (optional) | String | The Description of the usage service catalog | ||||||||||||
termed_service_requirements (mandatory) | String | Defines the settings related to whether a termed service will be required when adding a Usage Service on a Subscription. Applicable values are:
Available from CRM.COM R13.0.0 | ||||||||||||
| Boolean | If set to true then the usage service catalog will be updated as draft. If set to false or not specified at all, then the usage service catalog will be updated as effective. This is applicable only if the usage service catalog that will be updated is in draft life cycle state | |||||||||||||
provisioning_provider_identifier (optional) | Provisioning Provider Identifier | The provisioning provider related with the usage service catalog that will be updated. The allowed provisioning provider identifier fields are the following:
| ||||||||||||
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 Usage Service Catalog Validity Objects | The time periods during which the usage service catalog will be available to be used. If not specified then the usage service catalog will be always be available If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
(mandatory) | Set of Usage Service Catalog Usage Services | The usage services offered through the usage service catalog and their rates. At least one usage service should be specified. Each usage service can be included in a usage service catalog just once. Only products classified as usage services can be specified. If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
Note that usage services already included in a usage service catalog can be removed only if the usage service catalog is still draft, or if the usage service catalog is effective or not effective and there are no usage subscription services which are posted, billable and still not billed |
Referred Parameters Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one semi-optional parameter can be specified.
Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved usage service catalog |
| name | String | The Name of the retrieved usage service catalog |
| alternative_code | String | The Alternative Code of the retrieved usage service catalog |
| description | String | The Description of the retrieved usage service catalog |
| termed_service_requirements | String | The settings related to whether a termed service will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R13.0.0 From CRM.COM R14.0.0, DOES_NOT_REQ_TERMED_SERVICE value is not supported Deprecated from CRM.COM R15.0.0 |
| installed_item_requirements | String | The settings related to whether an installed item will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R14.0.0 Deprecated from CRM.COM R15.0.0 |
| life_cycle_state | String | The life cycle state of the retrieved usage service catalog. The supported life cycle states are the following: DRAFT, EFFECTIVE, NOT_EFFECTIVE, CANCELLED From CRM.COM R15.0.0, CANCELLED is deprecated From CRM.COM R17.0.0, DRAFT is deprecated |
| effective_date | Date | The Effective Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0 |
| expiration_date | Date | The Expiration Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.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_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 |
| provisioning_provider | Provisioning Provider Object | The provisioning provider related with the retrieved usage service catalog Deprecated from CRM.COM R15.0.0 |
| log_information | Log Information Object | The log information of the retrieved usage service catalog |
| validity_set | Set of Usage Service Catalog Validity Objects | The time periods during which the retrieved usage service catalog is available to be used. |
| validity_period_set | Set of Usage Service Catalog Validity Period Objects | The time periods during which the retrieved usage service catalog is available to be used Available from CRM.COM R17.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"A379559ECE1E49EFA893754C5322E8F3",
"usage_service_catalog_identifier":{"name":"Api Test"},
"usage_services_set":[
{
"action":"update",
"usage_service_identifier":{"id":"B1BCC73A5F134F03A192DBB96E6645D7"},
"base_rate":"150",
"tiered_rates_set":[
{
"action":"update",
"tier_rate_identifier":{"id":"75B3FEFB9F694FEEA91ADAB7F9AA3D6C"},
"rate":"12",
"maximum_usage":8
}
]
},
{
"action":"add",
"usage_service_identifier":{"code":"3 Days Left"},
"base_rate":"100",
"provisioning_id":"111",
"tiered_rates_set":[
{
"action":"add",
"rate":"12",
"minimum_usage":1,
"maximum_usage":"4"
}
]
}
]
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"provisioning_provider":
{
"provisioning_protocol": "EXSET_SMS_SERVICES",
"id": "1007A2DB26CF47E396E210FE85EFF839",
"name": "Exset",
"description": "Exset
Oracle XE 10.2",
"alternative_code": "XE"
},
"udf_float_1": 10,
"udf_float_2": 20,
"udf_date_1": "2015-05-05T15:49:59",
"udf_float_3": 30,
"udf_date_2": "2015-06-05T15:49:59",
"udf_float_4": 40,
"udf_date_3": "2015-07-05T15:49:59",
"udf_date_4": "2015-08-05T15:49:59",
"name": "Api Test",
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_6": "udf string 6",
"log_information":
{
"updated_date": "2015-09-21T10:41:34",
"created_date": "2015-09-21T09:10:38",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"validity_set":
[
{
"id": "2F7C5A2305984D1A89D2BA6518896523",
"valid_from": "2015-09-19T15:49:59",
"valid_to": "2015-09-30T15:49:59"
},
{
"id": "B0877AAA6DC445D4A2AD2B6859D6E819",
"valid_from": "2015-10-01T15:49:59",
"valid_to": null
}
],
"life_cycle_state": "EFFECTIVE",
"id": "9F9CF9074DB2406B994DD34EEAF44BA5",
"description": "Test Update From Api",
"alternative_code": "A_T"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"A379559ECE1E49EFA893754C5322E8F3",
"usage_service_catalog_identifier":{"name":"API Usage Service Catalog"},
"usage_services_set":
[
{
"action":"update",
"base_rate": 3,
"usage_service_catalog_identifier":{"id":"D6305E9CC64C4A8F96CB3F258E991F43"},
"pre_rated":true,
"apply_additional_discount":true
}
]
}
Response:
{
"data": {
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"alternative_code": "APIUSC",
"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": "2017-04-04T18:36:09",
"updated_date": "2017-04-04T18:39:43",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"udf_string_1": null,
"description": null,
"life_cycle_state": "EFFECTIVE",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"validity_set": [],
"name": "API Usage Service Catalog",
"provisioning_provider": {
"alternative_code": "IS",
"name": "Icareus Suite ",
"description": null,
"id": "5D71C690921F41C395DEDE486417448C",
"provisioning_protocol": "ICAREUS"
},
"id": "50D77DAF48284433A38500BD80D8F2CC",
"udf_string_6": null,
"udf_float_1": null,
"udf_string_7": null,
"udf_float_2": null,
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST usage_service_catalogs/cancel
This method is used to cancel a specific usage service catalog. This method is applicable only on draft, effective or not effective usage service catalogs, having no related usage detail records which are posted, billable and still not billed. Only one usage service catalog can be cancelled on each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
usage_service_catalog_identifier (mandatory) | Usage Service Catalog Identifier | The identifier of the usage service catalog .The allowed usage service catalog identifier fields are the following:
| ||||||||||||
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 semi-optional parameter can be specified.
Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved usage service catalog |
| name | String | The Name of the retrieved usage service catalog |
| alternative_code | String | The Alternative Code of the retrieved usage service catalog |
| description | String | The Description of the retrieved usage service catalog |
| termed_service_requirements | String | The settings related to whether a termed service will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R13.0.0 From CRM.COM R14.0.0, DOES_NOT_REQ_TERMED_SERVICE value is not supported Deprecated from CRM.COM R15.0.0 |
| installed_item_requirements | String | The settings related to whether an installed item will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R14.0.0 Deprecated from CRM.COM R15.0.0 |
| life_cycle_state | String | The life cycle state of the retrieved usage service catalog. The supported life cycle states are the following: DRAFT, EFFECTIVE, NOT_EFFECTIVE, CANCELLED From CRM.COM R15.0.0, CANCELLED is deprecated From CRM.COM R17.0.0, DRAFT is deprecated |
| effective_date | Date | The Effective Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0 |
| expiration_date | Date | The Expiration Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.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_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 |
| provisioning_provider | Provisioning Provider Object | The provisioning provider related with the retrieved usage service catalog Deprecated from CRM.COM R15.0.0 |
| log_information | Log Information Object | The log information of the retrieved usage service catalog |
| validity_set | Set of Usage Service Catalog Validity Objects | The time periods during which the retrieved usage service catalog is available to be used. |
| validity_period_set | Set of Usage Service Catalog Validity Period Objects | The time periods during which the retrieved usage service catalog is available to be used Available from CRM.COM R17.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"A379559ECE1E49EFA893754C5322E8F3",
"usage_service_catalog_identifier":{"name":"Api Test"}
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"provisioning_provider":
{
"provisioning_protocol": "EXSET_SMS_SERVICES",
"id": "1007A2DB26CF47E396E210FE85EFF839",
"name": "Exset",
"description": "Exset
Oracle XE 10.2",
"alternative_code": "XE"
},
"udf_float_1": 10,
"udf_float_2": 20,
"udf_date_1": "2015-05-05T15:49:59",
"udf_float_3": 30,
"udf_date_2": "2015-06-05T15:49:59",
"udf_float_4": 40,
"udf_date_3": "2015-07-05T15:49:59",
"udf_date_4": "2015-08-05T15:49:59",
"name": "Api Test",
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_6": "udf string 6",
"log_information":
{
"updated_date": "2015-09-21T10:44:41",
"created_date": "2015-09-21T09:10:38",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"validity_set":
[
{
"id": "B0877AAA6DC445D4A2AD2B6859D6E819",
"valid_from": "2015-10-01T15:49:59",
"valid_to": null
},
{
"id": "2F7C5A2305984D1A89D2BA6518896523",
"valid_from": "2015-09-19T15:49:59",
"valid_to": "2015-09-30T15:49:59"
}
],
"life_cycle_state": "CANCELLED",
"id": "9F9CF9074DB2406B994DD34EEAF44BA5",
"description": "Test Update From Api",
"alternative_code": "A_T"
}
}
POST usage_service_catalogs/set_as_effective
This method is used to set a specific usage service catalog as effective. This method is applicable only on draft or not effective usage service catalogs. Only one usage service catalog can be updated on each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
usage_service_catalog_identifier (mandatory) | Usage Service Catalog Identifier | The identifier of the usage service catalog .The allowed usage service catalog identifier fields are the following:
| ||||||||||||
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 semi-optional parameter can be specified.
Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved usage service catalog |
| name | String | The Name of the retrieved usage service catalog |
| alternative_code | String | The Alternative Code of the retrieved usage service catalog |
| description | String | The Description of the retrieved usage service catalog |
| termed_service_requirements | String | The settings related to whether a termed service will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R13.0.0 From CRM.COM R14.0.0, DOES_NOT_REQ_TERMED_SERVICE value is not supported Deprecated from CRM.COM R15.0.0 |
| installed_item_requirements | String | The settings related to whether an installed item will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R14.0.0 Deprecated from CRM.COM R15.0.0 |
| life_cycle_state | String | The life cycle state of the retrieved usage service catalog. The supported life cycle states are the following: DRAFT, EFFECTIVE, NOT_EFFECTIVE, CANCELLED From CRM.COM R15.0.0, CANCELLED is deprecated From CRM.COM R17.0.0, DRAFT is deprecated |
| effective_date | Date | The Effective Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0 |
| expiration_date | Date | The Expiration Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.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_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 |
| provisioning_provider | Provisioning Provider Object | The provisioning provider related with the retrieved usage service catalog Deprecated from CRM.COM R15.0.0 |
| log_information | Log Information Object | The log information of the retrieved usage service catalog |
| validity_set | Set of Usage Service Catalog Validity Objects | The time periods during which the retrieved usage service catalog is available to be used. |
| validity_period_set | Set of Usage Service Catalog Validity Period Objects | The time periods during which the retrieved usage service catalog is available to be used Available from CRM.COM R17.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"A379559ECE1E49EFA893754C5322E8F3",
"usage_service_catalog_identifier":{"name":"test l"}
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"provisioning_provider":
{
"provisioning_protocol": "CONAX_CONTEGO_WEB_SERVICES",
"id": "9C4930E3523BD2C8F0B513035322C423",
"name": "CONAX V5",
"description": "CONAX Contego 3.0 Web Services
connectSMS: Use to test the CA PIN update command
smsWs06: All othe",
"alternative_code": "CV5"
},
"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": "test l",
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"log_information":
{
"updated_date": "2015-09-21T10:48:08",
"created_date": "2015-09-11T11:38:42",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"udf_string_7": null,
"udf_string_8": null,
"validity_set":
[
],
"life_cycle_state": "EFFECTIVE",
"id": "5E5AD41E3939402085F421612C20B0A9",
"description": null,
"alternative_code": "tl"
}
}
POST usage_service_catalogs/set_as_not_effective
This method is used to set a specific usage service catalog as not effective. This method is applicable only on effective usage service catalogs. Only one usage service catalog can be updated on each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
usage_service_catalog_identifier (mandatory) | Usage Service Catalog Identifier | The identifier of the usage service catalog .The allowed usage service catalog identifier fields are the following:
| ||||||||||||
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 semi-optional parameter can be specified.
Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved usage service catalog |
| name | String | The Name of the retrieved usage service catalog |
| alternative_code | String | The Alternative Code of the retrieved usage service catalog |
| description | String | The Description of the retrieved usage service catalog |
| termed_service_requirements | String | The settings related to whether a termed service will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R13.0.0 From CRM.COM R14.0.0, DOES_NOT_REQ_TERMED_SERVICE value is not supported Deprecated from CRM.COM R15.0.0 |
| installed_item_requirements | String | The settings related to whether an installed item will be required when adding a Usage Service on a Subscription. The supported values are the following:
Available from CRM.COM R14.0.0 Deprecated from CRM.COM R15.0.0 |
| life_cycle_state | String | The life cycle state of the retrieved usage service catalog. The supported life cycle states are the following: DRAFT, EFFECTIVE, NOT_EFFECTIVE, CANCELLED From CRM.COM R15.0.0, CANCELLED is deprecated From CRM.COM R17.0.0, DRAFT is deprecated |
| effective_date | Date | The Effective Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0 |
| expiration_date | Date | The Expiration Date of the retrieved usage service catalog Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.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_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 |
| provisioning_provider | Provisioning Provider Object | The provisioning provider related with the retrieved usage service catalog Deprecated from CRM.COM R15.0.0 |
| log_information | Log Information Object | The log information of the retrieved usage service catalog |
| validity_set | Set of Usage Service Catalog Validity Objects | The time periods during which the retrieved usage service catalog is available to be used. |
| validity_period_set | Set of Usage Service Catalog Validity Period Objects | The time periods during which the retrieved usage service catalog is available to be used Available from CRM.COM R17.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"A379559ECE1E49EFA893754C5322E8F3",
"usage_service_catalog_identifier":{"name":"test l"}
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"provisioning_provider":
{
"provisioning_protocol": "CONAX_CONTEGO_WEB_SERVICES",
"id": "9C4930E3523BD2C8F0B513035322C423",
"name": "CONAX V5",
"description": "CONAX Contego 3.0 Web Services
connectSMS: Use to test the CA PIN update command
smsWs06: All othe",
"alternative_code": "CV5"
},
"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": "test l",
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"log_information":
{
"updated_date": "2015-09-21T10:47:15",
"created_date": "2015-09-11T11:38:42",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"udf_string_7": null,
"udf_string_8": null,
"validity_set":
[
],
"life_cycle_state": "NOT_EFFECTIVE",
"id": "5E5AD41E3939402085F421612C20B0A9",
"description": null,
"alternative_code": "tl"
}
}