Jump to

• Request
• Response

Update a hearing body week recurrence

patch

/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences/{WeekRecurrencesUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• WeekRecurrencesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId, HearingBodyCode, Occurrence and WeekDay ---for the Hearing Body Week Recurrences resource and used to uniquely identify an instance of Hearing Body Week Recurrences. The client should not generate the hash key value. Instead, the client should query on the Hearing Body Week Recurrences collection resource with a filter on the primary key values in order to navigate to a specific instance of Hearing Body Week Recurrences.
  
  For example: WeekRecurrences?q=AgencyId=<value1>;HearingBodyCode=<value2>;Occurrence=<value3>;WeekDay=<value4>
• publicSectorHearingBodiesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and HearingBodyCode ---for the Hearing Bodies resource and used to uniquely identify an instance of Hearing Bodies. The client should not generate the hash key value. Instead, the client should query on the Hearing Bodies collection resource with a filter on the primary key values in order to navigate to a specific instance of Hearing Bodies.
  
  For example: publicSectorHearingBodies?q=AgencyId=<value1>;HearingBodyCode=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorHearingBodies-WeekRecurrences-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates if the hearing body week recurrence is available to use.
• HearingBodyCode(optional): string
  Title: Hearing Body Code

  Maximum Length: 60

  The unique identifier of the hearing body.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• Occurrence(optional): string
  Title: Occurrence

  Maximum Length: 15

  The recurrence frequency of the hearing body meeting in a month. For example First Monday, Second Wednesday.
• WeekDay(optional): string
  Title: Weekday

  Maximum Length: 15

  The day of the week when the hearing body meeting is scheduled. For example Monday, Tuesday.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates if the hearing body week recurrence is available to use.",
            "title":"Enabled"
        },
        "HearingBodyCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier of the hearing body.",
            "title":"Hearing Body Code"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Occurrence":{
            "maxLength":15,
            "type":"string",
            "description":"The recurrence frequency of the hearing body meeting in a month. For example First Monday, Second Wednesday.",
            "title":"Occurrence"
        },
        "WeekDay":{
            "maxLength":15,
            "type":"string",
            "description":"The day of the week when the hearing body meeting is scheduled. For example Monday, Tuesday.",
            "title":"Weekday"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorHearingBodies-WeekRecurrences-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates if the hearing body week recurrence is available to use.
• HearingBodyCode(optional): string
  Title: Hearing Body Code

  Maximum Length: 60

  The unique identifier of the hearing body.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• Occurrence(optional): string
  Title: Occurrence

  Maximum Length: 15

  The recurrence frequency of the hearing body meeting in a month. For example First Monday, Second Wednesday.
• WeekDay(optional): string
  Title: Weekday

  Maximum Length: 15

  The day of the week when the hearing body meeting is scheduled. For example Monday, Tuesday.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates if the hearing body week recurrence is available to use.",
            "title":"Enabled"
        },
        "HearingBodyCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier of the hearing body.",
            "title":"Hearing Body Code"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Occurrence":{
            "maxLength":15,
            "type":"string",
            "description":"The recurrence frequency of the hearing body meeting in a month. For example First Monday, Second Wednesday.",
            "title":"Occurrence"
        },
        "WeekDay":{
            "maxLength":15,
            "type":"string",
            "description":"The day of the week when the hearing body meeting is scheduled. For example Monday, Tuesday.",
            "title":"Weekday"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top