production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/channels/bne/customers/{customerId}/segment
get /v1/channels/bne/customers/{customerId}/segment
GetBusinessSegment
To fetch the list of Customer Segment.
This API will be used to fetch the Customer Segment from the Backend system(Oracle DB) based on Customer Id. This API is private, pre-login and entry point.
oauth-1
oauth-1
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
api-key-1
X-IBM-Client-Id
(apiKey located in header)
Accept
Required in header
string
Content-Types that are acceptable for the response
Accept-Language
Optional in header
string
List of acceptable human languages for response
Authorization
Required in header
string
The Authorization Token recieved during login
client_id
Required in header
string
Client ID generated during application registration
uuid
Required in header
string
128 bit UUID that you generate for every request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
channelId
Required in header
string
channel where request originated
businesscode
Required in header
string
Business code identified during application registration
customerId
Required in path
string
Unique Identifier of the customer
200
The request has succeeded.
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 |
500
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
GET https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/channels/bne/customers/{customerId}/segment
Definitions
{
"properties": {
"customer": {
"$ref": "#/definitions/Customer"
}
}
}
{
"properties": {
"businessSegment": {
"description": "The customer's business segment",
"example": "PYME"
}
},
"required": [
"businessSegment"
]
}
{
"properties": {
"type": {
"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": "URI to human readable documentation of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}