Jump to

• Request
• Response

Update a hearing body

patch

/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}

Request

Path Parameters

• publicSectorHearingBodiesUniqID(required): string
  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>

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The address line 1 of the public hearing location.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The address line 2 of the public hearing location.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The address line 3 of the public hearing location.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The address line 4 of the public hearing location.
• AppealOnlyFlag: boolean
  Maximum Length: 1

  Default Value: true

  The flag to indicate whether the hearing body is an appeal only body.
• AppealPeriod: integer
  Title: Appeal Period in Days

  The number of days after the hearing during which an appeal is allowed.
• BipTemplateId: string
  Title: Decision Making Body Report Template

  Maximum Length: 32

  The identifier for the BIP report template associated with the hearing body.
• CityName: string
  Title: City

  Maximum Length: 60

  The city in which the public hearing is scheduled.
• Classification: string
  Maximum Length: 10

  Default Value: ORA_PZ

  The classification of the hearing body .
• CountryCode: string
  Title: Country

  Maximum Length: 3

  The country code of the public hearing location.
• CountyCodeIncits: string
  Title: County

  Maximum Length: 60

  The county in which the public hearing is scheduled.
• DayRecurrences: array Hearing Body Day Recurrences
  Title: Hearing Body Day Recurrences

  The hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting.
• Description: string
  Title: Additional Information

  Maximum Length: 800

  The description of the hearing body.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates if the hearing body is available to use.
• ExpirationPeriod: integer
  Title: Expiration Period

  The number of days after the hearing when the hearing schedule expires.
• FridayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Friday.
• MaximumAgendaItems: integer
  Title: Maximum Agenda Items

  The maximum number of agenda items that can be heard on a day.
• MondayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Monday.
• MonthRecurOption: string
  Title: Months Between Occurrences

  Maximum Length: 15

  Default Value: ORA_DATE

  The frequency in months within which the hearing body meets.
• Name: string
  Title: Name

  Maximum Length: 200

  The name of the hearing body.
• NotificationPeriod: integer
  Title: Reminder Notification Period

  The hearing body notification period.
• PostalPlus4Code: string
  Maximum Length: 10

  The postal code of the location in which the public hearing is scheduled.
• Province: string
  Title: Province

  Maximum Length: 60

  The province in which the public hearing is scheduled.
• RecurFrequency: integer (int32)
  Title: Weeks Between Occurrences

  The frequency in weeks within which the hearing body meets.
• RecurrenceOption: string
  Title: Recurrence Pattern

  Maximum Length: 15

  The recurrence of the hearing meetings of the hearing body.
• SaturdayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Saturday.
• StartDatetime: string (date-time)
  Title: Recurrence Start Date Time

  The start date and time of the meeting recurrence.
• StateCodeISO: string
  Title: State

  Maximum Length: 60

  The state in which the public hearing is scheduled.
• SundayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Sunday.
• ThursdayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Thursday.
• TuesdayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Tuesday.
• WednesdayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Wednesday.
• WeekRecurrences: array Hearing Body Week Recurrences
  Title: Hearing Body Week Recurrences

  The hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting.
• ZipCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the public hearing location.

