Jump to

• Request
• Response

Create a set of hearings

post

/fscmRestApi/resources/11.13.18.05/publicSectorHearings

Request

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

• DecisionComments: string
  Title: Comments

  Maximum Length: 1000

  The comments on the decision.
• EventDecision: string
  Title: Decision

  Maximum Length: 15

  The decision of the hearing event.
• EventDecisionDatetime: string (date-time)
  The date and time of the hearing event decision.
• EventStatus: string
  Title: Decision Status

  Maximum Length: 15

  Default Value: ORA_NOTSTRTD

  The status of the hearing event.
• HearingDecisionCode: string
  Title: Decision

  Maximum Length: 15

  The unique identifier of the hearing decision.
• HearingEventPuid: string
  Maximum Length: 480

  Default Value: 0

  The public unique identifier of the hearing event record.
• HearingHierarchyCode: string
  Title: Hierarchy Code

  Maximum Length: 60

  The code of the hearing hierarchy record.
• HearingPuid: string
  Maximum Length: 480

  The public unique identifier of the hearing record.
• HearingSequencePuid: string
  Maximum Length: 480

  Default Value: 0

  The public unique identifier of the hearing sequence record.
• LnpRecordKey: integer (int64)
  The unique identifier of the planning and zoning application.
• LnpRecordPuid: string
  Maximum Length: 480

  The public unique identifier of the planning and zoning application.
• ScheduleDatetime: string (date-time)
  Title: Decision Date

  The date and time of the scheduled hearing.
• ScheduleOrder: integer (int32)
  Default Value: 0

  The order of the hearings scheduled for a day.
• ScheduleStatus: string
  Title: Schedule Status

  Maximum Length: 15

  Default Value: ORA_UNSCHLD

  The status of the hearing schedule. For example Tentative, Final.
• StaffDecisionCode: string
  Maximum Length: 15

  The unique identifier of the staff decision.
• StaffDecisionComments: string
  Title: Comments

  Maximum Length: 1000

  The comments of the staff decision.
• StaffDecisionDatetime: string (date-time)
  Title: Staff Recommendation Date

  The date and time when the staff decision was updated.

{
    "type":"object",
    "properties":{
        "HearingPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the hearing record.",
            "nullable":false
        },
        "HearingDecisionCode":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the hearing decision.",
            "nullable":true
        },
        "EventDecision":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The decision of the hearing event.",
            "nullable":true
        },
        "ScheduleDatetime":{
            "title":"Decision Date",
            "type":"string",
            "description":"The date and time of the scheduled hearing.",
            "format":"date-time",
            "nullable":true
        },
        "EventStatus":{
            "title":"Decision Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the hearing event.",
            "nullable":false,
            "default":"ORA_NOTSTRTD"
        },
        "HearingSequencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the hearing sequence record.",
            "nullable":false,
            "default":"0"
        },
        "ScheduleOrder":{
            "type":"integer",
            "description":"The order of the hearings scheduled for a day.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":5
            }
        },
        "StaffDecisionDatetime":{
            "title":"Staff Recommendation Date",
            "type":"string",
            "description":"The date and time when the staff decision was updated.",
            "format":"date-time",
            "nullable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "HearingHierarchyCode":{
            "title":"Hierarchy Code",
            "maxLength":60,
            "type":"string",
            "description":"The code of the hearing hierarchy record.",
            "nullable":false
        },
        "DecisionComments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments on the decision.",
            "nullable":true
        },
        "HearingEventPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the hearing event record.",
            "nullable":false,
            "default":"0"
        },
        "EventDecisionDatetime":{
            "type":"string",
            "description":"The date and time of the hearing event decision.",
            "format":"date-time",
            "nullable":true
        },
        "LnpRecordPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the planning and zoning application.",
            "nullable":false
        },
        "StaffDecisionComments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments of the staff decision.",
            "nullable":true
        },
        "StaffDecisionCode":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the staff decision.",
            "nullable":true
        },
        "ScheduleStatus":{
            "title":"Schedule Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the hearing schedule. For example Tentative, Final.",
            "nullable":false,
            "default":"ORA_UNSCHLD"
        }
    }
}

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 : publicSectorHearings-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  Default Value: 1

  The unique identifier of the agency.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the hearing was created.
• DecisionComments: string
  Title: Comments

  Maximum Length: 1000

  The comments on the decision.
• EventDecision: string
  Title: Decision

  Maximum Length: 15

  The decision of the hearing event.
• EventDecisionDatetime: string (date-time)
  The date and time of the hearing event decision.
• EventStatus: string
  Title: Decision Status

  Maximum Length: 15

  Default Value: ORA_NOTSTRTD

  The status of the hearing event.
• HearingAppealKey: integer (int64)
  Read Only: true

  The unique identifier of the hearing appeal record.
• HearingBodyCode: string
  Title: Hearing Body Code

  Read Only: true

  Maximum Length: 60

  The code of the hearing body record.
• HearingBodyName: string
  Title: Decision Making Body

  Read Only: true

  Maximum Length: 200

  The name of the hearing body record.
• HearingDecisionCode: string
  Title: Decision

  Maximum Length: 15

  The unique identifier of the hearing decision.
• HearingDecisionName: string
  Title: Decision

  Read Only: true

  Maximum Length: 60

  The name of the hearing decision.
