Available from CRM.COM R8.0.0

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:

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

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

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

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

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:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

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:

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

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

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

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

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:

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

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

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:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

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:

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

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

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

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

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_tier_rates object data response

Name	Type	Description
id	String	The id of the retrieved usage service tiered rate
rate	Float	The rate of the retrieved usage service tiered rate
minimum_usage	Float	The minimum usage of the service that should be applied in order for the specified rate to be applicable
maximum_usage	Float	The maximum usage of the service that should be applied in order for the specified rate to be applicable
usage_start_time	Hour / Minute Object	The usage start time during which the specified rate is applicable
usage_end_time	Hour / Minute Object	The usage end time during which the specified rate is applicable
usage_method	Usage Detail Record Usage Method Object	The usage method that should be used in order for the specified rate to be applicable
device	Usage Detail Record Device Object	The device that should be used in order for the specified rate to be applicable
source_category	Usage Detail Record Source Category Object	The source category that should be used in order for the specified rate to be applicable
destination_category	Usage Detail Record Destination Category Object	The destination category that should be used in order for the specified rate to be applicable

Referred Objects Response Data

usage_detail_record_usage_method object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record usage method
name	String	The Name of the retrieved usage detail record usage method
alternative_code	String	The Alternative Code of the retrieved usage detail record usage method
description	String	The Description of the retrieved usage detail record usage method

usage_detail_record_device object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record device
name	String	The Name of the retrieved usage detail record device
alternative_code	String	The Alternative Code of the retrieved usage detail record device
description	String	The Description of the retrieved usage detail record device

usage_detail_record_source_category response data object

Name	Type	Description
Id	String	The ID of the retrieved usage detail record source category
name	String	The Name of the retrieved usage detail record source category
code	String	The code of the retrieved usage detail record source category
description	String	The description of the retrieved usage detail record source category

usage_detail_record_destination_category response data object

Name	Type	Description
Id	String	The ID of the retrieved usage detail record destination category
name	String	The Name of the retrieved usage detail record destination category
code	String	The code of the retrieved usage detail record destination category
description	String	The description of the retrieved usage detail record destination category

hour / minute object response data

Name	Type	Description
hour	Number	The hour value
minute	Number	The minute value

Examples

Example 1

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:

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

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:

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

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:

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

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

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:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

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:

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

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

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

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

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_tier_rates object data response

Name	Type	Description
id	String	The id of the retrieved usage service tiered rate
rate	Float	The rate of the retrieved usage service tiered rate
minimum_usage	Float	The minimum usage of the service that should be applied in order for the specified rate to be applicable
maximum_usage	Float	The maximum usage of the service that should be applied in order for the specified rate to be applicable
usage_start_time	Hour / Minute Object	The usage start time during which the specified rate is applicable
usage_end_time	Hour / Minute Object	The usage end time during which the specified rate is applicable
usage_method	Usage Detail Record Usage Method Object	The usage method that should be used in order for the specified rate to be applicable
device	Usage Detail Record Device Object	The device that should be used in order for the specified rate to be applicable
source_category	Usage Detail Record Source Category Object	The source category that should be used in order for the specified rate to be applicable
destination_category	Usage Detail Record Destination Category Object	The destination category that should be used in order for the specified rate to be applicable

Referred Objects Response Data

usage_detail_record_usage_method object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record usage method
name	String	The Name of the retrieved usage detail record usage method
alternative_code	String	The Alternative Code of the retrieved usage detail record usage method
description	String	The Description of the retrieved usage detail record usage method

usage_detail_record_device object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record device
name	String	The Name of the retrieved usage detail record device
alternative_code	String	The Alternative Code of the retrieved usage detail record device
description	String	The Description of the retrieved usage detail record device

usage_detail_record_source_category response data object

Name	Type	Description
Id	String	The ID of the retrieved usage detail record source category
name	String	The Name of the retrieved usage detail record source category
code	String	The code of the retrieved usage detail record source category
description	String	The description of the retrieved usage detail record source category

usage_detail_record_destination_category response data object

Name	Type	Description
Id	String	The ID of the retrieved usage detail record destination category
name	String	The Name of the retrieved usage detail record destination category
code	String	The code of the retrieved usage detail record destination category
description	String	The description of the retrieved usage detail record destination category

hour / minute object response data

Name	Type	Description
hour	Number	The hour value
minute	Number	The minute value

Examples

Example 1

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

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

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:

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

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

usage_services_set

(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

usage_service_catalog_validity parameter object data

Name

Type

Description

valid_from

(mandatory)

Date

The date that the usage service catalog will become valid

valid_to

(optional)

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_usage_services parameter object data

Name

Type

Description

usage_service_identifier

(semi-optional)

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

product_family_identifier

(semi-optional)

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)

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)

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)

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)

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)

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)

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)

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)

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

usage_service

(semi-optional)

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.

tiered_rates_set

(optional)

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

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

rate

(mandatory)

Float

The rate of the usage service tiered rate

minimum_usage

(semi-optional)

Float

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

maximum_usage

(semi-optional)

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)

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)

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)

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)

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)

Hour / Minute Object

The usage start time during which the specified rate is applicable

usage_end_time

(semi-optional)

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

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

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

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

update_as_draft

(optional and applicable on conditions)

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:

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

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

usage_services_set

(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

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

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:

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

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

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:

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

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

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

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