5.9.2. Change

The operation change in case of the entity ticket will replace an existing ticket partially or completely. Once the initial ticket has been filed, it may be updated in order to supply additional information. For instance with more information about a maintained claim file, or further additions about a complaint or question.

How to use variants

If you need to make changes to an existing ticket, select the operation change. If it is only necessary to change some details, the variant ‘detail’ can be used. If the complete ticket needs to be replaced, the ‘default’ or the ‘correction’ variants are applicable.

A positive response to the operation change contains the AFD structure of the request as reference, with the result of the transaction (process.statusType). The requested information that was collected during the transaction, is also added to the output.

If a negative response is generated, that means the request is technically incorrect, it follows the general rules as described in the Error section of the HTTP status codes and error handling chapter.

Variants

The variant enables a differentiation in requirements to suit the specific situations (listed below), and for each variant, to which AFD structure it applies.

<default> – Replace the entire ticket by a new version

The default variant replaces the entire ticket by a new version. The ticketStructure is used to change the ticket. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri } /tickets/{ticketId}/change	ticketStructure		ticketStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
ticket	refKey	I/O	Unique reference key assigned to an entity.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

correction – Replace the entire ticket by a new version due to wrong input

The variant correction is applicable, if the entire ticket file needs to be replaced by a new version due to wrong input. The ticketStructure is used to change the ticket. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri } /tickets/{ticketId}/correction	ticketStructure		ticketStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
ticket	refKey	I/O	Unique reference key assigned to an entity.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

detail – Apply a partial change to the ticket

The variant detail is used to apply a partial change to a ticket. The ticketStructure is used to change the ticket. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PATCH	{ uri } /tickets/{ticketId}/detail	ticketStructure		ticketStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
ticket	refKey	I/O	Unique reference key assigned to an entity.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.