• HearingEventKey: integer (int64)
  Title: Hearing Event Key

  Read Only: true

  The unique identifier of the hearing event record.
• HearingEventPuid: string
  Maximum Length: 480

  Default Value: 0

  The public unique identifier of the hearing event record.
• HearingHierarchyCode: string
  Title: Hierarchy Code

  Maximum Length: 60

  The code of the hearing hierarchy record.
• HearingKey: integer (int64)
  Read Only: true

  The unique identifier of the hearing record.
• HearingPuid: string
  Maximum Length: 480

  The public unique identifier of the hearing record.
• HearingSequenceKey: integer (int64)
  Read Only: true

  The unique identifier of the hearing sequence record.
• HearingSequencePuid: string
  Maximum Length: 480

  Default Value: 0

  The public unique identifier of the hearing sequence record.
• IsAppealAllowedFlag: string
  Read Only: true

  The flag to indicate whether appeal is allowed.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the hearing was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordKey: integer (int64)
  The unique identifier of the planning and zoning application.
• LnpRecordPuid: string
  Maximum Length: 480

  The public unique identifier of the planning and zoning application.
• ParentEventKey: integer (int64)
  Read Only: true

  The unique identifier of the parent hearing event.
• ParentSequenceKey: integer (int64)
  Read Only: true

  The unique identifier of the parent hearing sequence.
• ScheduleDatetime: string (date-time)
  Title: Decision Date

  The date and time of the scheduled hearing.
• ScheduleOrder: integer (int32)
  Default Value: 0

  The order of the hearings scheduled for a day.
• ScheduleStatus: string
  Title: Schedule Status

  Maximum Length: 15

  Default Value: ORA_UNSCHLD

  The status of the hearing schedule. For example Tentative, Final.
• SequenceAction: string
  Title: Hearing Outcome

  Read Only: true

  Maximum Length: 15

  The hearing sequence action of the record.
• SequenceActionDatetime: string (date-time)
  Read Only: true

  The date and time of the hearing sequence record.
• StaffDecisionCode: string
  Maximum Length: 15

  The unique identifier of the staff decision.
• StaffDecisionComments: string
  Title: Comments

  Maximum Length: 1000

  The comments of the staff decision.
• StaffDecisionDatetime: string (date-time)
  Title: Staff Recommendation Date

  The date and time when the staff decision was updated.
• StaffDecisionName: string
  Read Only: true

  Maximum Length: 255

  The name of the staff decision.

{
    "type":"object",
    "properties":{
        "HearingKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SequenceActionDatetime":{
            "type":"string",
            "description":"The date and time of the hearing sequence record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the hearing was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingDecisionCode":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the hearing decision.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "HearingSequenceKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing sequence record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ParentEventKey":{
            "type":"integer",
            "description":"The unique identifier of the parent hearing event.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HearingBodyCode":{
            "title":"Hearing Body Code",
            "maxLength":60,
            "type":"string",
            "description":"The code of the hearing body record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleDatetime":{
            "title":"Decision Date",
            "type":"string",
            "description":"The date and time of the scheduled hearing.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EventStatus":{
            "title":"Decision Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the hearing event.",
            "nullable":false,
            "default":"ORA_NOTSTRTD",
            "x-queryable":true
        },
        "HearingSequencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the hearing sequence record.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "IsAppealAllowedFlag":{
            "type":"string",
            "description":"The flag to indicate whether appeal is allowed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DecisionComments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments on the decision.",
            "nullable":true,
            "x-queryable":true
        },
        "HearingEventKey":{
            "title":"Hearing Event Key",
            "type":"integer",
            "description":"The unique identifier of the hearing event record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StaffDecisionName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the staff decision.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingEventPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the hearing event record.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "HearingDecisionName":{
            "title":"Decision",
            "maxLength":60,
            "type":"string",
            "description":"The name of the hearing decision.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the planning and zoning application.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SequenceAction":{
            "title":"Hearing Outcome",
            "maxLength":15,
            "type":"string",
            "description":"The hearing sequence action of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the hearing record.",
            "nullable":false,
            "x-queryable":true
        },
        "EventDecision":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The decision of the hearing event.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleOrder":{
            "type":"integer",
            "description":"The order of the hearings scheduled for a day.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "StaffDecisionDatetime":{
            "title":"Staff Recommendation Date",
            "type":"string",
            "description":"The date and time when the staff decision was updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HearingHierarchyCode":{
            "title":"Hierarchy Code",
            "maxLength":60,
            "type":"string",
            "description":"The code of the hearing hierarchy record.",
            "nullable":false,
            "x-queryable":true
        },
        "HearingBodyName":{
            "title":"Decision Making Body",
            "maxLength":200,
            "type":"string",
            "description":"The name of the hearing body record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentSequenceKey":{
            "type":"integer",
            "description":"The unique identifier of the parent hearing sequence.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HearingAppealKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing appeal record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventDecisionDatetime":{
            "type":"string",
            "description":"The date and time of the hearing event decision.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StaffDecisionComments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments of the staff decision.",
            "nullable":true,
            "x-queryable":true
        },
        "StaffDecisionCode":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the staff decision.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleStatus":{
            "title":"Schedule Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the hearing schedule. For example Tentative, Final.",
            "nullable":false,
            "default":"ORA_UNSCHLD",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the hearing 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