Tip
Available from CRM.COM R10.0.0

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

job_identifier

(mandatory)

Job identifier

The identifier of the job that should be returned as a result. The allowed jobs identifier fields are the following:

Include Page

	V4:job_identifier
	V4:job_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier
(mandatory)

Job type identifier

The identifier of the type of the new job. The allowed job type identifier fields are the following:

Include Page

	V4:job_type_identifier
	V4:job_type_identifier

status_identifier
(optional)

Job status identifier

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:

Include Page

	V4:job_status_identifier
	V4:job_status_identifier

category_identifier
(optional)

Job category identifier

The identifier of the category of the new job. The allowed job category identifier fields are the following:

Include Page

	V4:job_category_identifier
	V4:job_category_identifier

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the new job accounts receivable. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

subscription_identifier

(mandatory)

Subscriptions Identifier

The identifier of the subscription that will be deactivated through the new job. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

contact_email

(optional)

String

The email of the customer related with the job, which will be used in order to communicate the job

contact_phone

(optional)

String

The phone of the customer related with the job, which will be used in order to communicate the job

description
(optional)

String

The description of the new job

notes
(optional)

String

The notes of the new job

start_date
(optional)

Date

The date that the job is created

owned_by_group_identifier
(optional)

The identifier of the owned by group information

The owned by group information of the job. The allowed group identifier fields are the following:

Include Page

	V4:group_identifier
	V4:group_identifier

privacy_level_identifier
(optional)

The identifier of the privacy level

The privacy level of the job. The allowed privacy level identifier fields are the following:

Include Page

	V4:privacy_level_identifier
	V4:privacy_level_identifier

service_request_identifier
(optional)

The identifier of the service request

The service request related with the job. The allowed service request identifier fields are the following:

Include Page

	V4:service_request_identifier
	V4:service_request_identifier

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

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

expected_completion_date
(semi-optional)

Date

The date that the job is expected to be completed. It is automatically calculated if estimate completion time is specified.

estimated_completion_time
(semi-optional)

Time Period Object

The time that is estimated to complete the job, measured in minutes, hours, days, weeks, years. It is automatically calculated if expected completion date is specified.

billing_terms
(mandatory on conditions)

Job Billing terms object

The billing terms of the job to be created. This information is applicable and mandatory only if the job is billable

assigned_to
(mandatory)

Assigned to object

The assignment information for the job

requested_physical_goods_set

(optional)

Set of Requested Physical Good Objects

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.

requested_expenses_set

(optional)

Set of Requested Expense Objects

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)

Set of Requested Activity Service Objects

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)

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

...

Examples

