API Overview Resources Schemas

Schemas

troubleTicketResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "ticketId": "RED-84",
  "mirrorKey": "ONV-1024",
  "baseTroubleTicketState": "OPENACTIVE",
  "dialog": "ERI_MM_OLTZ3562010LAP012_para que se revise",
  "troubleType": "FTTH_PROVISION_RANGED_NO_NAVEGA",
  "troubleDescription": "ONT sincronizado, pero no navega.",
  "troubleDectectionTime": "2020-09-15T00:00:00Z",
  "preferredPriority": 1,
  "troubledObject": "CTO",
  "customerTroubleNum": "O99999999999/M9999999999",
  "wh1Parameter": "Red",
  "customer": 100
}

Name	Type	Required	Description
ticketId	string	false	none
mirrorKey	string	false	none
baseTroubleTicketState	string	false	none
dialog	string	false	none
troubleType	string	false	none
troubleDescription	string	false	none
troubleDectectionTime	string	false	none
preferredPriority	integer	false	none
troubledObject	string	false	none
customerTroubleNum	string	false	none
wh1Parameter	string	false	none
customer	string	false	none

updateTroubleTicketByValueRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "baseTroubleTicketState": "OPENACTIVE",
  "ticketId": "string",
  "mirrorKey": "string",
  "dialog": "string",
  "closeOutType": "string",
  "closeOutNarr": "string",
  "serviceRestoredTime": "2019-08-24T14:15:22Z",
  "customer": 0
}

Name	Type	Required	Description
baseTroubleTicketState	string	false	trouble ticket status
ticketId	string	true	id assigned to the trouble ticket in the TO systen
mirrorKey	string	true	id assigned to the trouble ticket in the TU systen
dialog	string	true	information about the issue
closeOutType	string	true	Resolution typifications agreed
closeOutNarr	string	true	Real typification
serviceRestoredTime	string(date-time)	true	resolution date time
customer	integer	false	clients number affected

Property	Values
baseTroubleTicketState	one of [OPENACTIVE, DEFERRED.AWAITING-CANCELATION, DEFERRED.AWAITING-INFORMATION, CLOSED.CANCELED, CLOSED, CLEARED]

createTroubleTicketByValueRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


{
  "baseTroubleTicketState": "OPENACTIVE",
  "mirrorKey": "string",
  "dialog": "string",
  "troubleType": "string",
  "troubleDescription": "string",
  "troubleDetectionTime": "2019-08-24T14:15:22Z",
  "preferredPriority": 1,
  "troubledObject": "string",
  "customerTroubleNum": "string",
  "homeId": "string",
  "gescal37ID": "string",
  "wh1Parameter": "cliente",
  "wh2Parameter": "string",
  "wh3Parameter": "string",
  "wh4Parameter": "string",
  "wh5Parameter": "string",
  "customer": "string",
  "clearencePerson": "string"
}

