POST usage_service_catalogs/update

Available from CRM.COM R8.0.0

From CRM.COM R14.0.0, this method will update only the latest version of the Usage Service Catalog. A new version of the usage service catalog will be created if the catalog is already used and any attribute other than adding a new product is updated

This method updates an existing usage service catalog, which is not already canceled. A single usage service catalog can be updated 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 usage service catalog that will be updated. The allowed usage service catalog identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage service catalog

name

(semi-optional)

String

The name of the usage service catalog

alternative_code

(semi-optional)

String

The alternative code of the usage service catalog

name

(optional)

String

The Name of the usage service catalog

From CRM.COM R14.0.0, this parameter can be updated only if the usage service catalog has one version and it is not already used

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

create_as_draft

(optional)

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

Deprecated from CRM.COM R17.0.0

termed_service_requirements

(optional)

String

Defines the settings related to whether a termed service will be required when adding a Usage Service on a Subscription. Applicable values are:

REQ_EFFECTIVE_TERMED_SERVICE
REQ_EFF_NOT_EFF_TERMED_SERVICE
DOES_NOT_REQ_TERMED_SERVICE

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 R16.1.0

installed_item_requirements

(optional)

String

Defines the settings related to whether a termed service will be required when adding a Usage Service on a Subscription. Applicable values are:

REQUIRES_INSTALLED_ITEM
DOES_NOT_REQ_INSTALLED_ITEM

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R16.1.0

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning provider

name

(semi-optional)

String

The name of the provisioning provider

alternative_code

(semi-optional)

String

The alternative code of the provisioning provider

Deprecated from CRM.COM R16.1.0

effective_date

(optional)

Date

The date that the new version of the usage service catalog will be set as effective

Applicable only when the catalog is used and any attribute of the catalog other than adding a new product is updated. If not specified, then the new version's effective date will be set as the current date

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R17.0.0

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

validity_set

(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",
            	...........
			}
		]

validity_period_set

(optional)

Set of Usage Service Catalog Validity Objects

The 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",
            	...........
			}
		]

If validity_set is specified, then this parameter should not be specified and vice versa

Available from CRM.COM R17.0.0

usage_services_set

(optional)

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

For releases prior CRM.COM R14.0.0, this parameter is mandatory

Referred Parameters Objects Data

usage_service_catalog_validity parameter object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

validity_identifier

(mandatory on update and remove)

Usage Service Catalog Validity Identifier

The usage service catalog validity entry that will be updated or removed. This is applicable only if the specified action is set to UPDATE or REMOVE. The allowed usage service catalog validity identifier fields are the following:

Name

Type

Description

id

(mandatory)

String

The ID of the usage service catalog validity entry

valid_from

(mandatory on add, optional on update, not applicable on remove)

Date

The date that the usage service catalog will become valid

valid_to

(optional on add and update, not applicable on remove)

Date

The date that the usage service catalog will become invalid. This is optional as a usage service catalog can be valid for ever, starting from a specific date

usage_service_catalog_validity parameter object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

validity_identifier

(mandatory on update and remove)

Usage Service Catalog Validity Identifier

The usage service catalog validity entry that will be updated or removed. This is applicable only if the specified action is set to UPDATE or REMOVE. The allowed usage service catalog validity identifier fields are the following:

Name

Type

Description

id

(mandatory)

String

The ID of the usage service catalog validity entry

valid_from

(semi-optional on add, optional on update, not applicable on remove)

Date

The date that the usage service catalog will become valid

valid_to

(optional on add and update, not applicable on remove)

Date

The date that the usage service catalog will become invalid. This is optional as a usage service catalog can be valid for ever, starting from a specific date

valid_month_from

(semi-optional on add, optional on update, not applicable on remove)

String

The month that the usage service catalog will become valid

This field is mandatory if the valid_day_from is specified, and vice versa

valid_month_to

(optional on add and update, not applicable on remove)

String

