GET usage_service_catalogs/list

Available from CRM.COM R8.0.0

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

currency_identifier

(optional)

Currency Identifier

The identifier of the currency of the retrieved Usage Service Catalog. The available currency identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the currency

code

(semi-optional)

String

The code of the currency

Available from CRM.COM R14.2.0

Number

The number of results that can be retrieved through each call

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Available from CRM.COM R13.0.0

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