expand

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
"token":"556240FE3F49469F9A2C868A66DE5C057A47C11648B9499A8903EAEA2E6D9A97",
"type_identifier":{"name":"Deactivate Subscription"},
"status_identifier": {"name":"DraftAssigned"},
"accounts_receivable_identifier":{"number":"ACR001143ACR001179"},
"subscription_identifier":{"number":"S60993S60992"},
"contact_email":"m_antoniadou@crm.com",
"contact_phone":"99626262",
"notes":"99848484Requested by subscriber",
"start_dateowned_by_group_identifier":"2016-07-27T14:00:00"{"name":"Main Group"},
"estimated_completion_time":
{
    "time_period_value":3,
    "time_period_uot":"DAYS"
},
"billing_terms":
{
    "billing_term_scheme_identifier":{"code":"PJBTS"},
    "price_plan_identifier":{"code":"BPP0614"},
    "agreement_date":"2016-07-27T1405T14:0020:00"
},
"assigned_to":
{
    "user_identifier":{"username":"MPAdministrator"}
},
"fieldsrequested_physical_goods_set":"id,number,contact_email,contact_phone,life_cycle_state,expected_completion_date,assigned_to,type,status,subscription,accounts_receivable,owned_by_group,log_information"
}
[
    {
        "product_identifier":{"code":"Antenna 1"},
        "quantity":1
    }
],
"requested_expenses_set":
[
    {
        "product_identifier":{"code":"Expence 2"}
    }
],
"requested_activity_services_set":
[
    {
        "activity_type_identifier":{"name":"Meeting"},
        "product_identifier":{"code":"MFee"}
    }
]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "numbernotes": "JOB000795",
    "expected_completion_date": "2016-07-30T14:00:00Marios Lannister\t28/7/2016 12:01:40\tRequested by subscriber",
    "assigned_torequested_physical_goods_set": {[
      "unit": {
        "community_nameid": "Internal CommunityFDA513D23A3C491FAE634F255A8F23D9",
        "idquantity": "48305F8849E3C18B227C5BE3A27BA6DF"1,
        "nameproduct": {
"Admin Unit",         "groupproduct_nametype": "Main Group",{
            "descriptionservice_type": "r1null,
 Test Description for resource  request tab.Test Description for resource  request tab."physical_good_type": "NONTRACEABLE",
        "alternative_code    "used_for_provisioning": "MG"false,
      },       "userclassification": {"PHYSICALGOODS",
            "personcomposition_namemethod": "Marios LannisterFLAT",
            "usernameid": "MPAdministrator0F94B51F175F06A475EB2948B4030074",
            "idname": "1Accessories",
            "emaildescription": "sakkascy1986@hotmail.com"
   A type which is used for accessories physical goods",
  }     },     "contactalternative_phonecode": "99848484005",
    "owned_by_group": {     },
 "community_name": "Internal Community",       "id": "84F33366CB592BAAE7E2044D93611C6A70FFDF2B2A74466DD7D0D5246ED1DD2D",
          "namedescription": "MainAntenna Groupv1",
          "descriptioncode": "MainAntenna Group1",
          "alternative_code": "MG1"ANT1"
        }
      }
    ],
    "logbilling_informationterms": {
      "updatedbinding_dateinformation": "2016-07-27T12:35:57"null,
      "createdagreement_date": "2016-07-27T1205T00:3500:5400",
      "createdconcurrent_usage_bybased_unitpricing": {
        "communityconcurrent_nameusage": "Internal Community"null,
        "idrate_percentage": "48305F8849E3C18B227C5BE3A27BA6DF",null
        "name": "Admin Unit"},
        "groupbilling_term_namescheme": "Main{
Group",         "descriptionlife_cycle_state": "r1EFFECTIVE",
Test Description for resource  request tab.Test Description for resource  request tab. "billing_method": "PERIOD",
        "alternative_codeclassification": "MG"
   JOBS",
  },       "updated_by_unitid": {"9C0B2B52003EFEEE0864212F34D41229",
        "community_name": "Internal CommunityP Job Billing Term Scheme",
        "idcode": "48305F8849E3C18B227C5BE3A27BA6DFPJBTS",
        "namebilling_type": "Admin Unit",NORMAL"
      },
      "groupeffective_namedate": "Main Group2016-07-28T00:00:00",
 
      "descriptionbilling_frequency": "r1null,
