Versions Compared

Key

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

Available from CRM.COM R10.0.0

Excerpt

This method completes a job of any fulfillment scope, which is already in progress

...

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

job_identifier

(mandatory)

Job Identifier

The identifier of the job that will be completed. The allowed job identifier fields are the following:

Include Page
V4:job_identifier
V4:job_identifier

status_identifier

(optional)

Job Status Identifier

The status that will be set on completing the job. If not specified the the default status for completing jobs of that type will be used. The allowed job status identifiers are the following:

Include Page
V4:job_status_identifier
V4:job_status_identifier

performed_by_user_identifier

(optional)

User identifier

The user that actually performed the action. This information is applicable only if the job type fulfillment scope is set to New Subscription. The allowed user identifier fields are the following:

Include Page
V4:user_identifier
V4:user_identifier

performed_on

(optional)

Date The date that the action was actually performed. This information is applicable only if the job type fulfillment scope is set to New Subscription.

scheduled_date

(optional)

Date

The date on which the subscription action will be scheduled to be performed. Required only if Subscription Action Rules prevent the immediate execution of the subscription action through which the job is delivered. Applicable only for jobs with fulfillment scopes:

  • Cancel Subscription
  • Cancel Subscription Services
  • Swap Subscription Services
  • Subscription Maintenance

Tip

Available from CRM.COM R13.0.0

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

...