Jump to

• Request
• Response

Close the core branches by given ID

patch

/service/corebranchs/{branchCode}/close

This endpoint is used to close the core branches identified by given ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• branchCode(required): string
  branchCode of the corebranchs Maintenance

Header Parameters

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

Body ()

Request body contain corebranchs and Modification no of corebranchs maintenance which need to be closed"

Root Schema : CloseDto

Type: object

Show Source

• modNo: integer
• remarks: string

{
    "type":"object",
    "properties":{
        "modNo":{
            "type":"integer"
        },
        "remarks":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml
• text/csv

200 Response

Successful operation.

Body ()

Root Schema : CoreBranchResponseDtoWrapper

Type: object

Show Source

• data: object CoreBranchDTO
• messages: object ResponseDto

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

Nested Schema : CoreBranchDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object CoreBranchDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "sourceBranchCode":{
                    "type":"string",
                    "description":"Branch code of the source system",
                    "minLength":0,
                    "maxLength":20,
                    "pattern":"[a-zA-Z0-9]+"
                },
                "sourceSystem":{
                    "type":"string",
                    "description":"Name of the source system"
                },
                "weekHol2":{
                    "type":"string",
                    "description":"Weekly holiday of the branch.",
                    "pattern":"[1-7]"
                },
                "weekHol1":{
                    "type":"string",
                    "description":"Weekly holiday of the branch.",
                    "pattern":"[1-7]"
                },
                "autoAuth":{
                    "type":"string",
                    "description":"To facilitate auto authorization."
                },
                "walkinCustomer":{
                    "type":"string",
                    "description":"Customer number of the walk-in customer."
                },
                "branchLcy":{
                    "type":"string",
                    "description":"Local currency of the branch"
                },
                "branchAddr3":{
                    "type":"string",
                    "description":"Third line of the branch address",
                    "minLength":0,
                    "maxLength":105
                },
                "branchAddr2":{
                    "type":"string",
                    "description":"Second line of the branch address",
                    "minLength":0,
                    "maxLength":105
                },
                "branchAddr1":{
                    "type":"string",
                    "description":"First line of the branch address",
                    "minLength":0,
                    "maxLength":105
                },
                "branchName":{
                    "type":"string",
                    "description":"Name of the branch.",
                    "minLength":1,
                    "maxLength":105,
                    "pattern":"[A-Za-z0-9 `@#$%&*()_+{}\\[\\]|;:'\"\\\\<,>.?\\/-]+"
                },
                "countryCode":{
                    "type":"string",
                    "description":"Country code of the branch."
                },
                "hostCode":{
                    "type":"string",
                    "description":"Host code to which the branch belongs to."
                },
                "branchCode":{
                    "type":"string",
                    "description":"Branch code of the branch to be configured.",
                    "minLength":3,
                    "maxLength":3,
                    "pattern":"[a-zA-Z0-9]+"
                },
                "CoreBranchPrefDTO":{
                    "$ref":"#/definitions/CoreBranchPrefDTO"
                },
                "CoreSwiftAddressDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CoreSwiftAddressDTO"
                    }
                }
            },
            "required":[
                "sourceBranchCode",
                "branchLcy",
                "branchName",
                "hostCode",
                "branchCode"
            ]
        }
    ]
}

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

Type: object

Show Source

• autoAuth: string
  To facilitate auto authorization.
• branchAddr1: string
  Minimum Length: 0

  Maximum Length: 105

  First line of the branch address
• branchAddr2: string
  Minimum Length: 0

  Maximum Length: 105

  Second line of the branch address
• branchAddr3: string
  Minimum Length: 0

  Maximum Length: 105

  Third line of the branch address
• branchCode(required): string
  Minimum Length: 3

  Maximum Length: 3

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

  Branch code of the branch to be configured.
• branchLcy(required): string
  Local currency of the branch
