Jump to

• Request
• Response

Get all valid Account Range

get

/service/accountrange

This endpoint is used to fetch all valid account range maintained.

Request

Supported Media Types

• application/json

Query Parameters

• authStat(optional): string
• branchCode(optional): string
• checkerId(optional): string
• includecloseandunauth(optional): boolean
  includecloseandunauth needs to be set to fetch record that are unauthorized and/or closed, defult value is false
• limit(optional): integer
  limit is the maximum number of records to be fetched
• makerId(optional): string
• modNo(optional): integer
• offset(optional): integer
  offset is the starting number of records to be fetched
• onceAuth(optional): string
• realCustomerNo(optional): string
• recordStat(optional): string

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : VamTmAccountRangeServiceMasterCollection

Type: object

Collection of accountrange.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object VamTmAccountRangeServiceMasterDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : VamTmAccountRangeServiceMasterDTO

Type: object

Match All

Show Source

• object VamTmAccountRangeServiceMasterDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "realCustomerNo":{
                    "type":"string",
                    "description":"Branch Code for which the Real Customer will have an Account Number Range",
                    "minLength":1,
                    "maxLength":20
                },
                "branchCode":{
                    "type":"string",
                    "description":"Branch Code for which the Real Customer will have an Account Number Range",
                    "minLength":3,
                    "maxLength":3,
                    "pattern":"^[a-zA-Z0-9]+$"
                },
                "makerId":{
                    "type":"string"
                },
                "makerDateStamp":{
                    "type":"string"
                },
                "checkerId":{
                    "type":"string"
                },
                "checkerDateStamp":{
                    "type":"string"
                },
                "modNo":{
                    "type":"number"
                },
                "recordStatus":{
                    "type":"string"
                },
                "authStatus":{
                    "type":"string"
                },
                "onceAuth":{
                    "type":"string"
                },
                "doerRemarks":{
                    "type":"string"
                },
                "approverRemarks":{
                    "type":"string"
                },
                "VamTmAccountRangeServiceDetailDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/VamTmAccountRangeServiceDetailDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : VamTmAccountRangeServiceMasterDTO-allOf[0]

Type: object

Show Source

• approverRemarks(optional): string
• authStatus(optional): string
• branchCode(optional): string
  Minimum Length: 3

  Maximum Length: 3

  Pattern: ^[a-zA-Z0-9]+$

  Branch Code for which the Real Customer will have an Account Number Range
• checkerDateStamp(optional): string
• checkerId(optional): string
• doerRemarks(optional): string
• makerDateStamp(optional): string
• makerId(optional): string
• modNo(optional): number
• onceAuth(optional): string
• realCustomerNo(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Branch Code for which the Real Customer will have an Account Number Range
• recordStatus(optional): string
• VamTmAccountRangeServiceDetailDTO(optional): array VamTmAccountRangeServiceDetailDTO

{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":"Branch Code for which the Real Customer will have an Account Number Range",
            "minLength":1,
            "maxLength":20
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code for which the Real Customer will have an Account Number Range",
            "minLength":3,
            "maxLength":3,
            "pattern":"^[a-zA-Z0-9]+$"
        },
        "makerId":{
            "type":"string"
        },
        "makerDateStamp":{
            "type":"string"
        },
        "checkerId":{
            "type":"string"
        },
        "checkerDateStamp":{
            "type":"string"
        },
        "modNo":{
            "type":"number"
        },
        "recordStatus":{
            "type":"string"
        },
        "authStatus":{
            "type":"string"
        },
        "onceAuth":{
            "type":"string"
        },
        "doerRemarks":{
            "type":"string"
        },
        "approverRemarks":{
            "type":"string"
        },
        "VamTmAccountRangeServiceDetailDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VamTmAccountRangeServiceDetailDTO"
            }
        }
    }
}

Nested Schema : VamTmAccountRangeServiceDetailDTO

Type: array

Show Source

• Array of: object VamTmAccountRangeServiceDetailDTO

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

Nested Schema : VamTmAccountRangeServiceDetailDTO

Type: object

Show Source

• branchCode(optional): string
  Minimum Length: 3

  Maximum Length: 3

  Pattern: ^[a-zA-Z0-9]+$

  Branch Code for which the Real Customer will have an Account Number Range
• endAccountNo(optional): number
  Minimum Length: 0

  Maximum Length: 20

  Pattern: ^[0-9]*$

  End Account Number of the Corporate Specific Range
• realCustomerNo(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Branch Code for which the Real Customer will have an Account Number Range
• startAccountNo(optional): number
  Minimum Length: 0

  Maximum Length: 20

  Pattern: ^[0-9]*$

  Start Account Number of the Corporate Specific Range

{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":"Branch Code for which the Real Customer will have an Account Number Range",
            "minLength":1,
            "maxLength":20
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code for which the Real Customer will have an Account Number Range",
            "minLength":3,
            "maxLength":3,
            "pattern":"^[a-zA-Z0-9]+$"
        },
        "startAccountNo":{
            "type":"number",
            "description":"Start Account Number of the Corporate Specific Range",
            "minLength":0,
            "maxLength":20,
            "pattern":"^[0-9]*$"
        },
        "endAccountNo":{
            "type":"number",
            "description":"End Account Number of the Corporate Specific Range",
            "minLength":0,
            "maxLength":20,
            "pattern":"^[0-9]*$"
        }
    }
}

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