---
swagger: "2.0"
info:
  title: Widget Preferences Microservice
  description: ' API for widget preferences'
  version: "2.0"
  x-ibm-name: widget-preferences-microservice
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/channels/bne/customers/widget:
    post:
      summary: Add or update customer widget preference
      description: This API is used to add or update customer widget preference
      tags:
      - AddUpdateCustomerWidgetPreference
      parameters:
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        type: string
        required: false
      - name: Authorization
        in: header
        description: The Authorization Token recieved during login
        type: string
        required: true
      - name: channelId
        in: header
        description: channel where request originated
        type: string
        required: true
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        type: string
        required: true
      - name: sid
        in: header
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: addUpdateCustomerWidgetRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/AddUpdateCustomerWidgetRequest'
      responses:
        200:
          description: Successful operation.
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidCard</td><td>Card
            not found or invalid</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized
            </td><td>Authorization credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/channels/bne/customers/widget/delete:
    post:
      tags:
      - DeleteCustomerWidgetPreference
      summary: API to delete the customer widget preference
      description: This API is used to delete the customer widget preference
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        type: string
        required: false
      - name: Authorization
        in: header
        description: The Authorization Token recieved during login
        type: string
        required: true
      - name: channelId
        in: header
        description: channel where request originated
        type: string
        required: true
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        type: string
        required: true
      - name: sid
        in: header
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: deleteCustomerWidgetRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/DeleteCustomerWidgetRequest'
      responses:
        200:
          description: Successful operation.
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/channels/bne/customers/widget/search:
    post:
      tags:
      - GetCustomerWidgetPreference
      summary: Fetch customer widget preference
      description: This API is to fetch customer widget preference
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        type: string
        required: false
      - name: Authorization
        in: header
        description: The Authorization Token recieved during login
        type: string
        required: true
      - name: channelId
        in: header
        description: channel where request originated
        type: string
        required: true
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        type: string
        required: true
      - name: sid
        in: header
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: getCustomerWidgetRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/GetCustomerWidgetRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/GetCustomerWidgetResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/channels/bne/customers/widget/{pageId}/admin:
    post:
      tags:
      - AddUpdateMasterListWidgetPreference
      summary: Add or update Master list widget preference
      description: This API is to add or update master list widget preference
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        type: string
        required: false
      - name: Authorization
        in: header
        description: The Authorization Token recieved during login
        type: string
        required: true
      - name: channelId
        in: header
        description: channel where request originated
        type: string
        required: true
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        type: string
        required: true
      - name: sid
        in: header
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: pageId
        in: path
        description: unique identifier of the page on which widget is placed
        type: string
        required: true
      - name: addUpdateMasterListWidgetRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/AddUpdateMasterListWidgetRequest'
      responses:
        200:
          description: Successful operation.
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
    get:
      tags:
      - GetMasterListWidgetPreference
      summary: Fetch the master list widget preference
      description: This API is to fetch the master list widget preference
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        type: string
        required: false
      - name: Authorization
        in: header
        description: The Authorization Token recieved during login
        type: string
        required: true
      - name: channelId
        in: header
        description: channel where request originated
        type: string
        required: true
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: false
        type: string
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        type: string
        required: true
      - name: sid
        in: header
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: pageId
        in: path
        description: unique identifier of the page on which widget is placed
        type: string
        required: true
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/GetMasterListWidgetResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  AddUpdateCustomerWidgetRequest:
    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
  GetCustomerWidgetRequest:
    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
  DeleteCustomerWidgetRequest:
    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
  GetCustomerWidgetResponse:
    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}]'
  GetMasterListWidgetResponse:
    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}]'
  AddUpdateMasterListWidgetRequest:
    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
  ErrorResponse:
    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
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: Default scope
    tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...