Test Description for resource  request tab.Test Description for resource  request tab. "id": "97E8673FECA345CEB170712DFA745C4D",
        "alternativeallowed_cancel_codedate": "MG"null,
      }"expiration_date": null,
      "created_by_userbilling_cycle_day": null,
      "price_plan": {
        "personeffective_namedate": "Marios Lannister2016-04-08T00:00:00",
        "usernametype": "MPAdministratorBASE",
        "id": "162F4D4E787AD4ACC895FD1D066037353",
      },   "name": "BPP0614",
        "updated_by_userdescription": {"Base Price PLan June 14 for Subscription Test Case "person_name": "Marios Lannister"6",
        "usernamecode": "MPAdministratorBPP0614",
        "idexpiration_date": "1"null
      }
    },
    "statusservice_request": {
 null,
    "udf_float_1": null,
    "lifeudf_cyclefloat_state2": "DRAFT"null,
      "id"udf_float_3": "0F1EE97BD63642699FFAEB461F471147"null,
      "namenumber": "DraftJOB000814",
      "description"udf_float_4": null,
      "alternative_code": "D"
    },
    "life_cycle_stateudf_string_1": "DRAFT"null,
    "accountsassigned_receivableto": {
      "account_ownerunit": {
        "lastcommunity_name": "AntonInternal Community",
        "middle_nameid": "N48305F8849E3C18B227C5BE3A27BA6DF",
        "life_cycle_statename": "FINANCIALAdmin Unit",
        "companygroup_profilename": "Main nullGroup",
        "titledescription": "Mrs",
r1 Test Description for resource  request tab.Test Description for resource  "first_name": "Marinarequest tab.",
        "typealternative_code": "PERSONMG",
      },
      "iduser": "EE621BE231714DFE8CE370261BF6DB25",{
        "person_name": "AntonMarios MarinaLannister",
        "company_nameusername": null"MPAdministrator",
        "demographicsid": {"1",
          "genderemail": "FEMALEsakkascy1986@hotmail.com",
      }
   "passport_issued_by_country": null },
      "udf_string_2": null,
    "socialprivacy_security_numberlevel": null,
    "estimated_completion_time": {
      "passporttime_period_numbervalue": null3,
  
       "industrytime_period_sectoruot": null,"DAYS"
    },
     "countryudf_ofstring_residence3": {null,
    "udf_string_4": null,
      "threecontact_character_codephone": "CYP99626262",
    "udf_string_5": null,
      "twoactivities_character_codeset": "CY"[],
    "udf_string_6": null,
      "id"physical_goods_set": "181"[],
    "udf_string_7": null,
      "name"udf_string_8": "CYPRUS"null,
    "accounts_receivable": {
      "alternativeaccount_codeowner": null{
          }"last_name": "Antoniadou",
          "middle_name_day": {
  "L",
         "monthlife_cycle_state": null,
   "FINANCIAL",
        "daycompany_profile": null,
          }"title": "Ms",
          "datefirst_of_birthname": {
  "Marina",
         "monthtype": null"PERSON",
            "dayid": null,
   "FA4A9EF8D7BD4D819B70E8CB1B8FA963",
        "yearname": null"Antoniadou Marina",
         },
 "company_name": null,
        "id_numberdemographics": "8945612",{
          "industrygender": null"FEMALE",
          "idpassport_issued_by_country": null,
        }  "social_security_number": null,
   },       "lifepassport_cycle_statenumber": "ACTIVE",null,
          "numberindustry_sector": "ACR001143"null,
      "id": "C88FBE77E4504F3791C219A7DCE21843",       "name"country_of_residence": "ACR001143"
  {
 },     "type": {       "fulfillmentthree_character_methodcode": "BASED_ON_ORDERED_ITEMSCYP",
            "fulfillmenttwo_character_scopecode": "DEACTIVATE_SUBSCRIPTIONCY",
            "id": "40F231681B984DA28EDBDA8B698E229E181",
            "name": "Deactivate SubscriptionCYPRUS",
      "description": null,       "alternative_code": "DS" null
          },
    "id": "1B2F356F53794165B691C220935DB87E",     "contactname_emailday": "m_antoniadou@crm.com",{
    "subscription": {       "life_cycle_statemonth": "EFFECTIVE"null,
      "accounts_receivable": {         "account_owner"day": {null
          "last_name": "Anton"},
          "middledate_of_namebirth": "N", {
            "life_cycle_statemonth": "FINANCIAL"null,
            "company_profileday": null,
            "titleyear": "Mrs" null
          },
          "firstid_namenumber": "Marina2365485",
          "typeindustry": "PERSON"null,
          "id_issued_by_country": "EE621BE231714DFE8CE370261BF6DB25",null
        }
 "name": "Anton Marina",    },
      "companylife_cycle_namestate": null"ACTIVE",
          "demographics": {"number": "ACR001179",
      "id": "1D48BF32F4164731AD5755B61838F1E5",
      "gendername": "FEMALEACR001179",
    },
       "passport_issued_by_country"id": null"74B83598E4954CD080CBE45959A77B68",
    "subscription": {
      "sociallife_securitycycle_numberstate": null,"EFFECTIVE",
      "accounts_receivable": {
        "passportaccount_numberowner": null,{
            "industrylast_sectorname": null"Antoniadou",
            "countrymiddle_of_residencename": {
   "L",
          "threelife_charactercycle_codestate": "CYPFINANCIAL",
              "twocompany_character_codeprofile": "CY",
   null,
          "idtitle": "181Ms",
              "first_name": "CYPRUSMarina",
   
          "alternative_codetype": null"PERSON",
            },
 "id": "FA4A9EF8D7BD4D819B70E8CB1B8FA963",
          "name_day": {
 "Antoniadou Marina",
            "monthcompany_name": null,
              "daydemographics": {
null             }"gender": "FEMALE",
            "datepassport_issued_ofby_birthcountry": {null,
              "month"social_security_number": null,
              "daypassport_number": null,
              "yearindustry_sector": null,
            "country_of_residence": {
 },             "idthree_character_numbercode": "8945612CYP",
            "industry  "two_character_code": null"CY",
              "id_issued_by_country": "181",
null           }   "name": "CYPRUS",
    },          "lifealternative_cycle_statecode": "ACTIVE",null
        "number": "ACR001143",      },
  "id": "C88FBE77E4504F3791C219A7DCE21843",         "name_day": "ACR001143"{
       },       "numbermonth": "S60993"null,
 
    "type": {         "idday": "D433A85FB6CD4880A1BCEEB1E164EFA4",null
           "name": "London", },
          "description  "date_of_birth": {
  "Subscription for London customers",         "alternative_codemonth": "LND"null,
       },       "idday": "1C921100E32646208E95B3B1263BC5F9"null,
      "first_activated_date": "2016-06-27T17:09:29",       "rating_state": "PENDING"year": null
            },
            "id_number": "2365485",
            "industry": null,
            "id_issued_by_country": null
          }
        }
}

