Tip
Available from CRM.COM R9.0.0

Table of Contents

maxLevel	2

GET warranty_policies/show

This method returns information related with a Warranty Policy. A single warranty is returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Identifier

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

...

fields_set

(optional)

...

List of Strings, comma separated

...

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

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

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "physical_goods_covered": [
      {
        "product_family": null,
        "product_brand": {
          "altCode": "Phillips",
          "id": "0CCF5FFE863F3753E49AD78C36FA23B3",
          "name": "Phillips",
          "description": "Band Philips"
        },
        "product_type": null,
        "product": null
      },
      {
        "product_family": null,
        "product_brand": null,
        "product_type": {
          "service_type": null,
          "physical_good_type": "TRACEABLE",
          "used_for_provisioning": 0,
          "classification": "PHYSICALGOODS",
          "composition_method": "FIXEDBUNDLE",
          "id": "3919A362F4EB4828A70773B0574CD0E3",
          "name": "Bundle-Traceble-Sakkas",
          "description": null,
          "alternative_code": "B_1"
        },
        "product": null
      },
      {
        "product_family": {
          "id": "C23C3894D55F015EE2E02DF956314B1B",
          "name": "Digital",
          "description": null,
          "code": null
        },
        "product_brand": null,
        "product_type": null,
        "product": null
      },
      {
        "product_family": null,
        "product_brand": null,
        "product_type": null,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "TRACEABLE",
            "used_for_provisioning": 0,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "3ADBA4F945204F8B80CFCB0917383F8E",
            "name": "Decoders-Sakkas",
            "description": null,
            "alternative_code": "D_2"
          },
          "id": "279A04187C1841209A2079F925C625BB",
          "name": null,
          "description": null,
          "code": "Decoder-Sakkas",
          "alternative_code": "D"
        }
      }
    ],
    "udf_float_1": null,
    "effective_date": "2016-03-15 00:00:00.0",
    "udf_float_2": null,
    "coverage_reasoning": [
      {
        "provides_coverage": 1,
        "warranty_coverage_reason": {
          "altCode": "WCR2",
          "id": "D98AEF9E5B404616BEC1F8656E05619E",
          "name": "Warranty Coverage Reasons 2",
          "description": "Warranty Coverage Reasons 2"
        }
      },
      {
        "provides_coverage": null,
        "warranty_coverage_reason": {
          "altCode": "CR1",
          "id": "0ACA0BCFAD594297AFF1E666248C4E1D",
          "name": "Coverage Reason 1",
          "description": "Coverage Reason 1"
        }
      }
    ],
    "udf_float_3": null,
    "udf_float_4": null,
    "number": "3.2",
    "name": "Warranty Policy 3.2",
    "udf_string_1": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "udf_string_4": null,
    "allowed_organisational_units_set": [
      {
        "community_name": null,
        "id": "F95BE5E978B34A1694F010CC0A13F677",
        "name": null,
        "group_name": "Main Group",
        "description": null,
        "alternative_code": null
      }
    ],
    "udf_string_5": null,
    "udf_string_6": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "duration": 20,
    "id": "C208D849F5BF4741A81D5D8A977B0302",
    "udf_date_1": null,
    "udf_date_2": null,
    "udf_date_3": null,
    "udf_date_4": null,
    "customer_responsibilities": "Bring Back",
    "company_responsibilities": "Nothing",
    "log_information": {
      "updated_date": "2016-03-03T14:39:42",
      "created_date": "2016-03-03T14:13:11",
      "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",
        "email": "sakkascy1986@hotmail.com"
      },
      "updated_by_user": {
        "person_name": "MPAdministrator",
        "username": "MPAdministrator",
        "id": "1",
        "email": "sakkascy1986@hotmail.com"
      }
    },
    "life_cycle_state": "EFFECTIVE",
    "unit_of_time": "DAYS",
    "replacement_coverage_policy": "CARRY_OVER_REMAINING_DURATION",
    "description": null,
    "expiration_date": null,
    "alternative_code": "WP3"
  }
}

