Jump to

• Request
• Response

Get all Valid Customer

get

/service/lmd/customer

This endpoint is used to get all the valid customer maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• customerName(optional): string
• includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• sourceSystem(optional): string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : LmmTmCustomerServiceCollection

Type: object

Collection of customer.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of customer.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmCustomerDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object LmmTmCustomerDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

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":"",
                    "maxLength":105
                },
                "parentCustomerId":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "address":{
                    "type":"string",
                    "description":"",
                    "maxLength":1000
                },
                "bankCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":4
                },
                "branchCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":4
                },
                "sourceSystem":{
                    "type":"string",
                    "description":"",
                    "maxLength":35
                },
                "sourceSystemCustNo":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "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(optional): string
  Maximum Length: 1000
• bankCode(optional): string
  Maximum Length: 4
• branchCode(optional): string
  Maximum Length: 4
• closedDtStamp(optional): string(date)
• closedStat(optional): string
• customerId: string
  Pattern: [a-zA-Z0-9]{1,20}
• customerName: string
  Maximum Length: 105
• isForgotten(optional): string
• parentCustomerId(optional): string
  Maximum Length: 20
• sourceSystem(optional): string
  Maximum Length: 35
• sourceSystemCustNo(optional): string
  Maximum Length: 50

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

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