Available from CRM.COM R11.0.0
This method updates jobs of fulfillment scope Replace Physical Goods. 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:
| ||||||||||||
status_identifier | Job status identifier | The identifier of the status of the new job. The allowed job status identifier fields are the following:
| ||||||||||||
category_identifier | Job category identifier | The identifier of the category of the new job. The allowed job category identifier fields are the following:
| ||||||||||||
| description (optional) | String | The description of the new job | ||||||||||||
notes | 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 | Date | The date that the activity is created | ||||||||||||
owned_by_group_identifier | The identifier of the owned by group information | The owned by group information of the job. The allowed group identifier fields are the following:
| ||||||||||||
privacy_level_identifier | The identifier of the privacy level | The privacy level of the job. The allowed privacy level identifier fields are the following:
| ||||||||||||
udf_string_1 | String | User Defined Field of type String | ||||||||||||
udf_string_2 | String | User Defined Field of type String | ||||||||||||
udf_string_3 | String | User Defined Field of type String | ||||||||||||
udf_string_4 | String | User Defined Field of type String | ||||||||||||
udf_string_5 | String | User Defined Field of type String | ||||||||||||
udf_string_6 | String | User Defined Field of type String | ||||||||||||
udf_string_7 | String | User Defined Field of type String | ||||||||||||
udf_string_8 | String | User Defined Field of type String | ||||||||||||
udf_float_1 | Float | User Defined Field of type Float | ||||||||||||
udf_float_2 | Float | User Defined Field of type Float | ||||||||||||
udf_float_3 | Float | User Defined Field of type Float | ||||||||||||
udf_float_4 | Float | User Defined Field of type Float | ||||||||||||
udf_date_1 | Date | User Defined Field of type Date | ||||||||||||
udf_date_2 | Date | User Defined Field of type Date | ||||||||||||
udf_date_3 | Date | User Defined Field of type Date | ||||||||||||
udf_date_4 | Date | User Defined Field of type Date | ||||||||||||
expected_completion_date | Date | The date that the job is expected to be completed. It is automatically calculated if estimate completion time is specified From CRM.COM R15.0.0, this parameter will be applicable only when the Recalculate Key Dates on Starting Progress option is not enabled through the related Job Type configuration | ||||||||||||
estimated_completion_time | 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 From CRM.COM R15.0.0, this parameter will be applicable only when the Recalculate Key Dates on Starting Progress option is not enabled through the related Job Type configuration | ||||||||||||
| 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. | ||||||||||||
(optional) | Set of Requested Physical Good Objects | The requested physical goods. This information is applicable only if the job is draft or pending If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
requested_replaced_physical_goods_set (optional) | Set of Requested Physical Good Replacements Objects | The requested physical goods to be replaced. This information is applicable only if the job is draft or pending If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
(optional) | Set of Requested Expense Objects | The requested expenses. This information is applicable only if the job is draft or pending If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
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 If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
| 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 If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
job_physical_goods_replacement_set | Set of physical good to be replaced objects | The physical goods that will be replaced as part of the retrieved job. This information is applicable only if the job is in progress If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
| 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 If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
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 |
Referred Parameter Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved job |
number | String | The number of the retrieved job |
| description | String | The description of the retrieved job |
| notes | String | The notes of the retrieved job |
| contact_email | String | The email of the customer related with the retrieved job, which will be used in order to communicate the job |
| contact_phone | String | The phone of the customer related with the retrieved job, which will be used in order to communicate the job |
life_cycle_state | String | The life cycle state of the retrieved job which can be DRAFT, PENDING, IN PROGRESS, COMPLETED, CANCELLED |
| start_date | Date | The date that the job is created |
| expected_completion_date | Date | The date that the job is expected to be completed |
| actual_completed_date | Date | The date that the job is actually completed |
| expiration_date | Date | The date on which the job expires. Available form CRM.COM R13.0.0 |
| rating_state | String | The rating state of the job that can be PENDING or COMPLETED |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| assigned_to | Assign Object | The assignment information of the retrieved job |
| type | Job type object | The type information of the retrieved job |
| billing_terms | Jobs Billing Terms Object | The billing terms of the retrieved job |
| status | Job Status object | The status information of the retrieved job |
| category | Job Category object | The category of the retrieved job |
| service_request | Service Request Object | The service request that was related with the retrieved job. |
| estimated_completion_time | Time Period Object | The time that is estimated to complete the job, measured in minutes, hours, days, weeks, years |
| time_to_completion | Time Period Object | The time that is left up to the expected completion date |
| time_overdue | Time Period Object | The time past the expected completion date |
Accounts Receivable object | The accounts receivable related with the specified job | |
| pricing_agreement_price_plan | Price Plan Object | The pricing agreement that was assigned against an Accounts Receivable Applicable for an Accounts Receivable that is owned by a Company (Corporate Account) and a Price Plan was agreed as part of a special pricing agreement Applicable for Accounts Receivables that are members in the related Corporate Account Group as well Available from CRM.COM R14.0.0 |
| location | Address Object | The physical location that the job should be performed and delivered to |
| cancellation_reason | Jobs Cancellation Object | The reason that the job was cancelled. This is applicable only if the job is on a cancelled life cycle state |
| owned_by_group | Group object | The group that is owning the job |
| privacy_level | Privacy level object | The job privacy level |
Log Information Object | The log information related with the retrieved job | |
| requested_physical_goods_replacement_set | Set of Requested Physical Goods Replacements Objects | The traceable physical goods which were requested to be replaced |
| requested_physical_goods_set | Set of Requested Physical Goods Objects | The physical goods that were requested by the retrieved job |
| requested_expenses_set | Set of Requested Expenses Objects | The expenses that were requested by the retrieved job |
| requested_activity_services_set | Set of Requested Activity Services Objects | The activity services that were requested by the retrieved job |
| physical_goods_replacements_set | Set of Physical Goods Replacement Objects | The traceable physical goods that will be replaced along with the traceable physical goods with which they will be replaced. |
| physical_goods_set | Set of Physical Goods Objects | The physical goods that will be provided as part of the job |
| expenses_set | Set of Expense Objects | A list of one time services which are applied on the job as expenses |
| activities_set | Set of Activity Objects | A set of activities which are planned for the specific job |
| bills_set | Set of Bill Objects | A set of bills that were generated by the billing engine in relation to the specific job |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"9CDAEDEE02F4444E85284BB9A794DD64",
"job_identifier":{"number":"J00000418"},
"job_physical_goods_replacements_set":
[
{
"action":"remove",
"job_physical_good_replacement_identifier":{"replaced_by_installed_item_identifier":{"serial_number":"stb_replace_001"}}
},
{
"action":"add",
"replaced_by_installed_item_identifier":{"serial_number":"stb_replace_001"},
"installed_item_identifier":{"serial_number":"stb_swap_replace_001"},
"warranty_coverage_reason_identifier":{"name":"Faulty"}
}
]
}
Response:
{
"data":
{
"notes": null,
"contact_phone": null,
"log_information":
{
"created_by_unit":
{
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit":
{
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-08-24T09:39:51",
"updated_date": "2016-08-24T12:55:46",
"updated_by_user":
{
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"requested_physical_goods_set":
[
],
"type":
{
"alternative_code": "RPG",
"name": "Replace Physical Goods",
"fulfillment_scope": "REPLACE_PHYSICAL_GOODS",
"description": null,
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"id": "E859291E838947F58C09BD0799E3613D"
},
"number": "J00000418",
"id": "B26FC357BDFD46349EB4F136235A2204",
"actual_completed_date": null,
"requested_expenses_set":
[
],
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"privacy_level": null,
"udf_string_1": null,
"life_cycle_state": "IN_PROGRESS",
"activities_set":
[
],
"physical_goods_set":
[
],
"time_overdue":
{
"time_period_uot": null,
"time_period_value": null
},
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"status":
{
"alternative_code": "2",
"name": "Approved",
"description": null,
"id": "7A98FA9566534F1C82227985EA48F617",
"life_cycle_state": "IN_PROGRESS"
},
"owned_by_group":
{
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"rating_state": "PENDING",
"expenses_set":
[
],
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"contact_email": "m_michael@crm.com",
"udf_date_3": null,
"physical_goods_replacements_set":
[
{
"installed_item":
{
"product":
{
"code": "Set-top-box",
"product_type":
{
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "STB",
"composition_method": "FLAT",
"name": "SET TOP BOX",
"description": "SET TOP BOX",
"id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "STB",
"description": "Set-top-box",
"id": "D613415339C14975B28BB4FC11598E93"
},
"alternative_code": "stb_swap_replace_001",
"serial_number": "stb_swap_replace_001",
"id": "2BA7FB596DA241B094B4A816EDC6375E",
"state": "EFFECTIVE"
},
"warranty_expiration_date": "2017-08-24T09:07:13",
"warranty_policy":
{
"number": "1",
"alternative_code": "NSS",
"name": "New Subscription Sales",
"id": "3C6F0E199A1F420BB74EA8EBF0DC0BF4",
"life_cycle_state": "EFFECTIVE"
},
"warranty_coverage_reason":
{
"name": "Faulty",
"description": "Faulty",
"id": "06B58CB81498454C8E2B3D1C46790AF4",
"altCode": "FLT"
},
"replacement_installed_item":
{
"product":
{
"code": "Set-top-box",
"product_type":
{
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "STB",
"composition_method": "FLAT",
"name": "SET TOP BOX",
"description": "SET TOP BOX",
"id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "STB",
"description": "Set-top-box",
"id": "D613415339C14975B28BB4FC11598E93"
},
"alternative_code": "stb_replace_001",
"serial_number": "stb_replace_001",
"id": "D77451FF2DA74C468049BD52332D26BB",
"state": "EFFECTIVE"
},
"id": "0579CED0044E458699A56D0593A3D058"
}
],
"udf_float_3": null,
"udf_float_4": null,
"estimated_completion_time":
{
"time_period_uot": "HOURS",
"time_period_value": 10
},
"service_request": null,
"udf_float_1": null,
"billing_terms":
{
"billing_frequency": null,
"billing_term_scheme":
{
"code": "PJBTS",
"name": "P Job Billing Term Scheme",
"billing_type": "NORMAL",
"id": "F3057AAF86104FF591C4C3131E731807",
"life_cycle_state": "EFFECTIVE",
"classification": "JOBS"
},
"allowed_cancel_date": null,
"billing_cycle_day": null,
"agreement_date": "2016-08-24T00:00:00",
"effective_date": "2016-08-24T00:00:00",
"price_plan":
{
"code": "MPP",
"name": "Main Price Plan",
"effective_date": "2016-07-21T00:00:00",
"description": "Main Price Plan",
"id": "E2858AC591A04CF58912A9636787139C",
"type": "BASE",
"expiration_date": null
},
"id": "7C7AE4F608B0406497F056E4E422DE5A",
"expiration_date": null,
"binding_information": null
},
"udf_float_2": null,
"start_date": "2016-08-24T09:39:51",
"assigned_to":
{
"unit":
{
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"user":
{
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"accounts_receivable":
{
"number": "ACR0000000266",
"name": "ACR0000000266 Polen Mayiar",
"id": "1E3E7AC4D2FA49458E2FFDE6912B7728",
"life_cycle_state": "ACTIVE",
"account_owner":
{
"company_profile": null,
"company_name": null,
"name": "Polen Mayiar",
"last_name": "Mayiar",
"id": "1E66220195AF49A1BE8B0BDFB92F6D91",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Polen",
"demographics":
{
"name_day":
{
"month": null,
"day": null
},
"id_number": "582649",
"gender": "MALE",
"country_of_residence":
{
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth":
{
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"time_to_completion":
{
"time_period_uot": "HOURS",
"time_period_value": 6.727777777777778
},
"requested_activity_services_set":
[
],
"requested_physical_goods_replacement_set":
[
{
"installed_item":
{
"product":
{
"code": "Modem",
"product_type":
{
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "Physical Good",
"composition_method": "FLAT",
"name": "Physical Good",
"description": null,
"id": "5B6DAF4AD7C94C4D9C3B49950E10B256",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "M_2",
"description": "Modem",
"id": "01BEEA0C9B7246E79CAF6E569A8C6ECF"
},
"alternative_code": "modem_replace_004",
"serial_number": "modem_replace_004",
"id": "DB7F65B4C43048459D244BB18B5DC48D",
"state": "EFFECTIVE"
},
"warranty_expiration_date": "2017-08-24T09:16:19",
"warranty_policy":
{
"number": "1",
"alternative_code": "NSS",
"name": "New Subscription Sales",
"id": "3C6F0E199A1F420BB74EA8EBF0DC0BF4",
"life_cycle_state": "EFFECTIVE"
},
"id": "DC81E5BB5DBD4A18BBF69A849D12CAD5"
},
{
"installed_item":
{
"product":
{
"code": "Set-top-box",
"product_type":
{
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "STB",
"composition_method": "FLAT",
"name": "SET TOP BOX",
"description": "SET TOP BOX",
"id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "STB",
"description": "Set-top-box",
"id": "D613415339C14975B28BB4FC11598E93"
},
"alternative_code": "stb_replace_001",
"serial_number": "stb_replace_001",
"id": "D77451FF2DA74C468049BD52332D26BB",
"state": "EFFECTIVE"
},
"warranty_expiration_date": "2017-08-24T09:07:13",
"warranty_policy":
{
"number": "1",
"alternative_code": "NSS",
"name": "New Subscription Sales",
"id": "3C6F0E199A1F420BB74EA8EBF0DC0BF4",
"life_cycle_state": "EFFECTIVE"
},
"id": "BE7FA613BC034B199945C017005CDB70"
}
],
"location":
{
"apartment_number": null,
"care_of": null,
"country":
{
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"municipality": null,
"type": "HOME",
"udf_date_2": null,
"udf_date_1": null,
"street_name": "Opote",
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"po_box_postal_code": null,
"udf_string_15": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "78E2AC42646744BEA7BBBD0CDF6AD19D",
"state": "Active",
"udf_string_10": null,
"floor": null,
"udf_float_1": null,
"udf_float_2": null,
"area": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"po_box": null,
"town_city": null,
"district": null,
"street_number": "55",
"postal_code": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null
},
"category": null,
"expected_completion_date": "2016-08-24T19:39:51"
},
"status":
{
"code": "OK",
"description": "",
"message": ""
}
}