GET warranty_policies/list

This method returns information related with warranty policies. Multiple warranty policies are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

group_identifier

(optional)

...

The identifier of the group that will be providing the warranty policy. The group is filtered against the warranty policy's allowed organisational units. The allowed group identifier fields are the following:

...

unit_identifier

(optional)

...

The identifier of the unit that will be providing the warranty policy. The unit is filtered against the warranty policy's allowed organisational units. The allowed unit identifier fields are the following:

...

job_type_identifier

(optional)

...

The identifier of the job type that will be used to provide the installed item under warranty. The retrieved warranty policies are filtered based on the list of warranty policies that are allowed to be provided by the specified job type. The allowed job type identifier fields are the following:

...

(optional)

...

Product Identifier

The identifier of the product whose warranty coverage is required. The product can only be a traceable physical good. The allowed product identifier fields are the following:

...

product_type_identifier

(optional)

...

The identifier of the product type whose warranty coverage is required. Only product types for traceable physical goods can be specified. The allowed product type identifier fields are the following:

...

product_brand_identifier

(optional)

...

The identifier of the product brand whose warranty coverage is required. The allowed product brand identifier fields are the following:

...

product_family_identifier

(optional)

...

The identifier of the product family whose warranty coverage is required. The allowed product family identifier fields are the following:

...

number_of_results

(optional)

...

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

...

offset

(optional)

...

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip
Available from CRM.COM R13.0.0

...

fields_set

(optional)

...

List of Strings, comma separated

...

A list of fields that should be included in the results. If not specified then all the available fields will be returned

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: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "physical_goods_covered": [
        {
          "product_family": {
            "id": "C23C3894D55F015EE2E02DF956314B1B",
            "name": "Digital",
            "description": null,
            "code": null
          },
          "product_brand": null,
          "product_type": null,
          "product": null
        },
        {
          "product_family": null,
          "product_brand": null,
          "product_type": null,
          "product": {
            "product_type": {
              "service_type": null,
              "physical_good_type": "TRACEABLE",
              "used_for_provisioning": 0,
              "classification": "PHYSICALGOODS",
              "composition_method": "FLAT",
              "id": "3ADBA4F945204F8B80CFCB0917383F8E",
              "name": "Decoders-Sakkas",
              "description": null,
              "alternative_code": "D_2"
            },
            "id": "279A04187C1841209A2079F925C625BB",
            "name": null,
            "description": null,
            "code": "Decoder-Sakkas",
            "alternative_code": "D"
          }
        },
        {
          "product_family": null,
          "product_brand": null,
          "product_type": {
            "service_type": null,
            "physical_good_type": "TRACEABLE",
            "used_for_provisioning": 0,
            "classification": "PHYSICALGOODS",
            "composition_method": "FIXEDBUNDLE",
            "id": "3919A362F4EB4828A70773B0574CD0E3",
            "name": "Bundle-Traceble-Sakkas",
            "description": null,
            "alternative_code": "B_1"
          },
          "product": null
        },
        {
          "product_family": null,
          "product_brand": {
            "altCode": "Phillips",
            "id": "0CCF5FFE863F3753E49AD78C36FA23B3",
            "name": "Phillips",
            "description": "Band Philips"
          },
          "product_type": null,
          "product": null
        }
      ],
      "effective_date": "2016-03-15 00:00:00.0",
      "udf_float_1": null,
      "coverage_reasoning": [
        {
          "provides_coverage": null,
          "warranty_coverage_reason": {
            "altCode": "CR1",
            "id": "0ACA0BCFAD594297AFF1E666248C4E1D",
            "name": "Coverage Reason 1",
            "description": "Coverage Reason 1"
          }
        },
        {
          "provides_coverage": 1,
          "warranty_coverage_reason": {
            "altCode": "WCR2",
            "id": "D98AEF9E5B404616BEC1F8656E05619E",
            "name": "Warranty Coverage Reasons 2",
            "description": "Warranty Coverage Reasons 2"
          }
        }
      ],
      "udf_float_2": null,
      "udf_float_3": null,
      "number": "3.2",
      "udf_float_4": null,
      "udf_string_1": null,
      "name": "Warranty Policy 3.2",
      "udf_string_2": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "allowed_organisational_units_set": [
        {
          "community_name": null,
          "id": "F95BE5E978B34A1694F010CC0A13F677",
          "name": null,
          "group_name": "Main Group",
          "description": null,
          "alternative_code": null
        }
      ],
      "udf_string_5": null,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null,
      "duration": 20,
      "id": "C208D849F5BF4741A81D5D8A977B0302",
      "udf_date_1": null,
      "udf_date_2": null,
      "udf_date_3": null,
      "udf_date_4": null,
      "customer_responsibilities": "Bring Back",
      "company_responsibilities": "Nothing",
      "log_information": {
        "updated_date": "2016-03-03T14:39:42",
        "created_date": "2016-03-03T14:13:11",
        "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",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "life_cycle_state": "EFFECTIVE",
      "unit_of_time": "DAYS",
      "description": null,
      "replacement_coverage_policy": "CARRY_OVER_REMAINING_DURATION",
      "expiration_date": null,
      "alternative_code": "WP3"
    }
  ]
}

