FaultTicket

Extends: TroubleTicket

Field Required Nullable Type Description Constraints Example

Field	Required	Nullable	Type	Description	Constraints	Example
`@type`	Yes	No	`String`	When sub-classing, this defines the sub-class Extensible name
`@baseType`	No	No	`String`	When sub-classing, this defines the super-class
`@schemaLocation`	No	No	`String`	A URI to a JSON-Schema file that defines additional attributes and relationships
`id`	No	No	`String`	Unique identifier		2d7ed5fd-9f62-4211-bc84-357f5f7b80f5
`href`	No	No	`URI`	Hyperlink reference		https://api.example.org/resource/id
`name`	No	No	`String`	Name of the trouble ticket, typically a short description provided by the user that create the ticket
`description`	No	No	`String`
`orderPostedDate`	Yes	No	`DateTime`	Date when the order was posted by the requester		2023-01-01T08:00:00+01:00
`severity`	No	No	`String`	The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. Severity values can be for example : Critical, Major, Minor
`ticketType`	Yes	No	`String`
`attachment`	No	No	`array` of AttachmentRefOrValue	File(s) attached to the trouble ticket. e.g. picture of broken device, scaning of a bill or charge
`channel`	No	No	ChannelRef
`creationDate`	No	No	`DateTime`	The date on which the trouble ticket was created
`requestedResolutionDate`	No	No	`DateTime`	The resolution date requested by the user
`expectedResolutionDate`	No	No	`DateTime`	The expected resolution date determined by the trouble ticket system
`resolutionDate`	No	No	`DateTime`	The date and time the trouble ticket was resolved
`externalIdentifier`	Yes	No	`array` of ExternalIdentifier
`lastUpdate`	No	No	`DateTime`	The date and time that the trouble ticket was last updated
`note`	No	No	`array` of TroubleTicketRemark	The note(s) that are associated to the ticket.
`priority`	No	No	`String`	The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc…
`relatedEntity`	No	No	`array` of RelatedEntityRefOrValue	An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated.
`relatedParty`	No	No	`array` of RelatedPartyOrPartyRole	The related party(ies) that are associated to the ticket.
`status`	No	No	`TroubleTicketStatusType`
`statusChangeDate`	No	No	`DateTime`	The date and time the status changed.
`statusChangeMessage`	No	No	`array` of Message	Message for the status change described as a combination of a text and a code.
`statusChangeHistory`	No	No	`array` of StatusChange	The status change history that are associated to the ticket. Populated by the server
`troubleTicketRelationship`	No	No	`array` of TroubleTicketRelationship	A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets
`troubleTicketCharacteristic`	No	No	`array` of Characteristic	List of characteristics of the trouble ticket
`troubleTicketJeopardyAlert`	No	No	`array` of TroubleTicketJeopardyAlert	List of TroubleTicketJeopardyAlerts. A TroubleTicketJeopardyAlert represents a predicted exception during a trouble ticket processing that would brings risk to resolve successfully the trouble ticket.
`troubleTicketMilestone`	No	No	`array` of TroubleTicketMilestone	List of TroubleTicketMilestones. A TroubleTicketMilestone represents an action or event marking a significant change or stage in processing of a trouble ticket.
`troubleTicketSpecification`	No	No	TroubleTicketSpecificationRef
`ticketIsChargingRelevant`	No	No	`Boolean`	Boolean amended by the provider defining if the processing of the TroubleTicket is charging relevant		false
`accessLineId`	No	No	`String`	Technical identifier for a physical connection		DEU.DTAG.FTYLIQ7PFT
`agreement`	Yes	No	`array` of AgreementRefOrValue	A reference to an agreement defined in the context of the product order
`endUserContactAllowed`	No	No	`Boolean`	Defines if direct contact with end user is allowed
`endUserAppointmentIsNecessary`	No	No	`Boolean`	Defines if an appointment with the endUser is necessary
`expressFaultResolution`	No	No	`ExpressFaultResolutionType`
`faultQuestionnaire`	No	No	`array` of QuestionAnswer	An array of questions and answers	minimum items `0`; maximum items `99`;
`interimMessagesRequested`	No	No	`Boolean`	Defines if interim messages are requested to be provided
`networkTerminationLocation`	No	No	`String`	Describes the location of the network termination in the building		Flur
`resolutionDisputeReason`	No	No	`String`	Indicates the reason why the resolution of the trouble ticket is disputed
`requestedTimeSlot`	No	No	TimeSlot
`appointment`	No	No	AppointmentRefOrValue
`categoryId`	No	No	`String`	Identifier of the trouble ticket category
`billingItem`	No	No	`array` of `String`	Array/List of billing items	minimum items `0`; maximum items `99`;

