GET resource_requests/get_availability

This method returns information related with the availability of resources Multiple records are returned by each call

Available from CRM.COM R4.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

one_time_service

(mandatory)

Product identifier

The identifier of the requested one time service. Only products classified as one time services can be specified. The allowed product identifier field 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

from_date

(mandatory)

Date

The start date of a period that the one time service should be available

to_date

(mandatory)

Date

The end date of a period that the one time service should be available

requested_unit

(mandatory)

Unit Identifier

The unit that is requested as a resource

from_time

(optional)

Time

The start time of a period that the one time service should be available

to_time

(optional)

Time

The end time of a period that the one time service should be available

number_of_resources

(optional)

Number

The number of required resources

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 of those parameters is allowed to be specified.

Response Data

Name	Type	Description
number_of_resources	Number	The number of required resources
date	Date	The date that th
from_time	Time	The start time of a period that the one time service should be available
to_time	Time	The end time of a period that the one time service should be available
requested_unit	Unit Object	The unit that is requested as a resource Deprecated from CRM.COM R18.0.0
requested_business_unit	Business Unit Object	The business unit that is requested as a resource Available from CRM.COM R18.0.0
resource_plan_entry	Resource Plan Entry object	The resource plan entry for that specific period of time

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

resource plan entry object response data

Name	Type	Description
id	String	The ID of the retrieved resource plan entry
number	String	The name of the retrieved resource plan entry
description	String	A description of the retrieved resource plan entry
effective_date	Date	The date that the retrieved resource plan entry is effective
resource_plan	Resource Plan Object	The Resource Plan that the Resource Plan Entry belongs to

Referred Objects Response Data

resource plan object response data

Name	Type	Description
id	String	The ID of the retrieved resource plan
number	String	The name of the retrieved resource plan
description	String	A description of the retrieved resource plan
effective_from	Date	The date which determines the start of the period which is covered by the resource plan
effective_to	Date	The date which determines the end of the period which is covered by the resource plan
planned_for_unit	Unit Object	The unit that the resource plan is created for Deprecated from CRM.COM R18.0.0
planned_for_business_unit	Business Unit Object	The business unit that the resource plan is created for Available from CRM.COM R18.0.0

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

Examples

Example 1

HTTP Method: GET

Request:

Response:

    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       [
           {
               "to_time": "18:00",
               "from_time": "14:00",
               "number_of_resources": 3,
               "requested_unit":
               {
                   "group_name": null,
                   "name": "Team 4 (Installations)",
                   "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                   "description": null,
                   "alternative_code": "T4I"
               },
               "resource_plan_entry":
               {
                   "effective_date": "2014-12-04T00:00:00",
                   "number": "1690",
                   "resource_plan":
                   {
                       "effective_from": "2014-12-01T00:00:00",
                       "effective_to": "2014-12-07T00:00:00",
                       "planned_for_unit":
                       {
                           "group_name": null,
                           "name": "Team 4 (Installations)",
                           "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                           "description": null,
                           "alternative_code": "T4I"
                       },
                       "number": "16",
                       "id": "BDFD9EFA018B3B4E587D4CD9DDA86B9A",
                       "description": null
                   },
                   "id": "0186B209103738494C4BC3B06D06C564",
                   "description": null
               }
           },
           {
               "to_time": "13:00",
               "from_time": "09:00",
               "number_of_resources": 1,
               "requested_unit":
               {
                   "group_name": null,
                   "name": "Team 4 (Installations)",
                   "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                   "description": null,
                   "alternative_code": "T4I"
               },
               "resource_plan_entry":
               {
                   "effective_date": "2014-12-05T00:00:00",
                   "number": "1691",
                   "resource_plan":
                   {
                       "effective_from": "2014-12-01T00:00:00",
                       "effective_to": "2014-12-07T00:00:00",
                       "planned_for_unit":
                       {
                           "group_name": null,
                           "name": "Team 4 (Installations)",
                           "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                           "description": null,
                           "alternative_code": "T4I"
                       },
                       "number": "16",
                       "id": "BDFD9EFA018B3B4E587D4CD9DDA86B9A",
                       "description": null
                   },
                   "id": "6AC078E4793E902F8D1273CBE1F2F006",
                   "description": null
               }
           },
           {
               "to_time": "18:00",
               "from_time": "14:00",
               "number_of_resources": 1,
               "requested_unit":
               {
                   "group_name": null,
                   "name": "Team 4 (Installations)",
                   "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                   "description": null,
                   "alternative_code": "T4I"
               },
               "resource_plan_entry":
               {
                   "effective_date": "2014-12-05T00:00:00",
                   "number": "1691",
                   "resource_plan":
                   {
                       "effective_from": "2014-12-01T00:00:00",
                       "effective_to": "2014-12-07T00:00:00",
                       "planned_for_unit":
                       {
                           "group_name": null,
                           "name": "Team 4 (Installations)",
                           "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                           "description": null,
                           "alternative_code": "T4I"
                       },
                       "number": "16",
                       "id": "BDFD9EFA018B3B4E587D4CD9DDA86B9A",
                       "description": null
                   },
                   "id": "6AC078E4793E902F8D1273CBE1F2F006",
                   "description": null
               }
           }
       ]
    }