GET warranty_policies/get_installed_item_coverage

This method checks whether installed items sold to customers are covered by warranty policies or not. The method can be used for checking installed items coverage which is required in Jobs which perform Swap Subscription Installed Item actions. Depending on the parameters, the method might return more than one installed item's warranty information.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

accounts_receivable

(semi-optional)

...

(semi-optional)

...

Installed Item Identifier

The identifier of the installed item whose warranty coverage is required. The allowed installed item identifier fields are the following:

...

warranty_coverage_reason_identifier

(optional)

...

The identifier of the warranty policy's coverage reason. The coverage reason represents the replacement reason so if set the installed item's warranty should support this coverage reason. The allowed warranty coverage reason identifier fields are the following:

...

fields_set

(optional)

...

List of Strings, comma separated

...

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

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

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "warehouse_issue_date": "2016-03-02 17:31:06.0",
      "warranty_policy": {
        "life_cycle_state": "EFFECTIVE",
        "number": "2",
        "id": "4B417948ADB44DFEAF735184B941D481",
        "name": "Policy1",
        "alternative_code": "p1"
      },
      "installed_item": {
        "state": "EFFECTIVE",
        "serial_number": "Smartcard2_001",
        "id": "791DF73677384DC8A00D8384F5FF85FF",
        "alternative_code": "Smartcard2_001",
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "TRACEABLE",
            "used_for_provisioning": 0,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "6173FC99331504AD1ACB5D697D54DA8C",
            "name": "Smartcards",
            "description": "Smartcards",
            "alternative_code": "SC"
          },
          "id": "80EEE8F6F46767AE32E6ABE68603E9F2",
          "name": null,
          "description": "SmartCards 2",
          "code": "Smartcard 2",
          "alternative_code": "SC2"
        }
      },
      "coverage": null,
      "warranty_expiration_date": "Wed Jul 20 17:31:06 EEST 2016",
      "warranty_remaining_coverage_period": 140
    }
  ]
}

...

Panel

name	blue

Child pages (Children Display)

all	true
excerpt	true

Versions Compared

Old Version 16

New Version Current

Key

GET warranty_policies/show

Resource URL

Parameters

Restrictions

Response Data

Examples

GET warranty_policies/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET warranty_policies/get_installed_item_coverage

Resource URL

Parameters

Restrictions

Response Data

Examples

Page Comparison

Versions Compared

Old Version 16

New Version Current

Key

GET warranty_policies/show

Resource URL

Parameters

Restrictions

Response Data

Examples

GET warranty_policies/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET warranty_policies/get_installed_item_coverage

Resource URL

Parameters

Restrictions

Response Data

Examples