---
swagger: "2.0"
info:
  title: Business Segment Microservice
  description: This API will be used to fetch the customer Segment from the Backend
    system(Oracle DB) based on CustomerId
  version: 1.0.0
  x-ibm-name: business-segment-microservice
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/channels/bne/customers/{customerId}/segment:
    get:
      summary: To fetch the list of Customer Segment.
      description: 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.
      tags:
      - GetBusinessSegment
      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: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        type: string
        required: true
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: channelId
        in: header
        description: channel where request originated
        type: string
        required: true
      - name: businesscode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      - name: customerId
        in: path
        description: Unique Identifier of the customer
        required: true
        type: string
      responses:
        200:
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/RetreiveBusinessSegmentResponse'
        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:
  RetreiveBusinessSegmentResponse:
    properties:
      customer:
        $ref: '#/definitions/Customer'
  Customer:
    properties:
      businessSegment:
        description: The customer's business segment
        example: PYME
    required:
    - businessSegment
  ErrorResponse:
    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
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  oauth-1:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
  api-key-1:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- oauth-1:
  - /api/v1
  api-key-1: []
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...