production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/channels/crp/branch-portfolio/customer-communication/units/performance
post /v1/channels/crp/branch-portfolio/customer-communication/units/performance
customer-communication-units-performance
This API retrieves porfolio indicators from mongo information
This API retrieves the mongo information
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
customerCommunicationUpRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/channels/crp/branch-portfolio/customer-communication/units/performance
/v2/channels/crp/branch-portfolios/customer-communications/units/performances/retrieve
post /v2/channels/crp/branch-portfolios/customer-communications/units/performances/retrieve
customer-communication-units-performance-v2
To retrieve the porfolio indicators from the mongo DB information for the customer communication unit performance.
This API is used to retrieve the porfolio indicators from the mongo DB information for the customer communication unit performance.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
customerCommunicationUnitsRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v2/channels/crp/branch-portfolios/customer-communications/units/performances/retrieve
/v1/channels/crp/branch-portfolio/customer-communication/amounts/performance
post /v1/channels/crp/branch-portfolio/customer-communication/amounts/performance
customer-communication-amounts-performance
This API retrieves porfolio indicators from mongo information
This API retrieves the mongo information
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
customerCommunicationRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/channels/crp/branch-portfolio/customer-communication/amounts/performance
/v2/channels/crp/branch-portfolios/customer-communications/amounts/performances/retrieve
post /v2/channels/crp/branch-portfolios/customer-communications/amounts/performances/retrieve
customer-communication-amounts-performance-v2
To retrieve the porfolio indicators from mongo DB information for the customer communication amounts performance
This API is used to retrieve the porfolio indicators from mongo DB information for the customer communication amounts performance
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
customerCommunicationAmountRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v2/channels/crp/branch-portfolios/customer-communications/amounts/performances/retrieve
Definitions
{
"type": "object",
"properties": {
"divisionCode": {
"description": "Division ID unique number to identify a Division in the Commercial Structure.",
"type": "string",
"example": "4567",
"maxLength": 10
},
"regionCode": {
"description": "Region ID unique number to identify a Region in the Commercial Structure.",
"type": "string",
"example": "1234",
"maxLength": 10
},
"marketCellCode": {
"description": "Market ID unique number to identify a Market in the Commercial Structure.",
"type": "string",
"example": "3008",
"maxLength": 10
},
"branchId": {
"description": "Branch SIRH unique number to identify a Branch in the Commercial Structure.",
"type": "string",
"example": "547",
"maxLength": 10
},
"segmentId": {
"description": "Type of segment asigned to the customer of the alert",
"type": "integer",
"format": "int32",
"example": 2,
"maxLength": 5
},
"agentType": {
"description": "Type of the banker assignment for the customer of the alert",
"type": "integer",
"format": "int32",
"example": 2,
"maxLength": 5
},
"expirationType": {
"description": "Type of the expiration of the alert based on the expiration date set for the aler",
"type": "integer",
"format": "int32",
"example": 2,
"maxLength": 5
},
"communicationId": {
"description": "The code to identify which type of alert it is",
"type": "integer",
"format": "int32",
"example": 2,
"maxLength": 5
},
"periodId": {
"description": "Period used to summarize the data as a snapshot",
"type": "integer",
"format": "int32",
"example": 2,
"maxLength": 5
},
"branchInfoOnly": {
"description": "Indicator to retrieve branch information Only",
"type": "boolean",
"example": "true"
},
"pageId": {
"description": "Page Id for pagination",
"type": "integer",
"example": 2
},
"pageSize": {
"description": "Number of records in current page",
"type": "integer",
"format": "int32",
"example": 10
}
}
}
{
"type": "object",
"properties": {
"pageId": {
"description": "Page Id for pagination",
"type": "integer",
"example": 2
},
"pageSize": {
"description": "Number of records in current page",
"type": "integer",
"format": "int32",
"example": 10
},
"totalRecords": {
"description": "Total records",
"type": "integer",
"format": "int32",
"example": 120
},
"totalPages": {
"description": "Total pages",
"type": "integer",
"format": "int32",
"example": 120
},
"executivePortfolioAmounts": {
"$ref": "#/definitions/CommunicationFollowUpAmounts"
}
}
}
{
"type": "array",
"items": {
"$ref": "#/definitions/CommunicationFollowUpAmount"
}
}
{
"type": "object",
"properties": {
"reportDate": {
"description": "Date to which the summary information is updated to.",
"type": "string",
"format": "date-time",
"example": "2019-04-29T23:25:45",
"maxLength": 20
},
"structureLevel": {
"$ref": "#/definitions/StructureLevel"
},
"amounts": {
"$ref": "#/definitions/Amounts"
}
}
}
{
"type": "object",
"properties": {
"totalAmount": {
"description": "Total amount corresponding to the alerts for the summary level of information.",
"type": "number",
"format": "double",
"example": 1564844806.46
},
"notWorkedAmount": {
"description": "Amount corresponding to the alerts in 'Not Worked' status for the summary level of information.",
"type": "number",
"format": "double",
"example": 1567980768
},
"notContactedAmount": {
"description": "Amount corresponding to the alerts in 'Not Contactable' status for the summary level of information.",
"type": "number",
"format": "double",
"example": 279100576.7
},
"notInterestedAmount": {
"description": "Amount corresponding to the alerts in 'Not Interested' status for the summary level of information.",
"type": "number",
"format": "double",
"example": 1406478748.9
},
"interestedAmount": {
"description": "Amount corresponding to the alerts in 'Interested' status for the summary level of information.",
"type": "number",
"format": "double",
"example": 714999230.21
},
"closedAmount": {
"description": "Amount corresponding to the alerts in 'Closed' status for the summary level of information.",
"type": "number",
"format": "double",
"example": 559769134.18
}
}
}
{
"type": "object",
"properties": {
"totalUnits": {
"description": "Total number of alerts for the summary level of information.",
"type": "integer",
"format": "int32",
"example": 1345789,
"maxLength": 9
},
"notWorkedUnits": {
"description": "Number of alerts in 'Not Worked' status for the summary level of information.",
"type": "integer",
"format": "int32",
"example": 1345789,
"maxLength": 9
},
"notContactedUnits": {
"description": "Number of alerts in 'Not Contactable' status for the summary level of information.",
"type": "integer",
"format": "int32",
"example": 1345789,
"maxLength": 9
},
"notInterestedUnits": {
"description": "Number of alerts in 'Not Interested' status for the summary level of information.",
"type": "integer",
"format": "int32",
"example": 1345789,
"maxLength": 9
},
"interestedUnits": {
"description": "Number of alerts in 'Interested' status for the summary level of information.",
"type": "integer",
"format": "int32",
"example": 1345789,
"maxLength": 9
},
"closedUnits": {
"description": "Number of customers with other insurance products in the portfolio.",
"type": "integer",
"format": "int32",
"example": 1345789,
"maxLength": 9
}
}
}
{
"type": "object",
"properties": {
"pageId": {
"description": "Page Id for pagination",
"type": "integer",
"format": "int32",
"example": 2
},
"pageSize": {
"description": "Number of records in current page",
"type": "integer",
"format": "int32",
"example": 10
},
"totalRecords": {
"description": "Total records",
"type": "integer",
"format": "int32",
"example": 120
},
"totalPages": {
"description": "Total pages",
"type": "integer",
"format": "int32",
"example": 120
},
"executivePortfolioUnits": {
"$ref": "#/definitions/CustomerCommunicationUpTotals"
}
}
}
{
"type": "array",
"items": {
"$ref": "#/definitions/CommunicationFollowUpUnits"
}
}
{
"type": "object",
"properties": {
"reportDate": {
"description": "Date to which the summary information is updated to.",
"type": "string",
"format": "date",
"example": "2019-04-29T23:25:45",
"maxLength": 20
},
"structureLevel": {
"$ref": "#/definitions/StructureLevel"
},
"units": {
"$ref": "#/definitions/Units"
}
}
}
{
"type": "object",
"properties": {
"divisionCode": {
"description": "Division ID unique number to identify a Division in the Commercial Structure.",
"type": "string",
"example": "4567"
},
"regionCode": {
"description": "Region ID unique number to identify a Region in the Commercial Structure.",
"type": "string",
"example": "1234"
},
"marketCellCode": {
"description": "Market ID unique number to identify a Market in the Commercial Structure.",
"type": "string",
"example": "3008"
},
"branchId": {
"description": "Branch SIRH unique number to identify a Branch in the Commercial Structure.",
"type": "string",
"example": "547"
},
"agentId": {
"description": "Executive SOEID unique employee to identify an Executive in the Commercial Structure.",
"type": "string",
"example": "SA61785"
}
}
}
{
"type": "object",
"properties": {
"pageId": {
"description": "Page Id for pagination",
"type": "integer",
"format": "int32",
"example": 2
},
"rowLimit": {
"description": "Number of records in current page",
"type": "integer",
"format": "int32",
"example": 10
},
"customerSegmentCode": {
"description": "Segment code of the customer. It'll contain numeric values to be mapped against a catalog in the front. Catalog descriptions can be as example: 'Priority', 'Citiblue', 'PYME'.",
"type": "string",
"example": "1",
"maxLength": 5
},
"agentTypeCode": {
"description": "Type of the banker assignment for the customer of the alert",
"type": "string",
"example": "3",
"maxLength": 5
},
"communicationTypeCode": {
"description": "The code to identify which type of communication it is",
"type": "string",
"example": "13",
"maxLength": 5
},
"communicationAmountRangeCode": {
"description": "The Amount for the communication in ranges. It'll contain numeric values to be mapped against a catalog in the front. Catalog descriptions can be as example: '$0 to $100,000', 'More than $500,000', etc.",
"type": "string",
"example": "1",
"maxLength": 5
},
"productEndDateCode": {
"description": "Expiry date of the product related in the communication. For example- for the Alerts for Fixed Term Investment Expirations, the relevant date is the date when the investment expires. It'll contain numeric values to be mapped against a catalog in the front. Catalog descriptions can be as example: 'Total', 'Today', 'Tomorrow', '2 to 5 days', 'More than 5 days'",
"type": "string",
"example": "1",
"maxLength": 5
},
"summaryPeriodCode": {
"description": "Month for which the summarized data has been retrieved. It'll contain numeric values to be mapped against a catalog in the front. Example- Current Month, last Month",
"type": "string",
"example": "2",
"maximum": 6
},
"branchOnlyFlag": {
"description": "Flag that indicates if only branch information is displayed",
"type": "boolean",
"example": true
},
"bankCommercialStructure": {
"$ref": "#/definitions/BankCommercialStructureDetail"
}
}
}
{
"type": "object",
"properties": {
"divisionCode": {
"description": "Division code to uniquely identify a Division in the Commercial Structure.",
"type": "string",
"example": "4567",
"maxLength": 4
},
"regionCode": {
"description": "Region code to uniquely identify a Region in the Commercial Structure.",
"type": "string",
"example": "1234",
"maxLength": 4
},
"marketCellCode": {
"description": "Market code to uniquely identify a Market in the Commercial Structure.",
"type": "string",
"example": "3008",
"maxLength": 4
},
"branchId": {
"description": "Branch SIRH unique number to identify a Branch in the Commercial Structure.",
"type": "string",
"example": "547",
"maxLength": 4
}
}
}
{
"type": "object",
"properties": {
"pageId": {
"description": "Page Id for pagination",
"type": "integer",
"format": "int32",
"example": 2
},
"rowLimit": {
"description": "Number of records in current page",
"type": "integer",
"format": "int32",
"example": 10
},
"recordCount": {
"description": "Total records",
"type": "integer",
"format": "int32",
"example": 120
},
"pageCount": {
"description": "Total pages",
"type": "integer",
"format": "int32",
"example": 120
},
"bankCommercialStructure": {
"type": "array",
"items": {
"$ref": "#/definitions/BankCommercialStructure"
}
}
}
}
{
"type": "object",
"properties": {
"divisionCode": {
"description": "Division code to uniquely identify a Division in the Commercial Structure.",
"type": "string",
"example": "6168"
},
"regionCode": {
"description": "Region code to uniquely identify a Region in the Commercial Structure.",
"type": "string",
"example": "7457"
},
"marketCellCode": {
"description": "Market code to uniquely identify a Market in the Commercial Structure.",
"type": "string",
"example": "8457"
},
"branchId": {
"description": "Unique identifier for the branch.",
"type": "string",
"example": "3032"
},
"agentId": {
"description": "SOEID of the agent.",
"type": "string",
"example": "PG12212"
},
"lastUpdatedTimestamp": {
"description": "Date on which the summary information was last updated.",
"type": "string",
"format": "date-time",
"example": "2019-04-29T23:25:45",
"maxLength": 20
},
"communication": {
"type": "array",
"items": {
"$ref": "#/definitions/CommunicationDetail"
}
}
}
}
{
"type": "object",
"properties": {
"communicationStatus": {
"description": "Describes the status of communication.",
"type": "string",
"example": "Not interested"
},
"communicationCount": {
"description": "Total number of communications having the same specified status",
"type": "integer",
"format": "int32",
"example": 45
}
}
}
{
"type": "object",
"properties": {
"pageId": {
"description": "Page Id for pagination",
"type": "integer",
"format": "int32",
"example": 2
},
"rowLimit": {
"description": "Number of records in current page",
"type": "integer",
"format": "int32",
"example": 10
},
"customerSegmentCode": {
"description": "Segment code of the customer. It'll contain numeric values to be mapped against a catalog in the front. Catalog descriptions can be as example: 'Priority', 'Citiblue', 'PYME'.",
"type": "string",
"example": "1",
"maxLength": 5
},
"agentTypeCode": {
"description": "Type of the banker assignment for the customer of the alert",
"type": "string",
"example": "3",
"maxLength": 5
},
"communicationTypeCode": {
"description": "The code to identify which type of alert it is",
"type": "string",
"example": "13",
"maxLength": 5
},
"communicationAmountRangeCode": {
"description": "Type of the Amount for the alert in ranges. It'll contain numeric values to be mapped against a catalog in the front. Catalog descriptions can be as example: '$0 a $100mil', 'Más de $500mil'",
"type": "string",
"example": "1",
"maxLength": 5
},
"productEndDateCode": {
"description": "Expiry date of the product related in the communication. For example- for the Alerts for Fixed Term Investment Expirations, the relevant date is the date when the investment expires. It'll contain numeric values to be mapped against a catalog in the front. Catalog descriptions can be as example: 'Total', 'Today', 'Tomorrow', '2 to 5 days', 'More than 5 days'",
"type": "string",
"example": "1",
"maxLength": 5
},
"summaryPeriodCode": {
"description": "Month for which the summarized data has been retrieved. It'll contain numeric values to be mapped against a catalog in the front. Example- Current Month, last Month",
"type": "string",
"example": "2",
"maximum": 6
},
"branchOnlyFlag": {
"description": "Flag that indicates if only branch information is displayed",
"type": "boolean",
"example": true
},
"bankCommercialStructure": {
"$ref": "#/definitions/BankCommercialStructureInformation"
}
}
}
{
"type": "object",
"properties": {
"divisionCode": {
"description": "Division code to uniquely identify a Division in the Commercial Structure.",
"type": "string",
"example": "4567",
"maxLength": 4
},
"regionCode": {
"description": "Region code to uniquely identify a Region in the Commercial Structure.",
"type": "string",
"example": "1234",
"maxLength": 4
},
"marketCellCode": {
"description": "Market code to uniquely identify a Market in the Commercial Structure.",
"type": "string",
"example": "3008",
"maxLength": 4
},
"branchId": {
"description": "Branch SIRH unique number to identify a Branch in the Commercial Structure.",
"type": "string",
"example": "547",
"maxLength": 4
}
}
}
{
"type": "object",
"properties": {
"pageId": {
"description": "Page Id for pagination",
"type": "integer",
"format": "int32",
"example": 2
},
"rowLimit": {
"description": "Number of records in current page",
"type": "integer",
"format": "int32",
"example": 10
},
"recordCount": {
"description": "Total records",
"type": "integer",
"format": "int32",
"example": 120
},
"pageCount": {
"description": "Total pages",
"type": "integer",
"format": "int32",
"example": 120
},
"bankCommercialStructure": {
"type": "array",
"items": {
"$ref": "#/definitions/BankCommercialStructureInfo"
}
}
}
}
{
"type": "object",
"properties": {
"divisionCode": {
"description": "Division code to uniquely identify a Division in the Commercial Structure.",
"type": "string",
"example": "6168"
},
"regionCode": {
"description": "Region code to uniquely identify a Region in the Commercial Structure.",
"type": "string",
"example": "7457"
},
"marketCellCode": {
"description": "Market code to uniquely identify a Market in the Commercial Structure.",
"type": "string",
"example": "8457"
},
"branchId": {
"description": "Unique identifier for the branch.",
"type": "string",
"example": "3032"
},
"agentId": {
"description": "SOEID of the agent.",
"type": "string",
"example": "PG12212"
},
"lastUpdatedTimestamp": {
"description": "Date on which the summary information was last updated.",
"type": "string",
"format": "date-time",
"example": "2019-04-29T23:25:45",
"maxLength": 20
},
"communication": {
"type": "array",
"items": {
"$ref": "#/definitions/CommunicationInfo"
}
}
}
}
{
"type": "object",
"properties": {
"communicationStatus": {
"description": "Describes the status of communication.",
"type": "string",
"example": "Without work"
},
"communicationAmount": {
"description": "The amount of communication corresponding to this status",
"type": "number",
"format": "double",
"example": 1567980768.12
}
}
}
{
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "More Info can be used to pass any additional details",
"type": "string"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}