The month that the usage service catalog will become invalid. This is optional as a usage service catalog can be valid for ever, starting from a specific month

Applicable only if valid_month_from and valid_day_from are specified

This field is mandatory if the valid_day_to is specified, and vice versa

valid_day_from

(semi-optional on add, optional on update, not applicable on remove)

String

The day that the usage service catalog will become valid

This field is mandatory if the valid_month_from is specified, and vice versa

valid_day_to

(optional on add and update, not applicable on remove)

String

The day that the usage service catalog will become invalid. This is optional as a usage service catalog can be valid for ever, starting from a specific day

Applicable only if valid_month_from and valid_day_from are specified

This field is mandatory if the valid_month_to is specified, and vice versa

usage_service_catalog_usage_services parameter object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

usage_service_catalog_identifier

(mandatory and applicable only on update or remove)

Usage Service Catalog Usage Service Identifier

The usage service catalog usage service entry that will be updated or removed. This is applicable only if the specified action is set to update or remove. The allowed usage service catalog usage service identifier fields are the following:

Name

Type

Description

id

(mandatory)

String

The ID of the usage service catalog usage service

usage_service_identifier

(semi-optional on add, not applicable on update or remove)

Usage Service Identifier

The identifier of the related usage service. This is applicable only when adding existing products in a usage service catalog. Only products classified as usage services can be added in a usage service catalog. This information is mandatory unless a usage service (object) is specified. The allowed usage service identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

Note that this information is applicable only if the specified action is set to add

product_family_identifier

(semi-optional on add, not applicable on update or remove)

Product Family Identifier

The identifier of the related product family of the usage service

The allowed product family identifier fields are the following

Name

Type

Description

id

(semi-optional)

String

The ID of the product family

name

(semi-optional)

String

The name of the product family

code

(semi-optional)

String

The code of a product family

Available from CRM.COM R17.0.0

product_category_identifier

(semi-optional on add, not applicable on update or remove)

Product Category Identifier

The identifier of the related product category of the usage service

The allowed product category identifier fields are the following

Name

Type

Description

id

(semi-optional)

String

The ID of the product category

name

(semi-optional)

String

The name of the product category

code

(semi-optional)

String

The code of a product category

Available from CRM.COM R17.0.0

start_date

(optional on add, optional on update, not applicable on remove)

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

(optional on add, optional on update, not applicable on remove)

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

base_rate

(mandatory on conditions and applicable only on add or update, not applicable on remove)

Float

The base rate of the usage service catalog usage service. This information is mandatory unless a default rate, related with the type of the specified usage service, was defined in the active usage service catalog definitions.

Deprecated from CRM.COM R15.0.0

provisioning_id

(mandatory and applicable on conditions on add, optional on update, not applicable on remove)

String

The ID used to provision the specified usage service. This information is applicable and mandatory only if the related usage service is classified as a provisioning service

Deprecated from CRM.COM R15.0.0

pre_rated

(optional on add and update, not applicable on remove)

Boolean

It defines if the 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 nor mandatory

Available from CRM.COM R12.0.0

Deprecated from CRM.COM R15.0.0

apply_additional_discount

(optional on add and update, not applicable on remove)

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

(optional on add, optional on update, not applicable on remove)

String

User Defined Field of type String

udf_string_2

(optional on add, optional on update, not applicable on remove)

String

User Defined Field of type String

udf_string_3

(optional on add, optional on update, not applicable on remove)

String

User Defined Field of type String

udf_string_4

(optional on add, optional on update, not applicable on remove)

String

User Defined Field of type String

udf_string_5

(optional on add, optional on update, not applicable on remove)

String

User Defined Field of type String

udf_string_6

(optional on add, optional on update, not applicable on remove)

String

User Defined Field of type String

udf_string_7

(optional on add, optional on update, not applicable on remove)

String

User Defined Field of type String

udf_string_8

(optional on add, optional on update, not applicable on remove)

