Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip

Available from CRM.COM R14.12.0


Excerpt

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.

...

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:

Include Page
v4:job_type_identifier
v4:job_type_identifier

Only generic job types are allowed to be specified

unit_identifier

(optionalmandatory)


StringUnit Identifier

The

unit that the job of that type will be assigned to. If no unit is specified then all unit restrictions are returned

identifier of the unit. The allowed unit identifiers are the following:

Include Page
v4:unit_identifier
v4:unit_identifier

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

...

Expand
titleExample 1

HTTP Method: GET


Request:

Response:


Code Block
languagejavascript
themeConfluence
linenumberstrue
{
    "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": ""
    }
}