Page Comparison

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 on which the requested subscription services will be added 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_subscription_services_set

(mandatory)

Set of Requested Subscription Service Objects

A list of services that were requested by the customer and should be provided as part of the subscription that will be updated. 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

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_subscription_physical_goods_set

(optional)

Set of Requested Subscription Physical Good Objects

A list of physical goods (products only) that were requested by the customer and should be provided as part of the subscription that will be updated. The subscription physical goods are filtered based on the specified subscription type. All the subscription related rules and restrictions are applicable on the requested subscription physical goods as well

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

...

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_subscription_services_set

(optional)

Set of Requested Subscription Service Objects

The requested subscription services to be added on the subscription to be updated. 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_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_subscription_physical_goods_set

(optional)

Set of Requested Subscription Physical Good Objects

The requested subscription physical goods to be added on the subscription to be updated. 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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
"token":"44720BFD213D4498BCD6DCD52B342D12",
"job_identifier":{"number":"JOB000808"},
"status_identifier":{"name":"To be Approved"},
"expected_completion_date":"2016-07-30T11:00:00",
"billing_terms":
{
    "price_plan_identifier":{"code":"BPP1"}
},
"requested_subscription_services_set":
[
    {
        "action":"REMOVE",
        "job_requested_subscription_service_identifier":
        {
            "id":"03CAF4D8224C4EB38F10D08CEF98BACF"
        }
    },
    {
        "action":"ADD",
        "service_identifier":
        {
            "code":"Movies 1"
        },
        "provisioning_distribution_set":
        [
            {
                "provisioning_distributor_identifier":{"name":"CONAX SMS Main"}
            }
        ]
    }
]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "requested_physical_goods_set": [
      {
        "id": "EAE74E5D2AC34211B938BE3487F96510",
        "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"
        }
      },
      {
        "id": "EBF6F9A8EB764FAC8DBA948A0FCFCEEB",
        "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": "3F01BB0B40264DF7311660F63CB2180D",
          "description": "Remote Control",
          "code": "Remote Control",
          "alternative_code": "REM"
        }
      }
    ],
    "service_request": null,
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_float_3": null,
    "udf_float_4": null,
    "udf_string_1": null,
    "udf_string_2": 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": null
    },
    "udf_string_3": null,
    "privacy_level": null,
    "udf_string_4": null,
    "udf_string_5": null,
    "contact_phone": null,
    "udf_string_6": null,
    "activities_set": [],
    "udf_string_7": null,
    "physical_goods_set": [],
    "udf_string_8": null,
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Anton",
        "middle_name": "333",
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": "Mrs",
        "first_name": "Mara",
        "type": "PERSON",
        "id": "3358197AD0334CE2834DB60933B2CE88",
        "name": "Anton Mara",
        "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": "568941",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR001182",
      "id": "570169F05EF949E89FF987AD086A09BE",
      "name": "ACR001182"
    },
    "id": "08632E19E3ED497E9CE4B7AA484245F8",
    "subscription": {
      "life_cycle_state": "EFFECTIVE",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Anton",
          "middle_name": "333",
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": "Mrs",
          "first_name": "Mara",
          "type": "PERSON",
          "id": "3358197AD0334CE2834DB60933B2CE88",
          "name": "Anton Mara",
          "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": "568941",
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR001182",
        "id": "570169F05EF949E89FF987AD086A09BE",
        "name": "ACR001182"
      },
      "number": "S61007",
      "type": {
        "id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
        "name": "London",
        "description": "Subscription for London customers",
        "alternative_code": "LND"
      },
      "id": "26505A7D9E904C069F03DE12AEDE015D",
      "first_activated_date": "2016-07-20T12:51:24",
      "rating_state": "PENDING"
    },
    "requested_activity_services_set": [
      {
        "activity_type": {
          "id": "938B9B6411AAB03DC25B3F569A443C6D",
          "name": "InstallationsX",
          "description": "Test",
          "alternative_code": "INX"
        },
        "id": "7C1AA5233E174062A9DE3E401B4A4C2A",
        "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": "8F7A45F44BBEB320718F309F58CCE097",
          "description": "Installation",
          "code": "Installation Fee",
          "alternative_code": "Ins"
        }
      }
    ],
    "requested_subscription_physical_goods_set": [
      {
        "swap_installed_item": null,
        "provisioning_distributor": {
          "id": "9653D381D3874E9A9CABCE9C2585C253",
          "name": "CONAX SMS Main",
          "alternative_code": "CONAX_SMS_Main"
        },
        "installed_item": null,
        "id": "57E80E80FC64408EB3780AEDD0B04CA9",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "TRACEABLE",
            "used_for_provisioning": false,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "6173FC99331504AD1ACB5D697D54DA8C",
            "name": "Smartcards",
            "description": "Smartcards",
            "alternative_code": "SC"
          },
          "id": "EAC7A30429364176616CFEF5DF709941",
          "description": "Smartcard 1",
          "code": "Smartcard 1",
          "alternative_code": "SC1"
        }
      }
    ],
    "expected_completion_date": "2016-07-30T11:00:00",
    "time_to_completion": {
      "time_period_value": 3,
      "time_period_uot": "DAYS"
    },
    "time_overdue": {
      "time_period_value": null,
      "time_period_uot": null
    },
    "log_information": {
      "updated_date": "2016-07-27T18:52:29",
      "created_date": "2016-07-27T18:22:05",
      "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"
      }
    },
    "life_cycle_state": "PENDING",
    "location": {
      "udf_string_10": null,
      "street_number": "10",
      "care_of": null,
      "udf_string_11": null,
      "udf_float_1": null,
      "street_name": "Athalassis",
      "udf_string_12": null,
      "udf_float_2": null,
      "udf_string_13": null,
      "udf_float_3": null,
      "udf_string_14": null,
      "udf_float_4": null,
      "udf_string_15": null,
      "udf_string_16": null,
      "po_box": "1136525",
      "udf_string_1": null,
      "floor": 2,
      "udf_string_2": null,
      "area": null,
      "udf_string_3": null,
      "district": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_6": null,
      "udf_string_7": null,
      "state": "Active",
      "udf_string_8": null,
      "udf_string_9": null,
      "country": {
        "three_character_code": "CYP",
        "two_character_code": "CY",
        "id": "181",
        "name": "CYPRUS",
        "alternative_code": null
      },
      "id": "3B808C39809A431EAE83C7FD2584D7D8",
      "postal_code": null,
      "udf_date_1": null,
      "udf_date_2": null,
      "udf_date_3": null,
      "udf_date_4": null,
      "po_box_postal_code": "3654",
      "apartment_number": "203",
      "town_city": "Nicosia",
      "type": "POBOX",
      "municipality": null
    },
    "type": {
      "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
      "fulfillment_scope": "ADD_SUBSCRIPTION_SERVICES",
      "id": "FE4AC73E0F8F4B3F999314CF556B6F1E",
      "name": "Add subscription services",
      "description": null,
      "alternative_code": "ADD_SERVICES"
    },
    "contact_email": "m_antoniadou@crm.com",
    "expenses_set": [],
    "notes": null,
    "billing_terms": {
      "binding_information": null,
      "agreement_date": "2016-07-27T00:00:00",
      "concurrent_usage_based_pricing": {
        "concurrent_usage": null,
        "rate_percentage": null
      },
      "billing_term_scheme": {
        "life_cycle_state": "EFFECTIVE",
        "billing_method": "PERIOD",
        "classification": "JOBS",
        "id": "9C0B2B52003EFEEE0864212F34D41229",
        "name": "P Job Billing Term Scheme",
        "code": "PJBTS",
        "billing_type": "NORMAL"
      },
      "effective_date": "2016-07-27T00:00:00",
      "billing_frequency": null,
      "id": "4E4D4EB5496A4901AAFB497FAEFDEB1D",
      "allowed_cancel_date": null,
      "expiration_date": null,
      "billing_cycle_day": null,
      "price_plan": {
        "effective_date": "2015-12-20T00:00:00",
        "type": "BASE",
        "id": "98E7E5DD4CC34EA3B860946A24F20B71",
        "name": "Basic 1",
        "description": "BPP for Billing TC9",
        "code": "BPP1",
        "expiration_date": null
      }
    },
    "number": "JOB000808",
    "estimated_completion_time": {
      "time_period_value": 2,
      "time_period_uot": "DAYS"
    },
    "requested_subscription_services_set": [
      {
        "product_bundle": null,
        "swap_product": null,
        "provisioning_distributor": {
          "id": "9653D381D3874E9A9CABCE9C2585C253",
          "name": "CONAX SMS Main",
          "alternative_code": "CONAX_SMS_Main"
        },
        "id": "18A7844E69364A749CBF867B281D9AE8",
        "product": {
          "product_type": {
            "service_type": "TERMED",
            "physical_good_type": null,
            "used_for_provisioning": true,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "600438B64B0F05AB3D020C902674949F",
            "name": "Subscription services",
            "description": "Subscription services",
            "alternative_code": "SS"
          },
          "id": "5B3841D63F6CAE5973366EEAFF3444E3",
          "description": "Movies 1",
          "code": "Movies 1",
          "alternative_code": "M1"
        }
      }
    ],
    "udf_date_1": null,
    "udf_date_2": null,
    "udf_date_3": null,
    "start_date": "2016-07-28T11:00:00",
    "udf_date_4": null,
    "requested_expenses_set": [
      {
        "id": "1BABF33983BB42769ADA1DDCBC33C159",
        "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": "8F7A45F44BBEB320718F309F58CCE097",
          "description": "Installation",
          "code": "Installation Fee",
          "alternative_code": "Ins"
        }
      }
    ],
    "rating_state": "PENDING",
    "owned_by_group": {
      "community_name": "Internal Community",
      "id": "84F33366CB592BAAE7E2044D93611C6A",
      "name": "Main Group",
      "description": "Main Group",
      "alternative_code": "MG1"
    },
    "status": {
      "life_cycle_state": "PENDING",
      "id": "59310E86D1DD626A04102462FC3E9D1B",
      "name": "To be Approved",
      "description": "To be Accepted",
      "alternative_code": "TBA"
    },
    "actual_completed_date": null,
    "description": "Add Service Cartoons 2",
    "category": null
  }
}

Versions Compared

Old Version 17

New Version 18

Key