Previous Next JavaScript must be enabled to correctly display this content

## Get all valid rm linkage customer

get

/rmlinkage/getLinkedCustomers

This endpoint is used to get all valid rm linkage customer.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
  CustomerId
- customerName(optional): string
  customerName
- excludeIfLinkedToAll(optional): string
  Denotes whether to exclude the customer list if user is linked to all customers
- limit(optional): integer
  limit is maximum no of records to be fetched
- offset(optional): integer
  offset is starting no of records to be fetched

Header Parameters

- userId: string
  UserId of the user that needs to be fetched

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 : RMCustomerCollection
Type: `object`
Show Source

- allCustomers(optional): boolean
- data(optional): array data

    {
        "type":"object",
        "properties":{
            "allCustomers":{
                "type":"boolean"
            },
            "data":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/RMCustomerDTO"
                }
            }
        }
    }

Nested Schema : data
Type: `array`
Show Source

- Array of: object RMCustomerDTO

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

Nested Schema : RMCustomerDTO
Type: `object`
Show Source

- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- customerName(optional): string

    {
        "type":"object",
        "properties":{
            "customerId":{
                "type":"string",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "customerName":{
                "type":"string"
            }
        }
    }

#### 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