The operation retrieve in case of a ticket will fetch ticket details which can contain information added by a third party, for example about a complaint or claim file.
The data is selected by providing the {ticketId} as a path parameter of the endpoint.
How to use variants
The retrieve operation is a webservice call without a body. For more information see the Retrieve operations section of the Design principles paragraph.
The output of the retrieve operation uses the ticketStructure as described in the ticketStructure section.
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.
| Variant | Description | ticket structure |
| <default> | Obtain full details of a single ticket based on the unique reference | Yes |
| status | Obtain status information of a ticket by a unique reference | Yes |
| iist | Obtain reference information of available tickets according to a query statement | Yes |
- <default> – Obtain full details of a single ticket based on the unique reference
-
The variant default retrieves full details of a ticket based on a unique reference, using the ticketStructure. 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 GET { uri } /tickets/{ticketId}/retrieve ticketStructure ticketStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based. commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional afdDefinitionName O Name of the AFD-definition. commonFunctional afdDefinitionVersion O Version of the AFD-definition. 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.
- status – Obtain status information of a ticket by a unique reference
-
The variant status retrieves all information about the status of a ticket by a unique reference, using the ticketStructure. 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 GET { uri } /tickets/{ticketId}/status ticketStructure N/A ticketStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based. commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional afdDefinitionName O Name of the AFD-definition. commonFunctional afdDefinitionVersion O Version of the AFD-definition. ticket refkey O Unique reference key assigned to an entity. ticket statusType O Status code. Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
- list – Obtain reference information of available tickets according to a query statement
-
The variant list is used to retrieve a list of tickets. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.
Endpoint definition
If the complete ticket is subject to the operation retrieve, no path parameter is included in the endpoint. This is shown in the table below. More information on query parameters is available in Design principles.
Method Endpoint Request Query
parameter(s)Response Remarks GET { uri } /tickets/list N/A _fields=[{attribute}],
_filter=[{attribute}|{operator}|{valueAttribute}] ]ticketStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based. commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional afdDefinitionName O Name of the AFD-definition. commonFunctional afdDefinitionVersion O Version of the AFD-definition. 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.
Post your comment on this topic.