Skip to end of banner
Go to start of banner

assets_to_be_removed_parameters

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

 assets_to_be_removed object parameter data

Name

Type

Description

installed_item_identifier
(semi-optional)

Installed Item Identifier

The identifier of the purchased installed item which is returned. The allowed installed item identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of  a installed item

return_reason_identifier

(optional)

 

Return Reason Indetifier

The identifier of the reason the customer returns the installed item. The allowed return reasons identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the warranty coverage reason

name

(semi-optional)

String

The name of the warranty coverage reason

alternative_code

(semi-optional)

String

The alternative code of the warranty coverage reason

Available from R14.2.0

set_as_not_effective

(optional)

Boolean

Defines whether the installed item will be set as Not Effective

Available from R15.0.0

state_classification

(mandatory on conditions)

State Classification Identifier

Defines the state classification of a Not Effective installed item. Applicable and mandatory only if set_as_not_effective is set to True. The allowed state classification identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the state classification

name

(semi-optional)

String

The name of the state classification

alternative_code

(semi-optional)

String

The alternative code of  a state classification

Available from R15.0.0

   

Restrictions

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

 

  • No labels