---
swagger: "2.0"
info:
title: csmt-crm-v-codi-settings
description: This microservice is used for register in Teradata setting from mobile
with App CoDi
version: 1.0.0
x-ibm-name: csmt-crm-v-codi-settings
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
'/v1/customers/codi-banxico/settings/detail ':
post:
tags:
- save-customer-codi-settings-detail
operationId: save-customer-codi-settings-detail
summary: 'LOB: Traditional Payments, Feature: Codi Settings, Functionality:
Save information.'
description: This API is used to save information changes to setting on mobile
device.
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: ChannelId
in: header
required: true
type: string
description: Channel where request originated
- 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: sid
in: header
required: true
type: string
description: SessionId sent by Consumer
- name: saveCustomerSettingsRequest
in: body
schema:
$ref: '#/definitions/SaveCustomerSettingsRequest'
responses:
204:
description: Successful operation.
400:
description:
Type | Code | Details |
error | invalidRequest | Missing
or invalid Parameters |
schema:
$ref: '#/definitions/ErrorResponse'
401:
description: Type | Code | Details |
error | unAuthorized | Authorization
credentials are missing or invalid |
schema:
$ref: '#/definitions/ErrorResponse'
403:
description: 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 |
schema:
$ref: '#/definitions/ErrorResponse'
404:
description: Type | Code | Details | More
Info |
error | resourceNotFound | The requested
resource was not found | Empty resource/resource not found |
schema:
$ref: '#/definitions/ErrorResponse'
422:
description: Type | Code | Details |
error | businessValidationFailed | Business
validation error occured on one or more parameters |
schema:
$ref: '#/definitions/ErrorResponse'
500:
description: Type | Code | Details |
fatal | serverUnavailable | The
request failed due to an internal error/server unavailability |
schema:
$ref: '#/definitions/ErrorResponse'
definitions:
SaveCustomerSettingsRequest:
type: object
properties:
lastUpdatedDate:
description: Date when application was last updated.Date in ISO 8601 date
format YYYY-MM-DD
type: string
format: date-time
example: "2017-07-21T17:32:28Z"
operation:
$ref: '#/definitions/Operation'
required:
- lastUpdatedDate
- operation
Operation:
type: object
properties:
responseOperationCode:
description: Response code of the operation settting in the mobile device
application.
type: integer
format: int32
example: 200
responseOperationDescription:
description: Description response code of the operation settting in the mobile
device application.
type: string
example: OK
operationType:
description: Type of operations performed on setting in the mobile device
application.
type: string
example: Enable NFC
required:
- responseOperationCode
- responseOperationDescription
- operationType
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
...