Jump to

• Request
• Response

Create a permit agency options definition

post

/fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions

Request

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)
  Default Value: 1

  The identifier for the agency associated with the permit agency options.
• AllowHideBusInfoFlag: boolean
  Title: Allow hiding business information and associated licenses from public view

  Maximum Length: 1

  Default Value: false

  Controls whether users are allowed to hide business information from public view or not.
• AllowViewBusLicCertFlag: boolean
  Maximum Length: 1

  Default Value: false

  Allows public users to view the certificate on the business page.
• AutoPendingInspections: boolean
  Title: Enable Automatic Creation of Pending Inspections

  Maximum Length: 1

  Default Value: false

  Controls whether pending inspections are created automatically.
• BlApplyInstructions: string
  Title: Instructional Text for Business Licenses

  Maximum Length: 50

  A unique value that identifies an instructional text for Business License.
• BlBEDocGroupId: string
  Title: Business Entity Document Group

  Maximum Length: 30

  Stores the document group identifier for business entity attachments.
• BlDisplaySpecialistContact: string
  Title: Display Assigned Specialist Information to Public Users

  Maximum Length: 30

  Default Value: ORA_SPC_NONE

  Indicate which BL specialist's contact to display to public users.
• BlGeneralSpecialistEmail: string
  Title: Specialist's General Email

  Maximum Length: 320

  Indicate the general specialist's email to display to public users.
• BlInsEnablePostponeFlag: boolean
  Title: Enable Postpone Inspection

  Maximum Length: 1

  Default Value: true

  The switch enables users to postpone inspections for business licenses.
• BlInsPublicCancelOpt: string
  Title: Public User Cancel Options

  Maximum Length: 30

  The cancel inspection options available to public users for business licenses.
• BlLocDocGroupId: string
  Title: Business Location Document Group

  Maximum Length: 30

  Stores the document group identifier for business location attachments.
• BlMultiAppFlag: boolean
  Title: Enable Multiple Application Selection

  Maximum Length: 1

  Default Value: false

  Indicates the business license multiple application flag.
• BlMultiAppType: string
  Title: General Information Type

  Maximum Length: 20

  Indicates the business license multiple application type.
• BlOwnDocGroupId: string
  Title: Business Owner Document Group

  Maximum Length: 30

  Stores the document group identifier for business owner attachments.
• CascadingCycleDueDate: boolean
  Title: Enable Cascading Cycle Due Date

  Maximum Length: 1

  Default Value: false

  Controls whether plan review cycle due dates are cascaded.
• ConfidentialAttachFlag: boolean
  Title: Enable Confidential Attachments

  Maximum Length: 1

  Default Value: false

  Indicates whether the applicant is allowed to set an individual document as confidential.
• ContentUrl: string
  Title: Button Content URL

  Maximum Length: 250

  The content URL used to link to an agency page outside of the permits service.
• CopyAssignedFlag: boolean
  Title: Copy Assigned Specialist for Amendments and Renewals

  Maximum Length: 1

  Default Value: false

  Indicates whether the assigned planner or specialist should be copied to the new transaction.
• DefaultPlanReviewName: boolean
  Title: Enable Default of Plan Review Name

  Maximum Length: 1

  Default Value: true

  Controls whether plan review names are defaulted.
• ElectronicPlanReview: boolean
  Title: Enable Electronic Plan Review

  Maximum Length: 1

  Default Value: false

  Controls whether electronic plan review is enabled.
• InsArrivalDisplayReady: string
  Maximum Length: 30

  Default Value: ORA_SPECIFC_TIME

  Indicates inspections ready arrival display.
• InsArrivalDisplayRequest: string
  Maximum Length: 30

  Default Value: ORA_SPECIFC_TIME

  Indicates inspections request arrival display.
• InsArrivalDisplaySchedule: string
  Maximum Length: 30

  Default Value: ORA_SPECIFC_TIME

  Indicates inspections schedule arrival display.
• InsAssignmentMethodReady: string
  Maximum Length: 30

  Default Value: ORA_DURATION

  Indicates inspections ready assignment method.
• InsAssignmentMethodRequest: string
  Maximum Length: 30

  Default Value: ORA_DURATION

  Indicates inspections request assignment method.
• InsAssignmentMethodSchedule: string
  Maximum Length: 30

  Default Value: ORA_DURATION

  Indicates inspections schedule assignment method.
• InsTimeEntryReady: string
  Title: Ready

  Maximum Length: 30

  Default Value: ORA_SPECIFC_TIME

  Indicates inspections ready entry method.
• InsTimeEntryRequest: string
  Title: Request

  Maximum Length: 30

  Default Value: ORA_TIME_RANGE

  Indicates inspections request entry method.