POST jobs/deactivate_subscription/update

This method updates jobs of fulfillment scope Deactivate Subscription. 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

...

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_physical_goods_set

(optional)

...

The requested physical goods. This information is applicable only if the job is draft or pending

...

requested_expenses_set

(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

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 ,
        "life_cycle_state": "ACTIVE",
        "number": "ACR001179",
        "id": "1D48BF32F4164731AD5755B61838F1E5",
        "name": "ACR001179"
      },
      "number": "S60992",
      "type": {
        "id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
        "name": "London",
        "description": "Subscription for London customers",
        "alternative_code": "LND"
      },
      "id": "B8DD89C675A743ABB798351C5BC6DE4E",
      "first_activated_date": "2016-06-27T12:54:14",
      "rating_state": "PENDING"
    },
    "requested_activity_services_set": [
      {
        "activity_type": {
          "id": "F609C9D1CD43463DA810B1EC415BB5E1",
          "name": "Meeting",
          "description": null,
          "alternative_code": "M"
        },
        "id": "D1C03E626C8A4875AD3D76FC70A4A0B8",
        "product": {
          "product_type": {
            "service_type": "EXPENSE",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "67FA013211E348C58F7CD27F8399AADE",
            "name": "Expense Type",
            "description": null,
            "alternative_code": "ET"
          },
          "id": "28709F00389D79015AF4511B4A1BDFF6",
          "description": "Meeting Fees",
          "code": "MFee",
          "alternative_code": "MFee"
        }
      }
    ],
    "udf_date_1": null,
    "udf_date_2": null,
    "expected_completion_date": "2016-07-31T13:31:40",
    "udf_date_3": null,
    "udf_date_4": null,
    "start_date": "2016-07-28T13:31:40",
    "time_overdue": {
      "time_period_value": null,
      "time_period_uot": null
    },
    "time_to_completion": {
      "time_period_value": 3,
      "time_period_uot": "DAYS"
    },
    "rating_state": "PENDING",
    "requested_expenses_set": [
      {
        "id": "152A42D1CA8340989006B3A67DB93898",
        "product": {
          "product_type": {
            "service_type": "EXPENSE",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "67FA013211E348C58F7CD27F8399AADE",
            "name": "Expense Type",
            "description": null,
            "alternative_code": "ET"
          },
          "id": "81D5550CF6004CE0B206A371F9F3A18A",
          "description": "Expence 2",
          "code": "Expence 2",
          "alternative_code": "exp2"
        }
      }
    ],
    "log_information": {
      "updated_date": "2016-07-28T13:31:41",
      "created_date": "2016-07-28T13:31:40",
      "created_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "updated_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "created_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1"
      },
      "updated_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1"
      }
    },
    "owned_by_group": {
      "community_name": "Internal Community",
      "id": "84F33366CB592BAAE7E2044D93611C6A",
      "name": "Main Group",
      "description": "Main Group",
      "alternative_code": "MG1"
    },
    "status": {
      "life_cycle_state": "PENDING",
      "id": "JobStatus1",
      "name": "Assigned",
      "description": null,
      "alternative_code": "AS"
    },
    "actual_completed_date": null,
    "location": null,
    "life_cycle_state": "PENDING",
    "type": {
      "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
      "fulfillment_scope": "DEACTIVATE_SUBSCRIPTION",
      "id": "40F231681B984DA28EDBDA8B698E229E",
      "name": "Deactivate Subscription",
      "description": null,
      "alternative_code": "DS"
    },
    "description": null,
    "contact_email": "m_antoniadou@crm.com",
    "expenses_set": [],
    "category": null
  }
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
"token":"556240FE3F49469F9A2C868A66DE5C05",
"type_identifier":{"name":"Deactivate Subscription"},
"status_identifier": {"name":"Draft"},
"accounts_receivable_identifier":{"number":"ACR001143"},
"subscription_identifier":{"number":"S60993"},
"contact_email":"m_antoniadou@crm.com",
"contact_phone":"99848484",
"start_date":"2016-07-27T14:00:00",
"estimated_completion_time":
{
    "time_period_value":3,
    "time_period_uot":"DAYS"
},
"billing_terms":
{
    "billing_term_scheme_identifier":{"code":"PJBTS"},
    "price_plan_identifier":{"code":"BPP0614"},
    "agreement_date":"2016-07-27T14:00:00"
},
"assigned_to":
{
    "user_identifier":{"username":"MPAdministrator"}
},
"fields_set":"id,number,contact_email,contact_phone,life_cycle_state,expected_completion_date,assigned_to,type,status,subscription,accounts_receivable,owned_by_group,log_information"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "number": "JOB000795",
    "expected_completion_date": "2016-07-30T14:00:00",
    "assigned_to": {
      "unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1",
        "email": "sakkascy1986@hotmail.com"
      }
    },
    "contact_phone": "99848484",
    "owned_by_group": {
      "community_name": "Internal Community",
      "id": "84F33366CB592BAAE7E2044D93611C6A",
      "name": "Main Group",
      "description": "Main Group",
      "alternative_code": "MG1"
    },
    "log_information": {
      "updated_date": "2016-07-27T12:35:57",
      "created_date": "2016-07-27T12:35:54",
      "created_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "updated_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "created_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1"
      },
      "updated_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1"
      }
    },
    "status": {
      "life_cycle_state": "DRAFT",
      "id": "0F1EE97BD63642699FFAEB461F471147",
      "name": "Draft",
      "description": null,
      "alternative_code": "D"
    },
    "life_cycle_state": "DRAFT",
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Anton",
        "middle_name": "N",
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": "Mrs",
        "first_name": "Marina",
        "type": "PERSON",
        "id": "EE621BE231714DFE8CE370261BF6DB25",
        "name": "Anton Marina",
        "company_name": null,
        "demographics": {
          "gender": "FEMALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "country_of_residence": {
            "three_character_code": "CYP",
            "two_character_code": "CY",
            "id": "181",
            "name": "CYPRUS",
            "alternative_code": null
          },
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": null,
            "day": null,
            "year": null
          },
          "id_number": "8945612",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR001143",
      "id": "C88FBE77E4504F3791C219A7DCE21843",
      "name": "ACR001143"
    },
    "type": {
      "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
      "fulfillment_scope": "DEACTIVATE_SUBSCRIPTION",
      "id": "40F231681B984DA28EDBDA8B698E229E",
      "name": "Deactivate Subscription",
      "description": null,
      "alternative_code": "DS"
    },
    "id": "1B2F356F53794165B691C220935DB87E",
    "contact_email": "m_antoniadou@crm.com",
    "subscription": {
      "life_cycle_state": "EFFECTIVE",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Anton",
          "middle_name": "N",
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": "Mrs",
          "first_name": "Marina",
          "type": "PERSON",
          "id": "EE621BE231714DFE8CE370261BF6DB25",
          "name": "Anton Marina",
          "company_name": null,
          "demographics": {
            "gender": "FEMALE",
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": null,
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": "CYP",
              "two_character_code": "CY",
              "id": "181",
              "name": "CYPRUS",
              "alternative_code": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "id_number": "8945612",
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR001143",
        "id": "C88FBE77E4504F3791C219A7DCE21843",
        "name": "ACR001143"
      },
      "number": "S60993",
      "type": {
        "id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
        "name": "London",
        "description": "Subscription for London customers",
        "alternative_code": "LND"
      },
      "id": "1C921100E32646208E95B3B1263BC5F9",
      "first_activated_date": "2016-06-27T17:09:29",
      "rating_state": "PENDING"
    }
  }
}

