---
swagger: "2.0"
info:
  title: CHNN-CRP-V-CustomerCommunicationPerformance
  description: NC. This Microservice retrieves the customer communication information
    of the customers that belong to the level in the commercial structure, that information
    provides follow up in described commercial level.
  version: 1.0.1
  x-ibm-name: chnn-crp-v-customercommunicationperformance
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/channels/crp/branch-portfolio/customer-communication/units/performance:
    post:
      tags:
      - customer-communication-units-performance
      operationId: customer-communication-units-performance
      summary: This API retrieves porfolio indicators from mongo information
      description: This API retrieves the mongo information
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: customerCommunicationUpRequest
        in: body
        schema:
          $ref: '#/definitions/CommunicationFollowUpRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CommunicationUnitsResponse'
        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'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</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'
  /v2/channels/crp/branch-portfolios/customer-communications/units/performances/retrieve:
    post:
      tags:
      - customer-communication-units-performance-v2
      operationId: customer-communication-units-performance-v2
      summary: To retrieve the porfolio indicators from the mongo DB information for
        the customer communication unit performance.
      description: This API is used to retrieve the porfolio indicators from the mongo
        DB information for the customer communication unit performance.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: customerCommunicationUnitsRequest
        in: body
        schema:
          $ref: '#/definitions/CustomerCommunicationUnitsRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CustomerCommunicationUnitsResponse'
        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'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</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/crp/branch-portfolio/customer-communication/amounts/performance:
    post:
      tags:
      - customer-communication-amounts-performance
      operationId: customer-communication-amounts-performance
      summary: This API retrieves porfolio indicators from mongo information
      description: This API retrieves the mongo information
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: customerCommunicationRequest
        in: body
        schema:
          $ref: '#/definitions/CommunicationFollowUpRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CommunicationAmountsResponse'
        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'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</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'
  /v2/channels/crp/branch-portfolios/customer-communications/amounts/performances/retrieve:
    post:
      tags:
      - customer-communication-amounts-performance-v2
      operationId: customer-communication-amounts-performance-v2
      summary: To retrieve the porfolio indicators from mongo DB information for the
        customer communication amounts performance
      description: This API is used to retrieve the porfolio indicators from mongo
        DB information for the customer communication amounts performance
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: customerCommunicationAmountRequest
        in: body
        schema:
          $ref: '#/definitions/CustomerCommunicationAmountRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CustomerCommunicationAmountResponse'
        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'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</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:
  CommunicationFollowUpRequest:
    type: object
    properties:
      divisionCode:
        description: Division ID unique number to identify a Division in the Commercial
          Structure.
        type: string
        example: "4567"
        maxLength: 10
      regionCode:
        description: Region ID unique number to identify a Region in the Commercial
          Structure.
        type: string
        example: "1234"
        maxLength: 10
      marketCellCode:
        description: Market ID unique number to identify a Market in the Commercial
          Structure.
        type: string
        example: "3008"
        maxLength: 10
      branchId:
        description: Branch SIRH unique number to identify a Branch in the Commercial
          Structure.
        type: string
        example: "547"
        maxLength: 10
      segmentId:
        description: Type of segment asigned to the customer of the alert
        type: integer
        format: int32
        example: 2
        maxLength: 5
      agentType:
        description: Type of the banker assignment for the customer of the alert
        type: integer
        format: int32
        example: 2
        maxLength: 5
      expirationType:
        description: Type of the expiration of the alert based on the expiration date
          set for the aler
        type: integer
        format: int32
        example: 2
        maxLength: 5
      communicationId:
        description: The code to identify which type of alert it is
        type: integer
        format: int32
        example: 2
        maxLength: 5
      periodId:
        description: Period used to summarize the data as a snapshot
        type: integer
        format: int32
        example: 2
        maxLength: 5
      branchInfoOnly:
        description: Indicator to retrieve branch information Only
        type: boolean
        example: "true"
      pageId:
        description: Page Id for pagination
        type: integer
        example: 2
      pageSize:
        description: Number of records in current page
        type: integer
        format: int32
        example: 10
  CommunicationAmountsResponse:
    type: object
    properties:
      pageId:
        description: Page Id for pagination
        type: integer
        example: 2
      pageSize:
        description: Number of records in current page
        type: integer
        format: int32
        example: 10
      totalRecords:
        description: Total records
        type: integer
        format: int32
        example: 120
      totalPages:
        description: Total pages
        type: integer
        format: int32
        example: 120
      executivePortfolioAmounts:
        $ref: '#/definitions/CommunicationFollowUpAmounts'
  CommunicationFollowUpAmounts:
    type: array
    items:
      $ref: '#/definitions/CommunicationFollowUpAmount'
  CommunicationFollowUpAmount:
    type: object
    properties:
      reportDate:
        description: Date to which the summary information is updated to.
        type: string
        format: date-time
        example: "2019-04-29T23:25:45"
        maxLength: 20
      structureLevel:
        $ref: '#/definitions/StructureLevel'
      amounts:
        $ref: '#/definitions/Amounts'
  Amounts:
    type: object
    properties:
      totalAmount:
        description: Total amount corresponding to the alerts for the summary level
          of information.
        type: number
        format: double
        example: 1564844806.460000
      notWorkedAmount:
        description: Amount corresponding to the  alerts in 'Not Worked' status for
          the summary level of information.
        type: number
        format: double
        example: 1567980768
      notContactedAmount:
        description: Amount corresponding to the  alerts in 'Not Contactable' status
          for the summary level of information.
        type: number
        format: double
        example: 279100576.700000
      notInterestedAmount:
        description: Amount corresponding to the  alerts in 'Not Interested' status
          for the summary level of information.
        type: number
        format: double
        example: 1406478748.900000
      interestedAmount:
        description: Amount corresponding to the  alerts in 'Interested' status for
          the summary level of information.
        type: number
        format: double
        example: 714999230.210000
      closedAmount:
        description: Amount corresponding to the  alerts in 'Closed' status for the
          summary level of information.
        type: number
        format: double
        example: 559769134.180000
  Units:
    type: object
    properties:
      totalUnits:
        description: Total number of alerts for the summary level of information.
        type: integer
        format: int32
        example: 1345789
        maxLength: 9
      notWorkedUnits:
        description: Number of alerts in 'Not Worked' status for the summary level
          of information.
        type: integer
        format: int32
        example: 1345789
        maxLength: 9
      notContactedUnits:
        description: Number of alerts in 'Not Contactable' status for the summary
          level of information.
        type: integer
        format: int32
        example: 1345789
        maxLength: 9
      notInterestedUnits:
        description: Number of alerts in 'Not Interested' status for the summary level
          of information.
        type: integer
        format: int32
        example: 1345789
        maxLength: 9
      interestedUnits:
        description: Number of alerts in 'Interested' status for the summary level
          of information.
        type: integer
        format: int32
        example: 1345789
        maxLength: 9
      closedUnits:
        description: Number of customers with other insurance products in the portfolio.
        type: integer
        format: int32
        example: 1345789
        maxLength: 9
  CommunicationUnitsResponse:
    type: object
    properties:
      pageId:
        description: Page Id for pagination
        type: integer
        format: int32
        example: 2
      pageSize:
        description: Number of records in current page
        type: integer
        format: int32
        example: 10
      totalRecords:
        description: Total records
        type: integer
        format: int32
        example: 120
      totalPages:
        description: Total pages
        type: integer
        format: int32
        example: 120
      executivePortfolioUnits:
        $ref: '#/definitions/CustomerCommunicationUpTotals'
  CustomerCommunicationUpTotals:
    type: array
    items:
      $ref: '#/definitions/CommunicationFollowUpUnits'
  CommunicationFollowUpUnits:
    type: object
    properties:
      reportDate:
        description: Date to which the summary information is updated to.
        type: string
        format: date
        example: "2019-04-29T23:25:45"
        maxLength: 20
      structureLevel:
        $ref: '#/definitions/StructureLevel'
      units:
        $ref: '#/definitions/Units'
  StructureLevel:
    type: object
    properties:
      divisionCode:
        description: Division ID unique number to identify a Division in the Commercial
          Structure.
        type: string
        example: "4567"
      regionCode:
        description: Region ID unique number to identify a Region in the Commercial
          Structure.
        type: string
        example: "1234"
      marketCellCode:
        description: Market ID unique number to identify a Market in the Commercial
          Structure.
        type: string
        example: "3008"
      branchId:
        description: Branch SIRH unique number to identify a Branch in the Commercial
          Structure.
        type: string
        example: "547"
      agentId:
        description: Executive SOEID unique employee to identify an Executive in the
          Commercial Structure.
        type: string
        example: SA61785
  CustomerCommunicationUnitsRequest:
    type: object
    properties:
      pageId:
        description: Page Id for pagination
        type: integer
        format: int32
        example: 2
      rowLimit:
        description: Number of records in current page
        type: integer
        format: int32
        example: 10
      customerSegmentCode:
        description: 'Segment code of the customer. It''ll contain numeric values
          to be mapped against a catalog in the front. Catalog descriptions can be
          as example: ''Priority'', ''Citiblue'', ''PYME''.'
        type: string
        example: "1"
        maxLength: 5
      agentTypeCode:
        description: Type of the banker assignment for the customer of the alert
        type: string
        example: "3"
        maxLength: 5
      communicationTypeCode:
        description: The code to identify which type of communication it is
        type: string
        example: "13"
        maxLength: 5
      communicationAmountRangeCode:
        description: 'The Amount for the communication in ranges. It''ll contain numeric
          values to be mapped against a catalog in the front. Catalog descriptions
          can be as example: ''$0 to $100,000'', ''More than $500,000'', etc.'
        type: string
        example: "1"
        maxLength: 5
      productEndDateCode:
        description: 'Expiry date of the product related in the communication. For
          example- for the Alerts for Fixed Term Investment Expirations, the relevant
          date is the date when the investment expires. It''ll contain numeric values
          to be mapped against a catalog in the front. Catalog descriptions can be
          as example: ''Total'', ''Today'', ''Tomorrow'', ''2 to 5 days'', ''More
          than 5 days'''
        type: string
        example: "1"
        maxLength: 5
      summaryPeriodCode:
        description: Month for which the summarized data has been retrieved. It'll
          contain numeric values to be mapped against a catalog in the front. Example-
          Current Month, last Month
        type: string
        example: "2"
        maximum: 6
      branchOnlyFlag:
        description: Flag that indicates if only branch information is displayed
        type: boolean
        example: true
      bankCommercialStructure:
        $ref: '#/definitions/BankCommercialStructureDetail'
  BankCommercialStructureDetail:
    type: object
    properties:
      divisionCode:
        description: Division code to uniquely identify a Division in the Commercial
          Structure.
        type: string
        example: "4567"
        maxLength: 4
      regionCode:
        description: Region code to uniquely identify a Region in the Commercial Structure.
        type: string
        example: "1234"
        maxLength: 4
      marketCellCode:
        description: Market code to uniquely identify a Market in the Commercial Structure.
        type: string
        example: "3008"
        maxLength: 4
      branchId:
        description: Branch SIRH unique number to identify a Branch in the Commercial
          Structure.
        type: string
        example: "547"
        maxLength: 4
  CustomerCommunicationUnitsResponse:
    type: object
    properties:
      pageId:
        description: Page Id for pagination
        type: integer
        format: int32
        example: 2
      rowLimit:
        description: Number of records in current page
        type: integer
        format: int32
        example: 10
      recordCount:
        description: Total records
        type: integer
        format: int32
        example: 120
      pageCount:
        description: Total pages
        type: integer
        format: int32
        example: 120
      bankCommercialStructure:
        type: array
        items:
          $ref: '#/definitions/BankCommercialStructure'
  BankCommercialStructure:
    type: object
    properties:
      divisionCode:
        description: Division code to uniquely identify a Division in the Commercial
          Structure.
        type: string
        example: "6168"
      regionCode:
        description: Region code to uniquely identify a Region in the Commercial Structure.
        type: string
        example: "7457"
      marketCellCode:
        description: Market code to uniquely identify a Market in the Commercial Structure.
        type: string
        example: "8457"
      branchId:
        description: Unique identifier for the branch.
        type: string
        example: "3032"
      agentId:
        description: SOEID of the agent.
        type: string
        example: PG12212
      lastUpdatedTimestamp:
        description: Date on which the summary information was last updated.
        type: string
        format: date-time
        example: "2019-04-29T23:25:45"
        maxLength: 20
      communication:
        type: array
        items:
          $ref: '#/definitions/CommunicationDetail'
  CommunicationDetail:
    type: object
    properties:
      communicationStatus:
        description: Describes the status of communication.
        type: string
        example: Not interested
      communicationCount:
        description: Total number of communications having the same specified status
        type: integer
        format: int32
        example: 45
  CustomerCommunicationAmountRequest:
    type: object
    properties:
      pageId:
        description: Page Id for pagination
        type: integer
        format: int32
        example: 2
      rowLimit:
        description: Number of records in current page
        type: integer
        format: int32
        example: 10
      customerSegmentCode:
        description: 'Segment code of the customer. It''ll contain numeric values
          to be mapped against a catalog in the front. Catalog descriptions can be
          as example: ''Priority'', ''Citiblue'', ''PYME''.'
        type: string
        example: "1"
        maxLength: 5
      agentTypeCode:
        description: Type of the banker assignment for the customer of the alert
        type: string
        example: "3"
        maxLength: 5
      communicationTypeCode:
        description: The code to identify which type of alert it is
        type: string
        example: "13"
        maxLength: 5
      communicationAmountRangeCode:
        description: 'Type of the Amount for the alert in ranges. It''ll contain numeric
          values to be mapped against a catalog in the front. Catalog descriptions
          can be as example: ''$0 a $100mil'', ''Más de $500mil'''
        type: string
        example: "1"
        maxLength: 5
      productEndDateCode:
        description: 'Expiry date of the product related in the communication. For
          example- for the Alerts for Fixed Term Investment Expirations, the relevant
          date is the date when the investment expires. It''ll contain numeric values
          to be mapped against a catalog in the front. Catalog descriptions can be
          as example: ''Total'', ''Today'', ''Tomorrow'', ''2 to 5 days'', ''More
          than 5 days'''
        type: string
        example: "1"
        maxLength: 5
      summaryPeriodCode:
        description: Month for which the summarized data has been retrieved. It'll
          contain numeric values to be mapped against a catalog in the front. Example-
          Current Month, last Month
        type: string
        example: "2"
        maximum: 6
      branchOnlyFlag:
        description: Flag that indicates if only branch information is displayed
        type: boolean
        example: true
      bankCommercialStructure:
        $ref: '#/definitions/BankCommercialStructureInformation'
  BankCommercialStructureInformation:
    type: object
    properties:
      divisionCode:
        description: Division code to uniquely identify a Division in the Commercial
          Structure.
        type: string
        example: "4567"
        maxLength: 4
      regionCode:
        description: Region code to uniquely identify a Region in the Commercial Structure.
        type: string
        example: "1234"
        maxLength: 4
      marketCellCode:
        description: Market code to uniquely identify a Market in the Commercial Structure.
        type: string
        example: "3008"
        maxLength: 4
      branchId:
        description: Branch SIRH unique number to identify a Branch in the Commercial
          Structure.
        type: string
        example: "547"
        maxLength: 4
  CustomerCommunicationAmountResponse:
    type: object
    properties:
      pageId:
        description: Page Id for pagination
        type: integer
        format: int32
        example: 2
      rowLimit:
        description: Number of records in current page
        type: integer
        format: int32
        example: 10
      recordCount:
        description: Total records
        type: integer
        format: int32
        example: 120
      pageCount:
        description: Total pages
        type: integer
        format: int32
        example: 120
      bankCommercialStructure:
        type: array
        items:
          $ref: '#/definitions/BankCommercialStructureInfo'
  BankCommercialStructureInfo:
    type: object
    properties:
      divisionCode:
        description: Division code to uniquely identify a Division in the Commercial
          Structure.
        type: string
        example: "6168"
      regionCode:
        description: Region code to uniquely identify a Region in the Commercial Structure.
        type: string
        example: "7457"
      marketCellCode:
        description: Market code to uniquely identify a Market in the Commercial Structure.
        type: string
        example: "8457"
      branchId:
        description: Unique identifier for the branch.
        type: string
        example: "3032"
      agentId:
        description: SOEID of the agent.
        type: string
        example: PG12212
      lastUpdatedTimestamp:
        description: Date on which the summary information was last updated.
        type: string
        format: date-time
        example: "2019-04-29T23:25:45"
        maxLength: 20
      communication:
        type: array
        items:
          $ref: '#/definitions/CommunicationInfo'
  CommunicationInfo:
    type: object
    properties:
      communicationStatus:
        description: Describes the status of communication.
        type: string
        example: Without work
      communicationAmount:
        description: The amount of communication corresponding to this status
        type: number
        format: double
        example: 1567980768.120000
  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: More Info can be used to pass any additional details
        type: string
      uuid:
        description: 128 bit UUID that you generate for every request
        type: string
      timestamp:
        description: Timestamp 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: ""
    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
...