@type

Yes

String

When sub-classing, this defines the sub-class Extensible name

@baseType

String

When sub-classing, this defines the super-class

@schemaLocation

String

A URI to a JSON-Schema file that defines additional attributes and relationships

id

String

Unique identifier

2d7ed5fd-9f62-4211-bc84-357f5f7b80f5

href

URI

Hyperlink reference

https://api.example.org/resource/id

name

String

Name of the trouble ticket, typically a short description provided by the user that create the ticket

description

String

orderPostedDate

Yes

DateTime

Date when the order was posted by the requester

2023-01-01T08:00:00+01:00

severity

String

The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. Severity values can be for example : Critical, Major, Minor

ticketType

Yes

String

attachment

array of AttachmentRefOrValue

File(s) attached to the trouble ticket. e.g. picture of broken device, scaning of a bill or charge

channel

ChannelRef

creationDate

DateTime

The date on which the trouble ticket was created

requestedResolutionDate

DateTime

The resolution date requested by the user

expectedResolutionDate

DateTime

The expected resolution date determined by the trouble ticket system

resolutionDate

DateTime

The date and time the trouble ticket was resolved

externalIdentifier

Yes

array of ExternalIdentifier

lastUpdate

DateTime

The date and time that the trouble ticket was last updated

note

array of TroubleTicketRemark

The note(s) that are associated to the ticket.

priority

String

The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc…

relatedEntity

array of RelatedEntityRefOrValue

An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated.

relatedParty

array of RelatedPartyOrPartyRole

The related party(ies) that are associated to the ticket.

status

TroubleTicketStatusType

statusChangeDate

DateTime

The date and time the status changed.

statusChangeMessage

array of Message

Message for the status change described as a combination of a text and a code.

statusChangeHistory

array of StatusChange

The status change history that are associated to the ticket. Populated by the server

troubleTicketRelationship

array of TroubleTicketRelationship

A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets

troubleTicketCharacteristic

array of Characteristic

List of characteristics of the trouble ticket

troubleTicketJeopardyAlert

array of TroubleTicketJeopardyAlert

List of TroubleTicketJeopardyAlerts. A TroubleTicketJeopardyAlert represents a predicted exception during a trouble ticket processing that would brings risk to resolve successfully the trouble ticket.

troubleTicketMilestone

array of TroubleTicketMilestone

List of TroubleTicketMilestones. A TroubleTicketMilestone represents an action or event marking a significant change or stage in processing of a trouble ticket.

troubleTicketSpecification

TroubleTicketSpecificationRef

ticketIsChargingRelevant

Boolean

Boolean amended by the provider defining if the processing of the TroubleTicket is charging relevant

false

accessLineId

String

Technical identifier for a physical connection

DEU.DTAG.FTYLIQ7PFT

agreement

Yes

array of AgreementRefOrValue

A reference to an agreement defined in the context of the product order

endUserContactAllowed

Boolean

Defines if direct contact with end user is allowed

endUserAppointmentIsNecessary

Boolean

Defines if an appointment with the endUser is necessary

expressFaultResolution

ExpressFaultResolutionType

faultQuestionnaire

array of QuestionAnswer

An array of questions and answers

minimum items 0; maximum items 99;

interimMessagesRequested

Boolean

Defines if interim messages are requested to be provided

networkTerminationLocation

String

Describes the location of the network termination in the building

Flur

resolutionDisputeReason

String

Indicates the reason why the resolution of the trouble ticket is disputed

requestedTimeSlot

TimeSlot

appointment

AppointmentRefOrValue

categoryId

String

Identifier of the trouble ticket category

billingItem

array of String

Array/List of billing items

minimum items 0; maximum items 99;