POST jobs/deactivate_subscription/update

This method updates jobs of fulfillment scope Deactivate Subscription. 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

job_identifier
(mandatory)

Job identifier

The identifier of the job. The allowed job identifier fields are the following:

Include Page

	V4:job_identifier
	V4:job_identifier

status_identifier
(optional)

Job status identifier

The identifier of the status of the new job. The allowed job status identifier fields are the following:

Include Page

	V4:job_status_identifier
	V4:job_status_identifier

category_identifier
(optional)

Job category identifier

The identifier of the category of the new job. The allowed job category identifier fields are the following:

Include Page

	V4:job_category_identifier
	V4:job_category_identifier

description
(optional)

String

The description of the new job

notes
(optional)

String

The notes of the new job

contact_email

(optional)

String

The email of the customer related with the job, which will be used in order to communicate the job

contact_phone

(optional)

String

The phone of the customer related with the job, which will be used in order to communicate the job

start_date
(optional)

Date

The date that the activity is created

owned_by_group_identifier
(optional)

The identifier of the owned by group information

The owned by group information of the job. The allowed group identifier fields are the following:

Include Page

	V4:group_identifier
	V4:group_identifier

privacy_level_identifier
(optional)

The identifier of the privacy level

The privacy level of the job. The allowed privacy level identifier fields are the following:

