Get all permit agency options definitions
get
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds all permit agency options definitions matching the primary key criteria specified.
Finder Variables:- AgencyId; integer; The unique identifier for the agency associated with the permit agency options.
- OfferingId; string; The unique identifier for the permits used by the agency.
- PrimaryKey: Finds all permit agency options definitions matching the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The identifier for the agency associated with the permit agency options.
- AllowHideBusInfoFlag; boolean; Controls whether users are allowed to hide business information from public view or not.
- AllowViewBusLicCertFlag; boolean; Allows public users to view the certificate on the business page.
- AutoPendingInspections; boolean; Controls whether pending inspections are created automatically.
- BlApplyInstructions; string; A unique value that identifies an instructional text for Business License.
- BlBEDocGroupId; string; Stores the document group identifier for business entity attachments.
- BlDisplaySpecialistContact; string; Indicate which BL specialist's contact to display to public users.
- BlGeneralSpecialistEmail; string; Indicate the general specialist's email to display to public users.
- BlInsEnablePostponeFlag; boolean; The switch enables users to postpone inspections for business licenses.
- BlInsPublicCancelOpt; string; The cancel inspection options available to public users for business licenses.
- BlLocDocGroupId; string; Stores the document group identifier for business location attachments.
- BlMultiAppFlag; boolean; Indicates the business license multiple application flag.
- BlMultiAppType; string; Indicates the business license multiple application type.
- BlOwnDocGroupId; string; Stores the document group identifier for business owner attachments.
- CascadingCycleDueDate; boolean; Controls whether plan review cycle due dates are cascaded.
- ContentUrl; string; The content URL used to link to an agency page outside of the permits service.
- DefaultPlanReviewName; boolean; Controls whether plan review names are defaulted.
- ElectronicPlanReview; boolean; Controls whether electronic plan review is enabled.
- IVR; boolean; Controls whether interactive voice response (IVR) is enabled.
- InsArrivalDisplayReady; string; Indicates inspections ready arrival display.
- InsArrivalDisplayRequest; string; Indicates inspections request arrival display.
- InsArrivalDisplaySchedule; string; Indicates inspections schedule arrival display.
- InsAssignmentMethodReady; string; Indicates inspections ready assignment method.
- InsAssignmentMethodRequest; string; Indicates inspections request assignment method.
- InsAssignmentMethodSchedule; string; Indicates inspections schedule assignment method.
- InsTimeEntryReady; string; Indicates inspections ready entry method.
- InsTimeEntryRequest; string; Indicates inspections request entry method.
- InsTimeEntrySchedule; string; Indicates inspections schedule entry method.
- IssueReissueDatesOpt; string; Indicates the option whether the issue date can be overwritten by the reissue date.
- OfferingId; string; The unique identifier for the functional product Permits in Oracle Permitting and Licensing that is used by the agency.
- OpaPolicyId; string; The identifier for the Oracle Policy Automation policy definition used for the permit guide.
- PendingInspections; boolean; The switch indicates whether inspections in pending status can be created or not.
- PlanReviewProtectDocOption; string; 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; A unique value that identifies an instructional text for Permits.
- PmtInsEnablePostponeFlag; boolean; The switch enables users to postpone inspections for permits.
- PmtInsPublicCancelOpt; string; The cancel inspection options available to public users for permits.
- PzAllowAppealForSelf; boolean; Indicates public users can submit appeal for self.
- PzApplyInstructions; string; A unique value that identifies an instructional text for Planning and Zoning.
- PzDisplayPlannerContact; string; Indicate which planner's contact to display to public users.
- PzGeneralPlannerEmail; string; Indicate the general planner's email to display to public users.
- ReportControlId; string; Identifies the type of consolidated report configurations for a business location.
- RequireCommentsInspection; string; Controls whether comments are required when results are provided on inspections or when an inspection is canceled.
- RequireCommentsPlanReview; string; Controls whether comments are required when decisions are provided on plan reviews or when a plan review cycle is canceled.
- SchedTimeAfterDescr; string; The description to show instead of the inspection scheduled time if after the configured cutoff.
- SchedTimeBeforeDescr; string; The description to show instead of the inspection scheduled time if before the configured cutoff.
- SchedTimeDisplayCutoff; string; Indicates the cutoff time to determine which description to show for the inspection scheduled time.
- ShortDescription; string; The short text version of the landing page message in a title format.
- TextLabel; string; 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorPermitAgencyOptions
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPermitAgencyOptions-item-response
Type:
Show Source
object
-
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. -
ContentUrl: string
Title:
Button Content URL
Maximum Length:250
The content URL used to link to an agency page outside of the permits service. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.