Jump to

• Request
• Response

Update an existing rule

put

/service/localholidays/{branchCode}/{year}

This endpoint is used to update an existing local holidays.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• branchCode: string
  branchCode of the localholidaycalendars Maintenance
• year: number
  year of the localholidaycalendars Maintenance

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

Request Body that contains data required for updating an existing localholidays

Root Schema : CmcTmLocalHolidayMasterDto

Type: object

Match All

Show Source

• allOf GenericDto
• object CmcTmLocalHolidayMasterDto-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "branchCode":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":3
                },
                "year":{
                    "type":"number",
                    "minLength":0,
                    "maxLength":4
                },
                "weeklyHolidays":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":7
                },
                "unexpHol":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "CmcTmLocalHolidayDto":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CmcTmLocalHolidayDto"
                    }
                }
            },
            "required":[
                "branchCode",
                "year"
            ]
        }
    ]
}

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

Type: object

Show Source

• branchCode: string
  Minimum Length: 0

  Maximum Length: 3
• CmcTmLocalHolidayDto(optional): array CmcTmLocalHolidayDto
• unexpHol(optional): string
  Minimum Length: 0

  Maximum Length: 1
• weeklyHolidays(optional): string
  Minimum Length: 0

  Maximum Length: 7
• year: number
  Minimum Length: 0

  Maximum Length: 4

{
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string",
            "minLength":0,
            "maxLength":3
        },
        "year":{
            "type":"number",
            "minLength":0,
            "maxLength":4
        },
        "weeklyHolidays":{
            "type":"string",
            "minLength":0,
            "maxLength":7
        },
        "unexpHol":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "CmcTmLocalHolidayDto":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CmcTmLocalHolidayDto"
            }
        }
    },
    "required":[
        "branchCode",
        "year"
    ]
}

Nested Schema : CmcTmLocalHolidayDto

Type: array

Show Source

• Array of: object CmcTmLocalHolidayDto

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

Nested Schema : CmcTmLocalHolidayDto

Type: object

Show Source

• branchCode(optional): string
  Minimum Length: 0

  Maximum Length: 3
• holidayList(optional): string
  Minimum Length: 0

  Maximum Length: 31
• id(optional): string
• localHolidayMasterId(optional): string
• month: number
  Minimum Length: 0

  Maximum Length: 2
• year(optional): number
  Minimum Length: 0

  Maximum Length: 4

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "branchCode":{
            "type":"string",
            "minLength":0,
            "maxLength":3
        },
        "year":{
            "type":"number",
            "minLength":0,
            "maxLength":4
        },
        "month":{
            "type":"number",
            "minLength":0,
            "maxLength":2
        },
        "holidayList":{
            "type":"string",
            "minLength":0,
            "maxLength":31
        },
        "localHolidayMasterId":{
            "type":"string"
        }
    },
    "required":[
        "month"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated localholidays

Body ()

Root Schema : CmcTmLocalHolidayMasterResponseDtoWrapper

Type: object

Show Source

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

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

Nested Schema : CmcTmLocalHolidayMasterDto

Type: object

Match All

Show Source

• allOf GenericDto
• object CmcTmLocalHolidayMasterDto-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "branchCode":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":3
                },
                "year":{
                    "type":"number",
                    "minLength":0,
                    "maxLength":4
                },
                "weeklyHolidays":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":7
                },
                "unexpHol":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "CmcTmLocalHolidayDto":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CmcTmLocalHolidayDto"
                    }
                }
            },
            "required":[
                "branchCode",
                "year"
            ]
        }
    ]
}

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

Type: object

Show Source

• branchCode: string
  Minimum Length: 0

  Maximum Length: 3
• CmcTmLocalHolidayDto(optional): array CmcTmLocalHolidayDto
• unexpHol(optional): string
  Minimum Length: 0

  Maximum Length: 1
• weeklyHolidays(optional): string
  Minimum Length: 0

  Maximum Length: 7
• year: number
  Minimum Length: 0

  Maximum Length: 4

{
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string",
            "minLength":0,
            "maxLength":3
        },
        "year":{
            "type":"number",
            "minLength":0,
            "maxLength":4
        },
        "weeklyHolidays":{
            "type":"string",
            "minLength":0,
            "maxLength":7
        },
        "unexpHol":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "CmcTmLocalHolidayDto":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CmcTmLocalHolidayDto"
            }
        }
    },
    "required":[
        "branchCode",
        "year"
    ]
}

Nested Schema : CmcTmLocalHolidayDto

Type: array

Show Source

• Array of: object CmcTmLocalHolidayDto

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

Nested Schema : CmcTmLocalHolidayDto

Type: object

Show Source

• branchCode(optional): string
  Minimum Length: 0

  Maximum Length: 3
• holidayList(optional): string
  Minimum Length: 0

  Maximum Length: 31
• id(optional): string
• localHolidayMasterId(optional): string
• month: number
  Minimum Length: 0

  Maximum Length: 2
• year(optional): number
  Minimum Length: 0

  Maximum Length: 4

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "branchCode":{
            "type":"string",
            "minLength":0,
            "maxLength":3
        },
        "year":{
            "type":"number",
            "minLength":0,
            "maxLength":4
        },
        "month":{
            "type":"number",
            "minLength":0,
            "maxLength":2
        },
        "holidayList":{
            "type":"string",
            "minLength":0,
            "maxLength":31
        },
        "localHolidayMasterId":{
            "type":"string"
        }
    },
    "required":[
        "month"
    ]
}

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.

405 Response

Invalid input

500 Response

Internal error

Back to Top