GET jobs/configuration/unit_restrictions/list

Available from CRM.COM R14.12.0

This method returns the restrictions applied per unit for the receipt method, working hours and allowed products during which generic jobs can be requested for. Multiple results are returned by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

job_type_identifier

(mandatory)

Job Type Identifier

The identifier of the job type for which the time restrictions will be retrieved. The allowed job type identifiers are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job type

name

(semi-optional)

String

The name of the job type

alternative_code

(semi-optional)

String

The alternative code of the job type

Only generic job types are allowed to be specified

unit_identifier

(mandatory)

Unit Identifier

The identifier of the unit. The allowed unit identifiers 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

Response Data

Name	Type	Description
day_and_time_restrictions	Day and Time Restrictions Object	The day and time frame that the unit is operating
allowed_products	Products Object	The products that the unit is allowed to provide for this job type
unavailable_products	Products Object	The products that the unit is temporarily disabling and can not provide for this job type

Referred Objects Response Data

day_and_time_restrictions object response data

Name	Type	Description
from	String	The time that the receipt method becomes available (defined in HH:MM)
to	String	The time that the receipt method becomes unavailable (defined in HH:MM)
days_of_week	Object	The day of week condition

Referred Objects Response Data

days_restrictions object response data

Name

Type

Description

day_of_week

String

The day of week condition. The supported values are the following:

MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

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

Examples

Example 1

{
"data": {
"day_and_time_restrictions": [
{
"days_of_week": {
"sunday": true,
"saturday": true,
"tuesday": false,
"wednesday": false,
"thursday": false,
"friday": false,
"monday": false
},
"from": "11:00",
"to": "20:00"
},
{
"days_of_week": {
"sunday": false,
"saturday": false,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"monday": true
},
"from": "20:00",
"to": "22:00"
}
],
"unavailable_products": [
{
"code": "Smartcard",
"product_type": {
"meter_reading_type": {
"unit_of_measurement": {
"alternative_code": "K",
"name": "Kilos",
"description": null,
"id": "42CACE552A58408F8143884E1C181057"
},
"alternative_code": "MTT",
"name": "MT TYPES",
"description": null,
"id": "4E951AFF3513471883161CF5E9029C3A",
"classification": "ONE_TIME_READING"
},
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "test",
"udr_type": null,
"composition_method": "FLAT",
"name": "SMARTCARD",
"description": "SMARTCARD",
"id": "D6BE0209EC0149989A89972CE889DF8B",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "SC1",
"description": "asd",
"id": "4F656ED5DAC44168B0805227881202CD",
"priority_level": null
},
{
"code": "Set-top-box",
"product_type": {
"meter_reading_type": null,
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "STB",
"udr_type": null,
"composition_method": "FLAT",
"name": "SET TOP BOX",
"description": "SET TOP BOX",
"id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "STB",
"description": "Set-top-box",
"id": "D613415339C14975B28BB4FC11598E93",
"priority_level": null
}
],
"available_products": [
{
"code": "CARD&BOX",
"product_type": {
"meter_reading_type": null,
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "IK",
"udr_type": null,
"composition_method": "FIXEDBUNDLE",
"name": "Installation Kit",
"description": "Provisioning Installation kit that can include traceable and non traceable products",
"id": "380C41872DA048DEB1D57CF67D7550F6",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "C_1",
"description": "Includes Smartcard & Set Top Box",
"id": "F676D8AB4D4643A6827D8F9BFBC00D84",
"priority_level": null
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}