Name	Type	Required	Description
baseTroubleTicketState	string	true	trouble ticket status
mirrorKey	string	true	trouble ticket id in TU ( territory user)
dialog	string	true	information about the issue
troubleType	string	true	agreed opening typifications
troubleDescription	string	true	short description about issue
troubleDetectionTime	string(date-time)	true	issue dectention datetime
preferredPriority	integer(integer)	true	issue severity level. Level 1 more than 200 clients , level 2 between 65 & 200 and level 3 between 10 & 65)
troubledObject	string	true	affected object
customerTroubleNum	string	true	affected client identifier
homeId	string	false	client home identifier. This field is required when issue type is client and IUA is not ready.
gescal37ID	string	false	Gescal 37 indetifier
wh1Parameter	string	true	issue type (client
wh2Parameter	string	false	generic field
wh3Parameter	string	false	generic field
wh4Parameter	string	false	generic field
wh5Parameter	string	false	generic field
customer	string	false	number of clients affected
clearencePerson	string	true	remote agent indentifier

Property	Values
baseTroubleTicketState	one of [OPENACTIVE]
preferredPriority	one of [1, 2, 3]
wh1Parameter	one of [cliente, red]

attachmentBase64

1
2
3
4
5


{
  "content": "string",
  "mimeType": "string",
  "name": "string"
}

Name	Type	Required	Description
content	string	false	The actual contents of the attachment object, if embedded, encoded as base64
mimeType	string	false	Attachment mime type such as extension file for video, picture and document
name	string	false	The name of the attachment

createTroubleTicketResponse

1
2
3
4


{
  "ticketId": "RED-84",
  "mirrorKey": "ONV-1024"
}

Name	Type	Required	Description
ticketId	string	false	none
mirrorKey	string	false	none

updateTroubleTicketResponse

1
2
3
4
5
6
7
8
9


{
  "ticketId": "RED-84",
  "dialog": "This is a comment example",
  "troubleType": "FTTH_INS_CTO INACCESIBLE",
  "troubleDescription": "trouble description example",
  "preferredPriority": "4",
  "customerTroubleNum": "O99999990",
  "wh1Parameter": "Incidencia Mutualizada"
}

Name	Type	Required	Description
ticketId	string	false	none
dialog	string	false	none
troubleType	string	false	none
troubleDescription	string	false	none
preferredPriority	string	false	none
customerTroubleNum	string	false	none
wh1Parameter	string	false	none

OssIllegalArgumentException

1
2
3


{
  "illegalArgumentException": "required fields: baseTroubleTicketState,mirrorKey,dialog"
}

Name	Type	Required	Description
illegalArgumentException	string	false	none

RemoteException

1
2
3


{
  "remoteException": "The field subcategory is not defined in created screen"
}

Name	Type	Required	Description
remoteException	string	false	none

ObjectNotFounException

1

"Issue not found"

None

error400

1
2
3
4
5
6


{
  "code": "0015",
  "status": "Bad Request",
  "message": "message about the error",
  "detailMsg": "detail message about the error"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

TOClosesTicketDueToWarrantyExpirationExample

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "baseTroubleTicketState": "CLOSED",
  "ticketId": "PROV-53625",
  "mirrorKey": "AFTTH-63972",
  "dialog": "Closed by warranty expired due Lyntia has not recieve a response from TU in the last 96 hours.",
  "closeOutType": "FTTH_REVENTA_OTROS",
  "closeOutNarr": "FTTH_REVENTA_OTROS",
  "serviceRestoredTime": "2023-11-27T13:59:00Z",
  "preferredPriority": -1,
  "clearancePerson": "RedeAberta"
}

Name	Type	Required	Description
baseTroubleTicketState	string	false	none
ticketId	string	false	none
mirrorKey	string	false	none
dialog	string	false	none
closeOutType	string	false	none
closeOutNarr	string	false	none
serviceRestoredTime	string	false	none
preferredPriority	integer	false	none
clearancePerson	string	false	none

TOCancellationRequestExample

1
2
3
4
5
6
7
8


{
  "baseTroubleTicketState": "DEFERRED.AWAITING-CANCELATION",
  "ticketId": "INST-577117",
  "mirrorKey": "AFTTH-65956",
  "dialog": "incidencia duplicada y repetida",
  "preferredPriority": -1,
  "clearancePerson": "RedeAberta"
}

Name	Type	Required	Description
baseTroubleTicketState	string	false	none
ticketId	string	false	none
mirrorKey	string	false	none
dialog	string	false	none
preferredPriority	integer	false	none
clearancePerson	string	false	none

TOResolutionRequestExample

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "baseTroubleTicketState": "CLEARED",
  "mirrorKey": "AFTTH-66575",
  "ticketId": "PROV-54374",
  "dialog": "Buenas tardes,\r\n\r\nEs necesario que para poder tramitar la incidencia nos indiquéis el ID Home afectado \r\n\r\n¿podéis facilitárnoslo para poder realizar la gestión?\r\n\r\nUn saludo ",
  "clearancePerson": "RedeAberta",
  "closeOutType": "FTTH_REVENTA_OTROS",
  "closeOutNarr": "FTTH_REVENTA_OTROS",
  "serviceRestoredTime": "2023-12-12T17:49:00Z"
}

Name	Type	Required	Description
baseTroubleTicketState	string	false	none
mirrorKey	string	false	none
ticketId	string	false	none
dialog	string	false	none
clearancePerson	string	false	none
closeOutType	string	false	none
closeOutNarr	string	false	none
serviceRestoredTime	string	false	none

TOResolutionRequestWithAttachmentsExample

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


{
  "baseTroubleTicketState": "CLEARED",
  "ticketId": "INST-585439",
  "mirrorKey": "MM-12574",
  "dialog": "Enviamos información de CTO actual y cercanas.",
  "closeOutType": "FTTH_REVENTA_ENVIO_INFORMACION",
  "closeOutNarr": "FTTH_INS_CTO ILOCALIZABLE",
  "serviceRestoredTime": "2023-12-12T17:12:00Z",
  "attachments": [
    {
      "content": "base 64 file content",
      "mimeType": "null",
      "name": "cto_actual_009.jpg"
    },
    {
      "content": "base 64 file content",
      "mimeType": "null",
      "name": "cto_013.jpg"
    }
  ],
  "clearancePerson": "RedeAberta"
}

