Jump to

• Request
• Response

Create a set of hearing body week recurrences

post

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

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency.
• 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.
• 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":{
        "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
        },
        "HearingBodyCode":{
            "title":"Hearing Body Code",
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the hearing body.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the hearing body week recurrence is available to use.",
            "nullable":false
        },
        "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
        }
    }
}

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

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

Back to Top