String

User Defined Field of type String

udf_float_1

(optional on add, optional on update, not applicable on remove)

Float

User Defined Field of type Float

udf_float_2

(optional on add, optional on update, not applicable on remove)

Float

User Defined Field of type Float

udf_float_3

(optional on add, optional on update, not applicable on remove)

Float

User Defined Field of type Float

udf_float_4

(optional on add, optional on update, not applicable on remove)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional on add, optional on update, not applicable on remove)

Date

User Defined Field of type Date

udf_date_3

(optional on add, optional on update, not applicable on remove)

Date

User Defined Field of type Date

udf_date_4

(optional on add, optional on update, not applicable on remove)

Date

User Defined Field of type Date

usage_service

(semi-optional on add, not applicable on update and remove)

Product Object

The related usage service. This is applicable only when adding new products in a usage service catalog. Only products classified as usage services can be added in a usage service catalog. This information is mandatory unless a usage service identifier is specified.

Note that this information is applicable only if the specified action is set to add

tiered_rates_set

(optional on add, optional on update, not applicable on remove)

Set of Usage Service Tiered Rates Objects

The tiered rates related with the usage service catalog usage service, which are different than the specified base rate, and are applied upon meeting a set of conditions

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",
            	...........
			}
		]

Deprecated from CRM.COM R15.0.0

Referred Parameter Objects Data

product parameter object data

Name

Type

Description

code

(mandatory)

String

The code of the product

alternative_code

(mandatory)

String

The alternative code of the product. If not specified then it is generated automatically based on the specified product code

type_identifier

(mandatory)

Product Type Identifier

The identifier of the product type. The allowed product type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product type

name

(semi-optional)

String

The name of the product type

alternative_code

(semi-optional)

String

The alternative code of a product type

For releases prior CRM.COM R14.0.0, the name of this parameter is type

From CRM.COM R14.0.0 and onwards, the name of this parameter is type_identifier

vat_rate_identifier

(mandatory)

VAT Rate Identifier

The identifier of the VAT rate that will be applicable on the product. The allowed VAT rate identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the VAT rate

name

(semi-optional)

String

The name of the VAT rate

alternative_code

(semi-optional)

String

The alternative code of the VAT rate

brand_identifier

(optional)

Product Brand Identifier

The identifier of the product brand. The allowed product brand identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product brand

name

(semi-optional)

String

The name of the product brand

alternative_code

(semi-optional)

String

The alternative code of a product brand

family_identifier

(optional)

Product Family Identifier

The identifier of the product family. The allowed product family identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product family

name

(semi-optional)

String

The name of the product family

code

(semi-optional)

String

The code of a product family

For releases prior CRM.COM R14.0.0, the name of this parameter is family

From CRM.COM R14.0.0 and onwards, the name of this parameter is family_identifier

description

(mandatory)

String

The description of the product

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

validity_set

(optional)

Set of Product Validity Objects

The time periods during which the product will be available to be used. If not specified then the product will be always be available

categories_set

(optional)

Set of Product Category Objects

The categories related with the product. More than one categories can be specified. Each category can be specified just once.

Referred Parameter Objects Data

product_validity parameter object data

Name

Type

Description

valid_from

(mandatory)

Date

The date that the product will become valid

valid_to

(optional)

Date

The date that the product will become invalid. This is optional as a product can be valid for ever, starting from a specific date

product_categories parameter object data

Name

Type

Description

category_identifier

(mandatory)

Product Category Identifier

The identifier of the product category. The allowed product categories identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product category

name

(semi-optional)

String

The name of the product category

code

(semi-optional)

String

The code of a product category

usage_service_tiered_rates parameter object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

tier_rate_identifier

(mandatory and applicable only on update or remove)

Usage Service Tier Rate Identifier

The identifier of the tier rate that will be updated or removed. This is applicable only if the specified action is set to UPDATE or REMOVE. The allowed usage service tier rate identifier fields are the following:

