| Tip |
|---|
Available from CRM.COM R10.0.0 |
| Table of Contents | ||
|---|---|---|
|
GET jobs/cancel_subscription_services/show
This method returns information related with a job of fulfillment scope Cancel Subscription Services. Single job is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Job identifier
The identifier of the job that should be returned as a result. The allowed jobs identifier fields are the following:
...
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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request: Response:
|
POST jobs/cancel_subscription_services/create
This method creates a job of fulfillment scope Cancel Subscription Services. Single job can be created by each call. Only customer jobs can be created through this method.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
type_identifier
(mandatory)
...
The identifier of the type of the new job. The allowed job type identifier fields are the following:
...
status_identifier
(optional)
...
The identifier of the status of the new job. If not specified then the default one will be used. The allowed job status identifier fields are the following:
...
category_identifier
(optional)
...
The identifier of the category of the new job. The allowed job category identifier fields are the following:
...
(mandatory)
...
The identifier of the new job accounts receivable. The allowed accounts receivable identifier fields are the following:
...
subscription_identifier
(mandatory)
...
The identifier of the subscription for which the requested subscription services will be cancelled through the new job. The allowed subscription identifier fields are the following:
...
contact_email
(optional)
...
The email of the customer related with the job, which will be used in order to communicate the job
...
contact_phone
(optional)
...
The phone of the customer related with the job, which will be used in order to communicate the job
...
description
(optional)
...
notes
(optional)
...
start_date
(optional)
...
owned_by_group_identifier
(optional)
...
The owned by group information of the job. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the job. The allowed privacy level identifier fields are the following:
...
The service request related with the job. The allowed service request identifier fields are the following:
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
...
scheduled_date
(optional)
...
The date on which the job is scheduled, which also indicates the date on which the Cancel Subscription Service action will be scheduled to be performed
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
expected_completion_date
(semi-optional)
...
estimated_completion_time
(semi-optional)
...
The billing terms of the job to be created. This information is applicable and mandatory only if the job is billable
...
requested_subscription_services_set
(mandatory)
...
A list of subscription services that were requested by the customer to be cancelled through the new job. The subscription services are filtered based on the specified subscription type and billing term scheme. All the subscription related rules and restrictions are applicable on the requested subscription services as well
...
(optional)
...
A list of physical goods (products only) that are requested by the customer, and should be delivered as part of fulfilling the ordered job. The requested physical goods are filtered based on the selected job type. Mandatory physical goods are added automatically.
...
(optional)
...
A list of requested expenses that are requested by the customer and should be delivered as part of fulfilling the ordered job. The requested expenses are filtered based on the selected job type. Mandatory expenses are added automatically
...
requested_activity_services_set
(optional)
...
A list of one time services that are requested by the customer and should be delivered by a scheduling and performing a specific activity. The requested activity services are defined by specifying the type of the activity and the activity services that should be performed. The activity types are filtered based on the selected job type. The activity services are filtered based on the selected activity type. Mandatory activity types and services are added automatically.
...
fields_set
(optional)
...
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
...
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
|
POST jobs/cancel_subscription_services/update
This method updates jobs of fulfillment scope Cancel Subscription Services. Single job can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
The identifier of the job. The allowed job identifier fields are the following:
...
status_identifier
(optional)
...
The identifier of the status of the new job. The allowed job status identifier fields are the following:
...
category_identifier
(optional)
...
The identifier of the category of the new job. The allowed job category identifier fields are the following:
...
notes
(optional)
...
contact_email
(optional)
...
The email of the customer related with the job, which will be used in order to communicate the job
...
contact_phone
(optional)
...
The phone of the customer related with the job, which will be used in order to communicate the job
...
start_date
(optional)
...
owned_by_group_identifier
(optional)
...
The owned by group information of the job. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the job. The allowed privacy level identifier fields are the following:
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
...
scheduled_date
(optional)
...
The date on which the job is scheduled, which also indicates the date on which the Cancel Subscription Service action will be scheduled to be performed
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
expected_completion_date
(optional)
...
estimated_completion_time
(optional)
...
The billing terms of the retrieved job.This information is applicable if the job is still draft or pending and if the job is billable
...
requested_subscription_services_set
(optional)
...
The requested subscription services of the subscription to be cancelled through the job. This information is applicable only if the job is draft or pending
...
(optional)
...
The requested physical goods. This information is applicable only if the job is draft or pending
...
(optional)
...
The requested expenses. This information is applicable only if the job is draft or pending
...
requested_activity_services_set
(optional)
...
The requested activity services. This information is applicable only if the job is draft or pending
...
The physical goods that will be provided as part of the retrieved job. This information is applicable only if the job is in progress
...
A list of one time services which are applied on the retrieved job as expenses. This information is applicable only if the job is in progress
...
fields_set
(optional)
...
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
...
Examples
| Expand | ||||||
|---|---|---|---|---|---|---|
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"7A47C11648B9499A8903EAEA2E6D9A97",
"job_identifier":{"number":"JOB000810"},
"contact_phone":"99656565",
"estimated_completion_time":
{
"time_period_value":2,
"time_period_uot":"DAYS"
},
"physical_goods_set":
[
{
"action":"ADD",
"product_identifier":{"alternative_code":"REM"},
"quantity":1
}
],
"expenses_set":
[
{
"action":"ADD",
"product_identifier":{"code":"Expence 3"}
}
]
} |
Response:
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
| name | blue |
|---|
| Child pages (Children Display) | ||
|---|---|---|
|