Jump to

• Request
• Response

Close the core trn codes by given ID

patch

/service/coretrncodes/{trnCode}/close

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

Request

Supported Media Types

• application/json

Path Parameters

• trnCode: string
  trnCode of the coretrncodes maintenance

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

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

Root Schema : CloseDto

Type: object

Show Source

• remarks(optional): string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : TransactionCodeResponseDtoWrapper

Type: object

Show Source

• data(optional): object TransactionCodeDTO
• messages(optional): object ResponseDto

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

Nested Schema : TransactionCodeDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object TransactionCodeDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "trnCode":{
                    "type":"string",
                    "description":"Transaction code",
                    "minLength":1,
                    "maxLength":3,
                    "pattern":"[a-zA-Z0-9]+"
                },
                "trnDesc":{
                    "type":"string",
                    "description":"Description for Transaction Code",
                    "minLength":0,
                    "maxLength":105
                },
                "sourceSystem":{
                    "type":"string",
                    "description":"Name of the Source System",
                    "minLength":0,
                    "maxLength":35
                },
                "sourceSystemTrnCode":{
                    "type":"string",
                    "description":"Transaction code in the source system",
                    "minLength":0,
                    "maxLength":35,
                    "pattern":"([a-zA-Z0-9]+)?"
                }
            },
            "required":[
                "trnCode"
            ]
        }
    ]
}

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): 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 : TransactionCodeDTO-allOf[1]

Type: object

Show Source

• sourceSystem(optional): string
  Minimum Length: 0

  Maximum Length: 35

  Name of the Source System
• sourceSystemTrnCode(optional): string
  Minimum Length: 0

  Maximum Length: 35

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

  Transaction code in the source system
• trnCode: string
  Minimum Length: 1

  Maximum Length: 3

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

  Transaction code
• trnDesc(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Description for Transaction Code

{
    "type":"object",
    "properties":{
        "trnCode":{
            "type":"string",
            "description":"Transaction code",
            "minLength":1,
            "maxLength":3,
            "pattern":"[a-zA-Z0-9]+"
        },
        "trnDesc":{
            "type":"string",
            "description":"Description for Transaction Code",
            "minLength":0,
            "maxLength":105
        },
        "sourceSystem":{
            "type":"string",
            "description":"Name of the Source System",
            "minLength":0,
            "maxLength":35
        },
        "sourceSystemTrnCode":{
            "type":"string",
            "description":"Transaction code in the source system",
            "minLength":0,
            "maxLength":35,
            "pattern":"([a-zA-Z0-9]+)?"
        }
    },
    "required":[
        "trnCode"
    ]
}

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(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): 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