---
swagger: "2.0"
info:
  title: csmt-crd-d-customer-employer
  description: The purpose of the domain-type microservice is to manage inserting,
    updating, and retrieving the client's employer information and its specific business
    rules.
  version: 1.0.0
  x-ibm-name: csmt-crd-d-customer-employer
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/customers/employers:
    post:
      tags:
      - create-customer-employer
      operationId: create-customer-employer
      summary: 'LOB: Data Analytics, Feature: Customer´s Employer Information, Functionality:
        Insert customer´s employer information.'
      description: The API manages the insertion of information of the client's employer
        indicated in the input parameters.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        type: string
        description: Client ID generated during application registration
        required: true
      - name: Authorization
        in: header
        description: The Authorization Token received during login
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        type: string
        required: false
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: true
        type: string
      - 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
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: customerEmployerRequest
        in: body
        schema:
          $ref: '#/definitions/CustomerEmployerRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CustomerInformationEmployerResponse'
        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'
    put:
      tags:
      - update-customer-employer
      operationId: update-customer-employer
      summary: 'LOB: Data Analytics, Feature: Customer´s Employer Information, Functionality:
        Update customer´s employer information.'
      description: The API manages the update of the information of the client's employer
        indicated in the input parameters.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        type: string
        description: Client ID generated during application registration
        required: true
      - name: Authorization
        in: header
        description: The Authorization Token received during login
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        type: string
        required: false
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: true
        type: string
      - 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
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: customerEmployerRequest
        in: body
        schema:
          $ref: '#/definitions/CustomerEmployerRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CustomerInformationEmployerResponse'
        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/customers/employers/retrieve:
    post:
      tags:
      - retrieve-customer-employer
      operationId: retrieve-customer-employer
      summary: 'LOB: Data Analytics, Feature: Customer´s Employer Information, Functionality:
        Retrieve customer´s employer information.'
      description: The API manages the information query of the client's employer
        indicated in the input parameters.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        type: string
        description: Client ID generated during application registration
        required: true
      - name: Authorization
        in: header
        description: The Authorization Token received during login
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        type: string
        required: false
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: true
        type: string
      - 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
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: customerInformationEmployerRequest
        in: body
        schema:
          $ref: '#/definitions/CustomerInformationEmployerRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CustomerInformationEmployerResponse'
        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:
  CustomerEmployerRequest:
    type: object
    properties:
      customer:
        $ref: '#/definitions/Customer'
      sourceSystem:
        description: Identifier of the consuming source system (this data is sent
          by the front).
        type: string
        example: "105099"
        maxLength: 6
      stationName:
        description: Identifier of the system that is attends the session of the client
          (this data is sent by the front).
        type: string
        example: Y1050X99
        maxLength: 8
      employeeId:
        description: Identifier of the employee (this data is sent by the front).
        type: string
        example: 0020007248
        maxLength: 10
    required:
    - customer
    - sourceSystem
    - stationName
    - employeeId
  CustomerInformationEmployerRequest:
    type: object
    properties:
      customerId:
        description: Unique identifier of the customer.
        type: string
        example: 000004945914
        maxLength: 12
      sourceSystem:
        description: Identifier of the consuming source system (this data is sent
          by the front).
        type: string
        example: "105099"
        maxLength: 6
      stationName:
        description: Identifier of the system that is attends the session of the client
          (this data is sent by the front).
        type: string
        example: Y1050X99
        maxLength: 8
      employeeId:
        description: Identifier of the employee (this data is sent by the front).
        type: string
        example: 0020007248
        maxLength: 10
    required:
    - customerId
    - sourceSystem
    - stationName
    - employeeId
  CustomerInformationEmployerResponse:
    type: object
    properties:
      customer:
        $ref: '#/definitions/Customer'
  Customer:
    type: object
    properties:
      customerId:
        description: Unique identifier of the customer.
        type: string
        example: 000004945914
        maxLength: 12
      fullName:
        description: Client's full legal name.
        type: string
        example: Luis Sergio Del Carmen Juarez
        maxLength: 170
      incomeSourceCode:
        description: Customer income source code, according to D835 catalog.
        type: string
        example: "14"
        maxLength: 4
      demographics:
        $ref: '#/definitions/Demographics'
      employment:
        $ref: '#/definitions/Employment'
    required:
    - customerId
  Demographics:
    type: object
    properties:
      countryOfBirthCode:
        description: Country of birth code, according to D000755 catalog.
        type: string
        example: "2"
        maxLength: 8
      stateOfBirthCode:
        description: State of birth code, according to D000060 catalog. Use value
          33 for foreign.
        type: string
        example: "33"
        maxLength: 2
  Employment:
    type: object
    properties:
      employerName:
        description: Employer name of customer.
        type: string
        example: Cifra S.A. de C.V.
        maxLength: 40
  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 or detailed description 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
...