Name

Type

Description

id

(mandatory)

String

The ID of the usage service tier rate

rate

(mandatory on add, optional on update, not applicable on remove)

Float

The rate of the usage service tiered rate

minimum_usage

(semi-optional on add, optional on update, not applicable on remove)

Float

The minimum usage of the service that should be applied in order for the specified rate to be applicable

maximum_usage

(semi-optional on add, optional on update, not applicable on remove)

Float

The maximum usage of the service that should be applied in order for the specified rate to be applicable

usage_method_identifier

(semi-optional on add, optional on update, not applicable on remove)

Usage Detail Record Usage Method Identifier

The usage method that should be used in order for the specified rate to be applicable. The allowed usage method identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record usage_method

name

(semi-optional)

String

The name of the usage detail record usage_method

alternative_code

(semi-optional)

String

The alternative code of the usage detail record usage_method

device_identifier

(semi-optional on add, optional on update, not applicable on remove)

Usage Detail Record Device Identifier

The device that should be used in order for the specified rate to be applicable. The allowed device identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record device

name

(semi-optional)

String

The name of the usage detail record device

alternative_code

(semi-optional)

String

The alternative code of the usage detail record device

source_category_identifier

(semi-optional on add, optional on update, not applicable on remove)

Usage Detail Record Source Category Identifier

The source category that should be used in order for the specified rate to be applicable. The allowed source category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record source category

name

(semi-optional)

String

The name of the usage detail record source category

code

(semi-optional)

String

The code of the usage detail record source category

destination_category_identifier

(semi-optional on add, optional on update, not applicable on remove)

Usage Detail Record Destination Category Identifier

The destination category that should be used in order for the specified rate to be applicable. The allowed destination category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record destination category

name

(semi-optional)

String

The name of the usage detail record destination category

code

(semi-optional)

String

The code of the usage detail record destination category

usage_start_time

(semi-optional on add, optional on update, not applicable on remove)

Hour / Minute Object

The usage start time during which the specified rate is applicable

usage_end_time

(semi-optional on add, optional on update, not applicable on remove)

Hour / Minute Object

The usage end time during which the specified rate is applicable

Referred Parameter Objects

hour / minute parameter object data

Name

Type

Description

hour

(mandatory)

Number

The hour value

minute

(mandatory)

Number

The minute value

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: REQ_EFFECTIVE_TERMED_SERVICE REQ_EFF_NOT_EFF_TERMED_SERVICE DOES_NOT_REQ_TERMED_SERVICE 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: REQUIRES_INSTALLED_ITEM DOES_NOT_REQ_INSTALLED_ITEM 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

provisioning_provider object response data

Name	Type	Description
id	String	The id of the retrieved provisioning provider
name	String	The name of the retrieved provisioning provider
alternative_code	String	The alternative code of the retrieved provisioning provider
description	String	The description of the retrieved provisioning providers
provisioning_protocol	String	The provisioning protocol used by the provisioning provider

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

usage_service_catalog_validity object data response

Name	Type	Description
id	String	The id of the usage service catalog validity entry
valid_from	Date	The date that the usage service catalog should become valid
valid_to	Date	The date that the usage service catalog should become invalid. This is optional as a usage service catalog can be valid for ever, starting from a specific date

usage_service_catalog_validity object data response

Name	Type	Description
id	String	The id of the usage service catalog validity entry
valid_date_from	Date	The date that the usage service catalog should become valid
valid_date_to	Date	The date that the usage service catalog should become invalid. This is optional as a usage service catalog can be valid for ever, starting from a specific date
valid_month_from	String	The month that the usage service catalog should become valid
valid_month_to	String	The month that the usage service catalog should become invalid
valid_day_from	String	The day that the usage service catalog should become valid
valid_day_to	String	The day that the usage service catalog should become invalid

Examples

Example 1

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"
    }
}

Example 2

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": ""
  }
}