Jump to

• Request
• Response

Fetch the list of location clusters

get

/service/v1/locationCluster

This API fetches list of location clusters based on given parameters

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStat(optional): string
  Auth Status need to be set to fetch summary record
• 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
• locationClusterCode(optional): string
  Location Cluster Code
• locationClusterDescription(optional): string
  Location Cluster Description
• offset(optional): integer
  offset is starting no of records to be fetched
• recordStat(optional): string
  Record Status need to be set to fetch summary record

Header Parameters

• appId: string
  Application Id
• branchCode: string
  Branch Code
• userId: string
  User Id

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created location cluster

Body ()

Root Schema : CmTmLocationClusterMasterCollection

Type: object

Collection of cmtmlocationclustermaster.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object CmTmLocationClusterMasterDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : CmTmLocationClusterMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object CmTmLocationClusterMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":""
                },
                "action":{
                    "type":"string",
                    "description":""
                },
                "autoAuth":{
                    "type":"string",
                    "description":""
                },
                "modificationStatus":{
                    "type":"string",
                    "description":""
                },
                "datasegmentCode":{
                    "type":"string",
                    "description":""
                },
                "checkerRemarks":{
                    "type":"string",
                    "description":""
                },
                "makerRemarks":{
                    "type":"string",
                    "description":""
                },
                "clearingDays":{
                    "type":"number",
                    "description":""
                },
                "locationClusterCode":{
                    "type":"string",
                    "description":""
                },
                "locationClusterDescription":{
                    "type":"string",
                    "description":""
                }
            }
        }
    ]
}

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 : CmTmLocationClusterMasterDTO-allOf[1]

Type: object

Show Source

• action(optional): string
• autoAuth(optional): string
• checkerRemarks(optional): string
• clearingDays(optional): number
• datasegmentCode(optional): string
• id(optional): string
• locationClusterCode(optional): string
• locationClusterDescription(optional): string
• makerRemarks(optional): string
• modificationStatus(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "action":{
            "type":"string",
            "description":""
        },
        "autoAuth":{
            "type":"string",
            "description":""
        },
        "modificationStatus":{
            "type":"string",
            "description":""
        },
        "datasegmentCode":{
            "type":"string",
            "description":""
        },
        "checkerRemarks":{
            "type":"string",
            "description":""
        },
        "makerRemarks":{
            "type":"string",
            "description":""
        },
        "clearingDays":{
            "type":"number",
            "description":""
        },
        "locationClusterCode":{
            "type":"string",
            "description":""
        },
        "locationClusterDescription":{
            "type":"string",
            "description":""
        }
    }
}

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