Skip to end of banner
Go to start of banner

POST resource_requests/reject

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This method is rejecting a single resource request. The method can be applied only on pending resource requests

Available from CRM.COM R4.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

resource_request_identifier

(mandatory)

Resource Request identifier

The identifier of the resource request that should be rejected. The allowed resource request identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the resource request

number

(semi-optional)

String

The number of the resource request

 

 

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

 resource request object response data

Name

Type

Description

id

String

The ID of the retrieved  resource request

number

String

The number of the retrieved resource request

descriptionStringThe description of the retrieved resource request
number_of_resourcesNumber

The number of required resources

from_dateDate

The start date and time of the period for which the resource is requested for

to_dateDate

The end date and time of the period for which the resource is requested for

life_cycle_state

String

The life cycle state of the retrieved resource request which can be PENDING, ACCEPTED, REJECTED or CANCELLED

requested_unit

Unit Object

The business 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

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

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

Examples

 Example 1

HTTP Method: POST

 

Request:

Body

{
    "token"    : "B38E3800EA1C3332E065BEAC0F5AE114",
    "resource_request_identifier" : { "number" : "11"}
} 


Response:

{
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "udf_float_1": null,
           "udf_float_2": null,
           "requested_by_group":
           {
               "community_name": null,
               "name": "Main Group",
               "id": "84F33366CB592BAAE7E2044D93611C6A",
               "description": "Main Group",
               "alternative_code": "das"
           },
           "udf_float_3": null,
           "udf_float_4": null,
           "number": "11",
           "udf_string_1": null,
           "udf_string_2": null,
           "udf_string_3": null,
           "udf_string_4": null,
           "udf_string_5": null,
           "udf_string_6": null,
           "udf_string_7": null,
           "udf_string_8": null,
           "id": "94D317BF32C6B12F1B4200B72425A650",
           "requested_by_unit":
           {
               "community_name": null,
               "group_name": "Main Group",
               "name": "Admin Unit",
               "id": "48305F8849E3C18B227C5BE3A27BA6DF",
               "description": "r1",
               "alternative_code": "MG"
           },
           "requested_resource_plan_entry": null,
           "requested_by_user":
           {
               "person_name": "MPAdministrator",
               "username": "MPAdministrator",
               "id": "1",
               "email": null
           },
           "from_date": "2014-11-03T09:00:00",
           "to_be_used_by_activity_service": null,
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_date_3": null,
           "udf_date_4": null,
           "to_be_used_by_activity":
           {
               "life_cycle_state": "IN_PROGRESS",
               "number": "245",
               "type": null,
               "id": "D49422CC3A5D6EB98057423994E5FB3D",
               "contact_information": null
           },
           "requested_one_time_service":
           {
               "product_type": null,
               "id": "23B0335123C123F75B890C0380625BDE",
               "description": "Package Change Service",
               "code": "Package Change Service",
               "alternative_code": null
           },
           "to_date": "2014-11-07T18:00:00",
           "number_of_resources": 4,
           "life_cycle_state": "REJECTED",
           "description": "Web Api Description Test"
       }
} 
  • No labels