{
    "type":"object",
    "properties":{
        "BipTemplateId":{
            "title":"Decision Making Body Report Template",
            "maxLength":"32",
            "type":"string",
            "description":"The identifier for the BIP report template associated with the hearing body.",
            "nullable":true
        },
        "StartDatetime":{
            "title":"Recurrence Start Date Time",
            "type":"string",
            "description":"The start date and time of the meeting recurrence.",
            "format":"date-time",
            "nullable":false
        },
        "Description":{
            "title":"Additional Information",
            "maxLength":"800",
            "type":"string",
            "description":"The description of the hearing body.",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the hearing body.",
            "nullable":false
        },
        "AppealOnlyFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The flag to indicate whether the hearing body is an appeal only body.",
            "nullable":true,
            "default":true
        },
        "ExpirationPeriod":{
            "title":"Expiration Period",
            "type":"integer",
            "description":"The number of days after the hearing when the hearing schedule expires.",
            "nullable":true
        },
        "MaximumAgendaItems":{
            "title":"Maximum Agenda Items",
            "type":"integer",
            "description":"The maximum number of agenda items that can be heard on a day.",
            "nullable":true
        },
        "DayRecurrences":{
            "title":"Hearing Body Day Recurrences",
            "type":"array",
            "description":"The hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting.",
            "items":{
                "$ref":"#/components/schemas/publicSectorHearingBodies-DayRecurrences-item-patch-request"
            }
        },
        "AppealPeriod":{
            "title":"Appeal Period in Days",
            "type":"integer",
            "description":"The number of days after the hearing during which an appeal is allowed.",
            "nullable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The address line 4 of the public hearing location.",
            "nullable":true
        },
        "Classification":{
            "maxLength":"10",
            "type":"string",
            "description":"The classification of the hearing body .",
            "nullable":false,
            "default":"ORA_PZ"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the hearing body is available to use.",
            "nullable":false
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country code of the public hearing location.",
            "nullable":true
        },
        "RecurFrequency":{
            "title":"Weeks Between Occurrences",
            "type":"integer",
            "description":"The frequency in weeks within which the hearing body meets.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "FridayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Friday.",
            "nullable":true
        },
        "ThursdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Thursday.",
            "nullable":true
        },
        "StateCodeISO":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in which the public hearing is scheduled.",
            "nullable":true
        },
        "ZipCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the public hearing location.",
            "nullable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The address line 2 of the public hearing location.",
            "nullable":true
        },
        "MonthRecurOption":{
            "title":"Months Between Occurrences",
            "maxLength":"15",
            "type":"string",
            "description":"The frequency in months within which the hearing body meets.",
            "nullable":false,
            "default":"ORA_DATE"
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The address line 3 of the public hearing location.",
            "nullable":true
        },
        "WednesdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Wednesday.",
            "nullable":true
        },
        "SundayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Sunday.",
            "nullable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The address line 1 of the public hearing location.",
            "nullable":true
        },
        "CityName":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in which the public hearing is scheduled.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in which the public hearing is scheduled.",
            "nullable":true
        },
        "CountyCodeIncits":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in which the public hearing is scheduled.",
            "nullable":true
        },
        "SaturdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Saturday.",
            "nullable":true
        },
        "PostalPlus4Code":{
            "maxLength":"10",
            "type":"string",
            "description":"The postal code of the location in which the public hearing is scheduled.",
            "nullable":true
        },
        "NotificationPeriod":{
            "title":"Reminder Notification Period",
            "type":"integer",
            "description":"The hearing body notification period.",
            "nullable":true
        },
        "MondayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Monday.",
            "nullable":true
        },
        "RecurrenceOption":{
            "title":"Recurrence Pattern",
            "maxLength":"15",
            "type":"string",
            "description":"The recurrence of the hearing meetings of the hearing body.",
            "nullable":false
        },
        "TuesdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Tuesday.",
            "nullable":true
        },
        "WeekRecurrences":{
            "title":"Hearing Body Week Recurrences",
            "type":"array",
            "description":"The hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting.",
            "items":{
                "$ref":"#/components/schemas/publicSectorHearingBodies-WeekRecurrences-item-patch-request"
            }
        }
    }
}

Nested Schema : Hearing Body Day Recurrences

Type: array

Title: Hearing Body Day Recurrences

The hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting.

Show Source

• Array of: object publicSectorHearingBodies-DayRecurrences-item-patch-request

{
    "title":"Hearing Body Day Recurrences",
    "type":"array",
    "description":"The hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting.",
    "items":{
        "$ref":"#/components/schemas/publicSectorHearingBodies-DayRecurrences-item-patch-request"
    }
}

Nested Schema : Hearing Body Week Recurrences

Type: array

Title: Hearing Body Week Recurrences

The hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting.

Show Source

• Array of: object schema

{
    "title":"Hearing Body Week Recurrences",
    "type":"array",
    "description":"The hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting.",
    "items":{
        "$ref":"#/components/schemas/publicSectorHearingBodies-WeekRecurrences-item-patch-request"
    }
}

Nested Schema : publicSectorHearingBodies-DayRecurrences-item-patch-request

Type: object

Show Source

• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the hearing body day recurrence is available to use.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the hearing body day recurrence is available to use.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates if the hearing body week recurrence is available to use.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the hearing body week recurrence is available to use.",
            "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 : publicSectorHearingBodies-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The address line 1 of the public hearing location.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The address line 2 of the public hearing location.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The address line 3 of the public hearing location.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The address line 4 of the public hearing location.
• AgencyId: integer
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency.
• AppealOnlyFlag: boolean
  Maximum Length: 1

  Default Value: true

  The flag to indicate whether the hearing body is an appeal only body.
• AppealPeriod: integer
  Title: Appeal Period in Days

  The number of days after the hearing during which an appeal is allowed.
• BipTemplateId: string
  Title: Decision Making Body Report Template

  Maximum Length: 32

  The identifier for the BIP report template associated with the hearing body.
• CityName: string
  Title: City

  Maximum Length: 60

  The city in which the public hearing is scheduled.
