Jump to

• Request
• Response

Update a holiday calendar

patch

/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}

Request

Path Parameters

• publicSectorHolidayCalendarsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and CalendarId ---for the Holiday Calendars resource and used to uniquely identify an instance of Holiday Calendars. The client should not generate the hash key value. Instead, the client should query on the Holiday Calendars collection resource with a filter on the primary key values in order to navigate to a specific instance of Holiday Calendars.
  
  For example: publicSectorHolidayCalendars?q=AgencyId=<value1>;CalendarId=<value2>

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 100

  The description of the holiday calendar.
• HolidayCalendarDetail: array Holiday Calendar Events
  Title: Holiday Calendar Events

  The holiday calendar events resource is used to view, create, or modify holiday calendar events.
• ValidFromDate: string (date)
  Title: Valid from Date

  The start date on which the holiday calendar becomes effective.
• ValidToDate: string (date)
  Title: Valid to Date

  The end date after which the holiday calendar is no longer effective.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the holiday calendar.",
            "nullable":false
        },
        "HolidayCalendarDetail":{
            "title":"Holiday Calendar Events",
            "type":"array",
            "description":"The holiday calendar events resource is used to view, create, or modify holiday calendar events.",
            "items":{
                "$ref":"#/components/schemas/publicSectorHolidayCalendars-HolidayCalendarDetail-item-patch-request"
            }
        },
        "ValidFromDate":{
            "title":"Valid from Date",
            "type":"string",
            "description":"The start date on which the holiday calendar becomes effective.",
            "format":"date",
            "nullable":false
        },
        "ValidToDate":{
            "title":"Valid to Date",
            "type":"string",
            "description":"The end date after which the holiday calendar is no longer effective.",
            "format":"date",
            "nullable":false
        }
    }
}

Nested Schema : Holiday Calendar Events

Type: array

Title: Holiday Calendar Events

The holiday calendar events resource is used to view, create, or modify holiday calendar events.

Show Source

• Array of: object publicSectorHolidayCalendars-HolidayCalendarDetail-item-patch-request

{
    "title":"Holiday Calendar Events",
    "type":"array",
    "description":"The holiday calendar events resource is used to view, create, or modify holiday calendar events.",
    "items":{
        "$ref":"#/components/schemas/publicSectorHolidayCalendars-HolidayCalendarDetail-item-patch-request"
    }
}

Nested Schema : publicSectorHolidayCalendars-HolidayCalendarDetail-item-patch-request

Type: object

Show Source

• Comments: string
  Title: Description

  Maximum Length: 100

  The description of the holiday calendar event.
• EventDate: string (date)
  Title: Event Date

  The date of the holiday calendar event.

{
    "type":"object",
    "properties":{
        "Comments":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the holiday calendar event.",
            "nullable":false
        },
        "EventDate":{
            "title":"Event Date",
            "type":"string",
            "description":"The date of the holiday calendar event.",
            "format":"date",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorHolidayCalendars-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The agency identifier of the public sector entity to which this holiday calendar applies.
• CalendarId: string
  Title: Calendar ID

  Maximum Length: 30

  The unique identifier for the holiday calendar.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the holiday calendar.
• HolidayCalendarDetail: array Holiday Calendar Events
  Title: Holiday Calendar Events

  The holiday calendar events resource is used to view, create, or modify holiday calendar events.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ValidFromDate: string (date)
  Title: Valid from Date

  The start date on which the holiday calendar becomes effective.
• ValidToDate: string (date)
  Title: Valid to Date

  The end date after which the holiday calendar is no longer effective.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this holiday calendar applies.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CalendarId":{
            "title":"Calendar ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the holiday calendar.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the holiday calendar.",
            "nullable":false,
            "x-queryable":true
        },
        "HolidayCalendarDetail":{
            "title":"Holiday Calendar Events",
            "type":"array",
            "description":"The holiday calendar events resource is used to view, create, or modify holiday calendar events.",
            "items":{
                "$ref":"#/components/schemas/publicSectorHolidayCalendars-HolidayCalendarDetail-item-response"
            }
        },
        "ValidFromDate":{
            "title":"Valid from Date",
            "type":"string",
            "description":"The start date on which the holiday calendar becomes effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ValidToDate":{
            "title":"Valid to Date",
            "type":"string",
            "description":"The end date after which the holiday calendar is no longer effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Holiday Calendar Events

Type: array

Title: Holiday Calendar Events

The holiday calendar events resource is used to view, create, or modify holiday calendar events.

Show Source

• Array of: object publicSectorHolidayCalendars-HolidayCalendarDetail-item-response

{
    "title":"Holiday Calendar Events",
    "type":"array",
    "description":"The holiday calendar events resource is used to view, create, or modify holiday calendar events.",
    "items":{
        "$ref":"#/components/schemas/publicSectorHolidayCalendars-HolidayCalendarDetail-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorHolidayCalendars-HolidayCalendarDetail-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The agency identifier of the public sector entity to which this holiday calendar applies.
• CalendarId: string
  Title: Calendar ID

  Maximum Length: 30

  The unique identifier for the holiday calendar.
• Comments: string
  Title: Description

  Maximum Length: 100

  The description of the holiday calendar event.
• EventDate: string (date)
  Title: Event Date

  The date of the holiday calendar event.
• EventId: string
  Title: Event ID

  Maximum Length: 30

  The unique identifier for the holiday calendar event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this holiday calendar applies.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CalendarId":{
            "title":"Calendar ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the holiday calendar.",
            "nullable":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the holiday calendar event.",
            "nullable":false,
            "x-queryable":true
        },
        "EventDate":{
            "title":"Event Date",
            "type":"string",
            "description":"The date of the holiday calendar event.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EventId":{
            "title":"Event ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the holiday calendar event.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

HolidayCalendarDetail

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail

Parameters:

• publicSectorHolidayCalendarsUniqID: $request.path.publicSectorHolidayCalendarsUniqID

The holiday calendar events resource is used to view, create, or modify holiday calendar events.

Back to Top