production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/channels/bne/customers/widget
post /v1/channels/bne/customers/widget
AddUpdateCustomerWidgetPreference
Add or update customer widget preference
This API is used to add or update customer widget preference
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
Default scope
Client ID
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
channelId
Required in header
string
channel where request originated
client_id
Required in header
string
Client ID generated during application registration
Content-Type
Required in header
string
Content-Types that are sent in the request
uuid
Required in header
string
128 bit UUID that you generate for every request
sid
Required in header
string
SessionId sent by Consumer
addUpdateCustomerWidgetRequest
Required in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidCard | Card not found or invalid |
| invalid | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/channels/bne/customers/widget
/v1/channels/bne/customers/widget/delete
post /v1/channels/bne/customers/widget/delete
DeleteCustomerWidgetPreference
API to delete the customer widget preference
This API is used to delete the customer widget preference
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
Default scope
Client ID
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
channelId
Required in header
string
channel where request originated
client_id
Required in header
string
Client ID generated during application registration
Content-Type
Required in header
string
Content-Types that are sent in the request
uuid
Required in header
string
128 bit UUID that you generate for every request
sid
Required in header
string
SessionId sent by Consumer
deleteCustomerWidgetRequest
Required 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 |
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/bne/customers/widget/delete
/v1/channels/bne/customers/widget/search
post /v1/channels/bne/customers/widget/search
GetCustomerWidgetPreference
Fetch customer widget preference
This API is to fetch customer widget preference
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
Default scope
Client ID
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
channelId
Required in header
string
channel where request originated
client_id
Required in header
string
Client ID generated during application registration
Content-Type
Required in header
string
Content-Types that are sent in the request
uuid
Required in header
string
128 bit UUID that you generate for every request
sid
Required in header
string
SessionId sent by Consumer
getCustomerWidgetRequest
Required 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 |
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/bne/customers/widget/search
/v1/channels/bne/customers/widget/{pageId}/admin
post /v1/channels/bne/customers/widget/{pageId}/admin
AddUpdateMasterListWidgetPreference
Add or update Master list widget preference
This API is to add or update master list widget preference
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
Default scope
Client ID
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
channelId
Required in header
string
channel where request originated
client_id
Required in header
string
Client ID generated during application registration
Content-Type
Required in header
string
Content-Types that are sent in the request
uuid
Required in header
string
128 bit UUID that you generate for every request
sid
Required in header
string
SessionId sent by Consumer
pageId
Required in path
string
unique identifier of the page on which widget is placed
addUpdateMasterListWidgetRequest
Required 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 |
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/bne/customers/widget/{pageId}/admin
get /v1/channels/bne/customers/widget/{pageId}/admin
GetMasterListWidgetPreference
Fetch the master list widget preference
This API is to fetch the master list widget preference
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
Default scope
Client ID
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
channelId
Required in header
string
channel where request originated
client_id
Required in header
string
Client ID generated during application registration
Content-Type
Optional in header
string
Content-Types that are sent in the request
uuid
Required in header
string
128 bit UUID that you generate for every request
sid
Required in header
string
SessionId sent by Consumer
pageId
Required in path
string
unique identifier of the page on which widget is placed
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 |
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/widget/{pageId}/admin
Definitions
{
"type": "object",
"properties": {
"lastUpdatedDateTimestamp": {
"description": "Last Updated DateTimestamp whenever any add, update, delete happens in Customer Preference.",
"type": "string",
"example": "1997-07-16T19:20:30.45+01:00"
},
"customerPreference": {
"description": "This will be the widget details entered by the consumer as per his needs",
"type": "string",
"example": "[{widgetId:1234 , widgetPreference:2}]"
},
"customerId": {
"description": "Unique Identifier for customer",
"type": "string",
"example": "123456789012",
"maxLength": 12
},
"legalRepresentativeId": {
"description": "Unique Identifier for representative",
"type": "string",
"example": "01",
"maxLength": 2
},
"pageId": {
"description": "Page Id",
"type": "string",
"example": "SCR01"
}
},
"required": [
"customerPreference",
"customerId",
"legalRepresentativeId",
"pageId"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique Identifier for customer",
"type": "string",
"example": "123456789012",
"maxLength": 12
},
"legalRepresentativeId": {
"description": "Unique Identifier for representative",
"type": "string",
"example": "01",
"maxLength": 2
},
"pageId": {
"description": "Page Id",
"type": "string",
"example": "SCR01"
}
},
"required": [
"customerId",
"legalRepresentativeId",
"pageId"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique Identifier for customer",
"type": "string",
"example": "123456789012",
"maxLength": 12
},
"legalRepresentativeId": {
"description": "Unique Identifier for representative",
"type": "string",
"example": "01",
"maxLength": 2
},
"pageId": {
"description": "Page Id",
"type": "string",
"example": "SCR01"
}
},
"required": [
"customerId",
"legalRepresentativeId",
"pageId"
]
}
{
"type": "object",
"properties": {
"lastUpdatedDateTimestamp": {
"description": "Last Updated DateTimestamp whenever any add, update, delete happens in Customer Preference.",
"type": "string",
"example": "1997-07-16T19:20:30.45+01:00"
},
"customerPreference": {
"description": "This will be the widget details entered by the consumer as per his needs",
"type": "string",
"example": "[{widgetId:1234 , widgetPreference:2}]"
}
}
}
{
"type": "object",
"properties": {
"lastUpdatedDateTimestamp": {
"description": "Last Updated DateTimestamp whenever any add, update, delete happens in Customer Preference.",
"type": "string",
"example": "1997-07-16T19:20:30.45+01:00"
},
"masterPreference": {
"description": "This will be the widget details entered by the consumer as per his needs",
"type": "string",
"example": "[{widgetId:1234 , widgetPreference:2}]"
}
}
}
{
"type": "object",
"properties": {
"lastUpdatedDateTimestamp": {
"description": "Last Updated DateTimestamp whenever any add, update, delete happens in Customer Preference.",
"type": "string",
"example": "1997-07-16T19:20:30.45+01:00"
},
"masterPreference": {
"description": "This will be the widget details entered by the consumer as per his needs",
"type": "string",
"example": "[{widgetId:1234 , widgetPreference:2}]"
}
},
"required": [
"masterPreference"
]
}
{
"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": "URI to human readable documentation of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}