Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Scribd
Upload
31 views

Complaints Microservice Api: Data Structures

This document describes the data structures and API for a complaints microservice. It defines objects for the client, complaint, product, and complaint details. It also documents a POST request to submit a new complaint with examples of the request body and successful/error response bodies.

Uploaded by

Abilio Cáceres Curo
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
31 views

Complaints Microservice Api: Data Structures

This document describes the data structures and API for a complaints microservice. It defines objects for the client, complaint, product, and complaint details. It also documents a POST request to submit a new complaint with examples of the request body and successful/error response bodies.

Uploaded by

Abilio Cáceres Curo
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4

FORMAT: 1A HOST: https://theshire-complaints:8080

Complaints MicroService API


Data Structures

RequestComplaints(object)
client(object[Client])
requestComplaint(object[RequestComplaint])
product(object[Product])
ComplaintDetailList(List)

Client (object)
uniqueCode (String)
clientName (String)
clientLastName(String)
documentType (String)
documentNumber(String)
sex(String)
emailAddress (String)
mobileCarrier (String)
mobileNumber (String)
personType(Enum[String])

Complaint(object)
requestType(string)
subResquetType(datetime)
motiveCode(string)
circuitCode(string)
requestInformation(string)
complaintCode (String)

Product(object)
productCode(String)

productCodeType(String)

cardNumber (String)

accountCardNumber(String)
productObservation(String)

ComplaintDetail(object)
complaintName(String)
compalintValue(String)

ComplaintDetailList (List)
complaintDetailList (List)

personType(enum[string])
Members

Metadata (object)
key(string)
value(string)

Request Complaints [POST /complaints/request/v1 ]


Request (application/json)

Headers

serviceId : SRM
consumerId : BPI
moduleId : ORQASOCIADOS
channelCode : 02
messageId : RASW201907050942
timestamp : 2018-08-03T18:37:07.193
countryCode : PE
groupMember : G0003
referenceNumber : 01153
netId : BI
userId : BPIB0001
supervisorId : BPIB0001
deviceId : 10.10.26.154
serverId : SERVER01
branchCode : 898
 

Parameters

Body

{
"client": {
"uniqueCode": "00000050043667",
"documentType": "01",
"documentNumber": "42187864",
"clientLastName": "TASAYCO FERREN",
"clientName": "LUIS TICO",
"sex": "M",
"emailAddress": "cuarso92@gmail.com",
"mobileCarrier": "M",
"mobileNumber": "965156854",
"personType": "F"
},
"complaint": {
"requestType": "13",
"subResquetType": "4",
"motiveCode" : "200",
"circuitCode" : "3",
"requestInformation": "UAT - Prueba de Nuevo WS de ALTA"
},
"product": {
"productCode": "002",
"productCodeType": "002",
"cardNumber": "4545787542136551",
"accountCardNumber": "20075923",
"productObservation": "Prueba WS de Alta UAT"
},
"ComplaintDetailList": {
"ComplaintDetail": [ {
  "complaintName": "NroCta",
  "compalintValue": "201346512"
  }, {
  "complaintName": "AdicNum1",
  "compalintValue": "1"
  }
]
}
}

 
Response 200 (application/json)

header

serviceId : SAT
consumerId : BPI
moduleId : ORQASOCIADOS
channelCode : 02
messageId : RASW201907050942
timestamp : 05/07/2019 09:38:28
countryCode : PE
groupMember : G0003
referenceNumber : 01153
responseType : 0
busResponseCode : 0
busResponseMessage : EJECUCION CON EXITO
srvResponseCode : 00
srvResponseMessage :
eqvResponseCode :
eqvResponseMessage :
messageIdResBus : SGI_UAT_0100c28c196b-a365-4a27-98c6-7afccd18a76c
apiResponseCode : 0
apiResponseMessage : EJECUCION EXITOSA
msResponseCode :
msResponseMessage :

Body

{
complaint":{
       "complaintCode":"77711"
  }
}

 
Response 404 (application/json)

Body

{
 "error": {
   "userMessage": "Resuqest and Complaints not found",
   "systemMessage": "Resuqest and Complaints not found",
   "code": "02.02.02"    
}
}

You might also like