The operation new in case of a ticket will add a new ticket. A ticket can (for example) be a question, complaint or (claim) file, but the entityType is always default.

How to use variants

If you want to add a new ticket, choose the operation new. Only one variant is applicable for ticket (the variant ‘default’). If you want to include a (either new or existing) claim file with the created ticket, you can do so via a reference to that claim: by including claimRef under the ticket entity.

A positive response to the operation new 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.


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

Variant Description ticket
<default> Add a new ticket Yes

<default> – Add a new ticket

The variant ‘default’ adds a new ticket. The ticketStructure is used to add 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
Response Remarks
POST { uri } /tickets/new ticketStructure N/A 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 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.
When referencing a claim file, claimRef is required under the ticket entity for both the input and output.


Thanks for your feedback.

Post your comment on this topic.

Please do not use this for support questions.
If you have any support questions, do not hesitate to contact us.

Post Comment