• InsTimeEntrySchedule: string
  Maximum Length: 30

  Default Value: ORA_SPECIFC_TIME

  Indicates inspections schedule entry method.
• IssueReissueDatesOpt: string
  Title: Issuance and Reissuance Dates

  Maximum Length: 30

  Default Value: ORA_OVERWRITE

  Indicates the option whether the issue date can be overwritten by the reissue date.
• IVR: boolean
  Title: Enable IVR

  Maximum Length: 1

  Default Value: false

  Controls whether interactive voice response (IVR) is enabled.
• LongDescription: string (byte)
  Title: Landing Page Message

  The long version of the landing page message title in a sentence format.
• OfferingId: string
  Maximum Length: 50

  The unique identifier for the functional product Permits in Oracle Permitting and Licensing that is used by the agency.
• OpaPolicyId: string
  Title: Oracle Policy Automation ID

  Maximum Length: 150

  The identifier for the Oracle Policy Automation policy definition used for the permit guide.
• PendingInspections: boolean
  Title: Enable Creation of Pending Inspections

  Maximum Length: 1

  Default Value: false

  The switch indicates whether inspections in pending status can be created or not.
• PlanReviewProtectDocOption: string
  Title: Protected Documents

  Maximum Length: 30

  Default Value: ORA_PSC_PER_ALLOW

  Identifies the options that can be selected for the handling of archive protected PDF documents. The default value is ORA_PSC_PER_ALLOW for Allow Protected Documents.
• PmtApplyInstructions: string
  Title: Instructional Text for Permits

  Maximum Length: 50

  A unique value that identifies an instructional text for Permits.
• PmtInsEnablePostponeFlag: boolean
  Title: Enable Postpone Inspection

  Maximum Length: 1

  Default Value: true

  The switch enables users to postpone inspections for permits.
• PmtInsPublicCancelOpt: string
  Title: Public User Cancel Options

  Maximum Length: 30

  The cancel inspection options available to public users for permits.
• PzAllowAppealForSelf: boolean
  Title: Allow public users to submit appeal for themselves

  Maximum Length: 1

  Default Value: true

  Indicates public users can submit appeal for self.
• PzApplyInstructions: string
  Title: Instructional Text for Planning Applications

  Maximum Length: 50

  A unique value that identifies an instructional text for Planning and Zoning.
• PzDisplayPlannerContact: string
  Title: Display Assigned Planner Information to Public Users

  Maximum Length: 30

  Default Value: ORA_PLN_NONE

  Indicate which planner's contact to display to public users.
• PzGeneralPlannerEmail: string
  Title: Planner's General Email

  Maximum Length: 320

  Indicate the general planner's email to display to public users.
• ReportControlId: string
  Maximum Length: 32

  Identifies the type of consolidated report configurations for a business location.
• RequireCommentsInspection: string
  Title: Required Inspection Comments

  Maximum Length: 30

  Controls whether comments are required when results are provided on inspections or when an inspection is canceled.
• RequireCommentsPlanReview: string
  Title: Required Plan Review Comments

  Maximum Length: 30

  Controls whether comments are required when decisions are provided on plan reviews or when a plan review cycle is canceled.
• SchedTimeAfterDescr: string
  Title: Time Range After Breakpoint

  Maximum Length: 30

  The description to show instead of the inspection scheduled time if after the configured cutoff.
• SchedTimeBeforeDescr: string
  Title: Time Range Before Breakpoint

  Maximum Length: 30

  The description to show instead of the inspection scheduled time if before the configured cutoff.
• SchedTimeDisplayCutoff: string (date-time)
  Title: Scheduled Time Range Breakpoint

  Indicates the cutoff time to determine which description to show for the inspection scheduled time.
• ShortDescription: string
  Title: Message Summary

  Maximum Length: 300

  The short text version of the landing page message in a title format.
• TextLabel: string
  Title: Message Title

  Maximum Length: 100

  The information in rich text that appears in a dialog box when the user clicks the read more button on a public landing page. If a URL to access an agency page is defined, this message is not needed.