Include Page

	V4:privacy_level_identifier
	V4:privacy_level_identifier

udf_string_1
(optional)

String

User Defined Field of type String

udf_string_2
(optional)

String

User Defined Field of type String

udf_string_3
(optional)

String

User Defined Field of type String

udf_string_4
(optional)

String

User Defined Field of type String

udf_string_5
(optional)

String

User Defined Field of type String

udf_string_6
(optional)

String

User Defined Field of type String

udf_string_7
(optional)

String

User Defined Field of type String

udf_string_8
(optional)

String

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

expected_completion_date
(optional)

Date

The date that the job is expected to be completed. It is automatically calculated if estimate completion time is specified.

estimated_completion_time
(optional)

Time Period Object

The time that is estimated to complete the job, measured in minutes, hours, days, weeks, years. It is automatically calculated if expected_completion_time is specified.

billing_terms
(optional)

Billing terms object

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

assigned_to
(optional)

Assigned to object

The assignment information for the retrieved job. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules.

requested_physical_goods_set

(optional)

Set of Requested Physical Good Objects

The requested physical goods. This information is applicable only if the job is draft or pending

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

requested_expenses_set

(optional)

Set of Requested Expense Objects

The requested expenses. This information is applicable only if the job is draft or pending

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

requested_activity_services_set

(optional)

Set of Requested Activity Service Objects

The requested activity services. This information is applicable only if the job is draft or pending

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

physical_goods_set
(optional)

Set of physical good to be provided objects

The physical goods that will be provided as part of the retrieved job. This information is applicable only if the job is in progress

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

expenses_set
(optional)

Set of expense objects

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

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

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

Anchor
job_update referred objects parameters
job_update referred objects parameters
Referred Parameter Objects Data

Include Page

	V4:time_period_parameters
	V4:time_period_parameters

Include Page

	V4:r10_billing_terms_jobs_parameters
	V4:r10_billing_terms_jobs_parameters

Include Page

	V4:assigned_to_parameters
	V4:assigned_to_parameters

Include Page

	V4:job_requested_physical_goods_update_parameters
	V4:job_requested_physical_goods_update_parameters

Include Page

	V4:job_requested_expense_update_parameters
	V4:job_requested_expense_update_parameters

Include Page

	V4:job_requested_activity_services_update_parameters
	V4:job_requested_activity_services_update_parameters

Include Page

	V4:job_physical_good_update_parameters
	V4:job_physical_good_update_parameters

Include Page

	V4:job_expense_update_parameters
	V4:job_expense_update_parameters

Restrictions

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

Response Data

Include Page

	V4:job_deactivate_subscription_complete
	V4:job_deactivate_subscription_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
