tdevapigists
11/28/2017 - 11:19 AM
sqPresentation.js
{
"swagger": "2.0",
"info": {
"title": "Service Qualification API",
"description": "This is an API that services for the given Location ID",
"version": "1.0.0",
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"host": "api.telstra.com",
"basePath": "/v1/service-qualification",
"schemes": [
"https"
],
"paths": {
"/service-addresses": {
"get": {
"operationId": "Get Services Available",
"summary": "Get the details based of services and MSQ available based on ADBoR ID ",
"description": "The service is to list the (NBN and NON-NBN) services available for a particular service address requested by the customer, via NBN Co in order to determine availability of NBN services and via Legacy/Core systems to determine availability of non-NBN services",
"produces": [
"application/json"
],
"parameters": [{
"name": "Authorization",
"in": "header",
"description": "A header in the format 'Bearer {access_token}' - get the token by using the OAuth API with the scope 'SQ'",
"type": "string",
"required": true
},
{
"name": "addressId",
"in": "query",
"description": "Address ID",
"type": "string",
"required": true
},
{
"name": "customerAuthorityDate",
"in": "query",
"description": "Customer Authority Date",
"type": "string",
"required": false
},
{
"name": "tc2Required",
"in": "query",
"description": "TC2 Required Indicator",
"type": "boolean",
"required": false
},
{
"name": "customerProfile",
"in": "query",
"description": "Customer profile(Retail/Wholesale)",
"type": "string",
"required": false
}
],
"tags": [
"Service Qualification"
],
"responses": {
"200": {
"description": "Success message. Response OK",
"schema": {
"$ref": "#/definitions/locationDetailsResponse"
}
},
"400": {
"description": "Invalid Request or bad input.",
"schema": {
"$ref": "#/definitions/locationDetailsApigeeError"
}
},
"401": {
"description": "Invalid or no credentials passed in the request",
"schema": {
"$ref": "#/definitions/locationDetailsApigeeError"
}
},
"404": {
"description": "The request URI does not exist",
"schema": {
"$ref": "#/definitions/locationDetailsSystemError"
}
},
"405": {
"description": "Method not allowed",
"schema": {
"$ref": "#/definitions/locationDetailsSystemError"
}
},
"500": {
"description": "An internal error occurred when processing the request",
"schema": {
"$ref": "#/definitions/locationDetailsError"
}
},
"503": {
"description": "A technical error occurred during the processing of this request by downstream system",
"schema": {
"$ref": "#/definitions/locationDetailsError"
}
}
},
"security": []
}
},
"/service-migration-qualification-details/retail": {
"post": {
"operationId": "service qualification for post",
"summary": "Get the details of services available based on address ID and FNN",
"description": "Business micro service that will execute business rules for service qualification and orchestrates calls between address and NBN site qualification services",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [{
"name": "Authorization",
"in": "header",
"description": "A header in the format 'Bearer {access_token}' - get the token by using the OAuth API with the scope 'NBNSEQ'",
"type": "string",
"required": true
},
{
"name": "request",
"in": "body",
"description": "Request body",
"required": true,
"schema": {
"$ref": "#/definitions/body"
}
}
],
"tags": [
"Service Qualification"
],
"responses": {
"200": {
"description": "SQ check = SUCCESSFUL",
"schema": {
"$ref": "#/definitions/serviceQualificationResponsePost"
}
},
"422": {
"description": "invalid input",
"schema": {
"$ref": "#/definitions/serviceQualificationError"
}
},
"500": {
"description": "LOC ID for ADBOR ID not found or techtype is not FTTN or copper pair block information not available or matching copper pair not found or matching copper pair SC is not 12 or Copper pair status not active",
"schema": {
"$ref": "#/definitions/serviceQualificationError"
}
},
"502": {
"description": "ADDR MICROSERVICE error or Core system or NBN MICROSERVICE error",
"schema": {
"$ref": "#/definitions/serviceQualificationError"
}
}
},
"security": [{
"OAuth2": [
"NBNSEQ"
]
}]
},
"get": {
"operationId": "service qualification for get",
"summary": "Get the details of services available based on address ID and FNN",
"description": "Business micro service that will execute business rules for service qualification and orchestrates calls between address and NBN site qualification services",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [{
"name": "Authorization",
"in": "header",
"description": "A header in the format 'Bearer {access_token}' - get the token by using the OAuth API with the scope 'NBNSEQ'",
"type": "string",
"required": true
},
{
"name": "addressId",
"in": "query",
"description": "Address ID",
"type": "string",
"required": true
},
{
"name": "FNN",
"in": "query",
"description": "FNN",
"type": "string",
"required": true
},
{
"name": "tc2Required",
"in": "query",
"description": "TC2 Required Indicator",
"type": "boolean",
"required": false
}
],
"tags": [
"Service Qualification"
],
"responses": {
"200": {
"description": "SQ check = SUCCESSFUL",
"schema": {
"$ref": "#/definitions/serviceQualificationResponseGet"
}
},
"422": {
"description": "invalid input",
"schema": {
"$ref": "#/definitions/serviceQualificationError"
}
},
"500": {
"description": "LOC ID for ADBOR ID not found or techtype is not FTTN or copper pair block information not available or matching copper pair not found or matching copper pair SC is not 12 or Copper pair status not active",
"schema": {
"$ref": "#/definitions/serviceQualificationError"
}
},
"502": {
"description": "ADDR MICROSERVICE error or Core system or NBN MICROSERVICE error",
"schema": {
"$ref": "#/definitions/serviceQualificationError"
}
}
},
"security": [{
"OAuth2": [
"NBNSEQ"
]
}]
}
}
},
"securityDefinitions": {
"OAuth2": {
"type": "oauth2",
"tokenUrl": "https:/api.in.telstra.com/v1/oauth/token",
"flow": "application",
"scopes": {
"NBNSEQ": "OAuth scope for the SQ API"
}
}
},
"definitions": {
"locationDetailsResponse": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "Response code for the message"
},
"status": {
"type": "integer",
"format": "int32",
"description": "HTTP status code"
},
"time": {
"type": "string",
"format": "date-time",
"description": "The date and time when the message was received by recipient."
},
"data": {
"type": "object",
"properties": {
"addressId": {
"type": "string",
"description": "Address id"
},
"unconditionedLocalLoop": {
"type": "array",
"description": "Unbundled LoopBack Details",
"items": {}
},
"productResourceIdentifierDetails": {
"type": "object",
"description": "Product Resource Identifier Details",
"properties": {
"productResourceIdentifierID": {
"type": "string",
"description": "Product Resource IdentifierID"
},
"nbnPriorityAssist": {
"type": "string",
"description": "NBN Priority Assist"
},
"serviceProviderId": {
"type": "string",
"description": "Service Provider Id"
},
"maxDownstreamSpeed": {
"type": "string",
"description": "Maximum Downstream Speed"
},
"maxUpstreamSpeed": {
"type": "string",
"description": "Maximum Upstream Speed"
},
"refCopperPairID": {
"type": "string",
"description": "Reference CopperPair ID"
}
}
},
"resourceDetails": {
"type": "array",
"description": "Resource Details",
"items": {}
},
"additionalTrafficClassAvailability": {
"type": "array",
"description": "Additional Traffic Class Availability",
"items": {}
},
"orderableTC2Capacity": {
"type": "array",
"description": "Optional Orderable TC2 Capacity",
"items": {}
},
"serviceTypeQualifications": {
"type": "array",
"description": "",
"items": {}
}
},
"description": "The response data received by the client."
},
"request": {
"type": "object",
"description": "Delivery status or metadata of the message"
},
"correlationId": {
"type": "string",
"description": "Correlation id of the message receieved"
}
},
"example": {
"code": 200,
"status": 200,
"time": "2017-11-16T18:38:28+11:00",
"data": {
"addressId": "444444525",
"serviceTypeQualifications": [
{
"serviceType": "Calling",
"technologyType": "Fibre To The Node",
"readyForServiceDate": "2009-12-10",
"serviceabilityClass": "13",
"newDevelopmentChargesApply": "No",
"locationId": "LOC000099111225",
"csaId": "CSA000216237702",
"demandType": "Standard Install",
"providerResources": [
{
"resourceType": "Copper Pair",
"id": "New Path",
"status": "",
"serviceabilityClass": "12"
}
],
"characteristics": [
{
"name": "Telephony Type",
"value": "IP Telephony"
}
],
"serviceTransferIndicator": "N",
"tc2EnabledCsa": true,
"priorityAssistApplicable": "No",
"appointmentRequired": "Yes",
"status": "Available",
"statusReason": "NBN Technology at this location only supports IP Telephony and NBN Lead-In is required to provide the services"
},
{
"serviceType": "Internet",
"technologyType": "Fibre To The Node",
"readyForServiceDate": "2009-12-10",
"serviceabilityClass": "13",
"newDevelopmentChargesApply": "No",
"locationId": "LOC000099111225",
"csaId": "CSA000216237702",
"demandType": "Standard Install",
"providerResources": [
{
"resourceType": "Copper Pair",
"id": "New Path",
"status": "",
"serviceabilityClass": "12"
}
],
"characteristics": [],
"serviceTransferIndicator": "N",
"appointmentRequired": "Yes",
"status": "Available",
"statusReason": "NBN Internet is serviceable at this address and NBN Lead-In is required to provide the services"
},
{
"serviceType": "Broadband ADSL",
"technologyType": "ADSL",
"status": "Available",
"statusReason": "BigPond Broadband ADSL is available",
"properties": {
"subStatus": "Y001",
"maxDownloadSpeed": "8000 kbps",
"minDownstreamSpeed":"1800 kbps",
"maxDownstreamSpeed":"6000 kbps",
"estimatedDownstreamSpeed":"4100 kbps"
}
},
{
"serviceType": "Broadband ADSL",
"technologyType": "ADSL2+",
"status": "Available",
"statusReason": "BigPond Broadband ADSL is available",
"properties": {
"subStatus": "Y001",
"maxDownloadSpeed": "24000 kbps",
"minDownstreamSpeed":"2100 kbps",
"maxDownstreamSpeed":"6400 kbps",
"estimatedDownstreamSpeed":"4500 kbps"
}
}
],
"orderableTC2Capacity": {
"maxBackhaul": "5Mbps",
"maxSpareCopperPair": "TC2 Not Supported"
},
"additionalTrafficClassAvailability": [
{
"name": "High Speed TC2 (greater or equal to 20Mbps)",
"value": false
},
{
"name": "NCAS TC2 5Mbps Capacity",
"value": true
},
{
"name": "NCAS TC2 10Mbps Capacity",
"value": false
},
{
"name": "NCAS TC2 20Mbps Capacity",
"value": false
},
{
"name": "NCAS TC2 30Mbps Capacity",
"value": false
},
{
"name": "NCAS TC2 40Mbps Capacity",
"value": false
},
{
"name": "NCAS TC1 High Speed Tiers (greater or equal to 2Mbps)",
"value": false
},
{
"name": "Multicast",
"value": false
}
],
"scheduledDates": {
"ceaseSaleDate": "",
"disconnectionDate": "",
"orderStabilityPeriodDate": ""
}
},
"request": {
"params": {
"addressId": "444444525",
"tc2Required": "true",
"customerProfile" : "Retail"
},
"data": {},
"path": "/service-addresses",
"method": "GET",
"requestId": "fee95c28-5910-46f2-b4cf-67b72c52e7d0",
"correlationId": "a2f539f7-36a5-46ad-a771-353c4b02c367"
},
"correlationId": "a2f539f7-36a5-46ad-a771-353c4b02c367"
}
},
"locationDetailsMSQError": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "Error code for the response."
},
"status": {
"type": "integer",
"format": "int32",
"description": "HTTP status."
},
"time": {
"type": "string",
"format": "date-time",
"description": "The timestamp of error message received by the client"
},
"errors": {
"type": "array",
"description": "The error details received by the client",
"items": {}
},
"request": {
"type": "object",
"description": "The error request metadata received by the client"
},
"correlationId": {
"type": "string",
"description": "Correlation Id received by the client"
}
},
"example": {
"code": 422,
"status": 422,
"time": "2017-08-01T12:01:36+00:00",
"errors": [{
"field": "addressId",
"message": "Required value.",
"code": 1000
}],
"request": {
"params": {},
"data": {
"correlationId":"1ea8f352-40ec-4596-bd81-2eb49948c41c",
"params": {
"consumerProfile": "Wholesale"
}
},
"path": "/servicequalification/resources/msq/sq1",
"method": "GET",
"requestId": "9524f18a-068b-43b9-8fd3-76a4347a28fd",
"correlationId": "84038e4f-a9e4-4eb5-9cf0-8c1c53947e50"
},
"correlationId": "84038e4f-a9e4-4eb5-9cf0-8c1c53947e50"
}
},
"locationDetailsError": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "Error code for the response."
},
"status": {
"type": "integer",
"format": "int32",
"description": "HTTP status."
},
"time": {
"type": "string",
"format": "date-time",
"description": "The timestamp of error message received by the client"
},
"errors": {
"type": "array",
"description": "The error details received by the client",
"items": {}
},
"request": {
"type": "object",
"description": "The error request metadata received by the client"
},
"correlationId": {
"type": "string",
"description": "Correlation Id received by the client"
}
},
"example": {
"code": 422,
"status": 422,
"time": "2017-08-01T12:01:36+00:00",
"errors": [{
"field": "addressId",
"message": "Required value.",
"code": 1000
}],
"request": {
"params": {
"addressId": ""
},
"data": {},
"path": "/service-addresses",
"method": "GET",
"requestId": "9524f18a-068b-43b9-8fd3-76a4347a28fd",
"correlationId": "84038e4f-a9e4-4eb5-9cf0-8c1c53947e50"
},
"correlationId": "84038e4f-a9e4-4eb5-9cf0-8c1c53947e50"
}
},
"locationDetailsSystemError": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "Error code for the response."
},
"message": {
"type": "string",
"description": "Error Message."
}
},
"example": {
"code": 405,
"message": "Method not supported"
}
},
"locationDetailsApigeeError": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "Error code for the response."
},
"status": {
"type": "integer",
"format": "int32",
"description": "HTTP status"
},
"timestamp": {
"type": "string",
"description": "Timestamp"
},
"message": {
"type": "string",
"description": "Error Message."
}
},
"example": {
"status": "401",
"code": "105004",
"timestamp": "2017-8-1T22:54:17.191+AEST",
"message": "Invalid token, authenticaton failed "
}
},
"body": {
"type": "object",
"required": [
"path",
"method",
"data"
],
"properties": {
"correlationId": {
"type": "integer",
"format": "int64"
},
"path": {
"type": "string",
"example": "/service-migration-qualification-details/retail"
},
"method": {
"type": "string",
"example": "post"
},
"data": {
"type": "object",
"properties": {
"addressId": {
"type": "string",
"example": "220682435"
},
"FNN": {
"type": "string",
"example": "0747748609"
}
}
}
}
},
"serviceQualificationResponsePost": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "response code for the message"
},
"time": {
"type": "string",
"format": "date-time",
"description": "The date and time when the message was received by recipient."
},
"data": {
"type": "object",
"properties": {
"serviceTypeQualifications": {
"type": "array",
"description": "array of service available",
"items": {
"type": "object",
"properties": {
"serviceType": {
"type": "string",
"description": ""
},
"status": {
"type": "string",
"description": ""
},
"technologyType": {
"type": "string",
"description": ""
},
"readyForServiceDate": {
"type": "string",
"description": ""
},
"serviceabilityClass": {
"type": "string",
"description": ""
},
"appointmentRequired": {
"type": "string",
"description": ""
},
"newDevelopmentChargesApply": {
"type": "string",
"description": ""
},
"locationId": {
"type": "string",
"description": ""
},
"csaId": {
"type": "string",
"description": ""
},
"characteristics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
}
}
}
},
"providerResources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"description": ""
},
"id": {
"type": "string",
"description": ""
},
"status": {
"type": "string",
"description": ""
},
"serviceabilityClass": {
"type": "string",
"description": ""
}
}
}
}
}
}
},
"correlationId": {
"type": "string",
"description": ""
}
},
"description": "The response data received by the client."
},
"request": {
"type": "object",
"description": "Delivery status or metadata of the message"
},
"correlationId": {
"type": "string",
"description": "Correlation id of the message receieved"
}
},
"example": {
"code": 5100,
"status": 200,
"time": "2017-08-22T08:04:40+00:00",
"data": {
"addressId": "444444709",
"serviceTypeQualifications": [{
"serviceType": "Calling",
"status": "Available",
"statusReason": "NBN Calling is serviceable at this address",
"technologyType": "Fibre",
"readyForServiceDate": "2009-12-10",
"serviceabilityClass": "1",
"locationId": "LOC000444444709",
"csaId": "CSA000216237702",
"appointmentRequired": "Yes",
"priortiyAssistApplicable": "No",
"demandType": "Standard Install",
"providerResources": [],
"characteristics": [],
"fullNationalNumber": "1234567890",
"tc2EnabledCsa": true
},
{
"serviceType": "Internet",
"status": "Available",
"statusReason": "NBN Internet is serviceable at this address",
"technologyType": "Fibre",
"readyForServiceDate": "2009-12-10",
"serviceabilityClass": "1",
"locationId": "LOC000444444709",
"csaId": "CSA000216237702",
"appointmentRequired": "Yes",
"priortiyAssistApplicable": "No",
"demandType": "Standard Install",
"providerResources": [],
"characteristics": [{
"name": "TC4 Downstream Upper Rate",
"value": "100Mbps"
},
{
"name": "TC4 Downstream Lower Rate",
"value": ""
},
{
"name": "TC4 Upstream Upper Rate",
"value": "40Mbps"
},
{
"name": "TC4 Upstream Lower Rate",
"value": ""
}
]
}
],
"additionalTrafficClassAvailability": [{
"name": "High Speed TC2 (greater or equal to 20Mbps)",
"value": false
},
{
"name": "TC2",
"value": false
},
{
"name": "NFAS TC2 5Mbps Capacity",
"value": false
},
{
"name": "NFAS TC2 10Mbps Capacity",
"value": false
},
{
"name": "NFAS TC2 20Mbps Capacity",
"value": false
},
{
"name": "NFAS TC2 30Mbps Capacity",
"value": false
},
{
"name": "NFAS TC2 40Mbps Capacity",
"value": false
}
],
"migration": false,
"reason": "Tech Type at Address ID 444444709 is not eligible for migration"
},
"request": {
"params": {},
"data": {
"addressId": "444444709",
"FNN": "1234567890"
},
"path": "/service-migration-qualification-details/retail",
"method": "POST",
"requestId": "31664632-5022-4916-b56a-eb590aa6de41",
"correlationId": "d826e11f-3c81-4e04-86b7-f106638fc751"
},
"correlationId": "d826e11f-3c81-4e04-86b7-f106638fc751"
}
},
"serviceQualificationResponseGet": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "response code for the message"
},
"time": {
"type": "string",
"format": "date-time",
"description": "The date and time when the message was received by recipient."
},
"data": {
"type": "object",
"properties": {
"serviceTypeQualifications": {
"type": "array",
"description": "array of service available",
"items": {
"type": "object",
"properties": {
"serviceType": {
"type": "string",
"description": ""
},
"status": {
"type": "string",
"description": ""
},
"technologyType": {
"type": "string",
"description": ""
},
"readyForServiceDate": {
"type": "string",
"description": ""
},
"serviceabilityClass": {
"type": "string",
"description": ""
},
"appointmentRequired": {
"type": "string",
"description": ""
},
"newDevelopmentChargesApply": {
"type": "string",
"description": ""
},
"locationId": {
"type": "string",
"description": ""
},
"csaId": {
"type": "string",
"description": ""
},
"characteristics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
}
}
}
},
"providerResources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"description": ""
},
"id": {
"type": "string",
"description": ""
},
"status": {
"type": "string",
"description": ""
},
"serviceabilityClass": {
"type": "string",
"description": ""
}
}
}
}
}
}
},
"orderableTC2Capacity": {
"type": "array",
"description": "Optional Orderable TC2 Capacity",
"items": {}
},
"correlationId": {
"type": "string",
"description": ""
}
},
"description": "The response data received by the client."
},
"request": {
"type": "object",
"description": "Delivery status or metadata of the message"
},
"correlationId": {
"type": "string",
"description": "Correlation id of the message receieved"
}
},
"example": {
"code": 200,
"status": 200,
"time": "2017-11-16T20:40:24+11:00",
"data": {
"addressId": "444444702",
"serviceTypeQualifications": [
{
"serviceType": "Calling",
"status": "Available",
"statusReason": "NBN Technology at this location only supports IP Telephony",
"technologyType": "Fibre To The Node",
"readyForServiceDate": "2009-12-10",
"serviceabilityClass": "13",
"newDevelopmentChargesApply": "No",
"locationId": "LOC000444444702",
"csaId": "CSA400000010875",
"appointmentRequired": "Yes",
"priorityAssistApplicable": "No",
"demandType": "Non EU Jumper Only",
"providerResources": [
{
"resourceType": "Copper Pair",
"id": "CPI300000891117",
"serviceabilityClass": "12",
"status": "Active"
}
],
"characteristics": [
{
"name": "Telephony Type",
"value": "IP Telephony"
}
],
"tc2EnabledCsa": true
},
{
"serviceType": "Internet",
"status": "Available",
"statusReason": "NBN Internet is serviceable at this address",
"technologyType": "Fibre To The Node",
"readyForServiceDate": "2009-12-10",
"serviceabilityClass": "13",
"newDevelopmentChargesApply": "No",
"locationId": "LOC000444444702",
"csaId": "CSA400000010875",
"appointmentRequired": "Yes",
"demandType": "Non EU Jumper Only",
"providerResources": [
{
"resourceType": "Copper Pair",
"id": "CPI300000891117",
"serviceabilityClass": "12",
"status": "Active"
}
]
}
],
"orderableTC2Capacity": {
"maxBackhaul": "20Mbps",
"maxSpareCopperPair": "TC2 Not Supported",
"maxTransitioningCopperPair": "TC2 Not Supported"
},
"additionalTrafficClassAvailability": [
{
"name": "Multicast",
"value": false
},
{
"name": "NCAS TC1 High Speed Tiers (greater or equal to 2Mbps)",
"value": true
},
{
"name": "High Speed TC2 (greater or equal to 20Mbps)",
"value": true
},
{
"name": "NCAS TC2 5Mbps Capacity",
"value": true
},
{
"name": "NCAS TC2 20Mbps Capacity",
"value": true
},
{
"name": "NCAS TC2 10Mbps Capacity",
"value": true
},
{
"name": "NCAS TC2 40Mbps Capacity",
"value": false
},
{
"name": "NCAS TC2 30Mbps Capacity",
"value": false
}
],
"migration": true,
"scheduledDates": {
"ceaseSaleDate": "",
"disconnectionDate": "",
"orderStabilityPeriodDate": ""
}
},
"request": {
"params": {
"addressId": "444444702",
"FNN": "1234567890",
"tc2Required": "true"
},
"data": {},
"path": "/service-migration-qualification-details/retail",
"method": "GET",
"requestId": "4288e530-25e4-403f-a9be-472ccf53b0d5",
"correlationId": "bf02173d-3204-4d10-8949-1cb13a1bb602"
},
"correlationId": "bf02173d-3204-4d10-8949-1cb13a1bb602"
}
},
"serviceQualificationError": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "The error status code received by the client."
},
"time": {
"type": "string",
"format": "date-time",
"description": "The timestamp of error message received by the client"
},
"request": {
"type": "object",
"description": "The error request metadata received by the client"
},
"correlationId": {
"type": "string",
"description": "Correlation Id received by the client"
}
},
"example": {
"code": 502,
"time": "2016-06-06T02:32:42+00:00",
"request": {
"body": {
"correlationId": "151f3092-d6fe-4130-bd10-28de5730eef9",
"requestId": "eaea8333-6b4d-4d16-b60a-033010bbc750",
"path": "/service-migration-qualification-details/retail",
"method": "post",
"data": {
"addressId": "220682435",
"FNN": "0747748609"
}
}
},
"correlationId": "151f3092-d6fe-4130-bd10-28de5730eef9"
}
},
"serviceQualificationErrornbnCo": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "The error status code received by the client."
},
"status": {
"type": "integer",
"format": "int32",
"description": "The error status code received by the client."
},
"time": {
"type": "string",
"format": "date-time",
"description": "The timestamp of error message received by the client"
},
"request": {
"type": "object",
"description": "The error request metadata received by the client"
},
"correlationId": {
"type": "string",
"description": "Correlation Id received by the client"
}
},
"example": {
"code": 5001,
"status": 500,
"time": "2017-03-13T21:40:26+11:00",
"message": "Unable to complete the service qualification due to core system errors",
"request": {
"params": {},
"data": {
"addressId": "555555509",
"FNN": "0299998888"
},
"path": "/service-migration-qualification-details/retail",
"method": "POST",
"requestId": "746f9a4e-4516-4fa3-ac31-d9df9cf7c12d",
"correlationId": "40307e42-0257-4465-8aeb-1eeb2e388c84"
},
"correlationId": "40307e42-0257-4465-8aeb-1eeb2e388c84"
}
},
"serviceQualificationErrorAPIGEE": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "The error status code received by the client."
},
"status": {
"type": "integer",
"format": "int32",
"description": "The error status code received by the client."
},
"time": {
"type": "string",
"format": "date-time",
"description": "The timestamp of error message received by the client"
},
"request": {
"type": "object",
"description": "The error request metadata received by the client"
},
"correlationId": {
"type": "string",
"description": "Correlation Id received by the client"
}
},
"example": {
"code": 5008,
"status": 500,
"time": "2017-03-13T21:40:26+11:00",
"message": "Unable to process request",
"request": {
"params": {},
"data": {
"addressId": "555555509",
"FNN": "0299998888"
},
"path": "/service-migration-qualification-details/retail",
"method": "POST",
"requestId": "746f9a4e-4516-4fa3-ac31-d9df9cf7c12d",
"correlationId": "40307e42-0257-4465-8aeb-1eeb2e388c84"
},
"correlationId": "40307e42-0257-4465-8aeb-1eeb2e388c84"
}
}
}
}