{
    "type":"object",
    "properties":{
        "SchedTimeBeforeDescr":{
            "title":"Time Range Before Breakpoint",
            "maxLength":"30",
            "type":"string",
            "description":"The description to show instead of the inspection scheduled time if before the configured cutoff.",
            "nullable":true
        },
        "ElectronicPlanReview":{
            "title":"Enable Electronic Plan Review",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether electronic plan review is enabled.",
            "nullable":false,
            "default":false
        },
        "PzApplyInstructions":{
            "title":"Instructional Text for Planning Applications",
            "maxLength":"50",
            "type":"string",
            "description":"A unique value that identifies an instructional text for Planning and Zoning.",
            "nullable":true
        },
        "InsArrivalDisplaySchedule":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections schedule arrival display.",
            "nullable":false,
            "default":"ORA_SPECIFC_TIME"
        },
        "ShortDescription":{
            "title":"Message Summary",
            "maxLength":"300",
            "type":"string",
            "description":"The short text version of the landing page message in a title format.",
            "nullable":true
        },
        "AllowViewBusLicCertFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Allows public users to view the certificate on the business page.",
            "nullable":false,
            "default":false
        },
        "InsTimeEntryReady":{
            "title":"Ready",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections ready entry method.",
            "nullable":false,
            "default":"ORA_SPECIFC_TIME"
        },
        "PendingInspections":{
            "title":"Enable Creation of Pending Inspections",
            "maxLength":"1",
            "type":"boolean",
            "description":"The switch indicates whether inspections in pending status can be created or not.",
            "nullable":false,
            "default":false
        },
        "ConfidentialAttachFlag":{
            "title":"Enable Confidential Attachments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the applicant is allowed to set an individual document as confidential.",
            "nullable":false,
            "default":false
        },
        "OpaPolicyId":{
            "title":"Oracle Policy Automation ID",
            "maxLength":"150",
            "type":"string",
            "description":"The identifier for the Oracle Policy Automation policy definition used for the permit guide.",
            "nullable":true
        },
        "BlMultiAppFlag":{
            "title":"Enable Multiple Application Selection",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the business license multiple application flag.",
            "nullable":false,
            "default":false
        },
        "BlOwnDocGroupId":{
            "title":"Business Owner Document Group",
            "maxLength":"30",
            "type":"string",
            "description":"Stores the document group identifier for business owner attachments.",
            "nullable":true
        },
        "OfferingId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the functional product Permits in Oracle Permitting and Licensing that is used by the agency.",
            "nullable":false
        },
        "BlDisplaySpecialistContact":{
            "title":"Display Assigned Specialist Information to Public Users",
            "maxLength":"30",
            "type":"string",
            "description":"Indicate which BL specialist's contact to display to public users.",
            "nullable":false,
            "default":"ORA_SPC_NONE"
        },
        "CopyAssignedFlag":{
            "title":"Copy Assigned Specialist for Amendments and Renewals",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the assigned planner or specialist should be copied to the new transaction.",
            "nullable":false,
            "default":false
        },
        "TextLabel":{
            "title":"Message Title",
            "maxLength":"100",
            "type":"string",
            "description":"The information in rich text that appears in a dialog box when the user clicks the read more button on a public landing page. If a URL to access an agency page is defined, this message is not needed.",
            "nullable":true
        },
        "BlMultiAppType":{
            "title":"General Information Type",
            "maxLength":"20",
            "type":"string",
            "description":"Indicates the business license multiple application type.",
            "nullable":true
        },
        "SchedTimeAfterDescr":{
            "title":"Time Range After Breakpoint",
            "maxLength":"30",
            "type":"string",
            "description":"The description to show instead of the inspection scheduled time if after the configured cutoff.",
            "nullable":true
        },
        "BlInsEnablePostponeFlag":{
            "title":"Enable Postpone Inspection",
            "maxLength":"1",
            "type":"boolean",
            "description":"The switch enables users to postpone inspections for business licenses.",
            "nullable":false,
            "default":true
        },
        "BlApplyInstructions":{
            "title":"Instructional Text for Business Licenses",
            "maxLength":"50",
            "type":"string",
            "description":"A unique value that identifies an instructional text for Business License.",
            "nullable":true
        },
        "CascadingCycleDueDate":{
            "title":"Enable Cascading Cycle Due Date",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether plan review cycle due dates are cascaded.",
            "nullable":false,
            "default":false
        },
        "AutoPendingInspections":{
            "title":"Enable Automatic Creation of Pending Inspections",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether pending inspections are created automatically.",
            "nullable":false,
            "default":false
        },
        "PmtInsEnablePostponeFlag":{
            "title":"Enable Postpone Inspection",
            "maxLength":"1",
            "type":"boolean",
            "description":"The switch enables users to postpone inspections for permits.",
            "nullable":false,
            "default":true
        },
        "DefaultPlanReviewName":{
            "title":"Enable Default of Plan Review Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether plan review names are defaulted.",
            "nullable":false,
            "default":true
        },
        "ContentUrl":{
            "title":"Button Content URL",
            "maxLength":"250",
            "type":"string",
            "description":"The content URL used to link to an agency page outside of the permits service.",
            "nullable":true
        },
        "BlLocDocGroupId":{
            "title":"Business Location Document Group",
            "maxLength":"30",
            "type":"string",
            "description":"Stores the document group identifier for business location attachments.",
            "nullable":true
        },
        "BlGeneralSpecialistEmail":{
            "title":"Specialist's General Email",
            "maxLength":"320",
            "type":"string",
            "description":"Indicate the general specialist's email to display to public users.",
            "nullable":true
        },
        "ReportControlId":{
            "maxLength":"32",
            "type":"string",
            "description":"Identifies the type of consolidated report configurations for a business location.",
            "nullable":true
        },
        "InsAssignmentMethodRequest":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections request assignment method.",
            "nullable":false,
            "default":"ORA_DURATION"
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the agency associated with the permit agency options.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "IVR":{
            "title":"Enable IVR",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether interactive voice response (IVR) is enabled.",
            "nullable":false,
            "default":false
        },
        "PzGeneralPlannerEmail":{
            "title":"Planner's General Email",
            "maxLength":"320",
            "type":"string",
            "description":"Indicate the general planner's email to display to public users.",
            "nullable":true
        },
        "RequireCommentsPlanReview":{
            "title":"Required Plan Review Comments",
            "maxLength":"30",
            "type":"string",
            "description":"Controls whether comments are required when decisions are provided on plan reviews or when a plan review cycle is canceled.",
            "nullable":true
        },
        "AllowHideBusInfoFlag":{
            "title":"Allow hiding business information and associated licenses from public view",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether users are allowed to hide business information from public view or not.",
            "nullable":false,
            "default":false
        },
        "IssueReissueDatesOpt":{
            "title":"Issuance and Reissuance Dates",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the option whether the issue date can be overwritten by the reissue date.",
            "nullable":false,
            "default":"ORA_OVERWRITE"
        },
        "SchedTimeDisplayCutoff":{
            "title":"Scheduled Time Range Breakpoint",
            "type":"string",
            "description":"Indicates the cutoff time to determine which description to show for the inspection scheduled time.",
            "format":"date-time",
            "nullable":true
        },
        "InsAssignmentMethodSchedule":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections schedule assignment method.",
            "nullable":false,
            "default":"ORA_DURATION"
        },
        "PlanReviewProtectDocOption":{
            "title":"Protected Documents",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the options that can be selected for the handling of archive protected PDF documents. The default value is ORA_PSC_PER_ALLOW for Allow Protected Documents.",
            "nullable":false,
            "default":"ORA_PSC_PER_ALLOW"
        },
        "InsTimeEntrySchedule":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections schedule entry method.",
            "nullable":false,
            "default":"ORA_SPECIFC_TIME"
        },
        "PzAllowAppealForSelf":{
            "title":"Allow public users to submit appeal for themselves",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates public users can submit appeal for self.",
            "nullable":false,
            "default":true
        },
        "InsAssignmentMethodReady":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections ready assignment method.",
            "nullable":false,
            "default":"ORA_DURATION"
        },
        "BlInsPublicCancelOpt":{
            "title":"Public User Cancel Options",
            "maxLength":"30",
            "type":"string",
            "description":"The cancel inspection options available to public users for business licenses.",
            "nullable":true
        },
        "InsArrivalDisplayReady":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections ready arrival display.",
            "nullable":false,
            "default":"ORA_SPECIFC_TIME"
        },
        "PmtInsPublicCancelOpt":{
            "title":"Public User Cancel Options",
            "maxLength":"30",
            "type":"string",
            "description":"The cancel inspection options available to public users for permits.",
            "nullable":true
        },
        "PmtApplyInstructions":{
            "title":"Instructional Text for Permits",
            "maxLength":"50",
            "type":"string",
            "description":"A unique value that identifies an instructional text for Permits.",
            "nullable":true
        },
        "PzDisplayPlannerContact":{
            "title":"Display Assigned Planner Information to Public Users",
            "maxLength":"30",
            "type":"string",
            "description":"Indicate which planner's contact to display to public users.",
            "nullable":false,
            "default":"ORA_PLN_NONE"
        },
        "InsArrivalDisplayRequest":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections request arrival display.",
            "nullable":false,
            "default":"ORA_SPECIFC_TIME"
        },
        "RequireCommentsInspection":{
            "title":"Required Inspection Comments",
            "maxLength":"30",
            "type":"string",
            "description":"Controls whether comments are required when results are provided on inspections or when an inspection is canceled.",
            "nullable":true
        },
        "BlBEDocGroupId":{
            "title":"Business Entity Document Group",
            "maxLength":"30",
            "type":"string",
            "description":"Stores the document group identifier for business entity attachments.",
            "nullable":true
        },
        "LongDescription":{
            "title":"Landing Page Message",
            "type":"string",
            "description":"The long version of the landing page message title in a sentence format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "InsTimeEntryRequest":{
            "title":"Request",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections request entry method.",
            "nullable":false,
            "default":"ORA_TIME_RANGE"
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The identifier for the agency associated with the permit agency options.
• AllowHideBusInfoFlag: boolean
  Title: Allow hiding business information and associated licenses from public view

  Maximum Length: 1

  Default Value: false

  Controls whether users are allowed to hide business information from public view or not.
• AllowViewBusLicCertFlag: boolean
  Maximum Length: 1

  Default Value: false

  Allows public users to view the certificate on the business page.
• AutoPendingInspections: boolean
  Title: Enable Automatic Creation of Pending Inspections

  Maximum Length: 1

  Default Value: false

  Controls whether pending inspections are created automatically.
• BlApplyInstructions: string
  Title: Instructional Text for Business Licenses

  Maximum Length: 50

  A unique value that identifies an instructional text for Business License.
• BlBEDocGroupId: string
  Title: Business Entity Document Group

  Maximum Length: 30

  Stores the document group identifier for business entity attachments.
• BlDisplaySpecialistContact: string
  Title: Display Assigned Specialist Information to Public Users

  Maximum Length: 30

  Default Value: ORA_SPC_NONE

  Indicate which BL specialist's contact to display to public users.
• BlGeneralSpecialistEmail: string
  Title: Specialist's General Email

  Maximum Length: 320

  Indicate the general specialist's email to display to public users.
• BlInsEnablePostponeFlag: boolean
  Title: Enable Postpone Inspection

  Maximum Length: 1

  Default Value: true

  The switch enables users to postpone inspections for business licenses.
• BlInsPublicCancelOpt: string
  Title: Public User Cancel Options

  Maximum Length: 30

  The cancel inspection options available to public users for business licenses.
• BlLocDocGroupId: string
  Title: Business Location Document Group

  Maximum Length: 30

  Stores the document group identifier for business location attachments.
• BlMultiAppFlag: boolean
  Title: Enable Multiple Application Selection

  Maximum Length: 1

  Default Value: false

  Indicates the business license multiple application flag.
• BlMultiAppType: string
  Title: General Information Type

  Maximum Length: 20

  Indicates the business license multiple application type.
• BlOwnDocGroupId: string
  Title: Business Owner Document Group

  Maximum Length: 30

  Stores the document group identifier for business owner attachments.
• CascadingCycleDueDate: boolean
  Title: Enable Cascading Cycle Due Date

  Maximum Length: 1

  Default Value: false

  Controls whether plan review cycle due dates are cascaded.
• ConfidentialAttachFlag: boolean
  Title: Enable Confidential Attachments

  Maximum Length: 1

  Default Value: false

  Indicates whether the applicant is allowed to set an individual document as confidential.
• ContentUrl: string
  Title: Button Content URL

  Maximum Length: 250

  The content URL used to link to an agency page outside of the permits service.
• CopyAssignedFlag: boolean
  Title: Copy Assigned Specialist for Amendments and Renewals

  Maximum Length: 1

  Default Value: false

  Indicates whether the assigned planner or specialist should be copied to the new transaction.
• DefaultPlanReviewName: boolean
  Title: Enable Default of Plan Review Name

  Maximum Length: 1

  Default Value: true

  Controls whether plan review names are defaulted.
• ElectronicPlanReview: boolean
  Title: Enable Electronic Plan Review

  Maximum Length: 1

  Default Value: false

  Controls whether electronic plan review is enabled.
• InsArrivalDisplayReady: string
  Maximum Length: 30

  Default Value: ORA_SPECIFC_TIME

  Indicates inspections ready arrival display.
• InsArrivalDisplayRequest: string
  Maximum Length: 30

  Default Value: ORA_SPECIFC_TIME

  Indicates inspections request arrival display.
• InsArrivalDisplaySchedule: string
  Maximum Length: 30

  Default Value: ORA_SPECIFC_TIME

  Indicates inspections schedule arrival display.
• InsAssignmentMethodReady: string
  Maximum Length: 30

  Default Value: ORA_DURATION

  Indicates inspections ready assignment method.
• InsAssignmentMethodRequest: string
  Maximum Length: 30

  Default Value: ORA_DURATION

  Indicates inspections request assignment method.
• InsAssignmentMethodSchedule: string
  Maximum Length: 30

  Default Value: ORA_DURATION

  Indicates inspections schedule assignment method.
• InsTimeEntryReady: string
  Title: Ready

  Maximum Length: 30

  Default Value: ORA_SPECIFC_TIME

  Indicates inspections ready entry method.
• InsTimeEntryRequest: string
  Title: Request

  Maximum Length: 30

  Default Value: ORA_TIME_RANGE

  Indicates inspections request entry method.
• InsTimeEntrySchedule: string
  Maximum Length: 30

  Default Value: ORA_SPECIFC_TIME

  Indicates inspections schedule entry method.
• IssueReissueDatesOpt: string
  Title: Issuance and Reissuance Dates

  Maximum Length: 30

  Default Value: ORA_OVERWRITE

  Indicates the option whether the issue date can be overwritten by the reissue date.
• IVR: boolean
  Title: Enable IVR

  Maximum Length: 1

  Default Value: false

  Controls whether interactive voice response (IVR) is enabled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongDescription: string (byte)
  Title: Landing Page Message

  The long version of the landing page message title in a sentence format.
• OfferingId: string
  Maximum Length: 50

  The unique identifier for the functional product Permits in Oracle Permitting and Licensing that is used by the agency.
• OpaPolicyId: string
  Title: Oracle Policy Automation ID

  Maximum Length: 150

  The identifier for the Oracle Policy Automation policy definition used for the permit guide.
• PendingInspections: boolean
  Title: Enable Creation of Pending Inspections

  Maximum Length: 1

  Default Value: false

  The switch indicates whether inspections in pending status can be created or not.
• PlanReviewProtectDocOption: string
  Title: Protected Documents

  Maximum Length: 30

  Default Value: ORA_PSC_PER_ALLOW

  Identifies the options that can be selected for the handling of archive protected PDF documents. The default value is ORA_PSC_PER_ALLOW for Allow Protected Documents.
• PmtApplyInstructions: string
  Title: Instructional Text for Permits

  Maximum Length: 50

  A unique value that identifies an instructional text for Permits.
• PmtInsEnablePostponeFlag: boolean
  Title: Enable Postpone Inspection

  Maximum Length: 1

  Default Value: true

  The switch enables users to postpone inspections for permits.
• PmtInsPublicCancelOpt: string
  Title: Public User Cancel Options

  Maximum Length: 30

  The cancel inspection options available to public users for permits.
• PzAllowAppealForSelf: boolean
  Title: Allow public users to submit appeal for themselves

  Maximum Length: 1

  Default Value: true

  Indicates public users can submit appeal for self.
• PzApplyInstructions: string
  Title: Instructional Text for Planning Applications

  Maximum Length: 50

  A unique value that identifies an instructional text for Planning and Zoning.
• PzDisplayPlannerContact: string
  Title: Display Assigned Planner Information to Public Users

  Maximum Length: 30

  Default Value: ORA_PLN_NONE

  Indicate which planner's contact to display to public users.
• PzGeneralPlannerEmail: string
  Title: Planner's General Email

  Maximum Length: 320

  Indicate the general planner's email to display to public users.
• ReportControlId: string
  Maximum Length: 32

  Identifies the type of consolidated report configurations for a business location.
• RequireCommentsInspection: string
  Title: Required Inspection Comments

  Maximum Length: 30

  Controls whether comments are required when results are provided on inspections or when an inspection is canceled.
• RequireCommentsPlanReview: string
  Title: Required Plan Review Comments

  Maximum Length: 30

  Controls whether comments are required when decisions are provided on plan reviews or when a plan review cycle is canceled.
• SchedTimeAfterDescr: string
  Title: Time Range After Breakpoint

  Maximum Length: 30

  The description to show instead of the inspection scheduled time if after the configured cutoff.
• SchedTimeBeforeDescr: string
  Title: Time Range Before Breakpoint

  Maximum Length: 30

  The description to show instead of the inspection scheduled time if before the configured cutoff.
• SchedTimeDisplayCutoff: string (date-time)
  Title: Scheduled Time Range Breakpoint

  Indicates the cutoff time to determine which description to show for the inspection scheduled time.
• ShortDescription: string
  Title: Message Summary

  Maximum Length: 300

  The short text version of the landing page message in a title format.
• TextLabel: string
  Title: Message Title

  Maximum Length: 100

  The information in rich text that appears in a dialog box when the user clicks the read more button on a public landing page. If a URL to access an agency page is defined, this message is not needed.

{
    "type":"object",
    "properties":{
        "SchedTimeBeforeDescr":{
            "title":"Time Range Before Breakpoint",
            "maxLength":"30",
            "type":"string",
            "description":"The description to show instead of the inspection scheduled time if before the configured cutoff.",
            "nullable":true,
            "x-queryable":true
        },
        "ElectronicPlanReview":{
            "title":"Enable Electronic Plan Review",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether electronic plan review is enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PzApplyInstructions":{
            "title":"Instructional Text for Planning Applications",
            "maxLength":"50",
            "type":"string",
            "description":"A unique value that identifies an instructional text for Planning and Zoning.",
            "nullable":true,
            "x-queryable":true
        },
        "InsArrivalDisplaySchedule":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections schedule arrival display.",
            "nullable":false,
            "default":"ORA_SPECIFC_TIME",
            "x-queryable":true
        },
        "ShortDescription":{
            "title":"Message Summary",
            "maxLength":"300",
            "type":"string",
            "description":"The short text version of the landing page message in a title format.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowViewBusLicCertFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Allows public users to view the certificate on the business page.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "InsTimeEntryReady":{
            "title":"Ready",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections ready entry method.",
            "nullable":false,
            "default":"ORA_SPECIFC_TIME",
            "x-queryable":true
        },
        "PendingInspections":{
            "title":"Enable Creation of Pending Inspections",
            "maxLength":"1",
            "type":"boolean",
            "description":"The switch indicates whether inspections in pending status can be created or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConfidentialAttachFlag":{
            "title":"Enable Confidential Attachments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the applicant is allowed to set an individual document as confidential.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "OpaPolicyId":{
            "title":"Oracle Policy Automation ID",
            "maxLength":"150",
            "type":"string",
            "description":"The identifier for the Oracle Policy Automation policy definition used for the permit guide.",
            "nullable":true,
            "x-queryable":true
        },
        "BlMultiAppFlag":{
            "title":"Enable Multiple Application Selection",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the business license multiple application flag.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "BlOwnDocGroupId":{
            "title":"Business Owner Document Group",
            "maxLength":"30",
            "type":"string",
            "description":"Stores the document group identifier for business owner attachments.",
            "nullable":true,
            "x-queryable":true
        },
        "OfferingId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the functional product Permits in Oracle Permitting and Licensing that is used by the agency.",
            "nullable":false,
            "x-queryable":true
        },
        "BlDisplaySpecialistContact":{
            "title":"Display Assigned Specialist Information to Public Users",
            "maxLength":"30",
            "type":"string",
            "description":"Indicate which BL specialist's contact to display to public users.",
            "nullable":false,
            "default":"ORA_SPC_NONE",
            "x-queryable":true
        },
        "CopyAssignedFlag":{
            "title":"Copy Assigned Specialist for Amendments and Renewals",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the assigned planner or specialist should be copied to the new transaction.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "TextLabel":{
            "title":"Message Title",
            "maxLength":"100",
            "type":"string",
            "description":"The information in rich text that appears in a dialog box when the user clicks the read more button on a public landing page. If a URL to access an agency page is defined, this message is not needed.",
            "nullable":true,
            "x-queryable":true
        },
        "BlMultiAppType":{
            "title":"General Information Type",
            "maxLength":"20",
            "type":"string",
            "description":"Indicates the business license multiple application type.",
            "nullable":true,
            "x-queryable":true
        },
        "SchedTimeAfterDescr":{
            "title":"Time Range After Breakpoint",
            "maxLength":"30",
            "type":"string",
            "description":"The description to show instead of the inspection scheduled time if after the configured cutoff.",
            "nullable":true,
            "x-queryable":true
        },
        "BlInsEnablePostponeFlag":{
            "title":"Enable Postpone Inspection",
            "maxLength":"1",
            "type":"boolean",
            "description":"The switch enables users to postpone inspections for business licenses.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "BlApplyInstructions":{
            "title":"Instructional Text for Business Licenses",
            "maxLength":"50",
            "type":"string",
            "description":"A unique value that identifies an instructional text for Business License.",
            "nullable":true,
            "x-queryable":true
        },
        "CascadingCycleDueDate":{
            "title":"Enable Cascading Cycle Due Date",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether plan review cycle due dates are cascaded.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AutoPendingInspections":{
            "title":"Enable Automatic Creation of Pending Inspections",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether pending inspections are created automatically.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PmtInsEnablePostponeFlag":{
            "title":"Enable Postpone Inspection",
            "maxLength":"1",
            "type":"boolean",
            "description":"The switch enables users to postpone inspections for permits.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "DefaultPlanReviewName":{
            "title":"Enable Default of Plan Review Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether plan review names are defaulted.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ContentUrl":{
            "title":"Button Content URL",
            "maxLength":"250",
            "type":"string",
            "description":"The content URL used to link to an agency page outside of the permits service.",
            "nullable":true,
            "x-queryable":true
        },
        "BlLocDocGroupId":{
            "title":"Business Location Document Group",
            "maxLength":"30",
            "type":"string",
            "description":"Stores the document group identifier for business location attachments.",
            "nullable":true,
            "x-queryable":true
        },
        "BlGeneralSpecialistEmail":{
            "title":"Specialist's General Email",
            "maxLength":"320",
            "type":"string",
            "description":"Indicate the general specialist's email to display to public users.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportControlId":{
            "maxLength":"32",
            "type":"string",
            "description":"Identifies the type of consolidated report configurations for a business location.",
            "nullable":true,
            "x-queryable":true
        },
        "InsAssignmentMethodRequest":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections request assignment method.",
            "nullable":false,
            "default":"ORA_DURATION",
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the agency associated with the permit agency options.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "IVR":{
            "title":"Enable IVR",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether interactive voice response (IVR) is enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PzGeneralPlannerEmail":{
            "title":"Planner's General Email",
            "maxLength":"320",
            "type":"string",
            "description":"Indicate the general planner's email to display to public users.",
            "nullable":true,
            "x-queryable":true
        },
        "RequireCommentsPlanReview":{
            "title":"Required Plan Review Comments",
            "maxLength":"30",
            "type":"string",
            "description":"Controls whether comments are required when decisions are provided on plan reviews or when a plan review cycle is canceled.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowHideBusInfoFlag":{
            "title":"Allow hiding business information and associated licenses from public view",
            "maxLength":"1",
            "type":"boolean",
            "description":"Controls whether users are allowed to hide business information from public view or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "IssueReissueDatesOpt":{
            "title":"Issuance and Reissuance Dates",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the option whether the issue date can be overwritten by the reissue date.",
            "nullable":false,
            "default":"ORA_OVERWRITE",
            "x-queryable":true
        },
        "SchedTimeDisplayCutoff":{
            "title":"Scheduled Time Range Breakpoint",
            "type":"string",
            "description":"Indicates the cutoff time to determine which description to show for the inspection scheduled time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InsAssignmentMethodSchedule":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections schedule assignment method.",
            "nullable":false,
            "default":"ORA_DURATION",
            "x-queryable":true
        },
        "PlanReviewProtectDocOption":{
            "title":"Protected Documents",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the options that can be selected for the handling of archive protected PDF documents. The default value is ORA_PSC_PER_ALLOW for Allow Protected Documents.",
            "nullable":false,
            "default":"ORA_PSC_PER_ALLOW",
            "x-queryable":true
        },
        "InsTimeEntrySchedule":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections schedule entry method.",
            "nullable":false,
            "default":"ORA_SPECIFC_TIME",
            "x-queryable":true
        },
        "PzAllowAppealForSelf":{
            "title":"Allow public users to submit appeal for themselves",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates public users can submit appeal for self.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "InsAssignmentMethodReady":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections ready assignment method.",
            "nullable":false,
            "default":"ORA_DURATION",
            "x-queryable":true
        },
        "BlInsPublicCancelOpt":{
            "title":"Public User Cancel Options",
            "maxLength":"30",
            "type":"string",
            "description":"The cancel inspection options available to public users for business licenses.",
            "nullable":true,
            "x-queryable":true
        },
        "InsArrivalDisplayReady":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections ready arrival display.",
            "nullable":false,
            "default":"ORA_SPECIFC_TIME",
            "x-queryable":true
        },
        "PmtInsPublicCancelOpt":{
            "title":"Public User Cancel Options",
            "maxLength":"30",
            "type":"string",
            "description":"The cancel inspection options available to public users for permits.",
            "nullable":true,
            "x-queryable":true
        },
        "PmtApplyInstructions":{
            "title":"Instructional Text for Permits",
            "maxLength":"50",
            "type":"string",
            "description":"A unique value that identifies an instructional text for Permits.",
            "nullable":true,
            "x-queryable":true
        },
        "PzDisplayPlannerContact":{
            "title":"Display Assigned Planner Information to Public Users",
            "maxLength":"30",
            "type":"string",
            "description":"Indicate which planner's contact to display to public users.",
            "nullable":false,
            "default":"ORA_PLN_NONE",
            "x-queryable":true
        },
        "InsArrivalDisplayRequest":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections request arrival display.",
            "nullable":false,
            "default":"ORA_SPECIFC_TIME",
            "x-queryable":true
        },
        "RequireCommentsInspection":{
            "title":"Required Inspection Comments",
            "maxLength":"30",
            "type":"string",
            "description":"Controls whether comments are required when results are provided on inspections or when an inspection is canceled.",
            "nullable":true,
            "x-queryable":true
        },
        "BlBEDocGroupId":{
            "title":"Business Entity Document Group",
            "maxLength":"30",
            "type":"string",
            "description":"Stores the document group identifier for business entity attachments.",
            "nullable":true,
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Landing Page Message",
            "type":"string",
            "description":"The long version of the landing page message title in a sentence format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "InsTimeEntryRequest":{
            "title":"Request",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates inspections request entry method.",
            "nullable":false,
            "default":"ORA_TIME_RANGE",
            "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