Name	Type	Required	Description
baseTroubleTicketState	string	false	none
ticketId	string	false	none
mirrorKey	string	false	none
dialog	string	false	none
closeOutType	string	false	none
closeOutNarr	string	false	none
serviceRestoredTime	string	false	none
attachments	[attachmentBase64]	false	[An attachment.]
clearancePerson	string	false	none

TOInformationRequestExample

1
2
3
4
5
6
7
8


{
  "baseTroubleTicketState": "DEFERRED.AWAITING-INFORMATION",
  "ticketId": "ATC-2088604",
  "mirrorKey": "AFTTH-65548",
  "dialog": "Buenas tardes,\r\nSolo viene fotos, no hay fichero para poder generar y cargar en ILR\r\n\r\nSaludos\r\nAlfonso",
  "preferredPriority": -1,
  "clearancePerson": "RedeAberta"
}

Name	Type	Required	Description
baseTroubleTicketState	string	false	none
ticketId	string	false	none
mirrorKey	string	false	none
dialog	string	false	none
preferredPriority	integer	false	none
clearancePerson	string	false	none

TURejectsCancellationRequestExample

1
2
3
4
5
6
7


{
  "baseTroubleTicketState": "OPENACTIVE",
  "ticketId": "<write here ticket Id from TO>",
  "mirrorKey": "<write here ticket id from TU>",
  "dialog": "<write here the detailed information about the reject cancellation>",
  "clearancePerson": "Remote Agent"
}

Name	Type	Required	Description
baseTroubleTicketState	string	false	none
ticketId	string	false	none
mirrorKey	string	false	none
dialog	string	false	none
clearancePerson	string	false	none

TURejectsTicketResolutionExample

1
2
3
4
5
6


{
  "baseTroubleTicketState": "OPENACTIVE",
  "ticketId": "<write here ticket Id from TO>",
  "mirrorKey": "<write here ticket id from TU>",
  "dialog": "<write here the detailed information about the reject ticket resolution>"
}

Name	Type	Required	Description
baseTroubleTicketState	string	false	none
ticketId	string	false	none
mirrorKey	string	false	none
dialog	string	false	none

TUSendsAdditionalInformationExample

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "baseTroubleTicketState": "OPENACTIVE",
  "ticketId": "<write here ticket Id from TO>",
  "mirrorKey": "<write here ticket id from TU>",
  "dialog": "<write here additional information>",
  "attachments": [
    {
      "content": "ZmlsZSBudW1iZXIgMQ==",
      "mimeType": "text/plain",
      "name": "file1.txt"
    },
    {
      "content": "ZmlsZSBudW1iZXIgMQ==",
      "mimeType": "text/plain",
      "name": "file2.txt"
    }
  ]
}

Name	Type	Required	Description
baseTroubleTicketState	string	false	none
ticketId	string	false	none
mirrorKey	string	false	none
dialog	string	false	none
attachments	[attachmentBase64]	false	[An attachment.]

TUClosesTicketExample

1
2
3
4
5
6


{
  "baseTroubleTicketState": "CLOSED",
  "ticketId": "<write here ticket Id from TO>",
  "mirrorKey": "<write here ticket id from TU>",
  "dialog": "<write here additional information if needed>"
}

Name	Type	Required	Description
baseTroubleTicketState	string	false	none
ticketId	string	false	none
mirrorKey	string	false	none
dialog	string	false	none

TUSendsAdditionalInformationWithoutStatusChangeExample

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


{
  "ticketId": "<write here ticket Id from TO>",
  "mirrorKey": "<write here ticket id from TU>",
  "dialog": "<write here issue information must be in the ticket>",
  "attachments": [
    {
      "content": "ZmlsZSBudW1iZXIgMQ==",
      "mimeType": "text/plain",
      "name": "file1.txt"
    },
    {
      "content": "ZmlsZSBudW1iZXIgMQ==",
      "mimeType": "text/plain",
      "name": "file2.txt"
    }
  ]
}

Name	Type	Required	Description
ticketId	string	false	none
mirrorKey	string	false	none
dialog	string	false	none
attachments	[attachmentBase64]	false	[An attachment.]

TUCancelsTicketExample

1
2
3
4
5
6


{
  "baseTroubleTicketState": "CLOSED.CANCELED",
  "ticketId": "<write here ticket Id from TO>",
  "mirrorKey": "<write here ticket id from TU>",
  "dialog": "<write here issue information must be in the ticket>"
}

Name	Type	Required	Description
baseTroubleTicketState	string	false	none
ticketId	string	false	none
mirrorKey	string	false	none
dialog	string	false	none