• branchName(required): string
  Minimum Length: 1

  Maximum Length: 105

  Pattern: [A-Za-z0-9 `@#$%&*()_+{}\[\]|;:'"\\<,>.?\/-]+

  Name of the branch.
• CoreBranchPrefDTO: object CoreBranchPrefDTO
• CoreSwiftAddressDTO: array CoreSwiftAddressDTO
• countryCode: string
  Country code of the branch.
• hostCode(required): string
  Host code to which the branch belongs to.
• sourceBranchCode(required): string
  Minimum Length: 0

  Maximum Length: 20

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

  Branch code of the source system
• sourceSystem: string
  Name of the source system
• walkinCustomer: string
  Customer number of the walk-in customer.
• weekHol1: string
  Pattern: [1-7]

  Weekly holiday of the branch.
• weekHol2: string
  Pattern: [1-7]

  Weekly holiday of the branch.

{
    "type":"object",
    "properties":{
        "sourceBranchCode":{
            "type":"string",
            "description":"Branch code of the source system",
            "minLength":0,
            "maxLength":20,
            "pattern":"[a-zA-Z0-9]+"
        },
        "sourceSystem":{
            "type":"string",
            "description":"Name of the source system"
        },
        "weekHol2":{
            "type":"string",
            "description":"Weekly holiday of the branch.",
            "pattern":"[1-7]"
        },
        "weekHol1":{
            "type":"string",
            "description":"Weekly holiday of the branch.",
            "pattern":"[1-7]"
        },
        "autoAuth":{
            "type":"string",
            "description":"To facilitate auto authorization."
        },
        "walkinCustomer":{
            "type":"string",
            "description":"Customer number of the walk-in customer."
        },
        "branchLcy":{
            "type":"string",
            "description":"Local currency of the branch"
        },
        "branchAddr3":{
            "type":"string",
            "description":"Third line of the branch address",
            "minLength":0,
            "maxLength":105
        },
        "branchAddr2":{
            "type":"string",
            "description":"Second line of the branch address",
            "minLength":0,
            "maxLength":105
        },
        "branchAddr1":{
            "type":"string",
            "description":"First line of the branch address",
            "minLength":0,
            "maxLength":105
        },
        "branchName":{
            "type":"string",
            "description":"Name of the branch.",
            "minLength":1,
            "maxLength":105,
            "pattern":"[A-Za-z0-9 `@#$%&*()_+{}\\[\\]|;:'\"\\\\<,>.?\\/-]+"
        },
        "countryCode":{
            "type":"string",
            "description":"Country code of the branch."
        },
        "hostCode":{
            "type":"string",
            "description":"Host code to which the branch belongs to."
        },
        "branchCode":{
            "type":"string",
            "description":"Branch code of the branch to be configured.",
            "minLength":3,
            "maxLength":3,
            "pattern":"[a-zA-Z0-9]+"
        },
        "CoreBranchPrefDTO":{
            "$ref":"#/definitions/CoreBranchPrefDTO"
        },
        "CoreSwiftAddressDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CoreSwiftAddressDTO"
            }
        }
    },
    "required":[
        "sourceBranchCode",
        "branchLcy",
        "branchName",
        "hostCode",
        "branchCode"
    ]
}

Nested Schema : CoreBranchPrefDTO

Type: object

Show Source

• branchCode: string
  Branch code of the branch to be configured.
• coreBranchId: string
  Master Table Reference.
• dsnName: string
  DSN name
• hostName: string
  Minimum Length: 0

  Maximum Length: 35

  Pattern: ([a-zA-Z0-9\s]+)?

  Host name to which the branch belongs to.
• id: string
  Primary Key
• reportDsn: string
  Minimum Length: 0

  Maximum Length: 35

  Pattern: ([a-zA-Z0-9\s]+)?

  Report DSN details

{
    "type":"object",
    "properties":{
        "reportDsn":{
            "type":"string",
            "description":"Report DSN details",
            "minLength":0,
            "maxLength":35,
            "pattern":"([a-zA-Z0-9\\s]+)?"
        },
        "dsnName":{
            "type":"string",
            "description":"DSN name"
        },
        "hostName":{
            "type":"string",
            "description":"Host name to which the branch belongs to.",
            "minLength":0,
            "maxLength":35,
            "pattern":"([a-zA-Z0-9\\s]+)?"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch code of the branch to be configured."
        },
        "id":{
            "type":"string",
            "description":"Primary Key"
        },
        "coreBranchId":{
            "type":"string",
            "description":"Master Table Reference."
        }
    }
}

Nested Schema : CoreSwiftAddressDTO

Type: array

Show Source

• Array of: object CoreSwiftAddressDTO

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

Nested Schema : CoreSwiftAddressDTO

Type: object

Show Source

• branchCode: string
  Branch Code
• coreBranchId: string
  Master Table Reference
• defaultBic: string
  Pattern: [Y,N]

  Checkbox to decide If default BIC is used or not
• id: string
  Primary Key
• swiftAddress(required): string
  Swift Address

{
    "type":"object",
    "properties":{
        "defaultBic":{
            "type":"string",
            "description":"Checkbox to decide If default BIC is used or not",
            "pattern":"[Y,N]"
        },
        "swiftAddress":{
            "type":"string",
            "description":"Swift Address"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "coreBranchId":{
            "type":"string",
            "description":"Master Table Reference"
        },
        "id":{
            "type":"string",
            "description":"Primary Key"
        }
    },
    "required":[
        "swiftAddress"
    ]
}

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.

500 Response

Internal error

Back to Top