"token":"7A47C11648B9499A8903EAEA2E6D9A97",
"job_identifier":{"number":"JOB000814"},
"billing_terms":
{
    "billing_term_scheme_identifier":{"code":"L Jobs All Price Plans"},
    "price_plan_identifier":{"code":"Ad2"}
},
"expected_completion_date":"2016-07-30T14:00:00",
"requested_physical_goods_set":
[
    {
        "action":"ADD",
        "product_identifier":{"code":"Decoders 1"},
        "quantity":1
    }
],
"requested_expenses_set":
[
    {
        "action":"REMOVE",
        "job_requested_expense_identifier":
        {
            "product_identifier":{"code":"Expence 2"}
        }
    }    
]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "notes": "Marios Lannister\t28/7/2016 12:01:40\tRequested by subscriber",
    "requested_physical_goods_set": [
      {
        "id": "362B7CFA817F47DDBCC02E037C3EE3FA",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "TRACEABLE",
            "used_for_provisioning": true,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "B4A1396AE3D1384B304A0FEB22F7BA50",
            "name": "Decoders",
            "description": "Decoders",
            "alternative_code": "D"
          },
          "id": "E8672BB71A9B1BD25E30705AC34D7D61",
          "description": "Decoders 1",
          "code": "Decoders 1",
          "alternative_code": "D1"
        }
      },
      {
        "id": "FDA513D23A3C491FAE634F255A8F23D9",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "NONTRACEABLE",
            "used_for_provisioning": false,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "0F94B51F175F06A475EB2948B4030074",
            "name": "Accessories",
            "description": "A type which is used for accessories physical goods",
            "alternative_code": "005"
          },
          "id": "70FFDF2B2A74466DD7D0D5246ED1DD2D",
          "description": "Antenna v1",
          "code": "Antenna 1",
          "alternative_code": "ANT1"
        }
      }
    ],
    "billing_terms": {
      "binding_information": null,
      "agreement_date": "2016-07-05T00:00:00",
      "concurrent_usage_based_pricing": {
        "concurrent_usage": null,
        "rate_percentage": null
      },
      "billing_term_scheme": {
        "life_cycle_state": "EFFECTIVE",
        "classification": "JOBS",
        "id": "235B7EAC84C2408EAD891ED7077174CE",
        "name": "L Jobs All Price Plans",
        "code": "L Jobs All Price Plans",
        "billing_type": "NORMAL"
      },
      "effective_date": "2016-07-28T00:00:00",
      "billing_frequency": null,
      "id": "97E8673FECA345CEB170712DFA745C4D",
      "allowed_cancel_date": null,
      "expiration_date": null,
      "billing_cycle_day": null,
      "price_plan": {
        "effective_date": "2015-12-20T00:00:00",
        "type": "BASE",
        "id": "1B5FF32B7D6149908FE2C9DA9B124564",
        "name": "Ad2",
        "description": null,
        "code": "Ad2",
        "expiration_date": null
      }
    },
    "service_request": null,
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_float_3": null,
    "number": "JOB000814",
    "udf_float_4": null,
    "udf_string_1": null,
    "assigned_to": {
      "unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "user": {
        "person_name": "MPAdministrator",
        "username": "MPAdministrator",
        "id": "1"
      }
    },
    "udf_string_2": null,
    "privacy_level": null,
    "estimated_completion_time": {
      "time_period_value": 2,
      "time_period_uot": "DAYS"
    },
    "udf_string_3": null,
    "udf_string_4": null,
    "contact_phone": "99626262",
    "udf_string_5": null,
    "activities_set": [],
    "udf_string_6": null,
    "physical_goods_set": [],
    "udf_string_7": null,
    "udf_string_8": null,
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Antoniadou",
        "middle_name": "L",
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": "Ms",
        "first_name": "Marina",
        "type": "PERSON",
        "id": "FA4A9EF8D7BD4D819B70E8CB1B8FA963",
        "name": "Antoniadou Marina",
        "company_name": null,
        "demographics": {
          "gender": "FEMALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "country_of_residence": {
            "three_character_code": "CYP",
            "two_character_code": "CY",
            "id": "181",
            "name": "CYPRUS",
            "alternative_code": null
          },
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": null,
            "day": null,
            "year": null
          },
          "id_number": "2365485",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR001179",
      "id": "1D48BF32F4164731AD5755B61838F1E5",
      "name": "ACR001179"
    },
    "id": "74B83598E4954CD080CBE45959A77B68",
    "subscription": {
      "life_cycle_state": "EFFECTIVE",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Antoniadou",
          "middle_name": "L",
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": "Ms",
          "first_name": "Marina",
          "type": "PERSON",
          "id": "FA4A9EF8D7BD4D819B70E8CB1B8FA963",
          "name": "Antoniadou Marina",
          "company_name": null,
          "demographics": {
            "gender": "FEMALE",
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": null,
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": "CYP",
              "two_character_code": "CY",
              "id": "181",
              "name": "CYPRUS",
              "alternative_code": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "id_number": "2365485",
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR001179",
        "id": "1D48BF32F4164731AD5755B61838F1E5",
        "name": "ACR001179"
      },
      "number": "S60992",
      "type": {
        "id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
        "name": "London",
        "description": "Subscription for London customers",
        "alternative_code": "LND"
      },
      "id": "B8DD89C675A743ABB798351C5BC6DE4E",
      "first_activated_date": "2016-06-27T12:54:14",
      "rating_state": "PENDING"
    },
    "requested_activity_services_set": [
      {
        "activity_type": {
          "id": "F609C9D1CD43463DA810B1EC415BB5E1",
          "name": "Meeting",
          "description": null,
          "alternative_code": "M"
        },
        "id": "D1C03E626C8A4875AD3D76FC70A4A0B8",
        "product": {
          "product_type": {
            "service_type": "EXPENSE",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "67FA013211E348C58F7CD27F8399AADE",
            "name": "Expense Type",
            "description": null,
            "alternative_code": "ET"
          },
          "id": "28709F00389D79015AF4511B4A1BDFF6",
          "description": "Meeting Fees",
          "code": "MFee",
          "alternative_code": "MFee"
        }
      }
    ],
    "udf_date_1": null,
    "udf_date_2": null,
    "expected_completion_date": "2016-07-30T14:00:00",
    "udf_date_3": null,
    "udf_date_4": null,
    "start_date": "2016-07-28T13:31:40",
    "time_overdue": {
      "time_period_value": null,
      "time_period_uot": null
    },
    "time_to_completion": {
      "time_period_value": 2,
      "time_period_uot": "DAYS"
    },
    "rating_state": "PENDING",
    "requested_expenses_set": [
      {
        "id": "152A42D1CA8340989006B3A67DB93898",
        "product": {
          "product_type": {
            "service_type": "EXPENSE",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "67FA013211E348C58F7CD27F8399AADE",
            "name": "Expense Type",
            "description": null,
            "alternative_code": "ET"
          },
          "id": "81D5550CF6004CE0B206A371F9F3A18A",
          "description": "Expence 2",
          "code": "Expence 2",
          "alternative_code": "exp2"
        }
      }
    ],
    "log_information": {
      "updated_date": "2016-07-28T13:38:04",
      "created_date": "2016-07-28T13:31:40",
      "created_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "updated_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "username": "MPAdministrator",
        "id": "1"
      },
      "updated_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1"
      }
    },
    "owned_by_group": {
      "community_name": "Internal Community",
      "id": "84F33366CB592BAAE7E2044D93611C6A",
      "name": "Main Group",
      "description": "Main Group",
      "alternative_code": "MG1"
    },
    "status": {
      "life_cycle_state": "PENDING",
      "id": "JobStatus1",
      "name": "Assigned",
      "description": null,
      "alternative_code": "AS"
    },
    "actual_completed_date": null,
    "location": null,
    "life_cycle_state": "PENDING",
    "type": {
      "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
      "fulfillment_scope": "DEACTIVATE_SUBSCRIPTION",
      "id": "40F231681B984DA28EDBDA8B698E229E",
      "name": "Deactivate Subscription",
      "description": null,
      "alternative_code": "DS"
    },
    "description": null,
    "contact_email": "m_antoniadou@crm.com",
    "expenses_set": [],
    "category": null
  }
}

Versions Compared

Old Version 15

New Version 16

Key

Examples

POST jobs/deactivate_subscription/update

Resource URL

Parameters

Restrictions

Response Data

Examples

POST jobs/deactivate_subscription/update

Resource URL

Parameters

Anchor
job_update referred objects parameters
job_update referred objects parameters
Referred Parameter Objects Data

Restrictions

Response Data

Examples

Page Comparison

Versions Compared

Old Version 15

New Version 16

Key

Examples

POST jobs/deactivate_subscription/update

Resource URL

Parameters

Restrictions

Response Data

Examples

POST jobs/deactivate_subscription/update

Resource URL

Parameters

Anchorjob_update referred objects parametersjob_update referred objects parametersReferred Parameter Objects Data

Restrictions

Response Data

Examples

Anchor
job_update referred objects parameters
job_update referred objects parameters
Referred Parameter Objects Data