• Classification: string
  Maximum Length: 10

  Default Value: ORA_PZ

  The classification of the hearing body .
• CountryCode: string
  Title: Country

  Maximum Length: 3

  The country code of the public hearing location.
• CountyCodeIncits: string
  Title: County

  Maximum Length: 60

  The county in which the public hearing is scheduled.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the hearing body row was created.
• DayRecurrences: array Hearing Body Day Recurrences
  Title: Hearing Body Day Recurrences

  The hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting.
• Description: string
  Title: Additional Information

  Maximum Length: 800

  The description of the hearing body.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates if the hearing body is available to use.
• ExpirationPeriod: integer
  Title: Expiration Period

  The number of days after the hearing when the hearing schedule expires.
• FridayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Friday.
• HearingBodyCode: string
  Title: Hearing Body Code

  Maximum Length: 60

  The unique identifier of the hearing body.
• HearingHierarchyCode: string
  Maximum Length: 60

  The hearing hierarchy code mapped to the hearing body.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the hearing body row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The name of the user who updated the hearing body row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumAgendaItems: integer
  Title: Maximum Agenda Items

  The maximum number of agenda items that can be heard on a day.
• MondayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Monday.
• MonthRecurOption: string
  Title: Months Between Occurrences

  Maximum Length: 15

  Default Value: ORA_DATE

  The frequency in months within which the hearing body meets.
• Name: string
  Title: Name

  Maximum Length: 200

  The name of the hearing body.
• NotificationPeriod: integer
  Title: Reminder Notification Period

  The hearing body notification period.
• PostalPlus4Code: string
  Maximum Length: 10

  The postal code of the location in which the public hearing is scheduled.
• Province: string
  Title: Province

  Maximum Length: 60

  The province in which the public hearing is scheduled.
• RecurFrequency: integer (int32)
  Title: Weeks Between Occurrences

  The frequency in weeks within which the hearing body meets.
• RecurrenceOption: string
  Title: Recurrence Pattern

  Maximum Length: 15

  The recurrence of the hearing meetings of the hearing body.
• SaturdayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Saturday.
• StartDatetime: string (date-time)
  Title: Recurrence Start Date Time

  The start date and time of the meeting recurrence.
• StateCodeISO: string
  Title: State

  Maximum Length: 60

  The state in which the public hearing is scheduled.
• SundayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Sunday.
• ThursdayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Thursday.
• TuesdayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Tuesday.
• WednesdayFlag: boolean
  Maximum Length: 1

  The hearing body meeting recurrence option for Wednesday.
• WeekRecurrences: array Hearing Body Week Recurrences
  Title: Hearing Body Week Recurrences

  The hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting.
• ZipCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the public hearing location.

