GET jobs/configuration/time_restrictions/list

Available from CRM.COM R14.5.0

This method returns the allowed time frames during which generic jobs can be requested for, depending on their receipt method. 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

receipt_method

(mandatory)

String

The receipt method that will be used on the job of that type

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

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)

Examples

Example 1

HTTP Method: GET

Request:

Response

 {
    "data": [
        {
            "from": "15/30",
            "to": "18/40"
        },
        {
            "from": "08/05",
            "to": "23/30"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}