Jump to

• Request
• Response

Update an existing customer.

put

/api/1.0/service/customer/{customerId}

This endpoint is used to update an existing customer.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• customerId(required): string
  Pattern: [a-zA-Z0-9]{1,20}

  Customer ID of the customer Maintenance

Header Parameters

• sourceCode(required): string
  Source from which request is initiated

Body ()

Request Body that contains data required for updating an existing customer

Root Schema : LmmTmCustomerDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmCustomerDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "customerName":{
                    "type":"string",
                    "description":""
                },
                "parentCustomerId":{
                    "type":"string",
                    "description":""
                },
                "address":{
                    "type":"string",
                    "description":""
                },
                "bankCode":{
                    "type":"string",
                    "description":""
                },
                "branchCode":{
                    "type":"string",
                    "description":""
                },
                "sourceSystem":{
                    "type":"string",
                    "description":""
                },
                "sourceSystemCustNo":{
                    "type":"string",
                    "description":""
                },
                "closedStat":{
                    "type":"string",
                    "description":""
                },
                "closedDtStamp":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "isForgotten":{
                    "type":"string",
                    "description":""
                }
            },
            "required":[
                "customerId",
                "customerName"
            ]
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmmTmCustomerDTO-allOf[1]

Type: object

Show Source

• address: string
• bankCode: string
• branchCode: string
• closedDtStamp: string(date)
• closedStat: string
• customerId(required): string
  Pattern: [a-zA-Z0-9]{1,20}
• customerName(required): string
• isForgotten: string
• parentCustomerId: string
• sourceSystem: string
• sourceSystemCustNo: string

{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":""
        },
        "parentCustomerId":{
            "type":"string",
            "description":""
        },
        "address":{
            "type":"string",
            "description":""
        },
        "bankCode":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "sourceSystem":{
            "type":"string",
            "description":""
        },
        "sourceSystemCustNo":{
            "type":"string",
            "description":""
        },
        "closedStat":{
            "type":"string",
            "description":""
        },
        "closedDtStamp":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "isForgotten":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "customerId",
        "customerName"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated customer

Body ()

Root Schema : CustomerServiceDtoWrapper

Type: object

Show Source

• data: object LmmTmCustomerDTO
• messages: object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/LmmTmCustomerDTO"
        }
    }
}

Nested Schema : LmmTmCustomerDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmCustomerDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "customerName":{
                    "type":"string",
                    "description":""
                },
                "parentCustomerId":{
                    "type":"string",
                    "description":""
                },
                "address":{
                    "type":"string",
                    "description":""
                },
                "bankCode":{
                    "type":"string",
                    "description":""
                },
                "branchCode":{
                    "type":"string",
                    "description":""
                },
                "sourceSystem":{
                    "type":"string",
                    "description":""
                },
                "sourceSystemCustNo":{
                    "type":"string",
                    "description":""
                },
                "closedStat":{
                    "type":"string",
                    "description":""
                },
                "closedDtStamp":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "isForgotten":{
                    "type":"string",
                    "description":""
                }
            },
            "required":[
                "customerId",
                "customerName"
            ]
        }
    ]
}

Nested Schema : ResponseDto

Type: object

Show Source

• codes: array codes
• id: string
• requestId: string
• status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmmTmCustomerDTO-allOf[1]

Type: object

Show Source

• address: string
• bankCode: string
• branchCode: string
• closedDtStamp: string(date)
• closedStat: string
• customerId(required): string
  Pattern: [a-zA-Z0-9]{1,20}
• customerName(required): string
• isForgotten: string
• parentCustomerId: string
• sourceSystem: string
• sourceSystemCustNo: string

{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":""
        },
        "parentCustomerId":{
            "type":"string",
            "description":""
        },
        "address":{
            "type":"string",
            "description":""
        },
        "bankCode":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "sourceSystem":{
            "type":"string",
            "description":""
        },
        "sourceSystemCustNo":{
            "type":"string",
            "description":""
        },
        "closedStat":{
            "type":"string",
            "description":""
        },
        "closedDtStamp":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "isForgotten":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "customerId",
        "customerName"
    ]
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Show Source

• arg: string
• args: array args
• Code: string
• Desc: string
• Language: string
• Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top