{
    "type":"object",
    "properties":{
        "BipTemplateId":{
            "title":"Decision Making Body Report Template",
            "maxLength":"32",
            "type":"string",
            "description":"The identifier for the BIP report template associated with the hearing body.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the hearing body row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDatetime":{
            "title":"Recurrence Start Date Time",
            "type":"string",
            "description":"The start date and time of the meeting recurrence.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Additional Information",
            "maxLength":"800",
            "type":"string",
            "description":"The description of the hearing body.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "HearingBodyCode":{
            "title":"Hearing Body Code",
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the hearing body.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the hearing body.",
            "nullable":false,
            "x-queryable":true
        },
        "AppealOnlyFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The flag to indicate whether the hearing body is an appeal only body.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "ExpirationPeriod":{
            "title":"Expiration Period",
            "type":"integer",
            "description":"The number of days after the hearing when the hearing schedule expires.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumAgendaItems":{
            "title":"Maximum Agenda Items",
            "type":"integer",
            "description":"The maximum number of agenda items that can be heard on a day.",
            "nullable":true,
            "x-queryable":true
        },
        "DayRecurrences":{
            "title":"Hearing Body Day Recurrences",
            "type":"array",
            "description":"The hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting.",
            "items":{
                "$ref":"#/components/schemas/publicSectorHearingBodies-DayRecurrences-item-response"
            }
        },
        "AppealPeriod":{
            "title":"Appeal Period in Days",
            "type":"integer",
            "description":"The number of days after the hearing during which an appeal is allowed.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The address line 4 of the public hearing location.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"10",
            "type":"string",
            "description":"The classification of the hearing body .",
            "nullable":false,
            "default":"ORA_PZ",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the hearing body is available to use.",
            "nullable":false,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country code of the public hearing location.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who updated the hearing body row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurFrequency":{
            "title":"Weeks Between Occurrences",
            "type":"integer",
            "description":"The frequency in weeks within which the hearing body meets.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "FridayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Friday.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the hearing body row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ThursdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Thursday.",
            "nullable":true,
            "x-queryable":true
        },
        "StateCodeISO":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in which the public hearing is scheduled.",
            "nullable":true,
            "x-queryable":true
        },
        "ZipCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the public hearing location.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The address line 2 of the public hearing location.",
            "nullable":true,
            "x-queryable":true
        },
        "MonthRecurOption":{
            "title":"Months Between Occurrences",
            "maxLength":"15",
            "type":"string",
            "description":"The frequency in months within which the hearing body meets.",
            "nullable":false,
            "default":"ORA_DATE",
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The address line 3 of the public hearing location.",
            "nullable":true,
            "x-queryable":true
        },
        "WednesdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Wednesday.",
            "nullable":true,
            "x-queryable":true
        },
        "SundayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Sunday.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The address line 1 of the public hearing location.",
            "nullable":true,
            "x-queryable":true
        },
        "CityName":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in which the public hearing is scheduled.",
            "nullable":true,
            "x-queryable":true
        },
        "HearingHierarchyCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The hearing hierarchy code mapped to the hearing body.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in which the public hearing is scheduled.",
            "nullable":true,
            "x-queryable":true
        },
        "CountyCodeIncits":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in which the public hearing is scheduled.",
            "nullable":true,
            "x-queryable":true
        },
        "SaturdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Saturday.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":"10",
            "type":"string",
            "description":"The postal code of the location in which the public hearing is scheduled.",
            "nullable":true,
            "x-queryable":true
        },
        "NotificationPeriod":{
            "title":"Reminder Notification Period",
            "type":"integer",
            "description":"The hearing body notification period.",
            "nullable":true,
            "x-queryable":true
        },
        "MondayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Monday.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurrenceOption":{
            "title":"Recurrence Pattern",
            "maxLength":"15",
            "type":"string",
            "description":"The recurrence of the hearing meetings of the hearing body.",
            "nullable":false,
            "x-queryable":true
        },
        "TuesdayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The hearing body meeting recurrence option for Tuesday.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the hearing body row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WeekRecurrences":{
            "title":"Hearing Body Week Recurrences",
            "type":"array",
            "description":"The hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting.",
            "items":{
                "$ref":"#/components/schemas/publicSectorHearingBodies-WeekRecurrences-item-response"
            }
        }
    }
}

Nested Schema : Hearing Body Day Recurrences

Type: array

Title: Hearing Body Day Recurrences

The hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting.

Show Source

• Array of: object publicSectorHearingBodies-DayRecurrences-item-response

{
    "title":"Hearing Body Day Recurrences",
    "type":"array",
    "description":"The hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting.",
    "items":{
        "$ref":"#/components/schemas/publicSectorHearingBodies-DayRecurrences-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 : Hearing Body Week Recurrences

Type: array

Title: Hearing Body Week Recurrences

The hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting.

Show Source

• Array of: object publicSectorHearingBodies-WeekRecurrences-item-response

{
    "title":"Hearing Body Week Recurrences",
    "type":"array",
    "description":"The hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting.",
    "items":{
        "$ref":"#/components/schemas/publicSectorHearingBodies-WeekRecurrences-item-response"
    }
}

Nested Schema : publicSectorHearingBodies-DayRecurrences-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency ID of the record.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 1

  Indicates whether the hearing body day recurrence is available to use.
• HearingBodyCode: string
  Title: Hearing Body Code

  Maximum Length: 60

  The hearing body code of the record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Occurrence: integer (int32)
  Title: Date

  The dates of the month when the hearing body meets. For example, 2, 30.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency ID of the record.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "HearingBodyCode":{
            "title":"Hearing Body Code",
            "maxLength":"60",
            "type":"string",
            "description":"The hearing body code of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the hearing body day recurrence is available to use.",
            "nullable":false,
            "x-queryable":true
        },
        "Occurrence":{
            "title":"Date",
            "type":"integer",
            "description":"The dates of the month when the hearing body meets. For example, 2, 30.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Nested Schema : publicSectorHearingBodies-WeekRecurrences-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 1

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

  Maximum Length: 60

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Occurrence: string
  Title: Occurrence

  Maximum Length: 15

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

  Maximum Length: 15

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

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

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"
    }
}

Links

DayRecurrences

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/DayRecurrences

Parameters:

• publicSectorHearingBodiesUniqID: $request.path.publicSectorHearingBodiesUniqID

The hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting.

WeekRecurrences

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences

Parameters:

• publicSectorHearingBodiesUniqID: $request.path.publicSectorHearingBodiesUniqID

The hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting.

Back to Top