REST API for Oracle Public Sector Compliance and Regulation Cloud

All REST Endpoints

AP Searches

The AP searches resource is used to view a list of property information. Agency staff can use the address parcel search to look up and select a parcel of real estate to make changes to the property information.

Get all address parcel rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApSearches
Get an address parcel row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApSearches/{publicSectorApSearchesUniqID}

AP Value Searches

The AP value searches resource is used to view a list of property information in a grid, for the purpose of reviewing property values.

Delete address parcel rows: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApValueSearches
Get all address parcel rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApValueSearches
Get an address parcel row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApValueSearches/{ParcelId}

APO Attachments

The APO attachments resource is used for adding and viewing the attachments for addresses, parcels, and owners.

Create an APO attachment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments
Delete an APO attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}
Get all APO attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments
Get an APO attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}
Update an APO attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}

APO Attachments/APO Attachment Accessors

The APO attachment accessor resource is used for displaying file-related information such as file name and file URL.

Create an APO attachment accessor: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor
Delete an APO attachment accessor: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{AttachedDocumentId}
Get all APO attachment accessors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor
Get an APO attachment accessor: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{AttachedDocumentId}
Update an APO attachment accessor: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{AttachedDocumentId}

APO Attachments/APO Attachment Accessors/APO Attachment Revisions

The APO attachments revision resource is used for displaying the historical information for an attachment.

Create an APO attachment revision: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete an APO attachment revision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all APO attachment revisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Get an APO attachment revision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Update an APO attachment revision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

APO Searches

The APO searches resource is used to view a list of property information. Agency staff can use the address parcel owner search to look up and select a parcel of real estate to make changes to the property information.

Get all address parcel owner rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoSearches
Get an address parcel owner row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoSearches/{publicSectorApoSearchesUniqID}

APO Value Searches

The APO value searches resource is used to view a list of amounts related to parcels of real estate in a grid. Agency staff can use the address parcel owner value search to select properties and further drill into amounts used in the calculation of property taxes.

Get all address parcel owner rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoValueSearches
Get an address parcel owner row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoValueSearches/{ParcelId}

Account Attachments

The account attachments resource is used to view, create, delete or modify attachments to registered public user account.

Create a set of attachments for a registered public user account: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments
Delete an attachment for a registered public user account: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}
Get all attachments for a registered public user account: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments
Get an attachment for a registered public user account: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}
Update an attachment for a registered public user account: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}

Account Attachments/Account Attachment Accessors

The account attachment accessor resource is used for displaying file-related information such as file name and file URL.

Create a set of account attachment accessor: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor
Delete an account attachment accessor: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{AttachedDocumentId}
Get all account attachment accessors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor
Get an account attachment accessor: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{AttachedDocumentId}
Update an account attachment accessor: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{AttachedDocumentId}

Account Attachments/Account Attachment Accessors/Account Attachment Revisions

The account attachments revision resource is used for displaying the historical information for an attachment.

Create a set of account attachment revisions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete an account attachment revision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all account attachment revisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Get an account attachment revision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Update an account attachment revision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Accounting Event Fields

The accounting event field resource is used to view event fields. An accounting event field defines a field name from a business source table, which is used in accounting rule criteria to specify the field values for generating accounting entries.

Get all accounting event fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingEventFields
Get an accounting event field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingEventFields/{publicSectorAccountingEventFieldsUniqID}
Update an accounting event field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingEventFields/{publicSectorAccountingEventFieldsUniqID}

Accounting Events

The accounting events resource is used to view and enable, or disable an accounting event. An accounting event identifies a specific type of agency transaction for which accounting journals are required.

Get all accounting events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents
Get an accounting event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents/{AccountingEventId}
Update an accounting event: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents/{AccountingEventId}

Accounting Events/Accounting Event Fields

Get all accounting event fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents/{AccountingEventId}/child/AccountingEventFields
Get an accounting event field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents/{AccountingEventId}/child/AccountingEventFields/{AccountingEventFieldsUniqID}
Update an accounting event field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents/{AccountingEventId}/child/AccountingEventFields/{AccountingEventFieldsUniqID}

Accounting Rule Criteria

The accounting rule criteria resource is used to view, create, delete, or modify accounting rule criteria. Accounting criteria define parameters that control which accounting transactions are processed by the rule.

Create an accounting rule criterion: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleCriteria
Delete an accounting rule criterion: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleCriteria/{publicSectorAccountingRuleCriteriaUniqID}
Get all accounting rule criteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleCriteria
Get an accounting rule criterion: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleCriteria/{publicSectorAccountingRuleCriteriaUniqID}
Update an accounting rule criterion: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleCriteria/{publicSectorAccountingRuleCriteriaUniqID}

Accounting Rule Field Values

The accounting rule field values resource is used to view, create, delete, or modify field values of an accounting rule. An accounting rule field value is specified by the user to control which accounting transactions are processed by the rule.

Create an accounting rule field value: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleFieldValues
Delete an accounting rule field value: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleFieldValues/{publicSectorAccountingRuleFieldValuesUniqID}
Get all accounting rule field values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleFieldValues
Get an accounting rule field value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleFieldValues/{publicSectorAccountingRuleFieldValuesUniqID}
Update an accounting rule field value: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleFieldValues/{publicSectorAccountingRuleFieldValuesUniqID}

Accounting Rule Keys

The accounting rule keys resource is used to get the current accounting rules for effective date functionality.

Get all accounting rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRulesKeys
Get an accounting rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRulesKeys/{publicSectorAccountingRulesKeysUniqID}

Accounting Rule Lines

The accounting rule lines resource is used to view, create, delete, or modify an accounting rule line. An accounting rule line identifies a debit or credit distribution line associated with a rule.

Create an accounting rule line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines
Delete an accounting rule line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines/{publicSectorAccountingRuleLinesUniqID}
Get all accounting rule lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines
Get an accounting rule line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines/{publicSectorAccountingRuleLinesUniqID}
Update an accounting rule line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines/{publicSectorAccountingRuleLinesUniqID}

Accounting Rule Totals

The accounting rule totals resource is used to get all accounting rules for effective date functionality.

Get all accounting rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRulesTotals
Get an accounting rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRulesTotals/{publicSectorAccountingRulesTotalsUniqID}

Accounting Rules

The accounting rules resource is used to view, create, delete, or modify an accounting rule. An accounting rule describes how accounting journal entries are created for a specific type of transaction.

Create an accounting rule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules
Delete an accounting rule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules/{publicSectorAccountingRulesUniqID}
Get all accounting rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules
Get an accounting rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules/{publicSectorAccountingRulesUniqID}
Update an accounting rule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules/{publicSectorAccountingRulesUniqID}
Validate the integrity of the accounting rule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules/{publicSectorAccountingRulesUniqID}

Accounts

The account resource is used to view, create, delete or modify an account. An account identifies the type of economic activity associated with an accounting transaction.

Create an account: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccounts
Delete an account: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccounts/{publicSectorAccountsUniqID}
Get all accounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccounts
Get an account: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccounts/{publicSectorAccountsUniqID}
Update an account: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAccounts/{publicSectorAccountsUniqID}

Active Agency Languages

The active agency languages resource is used to search for the languages supported by the agency.

Get a set of agency supported languages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorActiveAgencyLanguages/{LanguageCd}
Get all agency supported languages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorActiveAgencyLanguages

Active Languages

The system defined filters resource is used to view the active language code. The active language is language used during the current Fusion session.

Get all active languages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorActiveLanguages
Get an active language: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorActiveLanguages/{LanguageId}

Ad Hoc Alerts

The ad hoc alerts resource is used to create and maintain ad hoc alerts. An alert is information displayed on the landing page for registered and anonymous users.

Create an ad hoc alert: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts
Delete an ad hoc alert: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts/{LogId}
Get all ad hoc alerts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts
Get an ad hoc alert: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts/{LogId}
Update an ad hoc alert: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts/{LogId}

Ad Hoc Communications

The ad hoc communications resource is used to trigger ad hoc emails and notifications for targeted recipients using a composer.

Create an ad hoc communication request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocCommunications
Get all ad hoc communiactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocCommunications
Get an ad hoc communication: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocCommunications/{LogId}

Ad Hoc Emails

The ad hoc emails resource is used to trigger ad hoc emails for targeted recipients usig the email composer.

Create an ad hoc email: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocEmails
Get all ad hoc emails: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocEmails
Get an ad hoc email: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocEmails/{LogId}

Ad Hoc Notifications

The ad hoc notifications resource is used to trigger ad hoc notifications for targeted recipients using a notification composer.

Create an ad hoc notification: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocNotifications
Get all ad hoc notifications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocNotifications
Get an ad hoc notification: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocNotifications/{LogId}

Ad Hoc Texts

The ad hoc texts resource is used to trigger ad hoc texts for targeted recipients using the text composer.

Create an ad hoc text: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts
Delete an ad hoc text: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts/{LogId}
Get all ad hoc texts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts
Get an ad hoc text: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts/{LogId}
Update an ad hoc text: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts/{LogId}

Adapter Configs

The adapter configs resource is used to view, create, delete or modify payment adapter configurations. Setup of payment adapter configuration includes defining a configuration name and value.

Create a payment adapter configuration: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs
Delete a payment adapter configuration: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs/{publicSectorAdapterConfigsUniqID}
Get a payment adapter configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs/{publicSectorAdapterConfigsUniqID}
Get all payment adapter configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs
Update a payment adapter configuration: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs/{publicSectorAdapterConfigsUniqID}

Adapter Currencies

The adapter currencies resource is used to view, create, delete or modify payment adapter currencies. Setup of payment adapter currency includes defining the currency code, minimum threshold and maximum threshold.

Create a payment adapter currency: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterCurrencies
Delete a payment adapter currency: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterCurrencies/{publicSectorAdapterCurrenciesUniqID}
Get a payment adapter currency: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterCurrencies/{publicSectorAdapterCurrenciesUniqID}
Get all payment adapter currencies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterCurrencies
Update a payment adapter currency: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterCurrencies/{publicSectorAdapterCurrenciesUniqID}

Adapter Method Code Pros

The adapter method code pros resource is used to view the available payment method codes when setting up a payment adapter.

Get a payment method code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethodCodePros/{PaymentMethodCode}
Get all payment method codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethodCodePros

Adapter Methods

The adapter methods resource is used to view, create, delete or modify payment adapter payment methods. Setup of payment adapter payment methods includes defining the service charge percentage, service charge amount, service charge currency, service charge description, special instructions and redirect flag.

Create a payment adapter payment method: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods
Delete a payment adapter payment method: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods/{publicSectorAdapterMethodsUniqID}
Get a payment adapter payment method: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods/{publicSectorAdapterMethodsUniqID}
Get all payment adapter payment methods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods
Update a payment adapter payment method: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods/{publicSectorAdapterMethodsUniqID}

Adapters

The adapters resource is used to view, create, delete or modify payment adapters. Setup of payment adapters includes defining the payment gateway and adapter mode, and enabling or disabling the adapter.

Create a payment adapter: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapters
Delete a payment adapter: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapters/{publicSectorAdaptersUniqID}
Get a payment adapter: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapters/{publicSectorAdaptersUniqID}
Get all payment adapters: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapters
Update a payment adapter: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAdapters/{publicSectorAdaptersUniqID}

Address District Crosses

The address district crosses resource is used to view district information related to an address that is not assigned to any parcel. A district is an administrative region that, in some countries, is managed by local government.

Get all address districts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAddressDistrictsCrosses
Get an address district: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAddressDistrictsCrosses/{publicSectorAddressDistrictsCrossesUniqID}

Address Districts

The address districts resource is used to assign or unassign addresses without parcels to districts. A district is an administrative region that, in some countries, is managed by local government.

Create an address district: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAddressDistricts
Delete an address district: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAddressDistricts/{publicSectorAddressDistrictsUniqID}
Get all address districts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAddressDistricts
Get an address district: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAddressDistricts/{publicSectorAddressDistrictsUniqID}

Address Geographies

The address geographies resource is used to view the geographies that the agency operates in, such as the United States or Canada.

Get a geography: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAddressGeographies/{GeographyIdentifierId}
Get all geographies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAddressGeographies

Agencies

The agencies resource is used to view, create or modify an agency. Agency has a unique identifier and stores the default country, currency, timezone along with name and description. Agencies are entities which own transaction data like permit applications.

Create an agency: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies
Delete an agency: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}
Get all agencies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies
Get an agency: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}
Update an agency: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}

Agencies/Agency Addresses

The agency addresses resource is used to view, create, or modify an agency address. An address represents the location information of an agency. There can be multiple addresses for an agency, each with its own start and end date. One address is identified as primary.

Create an agency address: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress
Delete an agency address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress/{AgencyAddressUniqID}
Get all agency addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress
Get an agency address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress/{AgencyAddressUniqID}
Update an agency address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress/{AgencyAddressUniqID}

Agencies/Agency Languages

The agency languages resource is used to view, create or modify the languages the agency supports.

Create an agency language: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang
Delete an agency language: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang/{AgencyLangUniqID}
Get all agency languages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang
Get an agency language: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang/{AgencyLangUniqID}
Update an agency language: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang/{AgencyLangUniqID}

Agencies/Agency Options

The agency options resource is used to view and enable/disable product offerings as well as any optional features for an agency.

Create an agency offering: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions
Delete an agency offering: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions/{AgencyOptionsUniqID}
Get all agency offerings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions
Get an agency offering: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions/{AgencyOptionsUniqID}
Update an agency offering: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions/{AgencyOptionsUniqID}

Agency Addresses

Create an agency address: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses
Delete an agency address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses/{publicSectorAgencyAddressesUniqID}
Get all agency addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses
Get an agency address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses/{publicSectorAgencyAddressesUniqID}
Update an agency address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses/{publicSectorAgencyAddressesUniqID}

Agency Code Reference Groups

The agency code reference groups resource is used to view, create, delete, or modify the code reference group that is linked to an agency.

Create a code reference group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupAgencies
Delete a code reference group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupAgencies/{publicSectorCodeGroupAgenciesUniqID}
Get a code reference group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupAgencies/{publicSectorCodeGroupAgenciesUniqID}
Get all code reference groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupAgencies
Update a code reference group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupAgencies/{publicSectorCodeGroupAgenciesUniqID}

Agency Details

The agency details resource is used to get the oracle policy automation (OPA) policy ID that is associated with an agency.

Get all OPA policy IDs for an agency: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyDetails
Get an OPA policy ID for an agency: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyDetails/{AgencyId}

Agency Job Attributes

The agency job attributes resource is used to list the job attributes that are assigned to the job functions configured for an Agency.

Create a set of job attributes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobSectionByAgencies
Delete a job attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobSectionByAgencies/{publicSectorJobSectionByAgenciesUniqID}
Get a job attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobSectionByAgencies/{publicSectorJobSectionByAgenciesUniqID}
Get all job attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobSectionByAgencies
Update a job attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobSectionByAgencies/{publicSectorJobSectionByAgenciesUniqID}

Agency Job Functions

The agency job functions resource is used to list the configured job functions for an Agency.

Create a set of job functions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncByAgencies
Delete a job function: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncByAgencies/{JobFuncId}
Get a job function: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncByAgencies/{JobFuncId}
Get all job functions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncByAgencies
Update a job function: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncByAgencies/{JobFuncId}

Agency Language Lists

The agency language lists resource is used to view the languages that the agency supports.

Delete selected agency language.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguageLists
Get all agency languages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguageLists
Get an agency language: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguageLists/{publicSectorAgencyLanguageListsUniqID}

Agency Languages

The agency languages resource is used to view, create or modify a language that the agency supports.

Create an agency language: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages
Delete an agency language: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages/{publicSectorAgencyLanguagesUniqID}
Get all agency languages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages
Get an agency language: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages/{publicSectorAgencyLanguagesUniqID}
Update an agency language: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages/{publicSectorAgencyLanguagesUniqID}

Agency Options

The agency options resource is used to view and enable/disable product offerings as well as any optional features for an agency.

Create an agency offering: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions
Delete an agency offering: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions/{publicSectorAgencyOptionsUniqID}
Get all agency offerings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions
Get an agency offering: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions/{publicSectorAgencyOptionsUniqID}
Update an agency offering: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions/{publicSectorAgencyOptionsUniqID}

Agency Payment Options

The agency payment options resource is used to view, create, delete, or modify, at the agency level, the payment options used to process received payments. The application uses the setup defined at the agency level when no payment options are set up at the department level.

Create an agency payment option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies
Delete an agency payment option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies/{publicSectorPaymentOptionsAgenciesUniqID}
Get all agency payment options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies
Get an agency payment option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies/{publicSectorPaymentOptionsAgenciesUniqID}
Update an agency payment option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies/{publicSectorPaymentOptionsAgenciesUniqID}

Agency Time Rule Definitions

The agency time rule definitions resource is used to view, create, delete, or modify time rule definitions.

Create an agency time rule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimeRules
Delete an agency time rule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimeRules/{publicSectorAgencyTimeRulesUniqID}
Get all agency time rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimeRules
Get an agency time rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimeRules/{publicSectorAgencyTimeRulesUniqID}
Update an agency time rule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimeRules/{publicSectorAgencyTimeRulesUniqID}

Agency Time Zones

The agency time zones resource fetches all available time zones from fusion foundation data. One of the time zones is selected as the time zone for the agency. It is a read-only service.

Get a time zone: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimezones/{publicSectorAgencyTimezonesUniqID}
Get all time zones: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimezones

Aggregate Privileges

The aggregate privileges resource is used to capture all data security aggregate privileges for a transaction type, such as a permit or planning application. The data security secures specific sections of the application form from unauthorized users.

Create a data security aggregate privilege: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges
Delete a data security aggregate privilege: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges/{publicSectorAggrprivilegesUniqID}
Get a data security aggregate privilege: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges/{publicSectorAggrprivilegesUniqID}
Get all data security aggregate privileges: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges
Update a data security aggregate privilege: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges/{publicSectorAggrprivilegesUniqID}

All Permit Attachments

The all permit attachments resource is used to view all attachments associated with the permit. This includes all attachments associated with plan reviews, inspections, and workflow associated with the permit.

Get a permit attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}
Get all permit attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments

All Permit Attachments/All Permit Attachment Accessors

The all permit attachment accessors resource is used for displaying attachment file-related information such as file name and file URL.

Get all file-related information for permit attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor
Get file-related information for the permit attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor/{AttachedDocumentId}

All Permit Attachments/All Permit Attachment Accessors/All Permit Attachment Revisions

The all permit attachment revisions resource is used for displaying the historical information for a Permit attachment.

Get all attachment revisions for permit attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Get an attachment revision for permit attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Allow Case Appeals

The allow case appeal resource is used to view a case appeal allowance. Case appeals are used in Code Enforcement cases.

Get a case appeal allowance: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAllowCaseAppeals/{CaseKey}
Get all case appeal allowances: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAllowCaseAppeals

Applicant Profiles

The applicant profiles resource is used to view registered public user's profile information. Profile information such as applicant name, business name and contact information can be defaulted on to a permit application.

Get all applicant profiles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicantProfiles
Get an applicant profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicantProfiles/{CurrProfileId}

Application Categories

The application categories resource is used to view, create, modify, or delete an application category. An application category is the third level of categorization or grouping for a license or permit.

Create an application category: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCategories
Delete an application category: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCategories/{publicSectorCategoriesUniqID}
Get all application categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCategories
Get an application category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCategories/{publicSectorCategoriesUniqID}
Update an application category: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCategories/{publicSectorCategoriesUniqID}

Application Groups

The application groups resource is used to view, create, modify, or delete an application group. An application group is the second level of categorization for a license or permit.

Create an application group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplGroups
Delete an application group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplGroups/{publicSectorApplGroupsUniqID}
Get all application groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplGroups
Get an application group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplGroups/{publicSectorApplGroupsUniqID}
Update an application group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplGroups/{publicSectorApplGroupsUniqID}

Application ID Types

The application ID types resource stores the resource types for Oracle Public Sector Compliance and Regulation.

Create an application ID type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes
Delete an application ID type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}
Get all application ID types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes
Get an application ID type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}
Update an application ID type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}

Application ID Types/Catalogs

The catalogs resource contains API catalog information.

Create a catalog resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs
Delete a catalog resource: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs/{ResourceName}
Get a catalog resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs/{ResourceName}
Get all catalog resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs
Update a catalog resource: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs/{ResourceName}

Application Subcategories

The application subcategories resource is used to view, create, modify, or delete an application subcategory. A subcategory is the fourth level of categorization for a record type, such as a permit.

Create an application subcategory: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSubcategories
Delete an application subcategory: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSubcategories/{publicSectorSubcategoriesUniqID}
Get all application subcategories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSubcategories
Get an application subcategory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSubcategories/{publicSectorSubcategoriesUniqID}
Update an application subcategory: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSubcategories/{publicSectorSubcategoriesUniqID}

Application links

The application links resource is used to identify the agency staff who will receive the mobile application links as notifications.

Create a set of notifications for all agency staff: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationInstallLinks
Get all agency staff for notifications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationInstallLinks
Get an agency staff for notification: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationInstallLinks/{publicSectorApplicationInstallLinksUniqID}
Update an agency staff for notification: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApplicationInstallLinks/{publicSectorApplicationInstallLinksUniqID}

Assessment Details

The assessment details resource is used to view, create, delete, or modify an assessment definition. The assessment details identify the possible outcomes for an assessment type.

Create an assessment definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentDetails
Delete an assessment definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentDetails/{publicSectorAssessmentDetailsUniqID}
Get all assessment definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentDetails
Get an assessment definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentDetails/{publicSectorAssessmentDetailsUniqID}
Update an assessment definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentDetails/{publicSectorAssessmentDetailsUniqID}

Assessment Types

The assessment type resource is used to view, create, delete, or modify an assessment type. An assessment type identifies the ways in which an inspection may be assessed. For a given assessment type, there may be one or more assessment codes.

Create an assessment type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes
Delete an assessment type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}
Get all assessment types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes
Get an assessment type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}
Update an assessment type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}

Assessment Types/Assessment Details

The assessment details resource is used to view, create, delete, or modify an assessment definition. The assessment details identify the possible outcomes for an assessment type.

Create an assessment code: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail
Delete an assessment code: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail/{AssessmentDetailUniqID}
Get all assessment codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail
Get an assessment code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail/{AssessmentDetailUniqID}
Update an assessment code: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail/{AssessmentDetailUniqID}

Assigned Delegates

The assigned delegates resource is used to view contact information for all the delegates of a transaction owner.

Get a delegate's contact information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssignedDelegates/{DelegateHeaderId}
Get all delegates' contact information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAssignedDelegates

Assigned Tasks

The assigned tasks resource is used to retrieve all the tasks assigned to an agency user to take necessary actions.

Get all assigned tasks: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTasks
Get an assigned task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTasks/{taskId}

Assigned or Unassigned Inspections

The assigned or unassigned inspections resource is used by the inspection supervisor calendar. Unassigned inspections, based on the inspection types and districts associated to the supervisor, are displayed on the supervisor calendar so that they may be assigned in a timely fashion. Assigned inspections for a given day are also displayed, for visibility into the workload of the inspectors.

Create an inspection action is not supported: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnasgnInspections
Delete an inspection action is not supported: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnasgnInspections/{publicSectorUnasgnInspectionsUniqID}
Get all assigned or unassigned inspections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnasgnInspections
Get an assigned or unassigned inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnasgnInspections/{publicSectorUnasgnInspectionsUniqID}
Update an inspection action is not supported: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnasgnInspections/{publicSectorUnasgnInspectionsUniqID}

Autonumber Rules

The autonumber rules resource is used to view, create, modify, or delete an autonumber rule. An autonumber rule is used by transactions to generate identifying numbers based on business rules.

Create an autonumber rule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers
Delete an autonumber rule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers/{RuleId}
Get all autonumber rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers
Get an autonumber rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers/{RuleId}
Get the next number or numbers based on the given autonumber rule ID and on how many numbers should be returned in one call.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers/{RuleId}
Update an autonumber rule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers/{RuleId}

Available Calendar Inspection Dates

The available calendar inspection dates resource is used to return the next seven available inspection dates for a given permit and inspection type, based on any applicable holiday calendars and adhering to the inspection calendar associated with the inspection type and the inspection district as derived from the permit primary parcel address, if applicable, or the address district if the permit is associated to an address with no parcel.

Get all available inspection dates by calendar: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRCalendarAvailableDates
Get an available inspection date by calendar: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRCalendarAvailableDates/{Possibledate}

Available Inspection Dates

The available inspection dates resource is used to return the next seven available inspection dates for a given permit and inspection type, based on any applicable holiday calendars.

Get all available inspection dates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRAvailableDates
Get an available inspection date: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRAvailableDates/{Possibledate}

Available Meeting Slots

The available meeting slots resource is used to view the time when the agency staff are available for pre-application meetings.

Get all available meeting start date and time: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAvailableMeetingSlots
Get an available meeting start date and time: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAvailableMeetingSlots/{publicSectorAvailableMeetingSlotsUniqID}

Available User Roles

The available user roles resource is used to get the available application security roles.

Get all application security roles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAvailableUserRoles
Get an application security role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAvailableUserRoles/{roleGUID}

BIP Report Configurations

The BIP report configurations resource is used to view or modify reporting configuration data for a BIP report. It stores the parameters, parameter type on the basis of which reports can be filtered.

Create a report configuration parameter: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters
Delete a report configuration parameter: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters/{publicSectorBIPReportParametersUniqID}
Get a report configuration parameter: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters/{publicSectorBIPReportParametersUniqID}
Get all report configuration parameters: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters
Update a report configuration parameter: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters/{publicSectorBIPReportParametersUniqID}

BIP Reports

The BIP reports resource is used to view BIP reports. It stores the report identifier, description, and the file location path. A user can modify only the file location path.

Create a report configuration: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReports
Get a report configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}
Get all report configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReports
Update a report configuration: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}

BIP Reports/BIP Report Configurations

The BIP report configurations resource is used to view or modify reporting configuration data for a BIP report. It stores the parameters and parameter type on the basis of which reports can be filtered.

Create a report configuration parameter: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}/child/ReportMapParameters
Delete a report configuration parameter: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}/child/ReportMapParameters/{ReportMapParametersUniqID}
Get a report configuration parameter: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}/child/ReportMapParameters/{ReportMapParametersUniqID}
Get all report configuration parameters: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}/child/ReportMapParameters
Update a report configuration parameter: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}/child/ReportMapParameters/{ReportMapParametersUniqID}

BL Records

The bl record resource is used to view, create, modify, or delete a record. Note: The standard actions are not available in the BL records resource. You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Get a BL record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}
Get all BL records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBlRecords

BL Records/Business Locations

The business location resource is used to view, create, modify, or delete a contact list. A business location shows the location information associated with a record. Note: The standard actions are not available in the BL records resource. You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Get a location: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BusinessLocation/{LnpBusinessLocationKey}
Get all locations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BusinessLocation

BL Records/Business Owners

The business owner resource is used to view, create, modify, or delete a business owner information. This is the owner information associated with a BL record. Note: The standard actions are not available in the BL records resource. You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Get all owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BusinessOwner
Get an owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BusinessOwner/{LnpBusinessOwnersKey}

Bill Types

The bill types resource is used to view, create, delete, or modify bill types.

Create a bill type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBillTypes
Delete a bill type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBillTypes/{publicSectorBillTypesUniqID}
Get a bill type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBillTypes/{publicSectorBillTypesUniqID}
Get all bill types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBillTypes
Update a bill type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBillTypes/{publicSectorBillTypesUniqID}

Bus Entity Statuses

The business entity statuses resource is used to inactivate the status of a business entity.

Get a business entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusEntityStatuses/{publicSectorBusEntityStatusesUniqID}
Get all business entities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusEntityStatuses
Update a business entity: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusEntityStatuses/{publicSectorBusEntityStatusesUniqID}

Bus Location Statuses

The business location statuses resource is used to inactivate the status of a business location.

Get a business location: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusLocationStatuses/{publicSectorBusLocationStatusesUniqID}
Get all business locations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusLocationStatuses
Update a business location: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusLocationStatuses/{publicSectorBusLocationStatusesUniqID}

Business Categories

Use the business categories resource to view, update, create, and delete business categories. A business category is used to specify the business category of a business entity.

Create a business category: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories
Delete a business category: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}
Get a business category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}
Get all business categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories
Update a business category: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}

Business Categories/Business Subcategories

Use the business subcategories resource to view, update, create, and delete business subcategories. A business subcategory is used to specify the subcategory of a business category of a business entity.

Create a business subcategory: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}/child/BusinessSubcategory
Delete a business subcategory: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}/child/BusinessSubcategory/{BusinessSubcategoryUniqID}
Get a business subcategory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}/child/BusinessSubcategory/{BusinessSubcategoryUniqID}
Get all business subcategories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}/child/BusinessSubcategory
Update a business subcategory: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}/child/BusinessSubcategory/{BusinessSubcategoryUniqID}

Business Entity List Details

The business entity list details resource is used to view detailed information about business entities.

Get a business entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails/{publicSectorBusinessEntityListDetailsUniqID}
Get all business entites: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails

Business Entity Lists

The business entity lists resource is used to view business entities.

Get a business entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityLists/{publicSectorBusinessEntityListsUniqID}
Get all business entities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityLists

Business License Expiry Communications

The business license expiry communication resource is used to record attributes related to a business license when an expiry communication request is received.

Get a business license expiry communication item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBlExpiryCommunications/{LnpRecordKey}
Get all business license expiry communication items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBlExpiryCommunications

Business Location List Details

The business location list details resource is used to view detailed information about the locations associated with a business entity.

Get a business location: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationListDetails/{publicSectorBusinessLocationListDetailsUniqID}
Get all business locations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationListDetails

Business Location Lists

The business location lists resource is used to view the locations associated with a business entity.

Get a business location: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationLists/{publicSectorBusinessLocationListsUniqID}
Get all business locations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationLists

Business Owner List Details

The business owner list details resource is used to view detailed information about the owners associated with a business entity.

Get a business owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessOwnerListDetails/{publicSectorBusinessOwnerListDetailsUniqID}
Get all business owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessOwnerListDetails

Business Profiles

The business profiles resource is used to view, create, or modify a registered public user business profile.

Create a business profile of a registered public user: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles
Get a business profile of a registered public user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}
Get all business profiles of a registered public user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles
Update a business profile of a registered public user: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}

Business Profiles/Profile Emails

The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.

Create a set of email contact points for the user profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointEmail
Get all email contact points for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointEmail
Get an email contact point for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointEmail/{ContactPtId}
Update an email contact point for the user profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointEmail/{ContactPtId}

Business Profiles/Profile Locations

The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.

Create a set of contact address for the user profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileLocation
Get a contact address for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileLocation/{LocationSiteId}
Get all contact addresses for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileLocation
Update a contact address for the user profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileLocation/{LocationSiteId}

Business Profiles/Profile Phones

The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.

Create a set of phone contact points for the user profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointPhone
Get a phone contact point for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointPhone/{ContactPtId}
Get all phone contact points for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointPhone
Update a phone contact point for the user profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointPhone/{ContactPtId}

Business Registrations

The business registrations resource is used to create and update business entities.

Create a business entity: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations
Get a business entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}
Get all business entities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations
Update a business entity: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}

Business Registrations/Business Locations

The business locations resource is used to create and update business locations.

Create a business location: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessLocation
Get a business location: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessLocation/{BusinessLocationKey}
Get all business locations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessLocation
Update a business location: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessLocation/{BusinessLocationKey}

Business Registrations/Business Owners

The business owners resource is used to create and update Business Owners.

Create a business owner: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessOwner
Get a business owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessOwner/{ReferenceKey}
Get all business owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessOwner
Update a business owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessOwner/{ReferenceKey}

Business Rules Framework Actions

The business rules framework actions resource provides actions that are selected by users within each rule. If the conditions for a rule evaluate to true, the actions associated with that rule are performed by the system.

Create an action: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions
Delete an action: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions/{ActionId}
Get all actions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions
Get an action: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions/{ActionId}
Update an action: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions/{ActionId}

Business Rules Framework Conditions

The business rules framework conditions resource provides conditions that are created by users within a rule. Each condition is a field on a resource that is evaluated against a user-entered value.

Create a condition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions
Delete a condition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions/{ConditionId}
Get a condition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions/{ConditionId}
Get all conditions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions
Update a condition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions/{ConditionId}

Business Rules Framework Events

The business rules framework events resource is used to view events registered with the business rules framework.

Get all events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkEvents
Get an event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkEvents/{EventId}

Business Rules Framework Resource Actions

The business rules framework resource actions resource is used to display the available actions for a given business rules framework resource.

Get a resource action: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResourceActions/{ResourceActionId}
Get all resource actions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResourceActions

Business Rules Framework Resources

The business rules framework resources resource is used to display resources registered to the business rules framework.

Get a resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResources/{ResourceId}
Get all resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResources

Business Rules Framework Rules

The business rules framework rules resource provides rules that are created by users to store conditions and actions related to a resource and event.

Create a rule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRules
Delete a rule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRules/{RuleId}
Get a rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRules/{RuleId}
Get all rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRules
Update a rule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRules/{RuleId}

Business Rules Framework Schedules

The business rules framework schedules resource provides schedules that are create by a user within a rule. A rule schedule determines how often the system checks for the rule conditions and performs the rule actions.

Create a schedule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkSchedules
Delete a schedule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkSchedules/{ScheduleId}
Get a schedule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkSchedules/{ScheduleId}
Get all schedules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkSchedules
Update a schedule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkSchedules/{ScheduleId}

Business Subcategories

Create a business subcategory: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessSubcategories
Delete a business subcategory: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessSubcategories/{publicSectorBusinessSubcategoriesUniqID}
Get a business subcategory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessSubcategories/{publicSectorBusinessSubcategoriesUniqID}
Get all business subcategories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessSubcategories
Update a business subcategory: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessSubcategories/{publicSectorBusinessSubcategoriesUniqID}

Business Units

The business units resource is used to list all the organizational units that are business units in the system. The other organizational units in the system can a legal entity, a department, or a company.

Create a set of business units: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits
Delete a business unit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits/{publicSectorBusinessUnitsUniqID}
Get a business unit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits/{publicSectorBusinessUnitsUniqID}
Get all related business units: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits
Update a business unit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits/{publicSectorBusinessUnitsUniqID}

Calculate Citation Fees

The calculate citation fees resource is used to view a citation fee record. Citation fee records are used in Code Enforcement cases to calculate the citation fees.

Get a citation fee record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalculateCitationFees/{CaseKey}
Get all citation fee records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalculateCitationFees

Calendars

The calendar resource is used to view, create, or modify monthly accounting periods. Accounting periods are assigned to accounting journals by the Generate Accounting process based on the accounting date of the associated transactions.

Create a period: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalendars
Delete a period: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalendars/{publicSectorCalendarsUniqID}
Get a period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalendars/{publicSectorCalendarsUniqID}
Get all periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalendars
Update a period: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalendars/{publicSectorCalendarsUniqID}

Case Appeals

The case appeal resource is used to view, create, or modify a case appeal. Case appeals are used in Code Enforcement cases.

Create a case appeal: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAppeals
Get a case appeal: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAppeals/{CaseAppealKey}
Get all case appeals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAppeals
Update a case appeal: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAppeals/{CaseAppealKey}

Case Attachments

The case attachment resource is used to view, create, or modify a case attachment. Case attachments are used in Code Enforcement cases.

Create a case attachment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments
Delete a case attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}
Get a case attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}
Get all case attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments
Update a case attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}

Case Attachments/Case Attachment Contents

The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases.

Create a case attachment content: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor
Delete a case attachment content: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{AttachedDocumentId}
Get a case attachment content: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{AttachedDocumentId}
Get all case attachment contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor
Update a case attachment content: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{AttachedDocumentId}

Case Attachments/Case Attachment Contents/Case Attachment Revisions

The case attachment revision resource is used to view, create, or modify a case attachment revision. Case attachments are used in Code Enforcement cases.

Create a case attachment revision: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete a case attachment revision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get a case attachment revision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all case attachment revisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Update a case attachment revision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Case Citations

The case citation resource is used to view, create, or modify a case citation. Case citations are used in Code Enforcement cases.

Create a set of case citations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCitations
Delete a case citation: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}
Get a case citation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}
Get all case citations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCitations
Update a case citation: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}

Case Citations/Citation Payments

The citation payment resource is used to view a citation payment. Case citations are used in Code Enforcement cases.

Get a citation payment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}/child/PayCitation/{CitationKey2}
Get all citation payments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}/child/PayCitation

Case Code References

The case code reference resource is used to view, create, or modify a case code reference. Case code references are used in Code Enforcement cases.

Create a case code reference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences
Delete a case code reference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}
Get a case code reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}
Get all case code references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences
Update a case code reference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}

Case Comments

The case comment resource is used to view, create, or modify a case comment. Case comments are used in Code Enforcement cases.

Create a case comment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseComments
Delete a case comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseComments/{CommentKey}
Get a case comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseComments/{CommentKey}
Get all case comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseComments
Update a case comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseComments/{CommentKey}

Case Contacts

The case contact resource is used to view, create, or modify the contact details of a case. Case contacts are used in Code Enforcement cases.

Create a case contact: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts
Delete a case contact: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts/{CaseContactKey}
Get a case contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts/{CaseContactKey}
Get all case contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts
Update a case contact: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts/{CaseContactKey}

Case Fee Records

The case fee record resource is used to view, create, or modify a case appeal. Case fee records are used in Code Enforcement cases.

Get a case fee record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords/{FeeRecordKey}
Get all case fee records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords

Case History Records

The case history record resource is used to view the details of a case history record. Case history records track the changes made in Code Enforcement cases.

Get a case history record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseHistoryRecords/{CaseHistoryKey}
Get all case history records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseHistoryRecords

Case Notice Attachments

The case notice attachment resource is used to view, create, or modify a case notice attachment. Case notice attachments are used in Code Enforcement cases.

Create a case notice attachment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments
Delete a case notice attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}
Get a case notice attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}
Get all case notice attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments
Update a case notice attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}

Case Notice Attachments/Case Notice Attachment Contents

The case notice attachment content resource is used to view, create, or modify the content of a case notice attachment. Case notice attachments are used in Code Enforcement cases.

Create a case notice attachment content: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor
Delete a case notice attachment content: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{AttachedDocumentId}
Get a case notice attachment content: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{AttachedDocumentId}
Get all case notice attachment contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor
Update a case notice attachment content: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{AttachedDocumentId}

Case Notice Attachments/Case Notice Attachment Contents/Case Notice Attachment Revisions

The case notice attachment revision resource is used to view, create, or modify a case notice attachment revision. Case notice attachments are used in Code Enforcement cases.

Create a case notice attachment revision: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete a case notice attachment revision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get a case notice attachment revision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all case notice attachment revisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Update a case notice attachment revision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Case Notices

The case notice resource is used to view, create, or modify a case notice. Case notices are used in Code Enforcement cases.

Create a case notice: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices
Delete a case notice: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices/{CaseNoticeKey}
Get a case notice: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices/{CaseNoticeKey}
Get all case notices: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices
Update a case notice: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices/{CaseNoticeKey}

Cases

The case resource is used to view or modify a case. Cases are used to record violations in Code Enforcement.

Get a case: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}
Get all cases: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCases
Update a case: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}

Cash Discrepancy Types

The cash discrepancy types resource is used to view valid cash drawer reconciliation shortage and overage types.

Get a cash discrepancy type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDiscrepTypes/{DiscrepancyType}
Get all cash discrepany types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDiscrepTypes

Cash Drawer Payments

The cash drawer payments resource is used to view and create cash draw payment history information.

Create a cash drawer payment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments
Get a cash drawer payment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments/{publicSectorCashDrawerPaymentsUniqID}
Get all cash drawer payments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments
Update a cash drawer payment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments/{publicSectorCashDrawerPaymentsUniqID}

Cash Drawer Reconciliation Views

The cash drawer reconciliation views resource is used to collect cash drawer reconciliation view information.

Get a cash drawer reconciliation view: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcilViews/{SessionId}
Get all cash drawer reconciliation views: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcilViews

Cash Drawer Reconciliations

The cash drawer reconciliations resource is used to view or create cash drawer reconciliation information.

Create a cash drawer reconciliation: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcils
Delete a cash drawer reconciliation: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcils/{ReconcileId}
Get a cash drawer reconciliation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcils/{ReconcileId}
Get all cash drawer reconciliations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcils
Update a cash drawer reconciliation: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcils/{ReconcileId}

Cash Drawer Session Times

The cash drawer session times resource is used to record time details of cash drawer sessions, which can be opened or suspended multiple times.

Create a cash drawer session time: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessionTimes
Get a cash drawer session time: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessionTimes/{publicSectorCashDrawerSessionTimesUniqID}
Get all cash drawer session times: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessionTimes
Update a cash drawer session time: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessionTimes/{publicSectorCashDrawerSessionTimesUniqID}

Cash Drawer Sessions

The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.

Create a cash drawer session: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions
Get a cash drawer session: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}
Get all cash drawer sessions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions
Update a cash drawer session: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}

Cash Drawer Sessions/Cash Drawer Sessions Time Lines

The cash drawer sessions time lines resource is used to save the cashier session detail of open and close datetime.

Create a cash drawer session time line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}/child/BnpCashDrawerSessionTimeView
Get a cash drawer session time line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}/child/BnpCashDrawerSessionTimeView/{BnpCashDrawerSessionTimeViewUniqID}
Get all cash drawer session time lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}/child/BnpCashDrawerSessionTimeView
Update a cash drawer session time line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}/child/BnpCashDrawerSessionTimeView/{BnpCashDrawerSessionTimeViewUniqID}

Cash Drawers

The cash drawers resource is used to view, create, delete or modify cash drawers. A cash drawer is a mechanical or electronic device for registering and calculating monetary transactions at a point of sale.

Create a cash drawer: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers
Delete a cash drawer: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers/{publicSectorCashDrawersUniqID}
Get a cash drawer: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers/{publicSectorCashDrawersUniqID}
Get all cash drawers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers
Update a cash drawer: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers/{publicSectorCashDrawersUniqID}

Cash Session Prompts

The cash session prompts resource is used to collect enabled cash drawers in the cashier session setup.

Get a cash session prompt: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashSessionPrompts/{publicSectorCashSessionPromptsUniqID}
Get all cash session prompts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashSessionPrompts

Cash drawer reconciliation accountings

The cash drawer reconciliation accountings resource is used to view cash drawer reconciliation shortage/overage amounts.

Get all cash drawer reconciliation shortage/overage amounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashReconcileAcctgs
Get cash drawer reconciliation shortage/overage amount: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashReconcileAcctgs/{TransactionId}
Update a cash drawer reconciliation shortage/overage amount: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashReconcileAcctgs/{TransactionId}

Cashier Session Reconciliation Details

The cash drawer reconciliations resource is used to view cash drawer reconciliation information.

Get a set of cashier session reconciliation details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorReconcileDetailViews/{publicSectorReconcileDetailViewsUniqID}
Get all cashier session reconciliation details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorReconcileDetailViews

Cashier Sessions

The cashier sessions resource is used to show the details of cashier sessions. A cashier session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.

Get a cashier session: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashierSessions/{SessionId}
Get all cashier sessions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashierSessions
Gets the current server time and cashier session auto number rule name.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashierSessions
Gets the current server time.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCashierSessions

Catalog Resources

The catalog resources resource contains API catalog information.

Create a catalog resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources
Delete a catalog resource: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources/{ResourceName}
Get a catalog resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources/{ResourceName}
Get all catalog resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources
Update a catalog resource: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources/{ResourceName}

Checkouts

The checkouts resource is used to view, create, delete or update checkout data.

Create a set of payment checkout data: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts
Delete a set of payment checkout data: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}
Get a set of payment checkout data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}
Get all payment checkout data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts
Update a set of payment checkout data: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}

Checkouts/Checkout Lines

The checkout lines resource is used to view, create, delete or update checkout lines.

Create a payment checkout line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin
Delete a payment checkout line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin/{CheckoutLinUniqID}
Get a payment checkout line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin/{CheckoutLinUniqID}
Get all payment checkout lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin
Update a payment checkout line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin/{CheckoutLinUniqID}

Checkpoints

The checkpoint data resource is used to create, update, or view checkpoints created during Oracle Policy Automation interviews. The resource is also used to implement Web Service Connector operations such as Set Check Point and Get Check Point for integrating the Oracle Policy Automation product with the Public Sector Cloud application.

Create a set of checkpoint data: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData
Delete a checkpoint data: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/{CheckpointId}
Get a checkpoint data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/{CheckpointId}
Get a checkpoint data.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData
Get all checkpoint data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData
Set a checkpoint data.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData
Update a checkpoint data: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/{CheckpointId}

Citation Payments

The citation payment resource is used to view a citation payment. Case citations are used in Code Enforcement cases.

Get a citation payment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPayCitations/{CitationKey}
Get all citation payments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPayCitations

Cities

The cities resource is used to view, create, delete, or modify cities. A city is a large human settlement.

Create a city: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCities
Delete a city: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCities/{publicSectorCitiesUniqID}
Get a city: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCities/{publicSectorCitiesUniqID}
Get all cities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCities
Update a city: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCities/{publicSectorCitiesUniqID}

Code Enforcement Agency Options

The code enforcement agency options resource is used to view, create, delete, or modify the agency-level options for code enforcement.

Create a set of agency code enforcement options: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions
Delete an agency's code enforcement options: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions/{AgencyId}
Get all agencies code enforcement options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions
Get an agency's code enforcement options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions/{AgencyId}
Update an agency's code enforcement options: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions/{AgencyId}

Code Enforcement Districts

The code enforcement districts resource is used to view code enforcement districts. A district is an administrative region that, in some countries, is managed by local government.

Get a code enforcement district: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCEDistricts/{DistrictId}
Get all code enforcement districts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCEDistricts

Code Enforcement Incidents

The incidents resource is used to view, create, delete, or modify code enforcement incidents that are created by public users.

Create an incident: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidents
Delete an incident: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}
Get all incidents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidents
Get an incident: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}
Update an incident: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}

Code Enforcement Incidents/Incident Comments

The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.

Create a comment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment
Delete a comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment/{CommentKey}
Get a comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment/{CommentKey}
Get all comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment
Update a comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment/{CommentKey}

Code Enforcement Inspection Attachments

The code enforcement inspection attachments resource is used to add, update, view, or delete an attachment for an inspection.

Create a set of code enforcement inspection attachments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments
Delete a code enforcement inspection attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}
Get a code enforcement inspection attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}
Get all code enforcement inspection attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments
Update a code enforcement inspection attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}

Code Enforcement Inspection Attachments/Code Enforcement Inspection Attachment Accessors

The code enforcement inspection attachment accessors resource is used to display file-related information such as the file name and the file URL.

Create a set of code enforcement inspection attachment accessors: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}/child/InspectionAttachmentViewAccessor
Delete a code enforcement inspection attachment accessor: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}/child/InspectionAttachmentViewAccessor/{AttachedDocumentId}
Get a code enforcement inspection attachment accessor: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}/child/InspectionAttachmentViewAccessor/{AttachedDocumentId}
Get all code enforcement inspection attachment accessors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}/child/InspectionAttachmentViewAccessor
Update a code enforcement inspection attachment accessor: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}/child/InspectionAttachmentViewAccessor/{AttachedDocumentId}

Code Enforcement Inspection Attachments/Code Enforcement Inspection Attachment Accessors/Code Enforcement Inspection Attachment Revisions

The code enforcement inspection attachment revisions resource is used to display the historical information about an attachment.

Create a set of code enforcement inspection attachment revisions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}/child/InspectionAttachmentViewAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete a code enforcement inspection attachment revision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}/child/InspectionAttachmentViewAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get a code enforcement inspection attachment revision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}/child/InspectionAttachmentViewAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all code enforcement inspection attachment revisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}/child/InspectionAttachmentViewAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Update a code enforcement inspection attachment revision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{AttachmentKey}/child/InspectionAttachmentViewAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Code Enforcement Inspection Comments

The code enforcement inspection comments resource is used to view and add comments related to an inspection.

Create a set of code enforcement inspection comments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments
Delete a code enforcement inspection comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{CommentKey}
Get a code enforcement inspection comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{CommentKey}
Get all code enforcement inspection comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments
Update a code enforcement inspection comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{CommentKey}

Code Enforcement Inspection Lists

The code enforcement inspection list resource is used to retrieve the ongoing inspections in Code Enforcement.

Get a code enforcement inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionLists/{publicSectorCodeEnforcementInspectionListsUniqID}
Get all code enforcement inspections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionLists

Code Enforcement Inspections

The code enforcement inspections resource is used to record the inspections that are conducted as a part of the Code Enforcement process.

Create a set of all inspections: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections
Delete an inspection: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections/{publicSectorCodeEnforcementInspectionsUniqID}
Get all inspections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections
Get an inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections/{publicSectorCodeEnforcementInspectionsUniqID}
Update an inspection: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections/{publicSectorCodeEnforcementInspectionsUniqID}

Code Enforcement Recent Issues

The code enforcement recent issues resource is used to view issues in the list of issues recently reported by users.

Get an issue: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementRecentIssues/{CaseKey}
Get recent issues: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementRecentIssues

Code Enforcement Statuses

The code enforcement status options resource is used to view, create, delete, or modify statuses that are related to code enforcement.

Create a code enforcement status: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses
Delete a code enforcement status: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses/{publicSectorCodeEnforcementStatusesUniqID}
Get a code enforcement status: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses/{publicSectorCodeEnforcementStatusesUniqID}
Get code enforcement statuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses
Update a code enforcement status: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses/{publicSectorCodeEnforcementStatusesUniqID}

Code Officers

The code officers resource is used to get a list of all the Code Enforcement officers and their inspection schedules for the day.

Get a code officer: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeOfficerLists/{PersonId}
Get all code officers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeOfficerLists

Code References

The code references resource is used to view, create, modify, or delete a code reference. Code references provide detailed specifications and a link to a specific section in a source document such as a building code or other code, guideline, or ordinance.

Create a code reference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences
Delete a code reference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences/{publicSectorCodeReferencesUniqID}
Get a code reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences/{publicSectorCodeReferencesUniqID}
Get all code references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences
Update a code reference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences/{publicSectorCodeReferencesUniqID}

Code References Keys

The code reference keys resource is used to view a list of current effective dated code reference IDs and descriptions.

Create a code reference key is not supported: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesKeys
Delete a code reference key is not supported: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesKeys/{publicSectorCodeReferencesKeysUniqID}
Get a code reference key: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesKeys/{publicSectorCodeReferencesKeysUniqID}
Get all code reference keys: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesKeys
Update a code reference key is not supported: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesKeys/{publicSectorCodeReferencesKeysUniqID}

Code References Totals

The code references totals resource is used to view all effective dated rows for a code reference.

Create a record reference is not supported: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesTotals
Delete a code reference is not supported: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesTotals/{publicSectorCodeReferencesTotalsUniqID}
Get a code reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesTotals/{publicSectorCodeReferencesTotalsUniqID}
Get all code references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesTotals
Update a code reference is not supported: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesTotals/{publicSectorCodeReferencesTotalsUniqID}

Code Types

The code types resource is used to view, create, modify, or delete a code type. Code types represent specific published codes, guidelines, ordinances, and so forth.

Create a code type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeTypes
Delete a code type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeTypes/{publicSectorCodeTypesUniqID}
Get a code type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeTypes/{publicSectorCodeTypesUniqID}
Get all code types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeTypes
Update a code type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeTypes/{publicSectorCodeTypesUniqID}

Comment Application Groups

The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.

Create a comment application group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroups
Delete a comment application group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroups/{publicSectorCommentApplicationGroupsUniqID}
Get a comment application group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroups/{publicSectorCommentApplicationGroupsUniqID}
Get all comment application groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroups
Update a comment application group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroups/{publicSectorCommentApplicationGroupsUniqID}

Comment Categories

The comment category resource is used to view, create, or modify a comment category. Comment categories are used to categorize standard comments.

Create a comment category: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories
Delete a comment category: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}
Get a comment category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}
Get all comment categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories
Update a comment category: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}

Comment Categories/Comment Application Groups

The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.

Create a comment application group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentApplicationGroups
Delete a comment application group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentApplicationGroups/{CommentApplicationGroupsUniqID}
Get a comment application group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentApplicationGroups/{CommentApplicationGroupsUniqID}
Get all comment application groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentApplicationGroups
Update a comment application group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentApplicationGroups/{CommentApplicationGroupsUniqID}

Comment Categories/Comment Subcategories

The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.

Create a comment subcategory: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentSubCategories
Delete a comment subcategory: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentSubCategories/{CommentSubCategoriesUniqID}
Get a comment subcategory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentSubCategories/{CommentSubCategoriesUniqID}
Get all comment subcategories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentSubCategories
Update a comment subcategory: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentSubCategories/{CommentSubCategoriesUniqID}

Comment Setups

The comment setup resource is used to view, create, or modify a comment setup. An agency requires to define a comment setup.

Create a comment setup: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentSetups
Delete a comment setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentSetups/{AgencyId}
Get a comment setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentSetups/{AgencyId}
Get all comment setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentSetups
Update a comment setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentSetups/{AgencyId}

Comment Subcategories

The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.

Create a comment subcategory: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentSubCategories
Delete a comment subcategory: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentSubCategories/{publicSectorCommentSubCategoriesUniqID}
Get a comment subcategory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentSubCategories/{publicSectorCommentSubCategoriesUniqID}
Get all comment subcategories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentSubCategories
Update a comment subcategory: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommentSubCategories/{publicSectorCommentSubCategoriesUniqID}

Communication Alerts

The communication alerts resource is used to view communication alerts. An alert is information displayed on the landing page for registered users and anonymous users.

Get a communication alert: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationAlerts/{publicSectorCommunicationAlertsUniqID}
Get all communication alerts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationAlerts

Communication Events

The communication event resource is used to create and view communication events. A communication event is a metadata definition used by applications for triggering communications.

Create a communication event: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationEvents
Get a communication event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationEvents/{EventId}
Get all communication events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationEvents
Update a communication event: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationEvents/{EventId}

Communication Record Details

The communication record details resource is used to view communication details triggered through email, notification, and alert channels.

Get a communication details log: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails/{publicSectorCommunicationRecordDetailsUniqID}
Get all communication details logs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails

Communication Record Details/Web Forms

The web forms resource is used to view web form details associated with the communications triggered through ad hoc emails and ad hoc notifications.

Get a set of web form details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails/{publicSectorCommunicationRecordDetailsUniqID}/child/WebForms/{WebformId}
Get all web form details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails/{publicSectorCommunicationRecordDetailsUniqID}/child/WebForms

Communication Requests

The communication requests resource is used to trigger communications for targeted recipients using the email and notification channels.

Create a communication request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRequests
Get a communication request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRequests/{LogId}
Get all communication requests: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRequests

Communication Resend Messages

The communication resend messages resource is used to resend communications for targeted recipients using the email and notification channels.

Create a communication resend request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResendMessages
Get a communication resend request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResendMessages/{LogMessageId}
Get all communication resend requests: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResendMessages

Communication Resources

The communication resources resource is used to create and view communication resources. A communication resource is a metadata definition of a REST resource used by applications to trigger communications.

Create a communication resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources
Delete a communication resource: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}
Get a communication resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}
Get all communication resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources
Update a communication resource: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}

Communication Templates

The communication templates resource is used to create and view communication templates. A communication template is a metadata definition used by applications to trigger communications.

Create a communication template: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates
Delete a communication template: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates/{TemplateId}
Get a communication template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates/{TemplateId}
Get all communication template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates
Update a communication template: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates/{TemplateId}

Communication Text Senders

The communication text senders resource is used to fetch a valid list of text sender IDs from a Twilio account.

Create a communication text sender list: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTextSenders
Delete a communication text sender list: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTextSenders/{phoneNumber}
Get a communication text sender list: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTextSenders/{phoneNumber}
Get all communication text sender lists: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTextSenders
Update a communication text sender list: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTextSenders/{phoneNumber}

Condition List Details

The condition list details resource is used to view the details of the conditions applied against a transaction.

Checks for a condition with the specified transaction key values.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditionListDetails
Create a set of conditions against a transaction: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditionListDetails
Get a condition applied against a transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditionListDetails/{ConditionKey}
Get all conditions applied against a transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditionListDetails

Condition Lists

The condition lists resource is used to apply, update, or remove a condition that is applied against a record.

Create a set of conditions against a record: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditionLists
Get a condition applied against a record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditionLists/{ConditionKey}
Get all conditions applied against a record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditionLists
Update a condition applied against a record: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditionLists/{ConditionKey}

Conditions

The conditions resource is used to create, view, or update a condition setup.

Create a set of conditions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditions
Delete a condition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditions/{publicSectorConditionsUniqID}
Get a condition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditions/{publicSectorConditionsUniqID}
Get all conditions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditions
Update a condition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConditions/{publicSectorConditionsUniqID}

Contact Lists

Use the contact lists resource to view, create, modify, or delete a contact person on your list.

Create a contact person: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContactLists
Delete a contact person: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContactLists/{ContactId}
Get a contact person: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContactLists/{ContactId}
Get all contact persons: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContactLists
Update a contact person: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContactLists/{ContactId}

Contact Types

Use the contact types resource to view, create, modify, or delete contact types.

Create a contact type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContactTypes
Delete a contact type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContactTypes/{publicSectorContactTypesUniqID}
Get a contact type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContactTypes/{publicSectorContactTypesUniqID}
Get all contact types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContactTypes
Update a contact type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContactTypes/{publicSectorContactTypesUniqID}

Contextual Help

The contextual help resource is used to view, create, or modify contextual help defined for fields or areas on a page. Contextual help can be defined for static pages as well as for user defined paged created using the Permit Designer by an agency. The contextual help resource defines the association to a particular field or area on a page.

Create a new contextual help entry: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelps
Delete a contextual help entry: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}
Get a contextual help entry: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}
Get all contextual help entries: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelps
Update a contextual help entry: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}

Contextual Help Details

The contextual help details resource is used to view, create, or modify contextual help text defined for fields or areas on a page. Contextual help can be defined for static pages as well as for user defined paged created using the Permit Designer by an agency. The contextual help resource defines the association to a particular field or area on a page.

Create a set of contextual help details: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails
Delete a set contextual help details: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails/{publicSectorContextHelpDetailsUniqID}
Get a set of contextual help details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails/{publicSectorContextHelpDetailsUniqID}
Get all contextual help details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails
Update a set of contextual help details: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails/{publicSectorContextHelpDetailsUniqID}

Contextual Help/Contextual Help Details

The contextual help details resource is used to create or modify the desired help text.

Create a set of contextual help details: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail
Delete a set contextual help details: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail/{ContextHelpDetailUniqID}
Get a set of contextual help details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail/{ContextHelpDetailUniqID}
Get all contextual help details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail
Update a set of contextual help details: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail/{ContextHelpDetailUniqID}

Contractor Facts

The contractor facts resource is used to view and modify the names of specific pieces of information for contractor licenses.

Create a set of contractor validation facts is not allowed: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorFacts
Delete a contractor validation fact is not allowed: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorFacts/{publicSectorContractorFactsUniqID}
Get a contractor validation fact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorFacts/{publicSectorContractorFactsUniqID}
Get all contractor validation facts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorFacts
Update a contractor validation fact: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorFacts/{publicSectorContractorFactsUniqID}

Contractor Option Classifications

The contractor option classifications resource is used to view, add, delete and modify contractor license classifications.

Create a set of classifications for a contractor validation option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionClassifications
Delete a classification for a contractor validation option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionClassifications/{publicSectorContractorOptionClassificationsUniqID}
Get a classification for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionClassifications/{publicSectorContractorOptionClassificationsUniqID}
Get all classifications for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionClassifications
Update a classification for a contractor validation option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionClassifications/{publicSectorContractorOptionClassificationsUniqID}

Contractor Option Facts

The contractor option facts resource is used to view, add, and modify contractor license options that control which license information sections are enabled.

Create a set of contractor validation option facts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionFacts
Get a fact for contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionFacts/{publicSectorContractorOptionFactsUniqID}
Get all contractor validation option facts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionFacts
Update a fact for contractor validation option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionFacts/{publicSectorContractorOptionFactsUniqID}

Contractor Option Integrations

The contractor option integrations resource is used to view, add, delete and modify integration to an external source that validates contractor license information.

Create a set of integrations for a contractor validation option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations
Delete an integration for a contractor validation option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations/{publicSectorContractorOptionIntegrationsUniqID}
Get all integrations for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations
Get an integration for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations/{publicSectorContractorOptionIntegrationsUniqID}
Update an integration for a contractor validation option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations/{publicSectorContractorOptionIntegrationsUniqID}

Contractor Option License Types

The contractor option license types resource is used to view, add, delete and modify contractor license types.

Create a set of license types for a contractor validation option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionLicenseTypes
Delete a license type for a contractor validation option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionLicenseTypes/{publicSectorContractorOptionLicenseTypesUniqID}
Get a license type for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionLicenseTypes/{publicSectorContractorOptionLicenseTypesUniqID}
Get all license types for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionLicenseTypes
Update a license type for a contractor validation option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionLicenseTypes/{publicSectorContractorOptionLicenseTypesUniqID}

Contractor Option Status Mappings

The contractor option status mappings resource is used to view, add, delete and modify contractor validation status mappings.

Create a set of status mappings for a contractor validation option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionStatusMappings
Delete a status mapping for a contractor validation option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionStatusMappings/{publicSectorContractorOptionStatusMappingsUniqID}
Get a status mapping for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionStatusMappings/{publicSectorContractorOptionStatusMappingsUniqID}
Get all status mappings for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionStatusMappings
Update a status mapping for a contractor validation option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionStatusMappings/{publicSectorContractorOptionStatusMappingsUniqID}

Contractor Options

The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.

Create a set of contractor validation options: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions
Create a set of contractor validation options is not allowed: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions
Delete a contractor validation option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}
Delete a contractor validation option is not allowed: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}
Get a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}
Get a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}
Get all contractor validation options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions
Get all contractor validation options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions
Update a contractor validation option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}
Update a contractor validation option is not allowed: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}

Contractor Options/Contractor Option Classifications

The contractor option classifications resource is used to view, add, delete and modify contractor license classifications.

Create a set of classifications for a contractor validation option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionClassifications
Create a set of classifications for a contractor validation option is not allowed: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionClassifications
Delete a classification for a contractor validation option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}
Delete a classification for a contractor validation option is not allowed: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}
Get a classification for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}
Get a classification for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}
Get all classifications for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionClassifications
Get all classifications for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionClassifications
Update a classification for a contractor validation option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}
Update a classification for a contractor validation option is not allowed: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}

Contractor Options/Contractor Option Facts

The contractor option facts resource is used to view, add, delete and modify contractor license options that control which license information sections are enabled.

Create a set of facts for a contractor validation option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionFacts
Create a set of facts for a contractor validation option is not allowed: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionFacts
Delete a fact for a contractor validation option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}
Delete a fact for a contractor validation option is not allowed: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}
Get a fact for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}
Get a fact for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}
Get all facts for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionFacts
Get all facts for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionFacts
Update a fact for a contractor validation option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}
Update a fact for a contractor validation option is not allowed: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}

Contractor Options/Contractor Option Integrations

The contractor option integrations resource is used to view, add, delete and modify integration to an external source that validates contractor license information.

Create a set of integrations for a contractor validation option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionIntegrations
Delete an integration for a contractor validation option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionIntegrations/{ContractorOptionIntegrationsUniqID}
Get all integrations for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionIntegrations
Get an integration for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionIntegrations/{ContractorOptionIntegrationsUniqID}
Update an integration for a contractor validation option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionIntegrations/{ContractorOptionIntegrationsUniqID}

Contractor Options/Contractor Option License Types

The contractor option license types resource is used to view, add, delete and modify contractor license types.

Create a set of contractor validation option license types is not allowed is not allowed: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionLicenseTypes
Create a set of license types for a contractor validation option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionLicenseTypes
Delete a license type for a contractor validation option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}
Delete a license type of contractor validation option is not allowed is not allowed: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}
Get a license type for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}
Get a license type for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}
Get all contractor validation option license types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionLicenseTypes
Get all license types for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionLicenseTypes
Update a license type for a contractor validation option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}
Update a license type of contractor validation option is not allowed is not allowed: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}

Contractor Options/Contractor Option Status Mappings

The contractor option status mappings resource is used to view, add, delete and modify contractor validation status mappings.

Create a set of status mappings for a contractor validation option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionStatusMappings
Create a set of status mappings for a contractor validation option is not allowed: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings
Delete a status mapping for a contractor validation option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}
Delete a status mapping for a contractor validation option is not allowed: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}
Get a status mapping for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}
Get a status mapping for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}
Get all status mappings for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionStatusMappings
Get all status mappings for a contractor validation option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings
Update a status mapping for a contractor validation option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}
Update a status mapping for a contractor validation option is not allowed: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}

Corrective Actions

The corrective action resource is used to view, create, or modify a corrective action that is applied to resolve an issue. Corrective actions are used in Code Enforcement cases.

Create a corrective action: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions
Delete a corrective action: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions/{publicSectorCorrectiveActionsUniqID}
Get a corrective action: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions/{publicSectorCorrectiveActionsUniqID}
Get all corrective actions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions
Update a corrective action: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions/{publicSectorCorrectiveActionsUniqID}

Counties

The counties resource is used to view, create, delete, or modify counties. A county is a region within a state.

Create a county: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCounties
Delete a county: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCounties/{publicSectorCountiesUniqID}
Get a county: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCounties/{publicSectorCountiesUniqID}
Get all counties: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCounties
Update a county: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCounties/{publicSectorCountiesUniqID}

Countries

The countries resource is used to view, create, delete, or modify countries. A country is a region that is identified as a distinct national entity in political geography.

Create a country: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCountries
Delete a country: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCountries/{CountryCode}
Get a country: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCountries/{CountryCode}
Get all countries: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCountries
Update a country: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCountries/{CountryCode}

Currencies

The currencies resource is used to view, create, delete, or modify currencies. Currency refers to money in any form when in actual use or circulation as a medium of exchange, especially circulating banknotes and coins.

Create a currency: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCurrencies
Delete a currency: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCurrencies/{CurrencyCode}
Get a currency: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCurrencies/{CurrencyCode}
Get all currencies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCurrencies
Update a currency: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCurrencies/{CurrencyCode}

Current Contextual Help

The current contextual help resource is used to view contextual help defined for a specific field or areas on a page. Informational help text is displayed to the user when they click a help icon associated with the field or area.

Get a current contextual help entry: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCurrentContextHelps/{publicSectorCurrentContextHelpsUniqID}
Get all current contextual help entries: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCurrentContextHelps

Custom Callbacks

The custom callbacks resource is used for completing a variety of tasks when creating custom objects, such as setting up functional security, setting up data security, and registering the object in the API catalog. Only the POST method is used within the custom callbacks resource. This resource is intended to be used only by internal development teams within Oracle.

Create a custom callback: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCustomCallbacks
Delete a custom callback is not supported: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCustomCallbacks/{SubClassId}
Get a custom callback is not supported: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCustomCallbacks/{SubClassId}
Get all custom callbacks is not supported: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCustomCallbacks
Update a custom callback is not supported: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCustomCallbacks/{SubClassId}

Dashboard Configurations

The dashboard configurations resource is used to view, create, and modify the configuration for dashboards. Users can add new dashboards and modify the details of existing dashboards.

Create a dashboard configuration: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations
Delete a dashboard configuration: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations/{publicSectorAnalyticsConfigurationsUniqID}
Get a dashboard configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations/{publicSectorAnalyticsConfigurationsUniqID}
Get all dashboard configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations
Update a dashboard configuration: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations/{publicSectorAnalyticsConfigurationsUniqID}

Delegate Details

The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users.

Create a set of delegate detail information: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateDetails
Delete a delegate's detail information: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateDetails/{DelegateDetailId}
Get a delegate's detail information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateDetails/{DelegateDetailId}
Get all delegates' detail information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateDetails
Update a delegate's detail information: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateDetails/{DelegateDetailId}

Delegate Histories

The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users.

Create a set of delegate history information: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateHistories
Delete a delegate's history information: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateHistories/{DelegateHistoryId}
Get a delegate's history information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateHistories/{DelegateHistoryId}
Get all delegates' history information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateHistories
Update a delegate's history information: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateHistories/{DelegateHistoryId}

Delegate Invitation Notifications

The delegate invitation notifications resource is used to view delegate information for the creation of a notification template that contains accept and decline links.

Get a delegate's information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateInvitationNotifications/{DelegateHeaderId}
Get all delegates' information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateInvitationNotifications

Delegate Notifications

The delegate notifications resource is used to view, create, delete or modify delegate information for the creation of a notification template.

Create a list of delegate information: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications
Delete a delegate's information: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications/{DelegateHeaderId}
Get a delegate's information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications/{DelegateHeaderId}
Get all delegate information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications
Update a delegate's information: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications/{DelegateHeaderId}

Delegates

The delegates resource is used to view, create, delete or modify delegate information for registered public users.

Create a set of delegate information: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates
Decline an invitation based on the given delegation ID: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}
Delete a delegate's information: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}
Get a delegate's information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}
Get all delegate information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates
Get the delegation privilege based on a given profile ID or Transaction ID: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates
Send an invitation based on the given delegation ID: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}
Update a delegate's information: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}

Delegates/Delegate Details

The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users.

Create a set of delegate detail information: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail
Delete a delegate's detail information: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail/{DelegateDetailId}
Get a delegate's detail information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail/{DelegateDetailId}
Get all delegate detail information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail
Update a delegate's detail information: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail/{DelegateDetailId}

Delegates/Delegate Histories

The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users.

Create a set of delegate history information: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory
Delete a delegate's history information: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory/{DelegateHistoryId}
Get a delegate's history information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory/{DelegateHistoryId}
Get all delegate history information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory
Update a delegate's history information: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory/{DelegateHistoryId}

Department Payment Options

The department payment options resource is used to view, create, delete, or modify, at the department level, the payment options used to process payments received. When a department wants to use its own process options that are different from the agency payment options, the administrator must configure department payment options.

Create a department payment option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsDepartments
Delete a department payment option: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsDepartments/{publicSectorPaymentOptionsDepartmentsUniqID}
Get a department payment option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsDepartments/{publicSectorPaymentOptionsDepartmentsUniqID}
Get all department payment options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsDepartments
Update a department payment option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsDepartments/{publicSectorPaymentOptionsDepartmentsUniqID}

Departments

The department resource is used to view, create, delete or modify a department. Department identifies the financial entity or management unit that is responsible for an accounting transaction.

Create a department: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDepartments
Delete a department: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDepartments/{publicSectorDepartmentsUniqID}
Get a department: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDepartments/{publicSectorDepartmentsUniqID}
Get all departments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDepartments
Update a department: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDepartments/{publicSectorDepartmentsUniqID}

Designer Layouts

The designer layouts resource stores application form designs for a specific record type. A record type can be a permit, license, and so on. This resource is primarily intended to be used by internal Oracle development teams.

Create a designer layout: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts
Delete a designer layout: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{LayoutId}
Get a designer layout: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{LayoutId}
Get all designer layouts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts
Update a designer layout: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{LayoutId}

Designer Layouts/Designer Layout Types

The designer layout types resource stores different layout types for specific record types. A record could be a permit or license. A layout type can be either a draft layout or a published layout. This resource is primarily intended to be used by internal Oracle development teams.

Create a designer layout type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{LayoutId}/child/PscCfgrLayoutTypes
Delete a designer layout type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{LayoutId}/child/PscCfgrLayoutTypes/{PscCfgrLayoutTypesUniqID}
Get a designer layout type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{LayoutId}/child/PscCfgrLayoutTypes/{PscCfgrLayoutTypesUniqID}
Get all designer layout types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{LayoutId}/child/PscCfgrLayoutTypes
Update a designer layout type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{LayoutId}/child/PscCfgrLayoutTypes/{PscCfgrLayoutTypesUniqID}

Digital Assistant Setups

The digital assistant setup resource is used to view, create, or modify a digital assistant setup.

Create a set of digital assistant setups: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups
Delete a digital assistant setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups/{AgencyId}
Get a digital assistant setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups/{AgencyId}
Get all digital assistant setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups
Update a digital assistant setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups/{AgencyId}

Display Group Lines with Related Record Types

The display group lines with related record types resource is used to view a display group line and its related record type information.

Delete multiple display group line cross records.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLinesCross
Get a display group line with its related record type information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLinesCross/{publicSectorDisplayGroupLinesCrossUniqID}
Get all display group lines and their related record type information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLinesCross

District Prompts

The district prompts resource is used to display districts and the associated district types. This resource is used as a prompt table.

Create a district: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistrictPrompts
Delete a district: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistrictPrompts/{DistrictId}
Get a district: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistrictPrompts/{DistrictId}
Get all districts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistrictPrompts
Update a district: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistrictPrompts/{DistrictId}

District Types

The district types resource is used to view, create, delete or modify district types. A district is an administrative region that, in some countries, is managed by local government. A district type is a classification of multiple districts into district groups having similar characteristics.

Create a district type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes
Delete a district type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes/{DistrictType}
Get a district type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes/{DistrictType}
Get all district types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes
Update a district type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes/{DistrictType}

Districts

The districts resource is used to view, create, delete or modify districts. A district is an administrative region that, in some countries, is managed by local government.

Create a district: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistricts
Delete a district: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistricts/{DistrictId}
Get a district: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistricts/{DistrictId}
Get all districts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistricts
Update a district: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDistricts/{DistrictId}

Divisions

The division resource is used to view, create, delete or modify a division. A division identifies an organizational sub-grouping within a department that is associated with an accounting transaction.

Create a division: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDivisions
Delete a division: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDivisions/{publicSectorDivisionsUniqID}
Get a division: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDivisions/{publicSectorDivisionsUniqID}
Get all divisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDivisions
Update a division: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDivisions/{publicSectorDivisionsUniqID}

Document Categories

Use the document categories resource to view, update, create, and delete document categories. A document category is used to specify a category for an uploaded attachment.

Create a document category: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories
Delete a document category: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}
Get a document category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}
Get all document categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories
Update a document category: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}

Document Categories/Document Subcategories

Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.

Create a document subcategory: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory
Delete a document subcategory: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory/{DocumentSubcategoryUniqID}
Get a document subcategory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory/{DocumentSubcategoryUniqID}
Get all document subcategories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory
Update a document subcategory: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory/{DocumentSubcategoryUniqID}

Document Group Categories

Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.

Create a document group category: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategories
Delete a document group category: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategories/{publicSectorDocumentGroupCategoriesUniqID}
Get a document group category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategories/{publicSectorDocumentGroupCategoriesUniqID}
Get all document group categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategories
Update a document group category: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategories/{publicSectorDocumentGroupCategoriesUniqID}

Document Group Category Prompts

Use the document group category prompts resource to view document categories that are assigned to a document group. A document group category prompt is used to specify a category within a specific document group for an uploaded attachment.

Get a document group category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategoryPrompts/{publicSectorDocumentGroupCategoryPromptsUniqID}
Get all document group categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategoryPrompts

Document Groups

Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.

Create a document group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups
Delete a document group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}
Get a document group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}
Get all document groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups
Update a document group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}

Document Groups/Document Group Categories

Create a document group category: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory
Delete a document group category: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory/{DocumentGroupCategoryUniqID}
Get a document group category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory/{DocumentGroupCategoryUniqID}
Get all document group categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory
Update a document group category: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory/{DocumentGroupCategoryUniqID}

Document Subcategories

Use document subcategories to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.

Create a document subcategory: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories
Delete a document subcategory: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories/{publicSectorDocumentSubcategoriesUniqID}
Get a document subcategory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories/{publicSectorDocumentSubcategoriesUniqID}
Get all document subcategories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories
Update a document subcategory: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories/{publicSectorDocumentSubcategoriesUniqID}

Due Date Types

The due date types resource is used to configure the types of due dates that are used by Code Enforcement for Public Sector Compliance and Regulation.

Create a set of due date type definitions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementDueDateTypes
Delete a due date type definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementDueDateTypes/{publicSectorCodeEnforcementDueDateTypesUniqID}
Get a due date type definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementDueDateTypes/{publicSectorCodeEnforcementDueDateTypesUniqID}
Get all due date type definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementDueDateTypes
Update a due date type definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementDueDateTypes/{publicSectorCodeEnforcementDueDateTypesUniqID}

Employees

The employees resource is used to list the attributes of the agency staff.

Create a set of agency staff: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees
Get all agency staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees
Get an agency staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}
Update an agency staff: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}

Employees/Person Job Functions

The person job functions resource is used to view the list of job functions that are assigned to a person.

Create a set of job functions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions
Delete a job function: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}
Get a job function: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}
Get all job functions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions
Update a job function: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}

Employees/Person Job Functions/Person Job Attributes

The person job attributes resource is used to list the job attributes and their values assigned to a person.

Create a set of job attributes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}/child/PersonJobFuncAssignments
Delete a job attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}
Get a job attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}
Get all job attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}/child/PersonJobFuncAssignments
Update a job attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}

Entities

The entities resource is used to view entities that belong to an entity model. An entity represents a View object that exists in the application schema. The entity contains information about how the View object is referred to and is used in the Oracle Policy Modeling tool.

Create a set of entities: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities
Delete an entity: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}
Get all entities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities
Get an entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}
Update an entity: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}

Entities/Entity Attributes

The entity attributes resource is used to view attributes that belong to an entity. The entity attribute represents the attribute of a View object that exists in the application schema. The entity attribute contains information about how the View object attribute is referred to and is used in the Oracle Policy Modeling tool.

Create a set of entity attributes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}/child/EntityAttributeService
Delete an entity attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}/child/EntityAttributeService/{EntityAttributeServiceUniqID}
Get all entity attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}/child/EntityAttributeService
Get an entity attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}/child/EntityAttributeService/{EntityAttributeServiceUniqID}
Update an entity attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}/child/EntityAttributeService/{EntityAttributeServiceUniqID}

Entity Attributes

The entity attributes resource is used to view attributes that belong to an entity. The entity attribute represents the attribute of a View object present in the application schema. The attribute also contains information about how the View object attribute is referred to and used in the Oracle Policy Modeling tool.

Create a set of entity attributes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes
Delete an entity attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes/{publicSectorOpaEntityAttributesUniqID}
Get all entity attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes
Get an entity attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes/{publicSectorOpaEntityAttributesUniqID}
Update an entity attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes/{publicSectorOpaEntityAttributesUniqID}

Entity Models

The entity models resource is used to view all the entity models that exist in the Oracle Policy Automation configuration schema. The entity model represents an aggregation of one or more entities and their attributes that are used in the Oracle Policy Modeling tool.

Create a set of entity models: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels
Delete an entity model: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}
Get all entity models: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels
Get an entity model: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}
Update an entity model: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}

Entity Models/Entities

The entities resource is used to view entities that belong to an entity model. The entity represents a View object present in the application schema. The entity also contains information about how the View object is referred to and used in the Oracle Policy Modeling tool.

Create a set of entities: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService
Delete an entity: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService/{EntityServiceUniqID}
Get all entities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService
Get an entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService/{EntityServiceUniqID}
Update an entity: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService/{EntityServiceUniqID}

Enumeration Child Values

The enumeration child values resource is used to view all the child enumerations for a given enumeration. Enumerations can have multiple levels of values.

Create a set of enumeration child values: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumChildValues
Delete an enumeration child value: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumChildValues/{publicSectorOpaEnumChildValuesUniqID}
Get all enumeration child values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumChildValues
Get an enumeration child value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumChildValues/{publicSectorOpaEnumChildValuesUniqID}
Update an enumeration child value: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumChildValues/{publicSectorOpaEnumChildValuesUniqID}

Enumeration Values

The enumeration values resource is used to view all the values for a particular enumeration name.

Create a set of enumeration values: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues
Delete an enumeration value: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}
Get all enumeration values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues
Get an enumeration value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}
Update an enumeration value: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}

Enumeration Values/Enumeration Child Values

The enumeration child values resource is used to view all the child enumerations of an enumeration name. An enumeration can have multiple levels of values.

Create a set of enumeration child values: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}/child/EnumChildValueAccessor
Delete an enumeration child value: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}/child/EnumChildValueAccessor/{EnumChildValueAccessorUniqID}
Get all enumeration child values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}/child/EnumChildValueAccessor
Get an enumeration child value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}/child/EnumChildValueAccessor/{EnumChildValueAccessorUniqID}
Update an enumeration child value: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}/child/EnumChildValueAccessor/{EnumChildValueAccessorUniqID}

Enumerations

The enumerations resource is used to view all the enumeration names that are present in the Oracle Policy Automation configuration schema. An enumeration can have a single or multiple levels of values.

Create a set of enumerations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations
Delete an enumeration: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}
Get all enumerations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations
Get an enumeration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}
Update an enumeration: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}

Enumerations/Enumeration Values

The enumeration values resource is used to view the values associated to a particular enumeration name.

Create a set of enumeration values: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService
Delete an enumeration value: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService/{EnumValueServiceUniqID}
Get all enumeration values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService
Get an enumeration value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService/{EnumValueServiceUniqID}
Update an enumeration value: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService/{EnumValueServiceUniqID}

Event Transaction Line Errors

The event transaction line errors resource is used to view accounting transaction errors.

Get all accounting transaction errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEventTransactionLineErrors
Get an accounting transaction error: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEventTransactionLineErrors/{publicSectorEventTransactionLineErrorsUniqID}

Event Transaction Lines

The event transaction lines resource is used to view and create accounting transactions. These transactions are selected by the accounting generator to create accounting journal entries.

Get all accounting transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEventTransactionLines
Get an accounting transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorEventTransactionLines/{EventLineId}

Expiration Groups

The expiration group resource is used to create, update, or remove an expiration group.

Create an expiration group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups
Delete an expiration group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}
Get all expiration groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups
Get an expiration group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}
Update an expiration group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}

Expiration Groups Keys

The expiration groups key resource is used to get a unique value by using a combination of the expiration group ID and the name of the expiration group.

Get all expiration group keys: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroupsKeys
Get an expiration group key: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroupsKeys/{publicSectorExpirationGroupsKeysUniqID}

Expiration Groups Totals

The expiration groups total resource is used to list all the expiration groups.

Get all expiration groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroupsTotals
Get an expiration group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroupsTotals/{publicSectorExpirationGroupsTotalsUniqID}

Expiration Groups/Expiration Rules

The expiration rule resource is used to create, update, or remove expiration rules from an expiration group.

Create a set of expiration rules in an expiration group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}/child/ExpirationRuleD
Delete an expiration rule from an expiration group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}/child/ExpirationRuleD/{ExpirationRuleDUniqID}
Get all expiration rules from an expiration group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}/child/ExpirationRuleD
Get an expiration rule from an expiration group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}/child/ExpirationRuleD/{ExpirationRuleDUniqID}
Update an expiration rule in an expiration group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}/child/ExpirationRuleD/{ExpirationRuleDUniqID}

Expiration Rules

The expiration rules resource is used to create, update, or remove expiration rules from an expiration group.

Create a set of expiration rules in an expiration group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules
Delete an expiration rule from an expiration group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules/{publicSectorExpirationRulesUniqID}
Get all expiration rules from an expiration group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules
Get an expiration rule from an expiration group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules/{publicSectorExpirationRulesUniqID}
Update an expiration rule in an expiration group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules/{publicSectorExpirationRulesUniqID}

Explore Applications

The Explore Applications resource is used to search for and view parcel and address details for permits, planning applications, and business licenses that appear on a map.

Get a permit, planning application, or business license parcel address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExploreCityPermits/{LnpRecordKey}
Get all permit, planning application, and business license parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorExploreCityPermits

Favorite Comments

The favorite comment resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.

Create a favorite comment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments
Delete a favorite comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments/{publicSectorFavoriteCommentsUniqID}
Get a favorite comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments/{publicSectorFavoriteCommentsUniqID}
Get all favorite comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments
Update a favorite comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments/{publicSectorFavoriteCommentsUniqID}

Fee Communications

The fee communications resource is used to view fee record information when a fee communication event is requested.

Get a fee record for a fee communication event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeCommunications/{publicSectorFeeCommunicationsUniqID}
Get all fee records for a fee communication event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeCommunications

Fee Items

The fee item resource is used to view, create, delete, or modify fee items. A fee item is set up by an agency to define fees that are assessed during application processing.

Create a fee item: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeItems
Delete a fee item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeItems/{publicSectorFeeItemsUniqID}
Get a fee item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeItems/{publicSectorFeeItemsUniqID}
Get all fee items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeItems
Update a fee item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeItems/{publicSectorFeeItemsUniqID}

Fee Line Maps

The fee line maps resource is used to view, create, delete, or modify fee line mapping design. Fee line mappings are used to map application fields defined in Public Sector Compliance and Regulation with the fields defined in Oracle Autonomous Integration Cloud decision models. The field mapping is used for fee calculation.

Create a set of fee line mappings: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps
Delete a fee line mapping: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps/{publicSectorFeeLineMapsUniqID}
Get a fee line mapping: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps/{publicSectorFeeLineMapsUniqID}
Get all fee line mappings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps
Update a fee line mapping: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps/{publicSectorFeeLineMapsUniqID}

Fee Line Models

The fee line models resource is used to view the permit type, fee schedule, and fee line-related information for fee line mappings. It will retrieve the fee schedule that is for the current date.

Get a fee line decision model.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLineModels/{publicSectorFeeLineModelsUniqID}
Get all fee line decision models.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLineModels

Fee Lines

The fee lines resource is used to view, create, delete, or modify fee lines. Fee lines are used to define which fee decision model is used for the current fee schedule.

Copies the fee line requests.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLines
Copies the fee line requests.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLines
Create a fee line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLines
Delete a fee line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLines/{publicSectorFeeLinesUniqID}
Get a fee line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLines/{publicSectorFeeLinesUniqID}
Get all fee lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLines
Update a fee line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeLines/{publicSectorFeeLinesUniqID}

Fee Records

The fee records resource is used to view, create, or modify a fee item record. A fee record is used during for applicant to know how much he/she needs to pay during application process.

Calculate fees by intake form: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords
Confirm payment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords
Create a fee record: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords
Delete a fee record: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/{FeeRecordKey}
Get a fee record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/{FeeRecordKey}
Get all fee records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords
Perform the payment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords
Update a fee record: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/{FeeRecordKey}

Fee Records with Descriptions

The fee record with descriptions resource is used to view fee records displayed with the fee and department descriptions.

Delete multiple fee records: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayFeeRecords
Get a fee record with fee and department descriptions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayFeeRecords/{FeeRecordKey}
Get all fee records with fee and department descriptions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayFeeRecords

Fee Refunds

The fee refund resource is used to view, create, or modify a fee refund record. A fee refund record is used by an applicant to know the refund amount they will receive when they cancel their application.

Create a set of fee refund records: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds
Delete a fee refund record: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/{FeeRecordKey}
Get a fee refund record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/{FeeRecordKey}
Get all fee refund records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds
Initiates confirmation for refunding the fee items.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds
Initiates refund processing for the fee items.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds
Update a fee refund record: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/{FeeRecordKey}

Fee Schedule Effective Dates

The fee schedule effective dates resource is used to get all fee schedules for effective date functionality.

Get a fee schedule by effective date: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedulesTotals/{publicSectorFeeSchedulesTotalsUniqID}
Get all fee schedules by effective date: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedulesTotals

Fee Schedule Keys

The fee schedule keys resource is used to display the latest fee schedule using effective date functionality in the table view.

Delete multiple fee schedules: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedulesKeys
Get a fee schedule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedulesKeys/{publicSectorFeeSchedulesKeysUniqID}
Get all fee schedules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedulesKeys

Fee Schedule Maps

The fee schedule map resource is used to create, update, or delete fee schedule maps.

Create a set of fee schedule maps: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeScheduleMaps
Delete a fee schedule map: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeScheduleMaps/{publicSectorFeeScheduleMapsUniqID}
Get a fee schedule map: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeScheduleMaps/{publicSectorFeeScheduleMapsUniqID}
Get all fee schedule maps: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeScheduleMaps
Update a fee schedule map: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeScheduleMaps/{publicSectorFeeScheduleMapsUniqID}

Fee Schedules

The fee schedules resource is used to view, create, delete, or modify fee schedules. A fee schedule is used to define how the fees are calculated based on decision models defined in Oracle Autonomous Integration Cloud (OIC). For a given fee schedule, there may be one or more fee lines.

Create a fee schedule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules
Delete a fee schedule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}
Get a fee schedule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}
Get all fee schedules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules
Update a fee schedule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}

Fee Schedules/Fee Lines

The fee lines resource is used to view, create, delete, or modify fee lines. A fee line is used to define which decision model in OIC is used for the current fee schedule.

Copies the fee line information.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine
Copies the fee line information.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine
Create a fee line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine
Delete a fee line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}
Get a fee line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}
Get all fee lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine
Update a fee line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}

Fee Schedules/Fee Lines/Fee Schedule Map Data

The fee schedule map data resource is used to view, create, delete, or modify the data. The fee mapping is to store the mapping data and to calculate the DMN fee outside of the form design.

Create a set of fee schedule maps: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD
Delete a fee schedule map: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD/{FeeScheduleMapDUniqID}
Get a fee schedule map: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD/{FeeScheduleMapDUniqID}
Get all fee schedule maps: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD
Update a fee schedule map: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD/{FeeScheduleMapDUniqID}

Functions

The function resource is used to view, create, delete or modify a function. A function identifies the public service for which an agency is responsible associated with an accounting transaction.

Create a function: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFunctions
Delete a function: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFunctions/{publicSectorFunctionsUniqID}
Get a function: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFunctions/{publicSectorFunctionsUniqID}
Get all functions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFunctions
Update a function: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFunctions/{publicSectorFunctionsUniqID}

Funds

The fund resource is used to view, create, delete or modify a fund. Fund identifies the source or target of funding for an accounting transaction.

Create a fund: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFunds
Delete a fund: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFunds/{publicSectorFundsUniqID}
Get a fund: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFunds/{publicSectorFundsUniqID}
Get all funds: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFunds
Update a fund: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFunds/{publicSectorFundsUniqID}

Fusion Ledgers

The Fusion ledger resource is used to view a list of ledgers defined in the Fusion system through which PSCR sends its accounting entries.

Get a Fusion ledger: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFusionLedgers/{LedgerId}
Get all Fusion ledgers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorFusionLedgers

GIS Attribute Mappings

Use the GIS attribute mappings resource to view, update, create, and delete GIS attribute mappings. A GIS attribute mapping is used to specify information about your map service layers, including parcel, address, and owner layers.

Create an attribute mapping: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoMappings
Delete a GIS attribute mapping: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoMappings/{AgencyId}
Get a GIS attribute mapping: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoMappings/{AgencyId}
Get all GIS attribute mappings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoMappings
Update a GIS attribute mapping: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorApoMappings/{AgencyId}

Gateway Configs

The gateway configs resource is used to view, create, delete or modify payment gateway configurations. Payment gateway configuration includes determining the configuration name and description.

Create a payment gateway configuration: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs
Delete a payment gateway configuration: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs/{publicSectorGatewayConfigsUniqID}
Get a payment gateway configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs/{publicSectorGatewayConfigsUniqID}
Get all payment gateway configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs
Update a payment gateway configuration: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs/{publicSectorGatewayConfigsUniqID}

Gateway Name Pros

The gateway name pros resource is used to view the names of available payment gateways in the application.

Create a payment gateway name: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGatewayNamePros
Delete a payment gateway name: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGatewayNamePros/{GatewayName}
Get a payment gateway name: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGatewayNamePros/{GatewayName}
Get all payment gateway names: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGatewayNamePros
Update a payment gateway name: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGatewayNamePros/{GatewayName}

Gateways

The gateway resource is used to view, create, delete or modify payment gateways. Setup of payment gateways includes entering the product ID, product description, product version, test URL, and production URL, and enabling or disabling the gateway.

Create a payment gateway: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGateways
Delete a payment gateway: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGateways/{publicSectorGatewaysUniqID}
Get a payment gateway: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGateways/{publicSectorGatewaysUniqID}
Get all payment gateways: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGateways
Update a payment gateway: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorGateways/{publicSectorGatewaysUniqID}

Hearing Appeal Attachments

The hearing appeal attachments resource is used to view or create hearing appeal attachments. Hearing appeal attachments are documents used in planning and zoning applications.

Create a set of hearing appeal attachments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments
Delete a hearing appeal attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}
Get a hearing appeal attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}
Get all hearing appeal attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments
Update a hearing appeal attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}

Hearing Appeal Attachments/Appeal Attachments

The appeal attachments resource is used to view, create, and update attachments.

Create a set of appeal attachments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor
Delete an appeal attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{AttachedDocumentId}
Get all appeal attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor
Get an appeal attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{AttachedDocumentId}
Update an appeal attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{AttachedDocumentId}

Hearing Appeal Attachments/Appeal Attachments/Appeal Attachment Revisions

The appeal attachment revision resource is used to view revisions versions of the appeal attachment.

Create a set of appeal attachment revisions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete an appeal attachment revision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all appeal attachment revisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Get an appeal attachment revision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Update an appeal attachment revision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Hearing Appeals

The hearing appeals resource is used to view or create hearing appeals. Hearing appeals are used when appealing a hearing related to planning and zoning applications.

Create a set of hearing appeals: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals
Delete a hearing appeal: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals/{HearingAppealKey}
Get a hearing appeal: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals/{HearingAppealKey}
Get all hearing appeals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals
Update a hearing appeal: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals/{HearingAppealKey}

Hearing Applications

The hearing applications resource is used to view a planning and zoning application that requires hearing.

Get a hearing application: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingApplications/{publicSectorHearingApplicationsUniqID}
Get all hearing applications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingApplications

Hearing Bodies

The hearing body resource is used to view, create, or modify a hearing body. In the Planning and Zoning process, a hearing body is a group of individuals formed to evaluate the testimony presented by applicants and to provide their feedback.

Create a set of hearing bodies: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies
Delete a hearing body: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}
Get a hearing body: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}
Get all hearing bodies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies
Update a hearing body: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}

Hearing Bodies/Hearing Body Day Recurrences

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

Create a set of hearing body day recurrences: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/DayRecurrences
Delete a hearing body day recurrence: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/DayRecurrences/{DayRecurrencesUniqID}
Get a hearing body day recurrence: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/DayRecurrences/{DayRecurrencesUniqID}
Get all hearing body day recurrences: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/DayRecurrences
Update a hearing body day recurrence: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/DayRecurrences/{DayRecurrencesUniqID}

Hearing Bodies/Hearing Body Week Recurrences

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

Create a set of hearing body week recurrences: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences
Delete a hearing body week recurrence: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences/{WeekRecurrencesUniqID}
Get a hearing body week recurrence: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences/{WeekRecurrencesUniqID}
Get all hearing body week recurrences: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences
Update a hearing body week recurrence: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences/{WeekRecurrencesUniqID}

Hearing Body Day Recurrences

The hearing body day recurrence resource is used to view, create, or modify a hearing body meeting day recurrence. You can define daily recurrences of hearing body meetings.

Create a set of hearing body day recurrences: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyDayRecurrences
Delete a hearing body day recurrence: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyDayRecurrences/{publicSectorHearingBodyDayRecurrencesUniqID}
Get a hearing body day recurrence: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyDayRecurrences/{publicSectorHearingBodyDayRecurrencesUniqID}
Get all hearing body day recurrences: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyDayRecurrences
Update a hearing body day recurrence: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyDayRecurrences/{publicSectorHearingBodyDayRecurrencesUniqID}

Hearing Body Week Recurrences

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

Create a set of hearing body week recurrences: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyWeekRecurrences
Delete a hearing body week recurrence: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyWeekRecurrences/{publicSectorHearingBodyWeekRecurrencesUniqID}
Get a hearing body week recurrence: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyWeekRecurrences/{publicSectorHearingBodyWeekRecurrencesUniqID}
Get all hearing body week recurrences: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyWeekRecurrences
Update a hearing body week recurrence: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyWeekRecurrences/{publicSectorHearingBodyWeekRecurrencesUniqID}

Hearing Decisions

The hearing decision resource is used to view, create, or modify a hearing decision. Hearing decision refers to the outcome of the hearing for a zoning application.

Create a set of hearing body day decisions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingDecisions
Delete a hearing body day decision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingDecisions/{publicSectorHearingDecisionsUniqID}
Get a hearing body day decision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingDecisions/{publicSectorHearingDecisionsUniqID}
Get all hearing body day decisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingDecisions
Update a hearing body day decision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingDecisions/{publicSectorHearingDecisionsUniqID}

Hearing Events

The hearing event resource is used to view, create, or modify hearing event. Hearing events are used in the hearing process.

Create a set of hearing events: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingEvents
Get a hearing event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingEvents/{HearingEventKey}
Get all hearing events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingEvents
Update a hearing event: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingEvents/{HearingEventKey}

Hearing Hierarchies

The hearing hierarchy resource is used to view, create, or modify a hearing hierarchy. Hearing hierarchy defines the levels of escalation among hearing bodies.

Create a set of hearing hierarchy: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies
Delete a hearing hierarchy: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}
Get a hearing hierarchy: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}
Get all hearing hierarchies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies
Update a hearing hierarchy: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}

Hearing Hierarchies/Hearing Hierarchy Bodies

The hearing hierarchy body resource is used to view, create, or modify a hearing body in a hearing hierarchy.

Create a set of hearing hierarchy bodies: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/Bodies
Delete a hearing hierarchy body: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/Bodies/{BodiesUniqID}
Get a hearing hierarchy body: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/Bodies/{BodiesUniqID}
Get all hearing hierarchy bodies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/Bodies
Update a hearing hierarchy body: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/Bodies/{BodiesUniqID}

Hearing Hierarchy Bodies

The hearing hierarchy body resource is used to view, create, or modify a hearing hierarchy body. You can define a sequence of hearing bodies in a hearing hierarchy.

Create a set of hearing hierarchy bodies: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchyBodies
Delete a hearing hierarchy body: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchyBodies/{publicSectorHearingHierarchyBodiesUniqID}
Get a hearing hierarchy body: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchyBodies/{publicSectorHearingHierarchyBodiesUniqID}
Get all hearing hierarchy bodies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchyBodies
Update a hearing hierarchy body: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchyBodies/{publicSectorHearingHierarchyBodiesUniqID}

Hearing Notifications

The hearing notification resource is used to view the information that can be sent as a hearing notification. Hearing Notifications are used to notify users about Public Hearings.

Get a hearing notification: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingNotifications/{publicSectorHearingNotificationsUniqID}
Get all hearing notifications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingNotifications

Hearing Sequences

The hearing sequences resource is used to view or create a hearing sequence. Hearing sequence lists the sequence of hearing bodies that is to be followed in a hearing hierarchy.

Create a set of hearing sequences: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingSequences
Get a hearing sequence: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingSequences/{publicSectorHearingSequencesUniqID}
Get all hearing sequences: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearingSequences

Hearings

The hearings resource is used to view or create hearings. Hearings are used in planning and zoning applications.

Create a set of hearings: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearings
Get a hearing: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearings/{publicSectorHearingsUniqID}
Get all hearings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHearings

Help Setups

The help setups resource is used to retreive setup parameters needed to configure the Help Center. The setup parameters include the Oracle Help Center (OHC) domain and Library Context.

Create a help setup: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHelpSetups
Delete a help setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHelpSetups/{AgencyId}
Get a help setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHelpSetups/{AgencyId}
Get all help setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHelpSetups
Update a help setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHelpSetups/{AgencyId}

Holiday Calendar Date Validations

The holiday calendar date validations resource is an internal utility service used to validate holiday calendar dates. The holiday calendars resource is used to view, create, or modify a holiday calendar. A holiday calendar is used to establish the days that agency offices are closed and no field service operations are offered.

Create a holiday calendar: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendarDateValidations
Delete a holiday calendar: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendarDateValidations/{publicSectorHolidayCalendarDateValidationsUniqID}
Get a holiday calendar: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendarDateValidations/{publicSectorHolidayCalendarDateValidationsUniqID}
Get all holiday calendars: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendarDateValidations
Update a holiday calendar: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendarDateValidations/{publicSectorHolidayCalendarDateValidationsUniqID}

Holiday Calendar Events

The holiday calendar events resource is used to view, create, or modify holiday calendar events.

Create a set of holiday calendar events: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidCalEvents
Delete a holiday calendar event: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidCalEvents/{publicSectorHolidCalEventsUniqID}
Get a holiday calendar event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidCalEvents/{publicSectorHolidCalEventsUniqID}
Get a set of holiday calendar events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidCalEvents
Update a holiday calendar event: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidCalEvents/{publicSectorHolidCalEventsUniqID}

Holiday Calendars

The holiday calendars resource is used to view, create, or modify a holiday calendar. A holiday calendar is used to establish the days that agency offices are closed and no field service operations are offered.

Create a holiday calendar: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars
Delete a holiday calendar: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}
Get a holiday calendar: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}
Get all holiday calendars: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars
Update a holiday calendar: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}

Holiday Calendars and Events

The holiday calendar and events resource is used to list all calendars and their associated events. The parent-child relationship allows fast access to a calendar and its events.

Create a set of holiday calendar events: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails
Delete a holiday calendar event: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails/{publicSectorCalWithDetailsUniqID}
Delete the holiday calendar event.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails
Get a holiday calendar event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails/{publicSectorCalWithDetailsUniqID}
Get a set of holiday calendar events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails
Update a holiday calendar event: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails/{publicSectorCalWithDetailsUniqID}

Holiday Calendars/Holiday Calendar Events

The holiday calendar events resource is used to view, create, or modify holiday calendar events.

Create a set of holiday calendar events: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail
Delete a set of holiday calendar events: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail/{HolidayCalendarDetailUniqID}
Get a set of holiday calendar events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail/{HolidayCalendarDetailUniqID}
Get all holiday calendar events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail
Update a set of holiday calendar events: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail/{HolidayCalendarDetailUniqID}

IVR Inspection Group Lines

The IVR inspection group lines resource is used to return all inspection types for a given inspection group.

Get all IVR inspection groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRInspectionGroupLines
Get an IVR inspection group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRInspectionGroupLines/{publicSectorIVRInspectionGroupLinesUniqID}

IVR Inspections

The IVR inspections resource is used to capture all permit inspections and display the inspection information to the user, including inspection type, inspection ID, scheduling time, and the user who created the inspection.

Create an IVR inspection: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections
Delete an IVR inspection: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections/{InspectionId}
Get all IVR inspections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections
Get an IVR inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections/{InspectionId}
Update an IVR Inspection: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections/{InspectionId}

IVR Permit Conditions

The IVR permit conditions resource is used to view conditions applied to a permit and permit information including permit type, permit ID, and applicant profile ID.

Get all IVR permit conditions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordConditions
Get an IVR permit condition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordConditions/{ConditionKey}

IVR Record Lists

The IVR record lists resource is used to return all application records and display the application information to the user, including application type, application ID, property and parcel information, and fees and payments.

Get all IVR records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordLists
Get an IVR record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordLists/{LnpRecordKey}

IVR Record Types

The IVR record types resource is used to view a record type. A record type establishes the types of applications supported by an agency.

Get all IVR record types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordTypes
Get an IVR record type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordTypes/{RecordTypeId}

Incident Comments

The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.

Create a comment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments
Delete a comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments/{CommentKey}
Get a comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments/{CommentKey}
Get all comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments
Update a comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments/{CommentKey}

Incident Status Histories

Use the incident status histories resource to view status change histories for incidents.

Get all incident status history records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncStatusHistories
Get an incident status history record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIncStatusHistories/{publicSectorIncStatusHistoriesUniqID}

Incident Status Histories for Public Users

Use the incident status histories for public users resource to view incident status change information that is visible to registered public users.

Get all status history records of an incident: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegIncStatusHistories
Get an incident status history record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegIncStatusHistories/{publicSectorRegIncStatusHistoriesUniqID}

Inconsistent Instances

The inconsistent instances resource is used to retrieve all the workflow instances and transactions so that incomplete transactions and synchronization issues can be identified.

Get all inconsistent instances: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOutOfSyncInstances
Get an inconsistent instance: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOutOfSyncInstances/{publicSectorOutOfSyncInstancesUniqID}

Inspection Attachments

The inspection attachments resource is used to view, create, modify, or delete an inspection attachment.

Create an inspection attachment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments
Delete an inspection attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}
Get all inspection attachment records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments
Get an inspection attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}
Update an inspection attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}

Inspection Attachments/Attachment Accessors

The inspection attachment accessors resource is used to view the accessors that are associated with the attachment.

Create an inspection attachment accessor: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor
Delete an inspection attachment accessor: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{AttachedDocumentId}
Get all inspection attachment accessor records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor
Get an inspection attachment accessor: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{AttachedDocumentId}
Update an inspection attachment accessor: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{AttachedDocumentId}

Inspection Attachments/Attachment Accessors/Attachment Revisions

The attachment revision resource is used to view the revisions that are associated with the accessor.

Create an attachment revision: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete an attachment revision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all attachment revision records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Get an attachment revision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Update an attachment revision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Inspection Calendars

The Inspection Calendars resource is used to view, create, or modify an inspection calendar. An inspection calendar is used to define the hours and days of the week that inspectors can be assigned for a given inspection type and district.

Create an inspection calendar: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars
Delete an inspection calendar: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars/{publicSectorInspectionCalendarsUniqID}
Get all inspection calendars: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars
Get an inspection calendar: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars/{publicSectorInspectionCalendarsUniqID}
Update an inspection calendar: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars/{publicSectorInspectionCalendarsUniqID}

Inspection Checklist Categories

The inspection checklist category resource is used to view, create, delete, or modify an inspection checklist category. A checklist category is used to organize inspection checklist items into various categories.

Create a checklist category: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories
Delete a checklist category: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}
Get a checklist category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}
Get all checklist categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories
Update a checklist category: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}

Inspection Checklist Categories/Inspection Checklist Subcategories

The inspection checklist subcategory resource is used to view, create, delete, or modify an inspection checklist subcategory. A checklist subcategory is used to further organize inspection checklist items into various subcategories within a category.

Create a checklist subcategory: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}/child/ChecklistSubcategory
Delete a checklist subcategory: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}/child/ChecklistSubcategory/{ChecklistSubcategoryUniqID}
Get a checklist subcategory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}/child/ChecklistSubcategory/{ChecklistSubcategoryUniqID}
Get all checklist subcategories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}/child/ChecklistSubcategory
Update a checklist subcategory: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}/child/ChecklistSubcategory/{ChecklistSubcategoryUniqID}

Inspection Checklist Counts

The inspection checklist counts resource is used to capture checklist count information and display it to the user, including inspection ID, total number of checklists in an inspection, and total number of inspection checklists with results.

Get all inspection checklists with count information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListCounts
Get an inspection checklist with count information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListCounts/{InspectionId}

Inspection Checklist Details

The inspection checklist details resource is used to capture inspection checklists with checklist item count information and display them to the user, including inspection ID, checklist ID, checklist name, checklist score, checklist result description, the number of checklist items, and so on.

Get all inspection checklists with details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListDetails
Get an inspection checklist with details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListDetails/{publicSectorInspectionChkListDetailsUniqID}

Inspection Checklist Group Lines

The inspection checklist group line resource is used to view, create, delete or modify an inspection checklist group line. A checklist group line identifies the individual checklists associated with a checklist group.

Create a checklist group line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLines
Delete a checklist group line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLines/{publicSectorChecklistGroupLinesUniqID}
Get a checklist group line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLines/{publicSectorChecklistGroupLinesUniqID}
Get all checklist group lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLines
Update a checklist group line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLines/{publicSectorChecklistGroupLinesUniqID}

Inspection Checklist Group Lines with Descriptions

The inspection checklist group lines with descriptions resource is used to view checklist group lines along with the associated checklist descriptions. A checklist group line identifies the individual checklists associated with a checklist group, and the description of the line comes from the checklist definition.

Bulk delete multiple checklist group lines.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLinesCross
Get a checklist group line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLinesCross/{publicSectorChecklistGroupLinesCrossUniqID}
Get all checklist group lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLinesCross

Inspection Checklist Groups

The inspection checklist group resource is used to view, create, delete or modify an inspection checklist group. An inspection checklist group identifies a set of checklists that can be associated to an inspection type. The group contains one or more checklist lines.

Create an inspection checklist group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups
Delete an inspection checklist group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}
Get all inspection checklist groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups
Get an inspection checklist group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}
Update an inspection checklist group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}

Inspection Checklist Groups/Inspection Checklist Group Lines

The inspection checklist group line resource is used to view, create, delete or modify an inspection checklist group line. A checklist group line identifies an individual checklist that is associated with a checklist group.

Create an inspection checklist group line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}/child/ChecklistGroupLine
Delete an inspection checklist group line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}/child/ChecklistGroupLine/{ChecklistGroupLineUniqID}
Get all inspection checklist group lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}/child/ChecklistGroupLine
Get an inspection checklist group line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}/child/ChecklistGroupLine/{ChecklistGroupLineUniqID}
Update an inspection checklist group line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}/child/ChecklistGroupLine/{ChecklistGroupLineUniqID}

Inspection Checklist Item Details

The inspection checklist item resource is used to view all inspection checklist items, including inspection ID, checklist ID, checklist item ID, checklist item name, checklist item score, checklist item result, and so on.

Get all inspection checklist items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItemDetails
Get an inspection checklist item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItemDetails/{publicSectorInspectionChkListItemDetailsUniqID}

Inspection Checklist Items

The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.

Create a checklist item: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems
Delete a checklist item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}
Get a checklist item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}
Get all checklist items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems
Get all inspection checklist items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItems
Get an inspection checklist item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItems/{publicSectorInspectionChkListItemsUniqID}
Update a checklist item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}
Update an inspection checklist item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItems/{publicSectorInspectionChkListItemsUniqID}

Inspection Checklist Items/Inspection Checklist Instructions

The instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item.

Create a checklist item's instructions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}/child/Instruction
Delete a checklist item's instructions: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}/child/Instruction/{InstructionUniqID}
Get a checklist item's instructions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}/child/Instruction/{InstructionUniqID}
Get all checklist items' instructions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}/child/Instruction
Update a checklist item's instructions: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}/child/Instruction/{InstructionUniqID}

Inspection Checklist Result Codes

The inspection checklist result codes resource is used to view the inspection checklist result codes. The inspection checklist result codes specify all of the assessment codes that are associated with a checklist.

Get a checklist result code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistResultCodes/{publicSectorInspectionChecklistResultCodesUniqID}
Get all checklist result codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistResultCodes

Inspection Checklist Subcategories

Create a checklist subcategory: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistSubcategories
Delete a checklist subcategory: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistSubcategories/{publicSectorChecklistSubcategoriesUniqID}
Get a checklist subcategory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistSubcategories/{publicSectorChecklistSubcategoriesUniqID}
Get all checklist subcategories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistSubcategories
Update a checklist subcategory: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorChecklistSubcategories/{publicSectorChecklistSubcategoriesUniqID}

Inspection Checklists

The inspection checklists resource is used to capture all inspection checklists and display the checklist information to the user, including inspection ID, checklist ID, checklist name, checklist score, and so on.

Create a checklist: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists
Delete a checklist: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}
Get a checklist: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}
Get all checklists: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists
Get all inspection checklists: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkLists
Get an inspection checklist: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkLists/{publicSectorInspectionChkListsUniqID}
Update a checklist: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}
Update an inspection checklist: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkLists/{publicSectorInspectionChkListsUniqID}

Inspection Checklists/Inspection Checklist Items

Create a checklist item: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem
Delete a checklist item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}
Get a checklist item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}
Get all checklist items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem
Update a checklist item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}

Inspection Checklists/Inspection Checklist Items/Inspection Checklist Instructions

The instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item.

Create a checklist item's instructions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}/child/Instruction
Delete a checklist item's instructions: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}/child/Instruction/{InstructionUniqID}
Get a checklist item's instructions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}/child/Instruction/{InstructionUniqID}
Get all checklist items' instructions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}/child/Instruction
Update a checklist item's instructions: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}/child/Instruction/{InstructionUniqID}

Inspection Comments

The inspection comments resource is used to capture all inspection-related comments and display the comments to users, including comment type, comment text message, the user who created the comment, and so on.

Create an inspection comment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments
Delete an inspection comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments/{publicSectorInspectionCommentsUniqID}
Get all inspection comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments
Get an inspection comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments/{publicSectorInspectionCommentsUniqID}
Update an inspection comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments/{publicSectorInspectionCommentsUniqID}

Inspection Communications

The inspection communications resource is used to view permit information related to inspections for inspection communications.

Get all inspection communication items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionCommunications
Get an inspection communication item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionCommunications/{publicSectorInspectionCommunicationsUniqID}

Inspection Counts

The inspection counts resource is used to configure the number of inspections and their names that can be scheduled for a Code Enforcement inspection.

Create a set of inspection counts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementSetupInspectionCounts
Delete an inspection count: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementSetupInspectionCounts/{publicSectorCodeEnforcementSetupInspectionCountsUniqID}
Get all inspection counts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementSetupInspectionCounts
Get an inspection count: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementSetupInspectionCounts/{publicSectorCodeEnforcementSetupInspectionCountsUniqID}
Update an inspection count: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementSetupInspectionCounts/{publicSectorCodeEnforcementSetupInspectionCountsUniqID}

Inspection Group Lines

The inspection group lines resource is used to view, create, delete, or modify an inspection group line. An inspection group line identifies the individual inspections associated with a permit.

Create an inspection group line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines
Delete an inspection group line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}
Get all inspection group lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines
Get an inspection group line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}
Update an inspection group line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}

Inspection Groups

The inspection group resource is used to view, create, delete, or modify an inspection group. An inspection group identifies the group of inspection types associated with a permit, license, or plan. The group contains one or more inspection lines.

Create an inspection group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups
Delete an inspection group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}
Get all inspection groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups
Get an inspection group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}
Update an inspection group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}

Inspection Groups/Inspection Group Lines

The inspection group line resource is used to view, create, delete, or modify an inspection group line. An inspection group line identifies the individual inspection types associated with a permit, license, or plan.

Create an inspection group line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}/child/InspectionGroupLine
Delete an inspection group line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}/child/InspectionGroupLine/{InspectionGroupLineUniqID}
Get all inspection group lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}/child/InspectionGroupLine
Get an inspection group line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}/child/InspectionGroupLine/{InspectionGroupLineUniqID}
Update an inspection group line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}/child/InspectionGroupLine/{InspectionGroupLineUniqID}

Inspection Mobile Checklist Items

The mobile inspection checklist items resource is used to view all inspection checklist items and corresponding setup information, including the inspection ID, checklist ID, checklist item ID, checklist item name, checklist item score, checklist item result, setup score, setup major violation flag, and so on.

Get all inspection checklist items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionMobileChkListItems
Get an inspection checklist item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionMobileChkListItems/{publicSectorInspectionMobileChkListItemsUniqID}
Update an inspection checklist item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionMobileChkListItems/{publicSectorInspectionMobileChkListItemsUniqID}

Inspection Result Codes

The inspection result code resource is used for view the inspection result codes. The inspection result codes specify all the assessment codes that are associated with one inspection type.

Get all inspection result codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionResultCodes
Get an inspection result code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionResultCodes/{publicSectorInspectionResultCodesUniqID}

Inspection Statuses

The inspection statuses resource is used to view, create, delete, or modify an inspection status. An inspection status identifies the status of an inspection.

Get all inspection statuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionStatuses
Get an inspection status: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionStatuses/{publicSectorInspectionStatusesUniqID}
Update an inspection status: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionStatuses/{publicSectorInspectionStatusesUniqID}

Inspection Tab Filters

The inspection tab filters resource is used to get a count of inspections in various statuses.

Get all inspection tab filter counts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionTabFilters
Get an inspection tab filer count: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionTabFilters/{TabId}

Inspection Types

The inspection type resource is used for view, create, delete, or modify an inspection type. An inspection type identifies specific attributes for each type of inspection that a public agency may provide.

Create an inspection type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes
Delete an inspection type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes/{publicSectorInspectionTypesUniqID}
Get all inspection types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes
Get an inspection type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes/{publicSectorInspectionTypesUniqID}
Update an inspection type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes/{publicSectorInspectionTypesUniqID}

Inspections with Related Inspections

The inspections with related inspections resource is used to capture the main inspections that are associated with other inspection transactions, and display the inspection ID, related inspection ID, and information about the user. A related inspection might be a reinspection after the main inspection.

Create a related inspection for a main inspection: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedInspections
Delete a related inspection: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedInspections/{publicSectorRelatedInspectionsUniqID}
Get a main inspection and its related inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedInspections/{publicSectorRelatedInspectionsUniqID}
Get all main inspections and their related inspections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedInspections
Update a related inspection: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedInspections/{publicSectorRelatedInspectionsUniqID}

Instances

The instances resource is used to capture all data security object instances. An instance uniquely identifies a row (or rows) of a secured object, and it can be represented by a SQL predicate.

Create a data security instance: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInstances
Delete a data security instance: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInstances/{publicSectorInstancesUniqID}
Get a data security instance: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInstances/{publicSectorInstancesUniqID}
Get all data security instances: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInstances
Update a data security instance: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInstances/{publicSectorInstancesUniqID}

Instructions

The instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item.

Create a checklist item's instructions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInstructions
Delete a checklist item's instructions: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInstructions/{publicSectorInstructionsUniqID}
Get a checklist item's instructions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInstructions/{publicSectorInstructionsUniqID}
Get all checklist items' instructions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInstructions
Update a checklist item's instructions: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInstructions/{publicSectorInstructionsUniqID}

Intake Attachment Cross-References

The intake attachment cross-references resource is used to define cross-reference keys for creating intake attachments.

Create an attachment cross-reference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachmentCrossReferences
Delete an attachment cross-reference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachmentCrossReferences/{publicSectorIntakeAttachmentCrossReferencesUniqID}
Get all attachment cross-references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachmentCrossReferences
Get an attachment cross-reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachmentCrossReferences/{publicSectorIntakeAttachmentCrossReferencesUniqID}
Update an attachment cross-reference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachmentCrossReferences/{publicSectorIntakeAttachmentCrossReferencesUniqID}

Intake Attachments

The intake attachments resource is used to view, create, and update intake attachments.

Create an attachment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments
Delete an attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}
Get all attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments
Get an attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}
Update an attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}

Intake Attachments/Attachment View Accessors

The attachment view accessors resource is used to view, create, and update attachments.

Delete an attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{AttachedDocumentId}
Get all attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor
Get an attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{AttachedDocumentId}
Update an attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{AttachedDocumentId}
Upload an attachment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor

Intake Attachments/Attachment View Accessors/Attachment Revisions

The attachment revisions resource is used to view attachment revisions.

Get all attachment revisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Get an attachment revision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Remove an attachment revision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Replace an attachment revision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Upload an attachment revision: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{AttachedDocumentId}/child/AttachmentsRevision

Intakes

The intakes resource is used to view, create, delete, or modify code enforcement incidents and cases.

Create an intake: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes
Delete an intake: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}
Get all intakes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes
Get an intake: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}
Update an intake: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}

Intakes/Cases

The cases resource is used to view, create, delete, or modify code enforcement cases.

Create a case: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Case
Delete a case: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Case/{CaseKey}
Get a case: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Case/{CaseKey}
Get all cases: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Case
Update a case: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Case/{CaseKey}

Intakes/Cases/Case Code References

The case code references resource is used to view, create, delete, or modify code references that are part of code enforcement cases.

Create a code reference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Case/{CaseKey}/child/CaseCodeReference
Delete a code reference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Case/{CaseKey}/child/CaseCodeReference/{CodeReferenceKey}
Get a code reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Case/{CaseKey}/child/CaseCodeReference/{CodeReferenceKey}
Get all code references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Case/{CaseKey}/child/CaseCodeReference
Update a code reference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Case/{CaseKey}/child/CaseCodeReference/{CodeReferenceKey}

Intakes/Incidents

The incidents resource is used to view, create, delete, or modify code enforcement incidents.

Create an incident: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Incident
Delete an incident: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Incident/{IncidentKey}
Get all incidents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Incident
Get an incident: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Incident/{IncidentKey}
Update an incident: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Incident/{IncidentKey}

Invoice Forms

The invoice forms resource is used to view, create, delete, or modify invoice forms.

Create an invoice form: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoiceForms
Delete an invoice form: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoiceForms/{publicSectorInvoiceFormsUniqID}
Get all invoice forms: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoiceForms
Get an invoice form: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoiceForms/{publicSectorInvoiceFormsUniqID}
Update an invoice form: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoiceForms/{publicSectorInvoiceFormsUniqID}

Invoices

The invoices resource is used to view, create or update invoices.

Create an invoice data: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoices
Create invoices: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoices
Get all invoice data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoices
Get an invoice data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}
Update an invoice data: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}

Invoices/Bill Lines

The bill lines resource is used to view, create or update invoice lines.

Create an invoice line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLine
Get all invoice lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLine
Get an invoice line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLine/{BillLineUniqID}
Update an invoice line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLine/{BillLineUniqID}

Issue Subtype Code References

The issue subtype code references resource is used to view, create, delete, or modify the code reference group that is linked to an issue subtype.

Create a code reference group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupSubtypes
Delete a code reference group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupSubtypes/{publicSectorCodeGroupSubtypesUniqID}
Get a code reference group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupSubtypes/{publicSectorCodeGroupSubtypesUniqID}
Get all code reference groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupSubtypes
Update a code reference group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupSubtypes/{publicSectorCodeGroupSubtypesUniqID}

Issue Subtype Time Rules

The issue subtype time rules resource is used to view, create, delete, or modify time rule definitions.

Create a time rule definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypeTimeRules
Delete a time rule definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypeTimeRules/{publicSectorIssueSubtypeTimeRulesUniqID}
Get a time rule definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypeTimeRules/{publicSectorIssueSubtypeTimeRulesUniqID}
Get all time rule definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypeTimeRules
Update a time rule definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypeTimeRules/{publicSectorIssueSubtypeTimeRulesUniqID}

Issue Subtypes

The issue subtypes resource is used to view, create, or modify issue subtypes.

Create an issue subtype: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes
Get all issue subtypes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes
Get an issue subtype: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes/{publicSectorIssueSubtypesUniqID}
Update an issue subtype: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes/{publicSectorIssueSubtypesUniqID}

Issue Type Code References

The issue type code references resource is used to view, create, delete, or modify the code reference group that is linked to an issue type.

Create a code reference group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupTypes
Delete a code reference group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupTypes/{publicSectorCodeGroupTypesUniqID}
Get a code reference group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupTypes/{publicSectorCodeGroupTypesUniqID}
Get all code reference groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupTypes
Update a code reference group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupTypes/{publicSectorCodeGroupTypesUniqID}

Issue Type Time Rules

The issue type time rules resource is used to view, create, delete, or modify time rule definitions for an issue type.

Create a time rule definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueTypeTimeRules
Delete a time rule definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueTypeTimeRules/{publicSectorIssueTypeTimeRulesUniqID}
Get a time rule definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueTypeTimeRules/{publicSectorIssueTypeTimeRulesUniqID}
Get all time rule definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueTypeTimeRules
Update a time rule definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueTypeTimeRules/{publicSectorIssueTypeTimeRulesUniqID}

Issue Types

The issue type resource is used to view, create, delete, or modify an issue type. Issue types represent categories of code enforcement issues.

Create a set of issue types: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes
Get all issue types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes
Get an issue type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes/{publicSectorIssueTypesUniqID}
Update an issue type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes/{publicSectorIssueTypesUniqID}

Job Configurations

The job configurations resource is used to view the valid combinations of the various job functions and their attributes that are available for use within an agency.

Create a set of job function configurations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncConfigurations
Delete a job function configuration: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncConfigurations/{publicSectorJobFuncConfigurationsUniqID}
Get a job function configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncConfigurations/{publicSectorJobFuncConfigurationsUniqID}
Get all job function configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncConfigurations
Update a job function configuration: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncConfigurations/{publicSectorJobFuncConfigurationsUniqID}

Job Function Attributes

The job function attributes resource is used to view the pre configured job attributes assigned to a job function.

Create a set of job attributes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncSections
Delete a job attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncSections/{JobFuncSecId}
Get a job attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncSections/{JobFuncSecId}
Get all job attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncSections
Update a job attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFuncSections/{JobFuncSecId}

Job Functions

The job functions resource is used to view the job functions that are configured for an agency. Job functions mainly represent the areas of responsibility that are assigned to the agency staff.

Create a set of job functions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFunctions
Delete a job function: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFunctions/{JobFuncId}
Get a job function: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFunctions/{JobFuncId}
Get all job functions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFunctions
Update a job function: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobFunctions/{JobFuncId}

Job Group Attributes

The job group attributes resource is used to view the attributes and attribute values that are assigned to a job group definition.

Create a set of job group attributes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFuncSections
Delete a job group attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFuncSections/{publicSectorJobGroupFuncSectionsUniqID}
Get a job group attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFuncSections/{publicSectorJobGroupFuncSectionsUniqID}
Get all job group attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFuncSections
Update a job group attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFuncSections/{publicSectorJobGroupFuncSectionsUniqID}

Job Group Definitions

The job group definitions resource is to view the job groups that are configured for an agency. Job groups can be used to create templates from a combination of the job functions and their attributes that are assigned to an agency staff.

Create a set of job group definitions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupDefinitions
Delete a job group definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupDefinitions/{publicSectorJobGroupDefinitionsUniqID}
Get a job group definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupDefinitions/{publicSectorJobGroupDefinitionsUniqID}
Get all job group definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupDefinitions
Update a job group definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupDefinitions/{publicSectorJobGroupDefinitionsUniqID}

Job Group Functions

The job group functions resource is used to view the list of job functions that are associated to a job group definition.

Create a set of job group functions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions
Delete a job group function: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}
Get a job group function: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}
Get all job group functions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions
Update a job group function: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}

Job Group Functions/Job Group Attributes

The job group attributes resource is used to list the job attributes that are assigned to a job function definition.

Create a set of job group attributes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}/child/JobGrpFuncSec
Delete a job group attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}
Get a job group attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}
Get all job group attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}/child/JobGrpFuncSec
Update a job group attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}

Job Groups

The job groups resource is used to view the list of all configured job groups for an agency.

Create a set of job groups: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups
Delete a job group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}
Get a job group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}
Get all job groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups
Update a job group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}

Job Groups/Job Group Functions

The job group functions resource is used to view the list of job functions that are associated to a job group definition.

Create a set of job group functions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc
Delete a job group function: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}
Get a job group function: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}
Get all job group functions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc
Update a job group function: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}

Job Groups/Job Group Functions/Job Group Attributes

The job group attributes resource is used to list the job attributes that are assigned to a job function definition.

Create a job group attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}/child/JobGrpFuncSec
Delete a job group attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}
Get a job group attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}
Get all job group attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}/child/JobGrpFuncSec
Update a job group attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}

Job Titles

The job titles resource is used to view the job titles that are configured for use within an agency.

Create a set of job titles: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobTitles
Delete a job title: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobTitles/{publicSectorJobTitlesUniqID}
Get a job title: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobTitles/{publicSectorJobTitlesUniqID}
Get all related job titles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobTitles
Update a job title: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJobTitles/{publicSectorJobTitlesUniqID}

Journal Errors

The journal error resource is used to view the validation errors associated with a journal header. There can be one or more errors for a given journal header.

Get a journal header error: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalErrors/{publicSectorJournalErrorsUniqID}
Get all journal header errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalErrors

Journal Headers

The journal header resource is used to view a journal. A journal contains a set of accounting entries created as the result of business transactions within the organization. Its header stores the information such as accounting date, total debit and credit amounts, status, etc.

Get a journal header: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalHeaders/{JeHeaderId}
Get all journal headers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalHeaders
Update a journal header: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalHeaders/{JeHeaderId}

Journal Line Details

The journal line detail resource is used to view the details of a journal line. A journal line contains an accounting entry that consists of accounting segment values, debit or credit amount, currency, and status.

Get a journal line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalLineDetails/{JeLineId}
Get all journal lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalLineDetails
Update a journal line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalLineDetails/{JeLineId}

Journal Line Errors

The journal line error resource is used to view the validation errors associated with a journal line. There can be one or more errors for a journal line.

Get a journal line error: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalLineErrors/{publicSectorJournalLineErrorsUniqID}
Get all journal line errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalLineErrors

Journal Lines

The journal line resource is used to view the details of a journal line. A journal line contains an accounting entry that consists of accounting segment values, debit or credit amount, currency, and status. It also includes the accounting transaction key that can be linked back to the transaction from which the entry is generated.

Get a journal line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalLines/{publicSectorJournalLinesUniqID}
Get all journal lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalLines
Update a journal line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorJournalLines/{publicSectorJournalLinesUniqID}

Ledgers

The ledger resource is used to view, create, delete or modify a ledger. A ledger identifies the accounting treatment of the journals associated with the ledger.

Create a ledger: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLedgers
Delete a ledger: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLedgers/{publicSectorLedgersUniqID}
Get a ledger: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLedgers/{publicSectorLedgersUniqID}
Get all ledgers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLedgers
Update a ledger: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLedgers/{publicSectorLedgersUniqID}

Legal Employers

Use the legal employers resource to find the list of legal employers configured in the Fusion HR system.

Create a set of legal employers: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLegalEmployers
Delete a legal employer: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLegalEmployers/{publicSectorLegalEmployersUniqID}
Get a legal employer: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLegalEmployers/{publicSectorLegalEmployersUniqID}
Get all legal employers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLegalEmployers
Update a legal employer: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLegalEmployers/{publicSectorLegalEmployersUniqID}

License Agents

The license agents resource is used to view, add, delete and modify details associated with authorized contacts who act as agents for the holder of a contractor license.

Create a set of license agents for a contractor license: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseAgents
Delete a license agent for a contractor license: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseAgents/{LicenseAgentKey}
Get a license agent for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseAgents/{LicenseAgentKey}
Get all license agents for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseAgents
Update a license agent for a contractor license: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseAgents/{LicenseAgentKey}

License Facts

The license facts resource is used to view, add, delete and modify details pertaining to contractor license information such as classification, certification, status, and so forth.

Create a set of license facts for a contractor license: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseFacts
Delete a license fact for a contractor license: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseFacts/{LicenseFactKey}
Get a license fact for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseFacts/{LicenseFactKey}
Get all license facts for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseFacts
Update a license fact for a contractor license: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseFacts/{LicenseFactKey}

License Insurances

The license insurances resource is used to view, add, delete and modify details pertaining to insurance and workers compensation for a contractor license.

Create a set of license insurances for a contractor license: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances
Delete a license insurance for a contractor license: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances/{LicenseInsuranceKey}
Get a license insurance for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances/{LicenseInsuranceKey}
Get all license insurances for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances
Update a license insurance for a contractor license: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances/{LicenseInsuranceKey}

License Notifications

Use the license notifications resource to view license-related information that can be used in notifications.

Get a license that is associated with a registered public user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLicenseNotifications/{publicSectorLicenseNotificationsUniqID}
Get all licenses for a registered public user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLicenseNotifications

Licenses

The licenses resource is used to view, add, delete and modify general information for a contractor license.

Create a set of contractor licenses: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses
Delete a contractor license: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}
Get a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}
Get all contractor licenses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses
Update a contractor license: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}

Licenses/License Agents

The license agents resource is used to view, add, delete and modify details associated with authorized contacts who act as agents for the holder of a contractor license.

Create a set of license agents for a contractor license: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents
Delete a license agent for a contractor license: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents/{LicenseAgentKey}
Get a license agent for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents/{LicenseAgentKey}
Get all license agents for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents
Update a license agent for a contractor license: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents/{LicenseAgentKey}

Licenses/License Facts

The license facts resource is used to view, add, delete and modify details pertaining to contractor license information such as classification, certification, status, and so forth.

Create a set of license facts for a contractor license: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts
Delete a license fact for a contractor license: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts/{LicenseFactKey}
Get a license fact for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts/{LicenseFactKey}
Get all license facts for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts
Update a license fact for a contractor license: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts/{LicenseFactKey}

Licenses/License Insurances

The license insurances resource is used to view, add, delete and modify details pertaining to insurance and workers compensation for a contractor license.

Create a set of license insurances for a contractor license: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances
Delete a license insurance for a contractor license: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances/{LicenseInsuranceKey}
Get a license insurance for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances/{LicenseInsuranceKey}
Get all license insurances for a contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances
Update a license insurance for a contractor license: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances/{LicenseInsuranceKey}

List Case Appeals

The case appeal resource is used to view a case appeal. Case appeals are used in Code Enforcement cases.

Get a case appeal: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCaseAppeals/{CaseAppealKey}
Get all case appeals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCaseAppeals

List Citation Notices

The list citation notice resource is used to view a citation notice. Citation notices are used in Code Enforcement cases.

Get a citation notice: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCitationNotices/{CaseNoticeKey}
Get all citation notices: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCitationNotices

List Citation Notices/Case Contacts

The case contact resource is used to view the contact information of a citation notice. Citation notices are used in Code Enforcement cases.

Get a case contact for a citation notice: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCitationNotices/{CaseNoticeKey}/child/CaseContacts/{CaseContactKey}
Get all case contacts for a citation notice: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCitationNotices/{CaseNoticeKey}/child/CaseContacts

List Violation Notices

The list violation notice resource is used to view a list of violation notices. Violation notices are used in Code Enforcement cases.

Get a violation notice: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListViolationNotices/{CaseNoticeKey}
Get all violation notices: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListViolationNotices

List Violation Notices/Case Contacts

The case contact resource is used to view the contact details of a violation notice. Violation notices are used in Code Enforcement cases.

Get a case contact of a violation notice: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListViolationNotices/{CaseNoticeKey}/child/CaseContacts/{CaseContactKey}
Get all case contacts of a violation notice: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListViolationNotices/{CaseNoticeKey}/child/CaseContacts

List of Cases

The case list resource is used to view a list of cases. Case list is used to view code enforcement cases.

Get a case: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}
Get all cases: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCases

List of Cases/Administer Case Status Permissions

The administer case status access resource is used to determine whether the status of a case can be modified.

Get all administer case status accesses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/AdministerCaseStatusAccess
Get an administer case status access: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/AdministerCaseStatusAccess/{CaseKey2}

List of Cases/Case Status Change Permissions

The update case status access resource is used to determine whether the status of a case can be modified.

Get all update case status accesses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/UpdateCaseStatusAccess
Get an update case status access: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/UpdateCaseStatusAccess/{CaseKey2}

List of Cases/Update Case Permissions

The update case access resource is used to determine whether a case can be modified.

Get all update case accesses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/UpdateAccess
Get an update case access: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/UpdateAccess/{CaseKey2}

List of Values/Rated Currencies

The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.

Get a rated currency: Method: get
Path: /fscmRestApi/resources/11.13.18.05/ratedCurrencies/{CurrencyCode}
Get all rated currencies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/ratedCurrencies

Localities

The localities resource is used to view, create, delete or modify localities. A locality is a geographic object like a city or region.

Create a locality: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLocalities
Delete a locality: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLocalities/{publicSectorLocalitiesUniqID}
Get a locality: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLocalities/{publicSectorLocalitiesUniqID}
Get all localities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLocalities
Update a locality: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLocalities/{publicSectorLocalitiesUniqID}

The login profiles resource is used to view account profiles for the currently signed in registered public user.

Get all account profiles for the currently signed in registered public user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLoginProfiles
Get an account profile for the currently signed in registered public user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLoginProfiles/{ProfileId}

Lookup Types

The lookup type resource is used to view, create, delete or modify lookup types. The object stores lookup type information such as lookup type and configuration level.

Create a lookup type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes
Delete a lookup type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}
Get a lookup type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}
Get all lookup types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes
Update a lookup type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}

Lookup Types/Lookup Values

The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.

Create a lookup value associated with a lookup type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}/child/PscLookupValue
Delete a lookup value: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}/child/PscLookupValue/{PscLookupValueUniqID}
Get a lookup value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}/child/PscLookupValue/{PscLookupValueUniqID}
Get all lookup values associated with a lookup type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}/child/PscLookupValue
Update a lookup value: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}/child/PscLookupValue/{PscLookupValueUniqID}

Lookup Values

The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.

Create a lookup value associated with a lookup type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupValues
Delete a lookup value: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupValues/{publicSectorLookupValuesUniqID}
Get a lookup value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupValues/{publicSectorLookupValuesUniqID}
Get all lookup values associated with a lookup type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupValues
Update a lookup value: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLookupValues/{publicSectorLookupValuesUniqID}

Lookups

The lookups resource is used to view standard lookup codes.

Get a lookup.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/fndStaticLookups/{fndStaticLookupsUniqID}
Get all lookups.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/fndStaticLookups

Map Profile References

Use map profile references to view, update, create, and delete map profile references. A map profile reference associates a map profile with a map and includes additional map configuration options that are specific to the individual map.

Create a map profile reference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences
Delete a map profile reference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences/{publicSectorMapProfileReferencesUniqID}
Get a map profile reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences/{publicSectorMapProfileReferencesUniqID}
Get all map profile references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences
Update a map profile reference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences/{publicSectorMapProfileReferencesUniqID}

Map Profiles

Use the map profiles resource to view, update, create, and delete map profiles. A map profile contains map configuration options that can be applied to one or more maps.

Create a map profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMapProfiles
Create a map profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles
Delete a map profile: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMapProfiles/{publicSectorMapProfilesUniqID}
Delete a map profile: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}
Get a map profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMapProfiles/{publicSectorMapProfilesUniqID}
Get a map profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}
Get all map profiles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMapProfiles
Get all map profiles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles
Update a map profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMapProfiles/{publicSectorMapProfilesUniqID}
Update a map profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}

Map Profiles/Map Profile References

Create a map profile reference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences
Delete a map profile reference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}
Get a map profile reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}
Get all map profile references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences
Update a map profile reference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}

Map Runtime Profiles

Use the map runtime profiles resource to get map profile information to use when displaying a map page at runtime.

Get a map profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRuntimeMapProfiles/{publicSectorRuntimeMapProfilesUniqID}
Get all map profiles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRuntimeMapProfiles

Mapping Attachments

The mapping attachments resource is used to store Data Format Exchange mapping attachments.

Create a set of mapping attachments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments
Delete a mapping attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}
Get a mapping attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}
Get all mapping attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments
Replace a mapping attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}

Mapping Attachments/Mapping Attachment Accessors

The mapping attachment accessors resource is used to store Data Format Exchange mapping attachment file-related information such as file name and file URL.

Create a set of mapping attachment file-related information: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor
Delete a mapping attachment's file-related information: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{AttachedDocumentId}
Get a mapping attachment's file-related information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{AttachedDocumentId}
Get all mapping attachment file-related information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor
Update a mapping attachment's file-related information: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{AttachedDocumentId}

Mapping Attachments/Mapping Attachment Accessors/Mapping Attachment Revisions

The mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.

Create a set of mapping attachment revisions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete a mapping attachment revision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get a mapping attachment revision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all mapping attachment revisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Update a mapping attachment revision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Mapping Details

The mapping detail resource is used to store the mapping pairs between the source and the target in a Data Format Exchange mapping.

Create a mapping pair: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingDetails
Delete a mapping pair: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingDetails/{publicSectorMappingDetailsUniqID}
Get a mapping pair: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingDetails/{publicSectorMappingDetailsUniqID}
Get all mapping pairs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingDetails
Update a mapping pair: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingDetails/{publicSectorMappingDetailsUniqID}

Mapping Headers

The sector mapping headers resource is used to store Data Format Exchange header information.

Create a mapping header definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders
Delete a mapping header definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}
Get a mapping header definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}
Get all mapping header definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders
Update a mapping header definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}

Mapping Headers/Mapping Details

The mapping details resources is used to store the mapping pairs between the source and the target.

Create a mapping pair: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetail
Delete a mapping pair: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetail/{MappingDetailUniqID}
Get a mapping pair: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetail/{MappingDetailUniqID}
Get all mapping pairs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetail
Update a mapping pair: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetail/{MappingDetailUniqID}

Mapping Headers/Mapping Navigators

The mapping navigators resource is used to store the status of the setup wizard.

Create a mapping navigator: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigator
Delete a mapping navigator: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigator/{MappingNavigatorUniqID}
Get a mapping navigator: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigator/{MappingNavigatorUniqID}
Get all mapping navigators: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigator
Update a mapping navigator: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigator/{MappingNavigatorUniqID}

Mapping Headers/Mapping Sources

The mapping sources resource is used to store the defination of the source for Data Format Exchange.

Create a mapping source: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource
Delete a mapping source: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource/{MappingSourceUniqID}
Get a mapping source: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource/{MappingSourceUniqID}
Get all mapping sources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource
Update a mapping source: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource/{MappingSourceUniqID}

Mapping Headers/Mapping Targets

The mapping targets resource is used to store the definition of the target for Data Format Exchange.

Create a mapping target: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget
Delete a mapping target: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget/{MappingTargetUniqID}
Get a mapping target: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget/{MappingTargetUniqID}
Get all mapping targets: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget
Update a mapping target: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget/{MappingTargetUniqID}

Mapping Navigators

The mapping navigator resource is used to store the status of steps in the Data Format Exchange setup wizard.

Create a mapping navigator: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingNavigators
Delete a mapping navigator: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingNavigators/{publicSectorMappingNavigatorsUniqID}
Get a mapping navigator: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingNavigators/{publicSectorMappingNavigatorsUniqID}
Get all mapping navigators: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingNavigators
Update a mapping navigator: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingNavigators/{publicSectorMappingNavigatorsUniqID}

Mapping Source Fields

The mapping source fields resource is used to store the definition of the source object fields used in a Data Format Exchange mapping.

Create a mapping source field: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingSourceFields
Delete a mapping source field: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingSourceFields/{publicSectorMappingSourceFieldsUniqID}
Get a mapping source field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingSourceFields/{publicSectorMappingSourceFieldsUniqID}
Get all mapping source fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingSourceFields
Update a mapping source field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingSourceFields/{publicSectorMappingSourceFieldsUniqID}

Mapping Sources

The mapping source resource is used to store the definition of the source object used in a Data Format Exchange mapping.

Create a mapping source: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingSources
Delete a mapping source: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingSources/{publicSectorMappingSourcesUniqID}
Get a mapping source: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingSources/{publicSectorMappingSourcesUniqID}
Get all mapping sources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingSources
Update a mapping source: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingSources/{publicSectorMappingSourcesUniqID}

Mapping Target Fields

The mapping target fields resource is used to store the definition of the target object fields used in a Data Format Exchange mapping.

Create a mapping target field: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingTargetFields
Delete a mapping target field: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingTargetFields/{publicSectorMappingTargetFieldsUniqID}
Get a mapping target field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingTargetFields/{publicSectorMappingTargetFieldsUniqID}
Get all mapping target fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingTargetFields
Update a mapping target field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingTargetFields/{publicSectorMappingTargetFieldsUniqID}

Mapping Targets

The mapping target resource is used to store the definition of the target object used in a Data Format Exchange mapping.

Create a mapping target: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets
Delete a mapping target: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets/{publicSectorMappingTargetsUniqID}
Get a mapping target: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets/{publicSectorMappingTargetsUniqID}
Get all mapping targets: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets
Update a mapping target: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets/{publicSectorMappingTargetsUniqID}

Mapping View Objects

The mapping view objects resource is used to store the definition of view objects available in a Data Format Exchange mapping.

Create a mapping view object: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingViewObjects
Delete a mapping view object: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingViewObjects/{VoCode}
Get a mapping view object: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingViewObjects/{VoCode}
Get all mapping view objects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingViewObjects
Update a mapping view object: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMappingViewObjects/{VoCode}

Meeting Participants

The public sector meeting participants resource is used to view, add, and remove participants from meetings.

Create a set of meeting participants: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingParticipants
Delete a meeting participant: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingParticipants/{publicSectorMeetingParticipantsUniqID}
Get a meeting participant: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingParticipants/{publicSectorMeetingParticipantsUniqID}
Get all meeting participants: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingParticipants
Update a meeting participant: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingParticipants/{publicSectorMeetingParticipantsUniqID}

Meeting Rosters

The public sector meeting rosters resource is used to view schedule meetings.

Create a set of meetings: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters
Delete a meeting: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}
Get a meeting: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}
Get all meetings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters
Update a meeting: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}

Meeting Rosters/Meeting Participants

The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting.

Create a set of meeting participants: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipant
Delete a meeting participant: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipant/{MeetingParticipantUniqID}
Get a meeting participant: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipant/{MeetingParticipantUniqID}
Get all participants: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipant
Update a meeting participant: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipant/{MeetingParticipantUniqID}

Menu Item Attributes

The menu item attributes resource is used to view, create, modify, or delete a navigation menu item attribute. The term "menu" is also referred to as a "registry".

Create a menu item attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemAttributes
Delete a menu item attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemAttributes/{publicSectorRegistryItemAttributesUniqID}
Get a menu item attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemAttributes/{publicSectorRegistryItemAttributesUniqID}
Get all menu item attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemAttributes
Update a menu item attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemAttributes/{publicSectorRegistryItemAttributesUniqID}

Menu Item Configurations

The menu item configurations resource is used to view, create, modify, or delete the customer configuration data of a navigation menu item. The term "menu" is also referred to as a "registry".

Create a menu item customer configuration data record: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemConfigurations
Delete a menu item customer configuration data record: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemConfigurations/{publicSectorRegistryItemConfigurationsUniqID}
Get a menu item customer configuration data record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemConfigurations/{publicSectorRegistryItemConfigurationsUniqID}
Get all menu item customer configuration data records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemConfigurations
Update a menu item customer configuration data record: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemConfigurations/{publicSectorRegistryItemConfigurationsUniqID}

Menu Item Security Assignments

The menu item security assignments resource is used to view, create, modify, or delete a navigation menu item security assignment. The term "menu" is also referred to as a "registry". Note that this resource is no longer in use. Menu item security should be configured through the Security Console.

Create a menu item security assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemSecurities
Delete a menu item security assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemSecurities/{publicSectorRegistryItemSecuritiesUniqID}
Get a menu item security assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemSecurities/{publicSectorRegistryItemSecuritiesUniqID}
Get all menu item security assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemSecurities
Update a menu item security assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemSecurities/{publicSectorRegistryItemSecuritiesUniqID}

Menu Items

The menu items resource is used to view, create, modify, or delete a navigation menu item. The term "menu" is also referred to as "registry".

Create a menu item: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions
Delete a menu item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}
Get a menu item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}
Get all menu items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions
Update a menu item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}

Menu Items/Menu Item Attributes

The menu item attributes resource is used to view, create, modify, or delete a navigation menu item attribute.

Create a menu item attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Attributes
Delete a menu item attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Attributes/{AttributesUniqID}
Get a menu item attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Attributes/{AttributesUniqID}
Get all menu item attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Attributes
Update a menu item attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Attributes/{AttributesUniqID}

Menu Items/Menu Item Configurations

The menu item configurations resource is used to view, create, modify, or delete a navigation item customer configuration data.

Create a menu item customer configuration data record: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Configurations
Delete a menu item customer configuration data record: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Configurations/{ConfigurationsUniqID}
Get a menu item customer configuration data record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Configurations/{ConfigurationsUniqID}
Get all menu item customer configuration data records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Configurations
Update a menu item customer configuration data record: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Configurations/{ConfigurationsUniqID}

Menu Items/Menu Item Security Assignments

The menu item security resource was used to view, create, modify, or delete the security assignment for a menu item. This resource is no longer in use. Menu item security assignment is handled using the Security Console.

Create a menu item security assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Securities
Delete a menu item security assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Securities/{SecuritiesUniqID}
Get a menu item security assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Securities/{SecuritiesUniqID}
Get all menu item security assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Securities
Update a menu item security assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Securities/{SecuritiesUniqID}

Menu Security Assignments

The menu security assignments resource is used to view, create, modify, or delete a navigation menu security assignment. Note that this resource is no longer in use. Menu security assignments should be configured through the Security Console. The term "menu" is also referred to as a "registry".

Create a menu security assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitionSecurities
Delete a menu security assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitionSecurities/{publicSectorRegistryDefinitionSecuritiesUniqID}
Get a menu security assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitionSecurities/{publicSectorRegistryDefinitionSecuritiesUniqID}
Get all menu security assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitionSecurities
Update a menu security assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitionSecurities/{publicSectorRegistryDefinitionSecuritiesUniqID}

Menus

The menus resource is used to view, create, modify, or delete a navigation menu.

Create a menu: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions
Delete a menu: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}
Get a menu: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}
Get all menus: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions
Update a menu: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}

Menus/Menu Security Assignments

Create a menu security assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}/child/Securities
Delete a menu security assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}/child/Securities/{SecuritiesUniqID}
Get a menu security assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}/child/Securities/{SecuritiesUniqID}
Get all menu security assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}/child/Securities
Update a menu security assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}/child/Securities/{SecuritiesUniqID}

Metadata Entity Links

The metadata entity links resource is used to view the relationship between entities that belong to different entity models of a particular metadata model within the Oracle Policy Automation configuration schema.

Create a set of metadata entity links: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityLinks
Delete a metadata entity link: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityLinks/{publicSectorOpaMetaDataEntityLinksUniqID}
Get a metadata entity link: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityLinks/{publicSectorOpaMetaDataEntityLinksUniqID}
Get all metadata entity links: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityLinks
Update a metadata entity link: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityLinks/{publicSectorOpaMetaDataEntityLinksUniqID}

Metadata Entity Relationships

The metadata entity relationships resource is used to view the mapping that exists between the entity models and the metadata models within the Oracle Policy Automation configuration schema. Every entity model is associated with one or more metadata models that exist in the configuration schema.

Create a set of metadata entity relationships: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships
Delete a metadata entity relationship: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}
Get a metadata entity relationship: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}
Get all metadata entity relationships: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships
Update a metadata entity relationship: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}

Metadata Entity Relationships/Metadata Entity Links

The metadata entity links resource is used to view the relationship between entities. Entities belong to the various entity models of a particular metadata model within the Oracle Policy Automation configuration schema.

Create a se of metadata entity links: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}/child/MetaDataEntityLinkAccessor
Delete a metadata entity link: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}/child/MetaDataEntityLinkAccessor/{MetaDataEntityLinkAccessorUniqID}
Get a metadata entity link: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}/child/MetaDataEntityLinkAccessor/{MetaDataEntityLinkAccessorUniqID}
Get all metadata entity links: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}/child/MetaDataEntityLinkAccessor
Update a metadata entity link: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}/child/MetaDataEntityLinkAccessor/{MetaDataEntityLinkAccessorUniqID}

Metadata Enumeration Relationships

The metadata enumeration relationships resource is used to view the mapping that exists between the enumerations and the metadata models within the Oracle Policy Automation configuration schema. Each enumeration is associated with one or more metadata models that exist in the configuration schema.

Create a set of metadata enumeration relationships: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEnumRelationships
Delete a metadata enumeration relationship: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEnumRelationships/{publicSectorOpaMetaDataEnumRelationshipsUniqID}
Get a metadata enumeration relationship: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEnumRelationships/{publicSectorOpaMetaDataEnumRelationshipsUniqID}
Get all metadata enumeration relationships: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEnumRelationships
Update a metadata enumeration relationship: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEnumRelationships/{publicSectorOpaMetaDataEnumRelationshipsUniqID}

Metadata Models

The metadata models resource is used to view or update metadata models that exist in the Oracle Policy Automation configuration schema. The metadata model is an aggregation of one or more entity models, and the relationship between them. The Oracle Policy Modeling tool is configured to work with a metadata model that exists in the configuration schema. The metadata models resource is also used to implement Web Service Connector operations like GetMetadata, Load, and Save for integrating the Oracle Policy Automation product with the Public Sector Cloud application.

Create a set of metadata models: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Delete a metadata model: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}
Get a metadata model: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}
Get all metadata models: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the metadata model to be used for policy modeling.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the metadata model to be used for policy modeling.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the metadata model to be used for policy modeling.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the metadata model to be used for policy modeling.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the metadata model to be used for policy modeling.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the metadata model to be used for policy modeling.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the metadata model to be used for policy modeling.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the seed data to be loaded at the start of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the seed data to be loaded at the start of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the seed data to be loaded at the start of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the seed data to be loaded at the start of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the seed data to be loaded at the start of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the seed data to be loaded at the start of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Get the seed data to be loaded at the start of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Save the outcome data at the end of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Save the outcome data at the end of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Save the outcome data at the end of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Save the outcome data at the end of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Save the outcome data at the end of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Save the outcome data at the end of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Save the outcome data at the end of an interview.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Update a metadata model: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}

Metadata Models/Metadata Entity Relationships

The metadata entity relationships resource is used to view the mapping that exists between the entity models and the metadata models that exist in the Oracle Policy Automation configuration schema. Each entity model is associated with one or more metadata models existing in the configuration schema.

Create a set of metadata entity relationships: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataEntityRelationAccessor
Delete a metadata entity relationship: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataEntityRelationAccessor/{MetaDataEntityRelationAccessorUniqID}
Get a metadata entity relationship: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataEntityRelationAccessor/{MetaDataEntityRelationAccessorUniqID}
Get all metadata entity relationships: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataEntityRelationAccessor
Update a metadata entity relationship: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataEntityRelationAccessor/{MetaDataEntityRelationAccessorUniqID}

Metadata Models/Metadata Enumeration Relationships

Create a set of metadata enumeration relationships: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataModelEnumRelation
Delete a metadata enumeration relationship: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataModelEnumRelation/{MetaDataModelEnumRelationUniqID}
Get a metadata enumeration relationship: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataModelEnumRelation/{MetaDataModelEnumRelationUniqID}
Get all metadata enumeration relationships: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataModelEnumRelation
Update a metadata enumeration relationship: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataModelEnumRelation/{MetaDataModelEnumRelationUniqID}

Mobile Communications

The mobile communications resource is used to view, create, and update common content, which will be passed through email as part of the email notification template in a mobile application, such as the Oracle Inspector app.

Create content: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileCommunications
Delete the content details: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileCommunications/{ContentId}
Get all content: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileCommunications
Get the content details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileCommunications/{ContentId}
Update a particular piece of content: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileCommunications/{ContentId}

Mobile Offline Configurations

The mobile offline configurations resource is used to view or modify REST requests from Public Sector Compliance and Regulation mobile applications.

Get a mobile offline control field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineControlFields/{publicSectorMobileOfflineControlFieldsUniqID}
Get all mobile offline control fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineControlFields
Update a mobile offline control field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineControlFields/{publicSectorMobileOfflineControlFieldsUniqID}

Mobile Offline Resources

The mobile offline resources resource lists the resources to be made available for offline usage by a mobile application, such as the Oracle Inspector application.

Get all offline-enabled resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineResources
Get an offline-enabled resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineResources/{publicSectorMobileOfflineResourcesUniqID}

Mobile Offline Work Units

The mobile offline work units resource is used to view, create and update all units of work uploaded by the inspector from a mobile device when using the mobile inspector app. The unit of work contains information related to the issue type and whether there was an error in uploaded data or a conflict between the data in the system and the data uploaded from the mobile device.

Create a mobile offline unit of work: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows
Delete a mobile offline unit of work: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}
Get a mobile offline unit of work: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}
Get all mobile offline units of work: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows
Update a mobile offline unit of work: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}

Mobile Offline Work Units/Mobile Offline Unit of Work Records

The mobile offline unit of work records resource is used to view, create, and update records belonging to a unit of work. The unit of work record contains information related to the unit of work content and the error response.

Create a mobile offline unit of work record: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord
Delete a mobile offline unit of work record: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}
Get a mobile offline unit of work record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}
Get all mobile offline unit of work records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord
Update a mobile offline unit of work record: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}

Mobile Signons

The mobile signons resource is used by the Oracle Inspector app to authenicte and authorize users. The mobile signons resource doesn't return any data and is expected to be used internally by the Oracle Inspector app. The mobile signons resource is intended to be used solely by internal Oracle application development teams.

Get access to the mobile app on success: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileLoginStatus/{publicSectorMobileLoginStatusUniqID}
Get all access to the mobile app on success: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMobileLoginStatus

Modules

The module resource is used to view the module information related to logical business areas. The object stores module information, including module ID and module name.

Get a module by key: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorModules/{ModuleId}
Get all modules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorModules

My Licenses

The my licenses resource is used to view, create, modify, or delete licenses that are associated with a registered public user's account profile.

Create a license: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLicenses
Delete a license: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLicenses/{LicenseReferenceId}
Get a license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLicenses/{LicenseReferenceId}
Get all licenses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLicenses
Update a license: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorLicenses/{LicenseReferenceId}

My Payment Accounts

The my payment accounts resource is used to view, create, modify, or delete payment accounts that are associated with a registered public user's account profile.

Create a payment account: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentAccounts
Delete a payment account: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentAccounts/{PaymentAccountId}
Get a payment account: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentAccounts/{PaymentAccountId}
Get all payment accounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentAccounts
Update a payment account: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentAccounts/{PaymentAccountId}

My Ready for Inspection Permits

The my ready for inspections permits resource is used to view a list of permits which the user is an applicant on and are ready to be inspected. This includes permits in Permit Issued, Inspection or About to Expire statuses.

Get all my permits ready for inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMyInspectionsPermits
Get my permit ready for inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorMyInspectionsPermits/{publicSectorMyInspectionsPermitsUniqID}

NAICS Codes

Use the NAICS codes resource to assign NAICS codes to a business license application. These values are known as industry classifications.

Create a NAICS code: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSCodes
Delete a NAICS code: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSCodes/{publicSectorNAICSCodesUniqID}
Get a NAICS code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSCodes/{publicSectorNAICSCodesUniqID}
Get all NAICS codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSCodes
Update a NAICS code: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSCodes/{publicSectorNAICSCodesUniqID}

NAICS Group Code Prompts

Use the NAICS group code prompts resource to view NAICS codes that are assigned to a NAICS group. A NAICS group code prompt is used to specify a NAICS code for a license application.

Get a NAICS group code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodePrompts/{publicSectorNAICSGroupCodePromptsUniqID}
Get all NAICS group codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodePrompts

NAICS Group Codes

Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.

Create a NAICS group code: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodes
Delete a NAICS group code: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodes/{publicSectorNAICSGroupCodesUniqID}
Get a NAICS group code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodes/{publicSectorNAICSGroupCodesUniqID}
Get all NAICS group codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodes
Update a NAICS group code: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodes/{publicSectorNAICSGroupCodesUniqID}

NAICS Groups

Use the NAICS groups resource to view, update, create, and delete NAICS groups. A NAICS group is used to organize NAICS codes.

Create a NAICS group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups
Delete a NAICS group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}
Get a NAICS group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}
Get all NAICS groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups
Update a NAICS group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}

NAICS Groups/NAICS Group Codes

Create a NAICS group code: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor
Delete a NAICS group code: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor/{NAICSGroupCodeAccessorUniqID}
Get a NAICS group code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor/{NAICSGroupCodeAccessorUniqID}
Get all NAICS group codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor
Update a NAICS group code: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor/{NAICSGroupCodeAccessorUniqID}

Notifications

The notifications resource is used to view communication details triggered using the notification channel.

Get a notification: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNotifications/{publicSectorNotificationsUniqID}
Get all notifications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNotifications
Update a notification: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorNotifications/{publicSectorNotificationsUniqID}

Object Attributes

The object attributes resource is used to capture all data security objects and the associated attributes.

Create a data security object and its attributes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorObjectattrs
Delete a data security object and its attributes: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorObjectattrs/{publicSectorObjectattrsUniqID}
Get a data security object and its attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorObjectattrs/{publicSectorObjectattrsUniqID}
Get all data security objects and its attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorObjectattrs
Update a data security object and its attributes: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorObjectattrs/{publicSectorObjectattrsUniqID}

Objects

The objects resource is used to capture all data security objects.

Create a data security object: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorObjects
Delete a data security object: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorObjects/{publicSectorObjectsUniqID}
Get a data security object: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorObjects/{publicSectorObjectsUniqID}
Get all data security objects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorObjects
Unregister a data security object: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorObjects
Update a data security object: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorObjects/{publicSectorObjectsUniqID}

Ownership Types

The ownership types resource is used to view, create, delete or modify ownership types.

Create an ownership type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOwnershipTypes
Delete an ownership type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOwnershipTypes/{publicSectorOwnershipTypesUniqID}
Get all ownership types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOwnershipTypes
Get an ownership type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOwnershipTypes/{publicSectorOwnershipTypesUniqID}
Update an ownership type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOwnershipTypes/{publicSectorOwnershipTypesUniqID}

PCS Offline Tasks

The PCS offline tasks resource is used to capture all requests made to Oracle Integration Cloud (OIC) while it is offline or unreachable. When OIC returns online or becomes reachable, internal processes use this resource to replay the requests and synchronize the systems. This resource is intended for internal use by Oracle development teams and internal application processes.

Create an offline task: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks
Delete an offline task: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}
Get all offline tasks: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks
Get an offline task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}
Update an offline task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}

Parcel Addresses

The parcel addresses resource is used to view, create, delete or modify addresses and associate them with parcels of real estate.

Create a parcel address: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses
Delete a parcel address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses/{publicSectorParcelAddressesUniqID}
Get a parcel address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses/{publicSectorParcelAddressesUniqID}
Get all parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses
Update a parcel address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses/{publicSectorParcelAddressesUniqID}

Parcel District Crosses

The ParcelDistrictCrosses resource is used to view district information related to a parcel. A district is an administrative region that, in some countries, is managed by local government.

Delete parcel district rows.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelDistrictsCrosses
Get a parcel district: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelDistrictsCrosses/{publicSectorParcelDistrictsCrossesUniqID}
Get all parcel districts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelDistrictsCrosses

Parcel Districts

The parcel districts resource is used to assign or unassign parcels of real estate to districts. A district is an administrative region that, in some countries, is managed by local government.

Create a parcel district: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelDistricts
Delete a parcel district: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelDistricts/{publicSectorParcelDistrictsUniqID}
Get a parcel district: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelDistricts/{publicSectorParcelDistrictsUniqID}
Get all parcel districts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelDistricts
Update a parcel district: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelDistricts/{publicSectorParcelDistrictsUniqID}

Parcel Owners

The parcel owners resource is used to view, create, delete or modify owner information for parcels of real estate.

Create a parcel owner: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners
Delete a parcel owner: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners/{publicSectorParcelOwnersUniqID}
Get a parcel owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners/{publicSectorParcelOwnersUniqID}
Get all parcel owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners
Update a parcel owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners/{publicSectorParcelOwnersUniqID}

Parcel Properties

The parcel properties resource is used to view or modify a record parcel and its properties, such as primary parcel addresses and parcel-related information. Record parcels are plots of real estate associated with a permit.

Get a record parcel and related parcel information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties/{ParcelKey}
Get all record parcels and related parcel information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties
Gets the record parcel count information.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties
Update a record parcel and related parcel information: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties/{ParcelKey}

Parcel Values

The parcel values resource is used to view, create, delete or modify amounts related to parcels of real estate that are used in the calculation of property taxes.

Create a parcel vaue: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelValues
Delete a parcel value: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelValues/{publicSectorParcelValuesUniqID}
Get a parcel value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelValues/{publicSectorParcelValuesUniqID}
Get all parcel values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelValues
Update a parcel value: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelValues/{publicSectorParcelValuesUniqID}

Parcel Values Keys

The parcel values keys resource is used to view amounts related to parcels of real estate in a grid. Those amounts represent values that are used to calculate property taxes.

Get a parcel value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelValuesKeys/{publicSectorParcelValuesKeysUniqID}
Get all parcel values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelValuesKeys

Parcel Values Totals

The parcel values totals resource is used to display total amounts that are used in the calculation of property taxes.

Get a parcel value total: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelValuesTotals/{publicSectorParcelValuesTotalsUniqID}
Get all parcel value totals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcelValuesTotals

Parcels

The parcel resource is used to view, create, delete or modify parcels of real estate. A parcel is a defined piece of real estate, usually resulting from the division of a large area of land.

Create a parcel: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcels
Delete a parcel: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcels/{ParcelId}
Get a parcel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcels/{ParcelId}
Get all parcels: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcels
Update a parcel: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorParcels/{ParcelId}

Passing Rule Details

The passing rule details resource is used to view, create, delete, or modify a scoring range definition. A scoring range identifies the range of scores used in a passing rule. There can be one or more scoring ranges for a given passing rule.

Create a scoring range: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRuleDetails
Delete a scoring range: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRuleDetails/{publicSectorPassingRuleDetailsUniqID}
Get a scoring range: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRuleDetails/{publicSectorPassingRuleDetailsUniqID}
Get all scoring range: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRuleDetails
Update a scoring range: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRuleDetails/{publicSectorPassingRuleDetailsUniqID}

Passing Rules

The passing rules resource is used to view, create, delete, or modify a passing rule. A passing rule provides pass and fail criteria to determine the result of an inspection.

Create a passing rule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRules
Delete a passing rule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}
Get a passing rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}
Get all passing rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRules
Update a passing rule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}

Passing Rules/Passing Rule Details

The passing rule details resource is used to view, create, delete, or modify a passing rule scoring range. There can be one or more scoring ranges for a given passing rule.

Create a passing rule scoring range: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}/child/PassingRuleDetail
Delete a passing rule scoring range: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}/child/PassingRuleDetail/{PassingRuleDetailUniqID}
Get a passing rule scoring range: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}/child/PassingRuleDetail/{PassingRuleDetailUniqID}
Get all passing rule scoring ranges: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}/child/PassingRuleDetail
Update a passing rule scoring range: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}/child/PassingRuleDetail/{PassingRuleDetailUniqID}

Pay Case Fees

The pay case fee resource is used to view or modify a case fee. Case fees are used in Code Enforcement cases.

Get a case fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPayCaseFees/{FeeRecordKey}
Get all case fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPayCaseFees
Update a case fee: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPayCaseFees/{FeeRecordKey}

Payment Cart Records

The payment cart records resource is used to view fee and applicant information associated with items in the payment cart.

Get all items from the cart record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordCarts
Get an item from the cart record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordCarts/{LnpRecordKey}

Payment Carts

The payment carts resource is used by public users to manage fees for payment by adding permits to the cart that are ready for checkout and removing permits from the cart as needed.

Check out selected permits and create a checkout ID: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts
Create an item in the payment cart: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts
Delete an item from payment cart: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}
Get a payment cart item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}
Get all payment cart items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts
Send confirmation of the payment status to payment cart.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts
Update an item in the payment cart: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}

Payment Carts/Associated Projects

The associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart.

Get all projects associated with permit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}/child/AssociatedProject
Get one project associated with permit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}/child/AssociatedProject/{AssociatedProjectUniqID}

Payment Communications

The payment communications resource is used to view payment data used in payment notifications.

Get all payment data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCommunications
Get payment data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCommunications/{PaymentHistoryKey}

Payment Groups

The payment groups resource is used to view the payment history groups.

Get a payment group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentGroups/{PaymentHistoryKey}
Get all payment groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentGroups

Payment Options

The payment options resource is used to view the available payment options that are set up for agencies and departments.

Get a payment option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptions/{publicSectorPaymentOptionsUniqID}
Get all payment options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptions

Payment Records

The payment records resource is used to view the payment records.

Get a payment record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentRecords/{publicSectorPaymentRecordsUniqID}
Get all payment records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentRecords

Payment Refunds

The payment refunds resource is used to view or create payment refunds.

Create a set of refund data: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds
Get a set of refund data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}
Get all refund data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds
Update a payment refund: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}

Payment Refunds/Payment Refund Lines

The payment refund lines resource is used to view or create payment refund detail lines.

Create a refund line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}/child/RefundHistoryLine
Get a refund line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}/child/RefundHistoryLine/{RefundHistoryLineUniqID}
Get all refund lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}/child/RefundHistoryLine

Payments

The payments resource is used to view or create payment records.

Create payment data: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPayments
Get all payment data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPayments
Get payment data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}

Payments/Payment Lines

The payment lines resource is used to view or create payment detail lines.

Create a payment line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLine
Get a payment line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLine/{PaymentHistoryLineUniqID}
Get all payment lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLine

Permit Agency Options

The permit agency options resource is used to define agency options on the permits landing pages for public users.

Create a permit agency options definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions
Delete a permit agency options definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions/{publicSectorPermitAgencyOptionsUniqID}
Get a permit agency options definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions/{publicSectorPermitAgencyOptionsUniqID}
Get all permit agency options definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions
Update a permit agency options definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions/{publicSectorPermitAgencyOptionsUniqID}

Permit Conditions

The permit conditions resource is used to view conditions applied to a permit and permit information including permit type, permit ID, and applicant profile ID.

Get a permit condition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordConditions/{ConditionKey}
Get all permit conditions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordConditions

Permit Contacts

The permit contacts resource is used to view the list of contacts associated with a permit.

Get a list of permit contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitContacts/{publicSectorPermitContactsUniqID}
Get all lists of permit contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitContacts

Permit Expiry Communications

The permit expiry communication resource is used to record attributes related to a permit when an expiry communication request is received.

Get a permit expiry communication item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitExpiryCommunications/{LnpRecordKey}
Get all permit expiry communication items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPermitExpiryCommunications

Permit Inspections

The inspections resource is used to capture all permit inspections and display the inspection information to the user, including inspection type, inspection ID, scheduling time, the user who created the inspection, and so on.

Create an inspection: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspections
Get all inspections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspections
Get an inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionId}
Update an inspection: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionId}

Permit Inspections/Permits Related Inspections

The permits related inspections resource is used to capture the main inspections associated with other inspection transactions, and display the inspection ID, related inspection ID information to the user.

Create a related inspection: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionId}/child/InsuranceRelatedInspectionView
Delete a related inspection: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionId}/child/InsuranceRelatedInspectionView/{InsuranceRelatedInspectionViewUniqID}
Get a related inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionId}/child/InsuranceRelatedInspectionView/{InsuranceRelatedInspectionViewUniqID}
Get all related inspections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionId}/child/InsuranceRelatedInspectionView
Update a related inspection: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionId}/child/InsuranceRelatedInspectionView/{InsuranceRelatedInspectionViewUniqID}

Person Details

The person details resource is used to find the agency staff and their job functions, along with the attribute assignments and other HR attributes.

Get a person: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonDetails/{UserId}
Get all persons: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonDetails

Person Details/Person Job Attributes

The person job attributes resource is used to list the job attributes and their values assigned to a person.

Get a job function: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonDetails/{UserId}/child/PersonJobFuncAssignmentP/{PersonJobFuncAssignmentPUniqID}
Get all job functions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonDetails/{UserId}/child/PersonJobFuncAssignmentP

Person Job Attributes

The person job attributes resource is used to list the job attributes and their values assigned to a person.

Create a set of job attributes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctionSections
Delete a job attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctionSections/{publicSectorPersonJobFunctionSectionsUniqID}
Get a job attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctionSections/{publicSectorPersonJobFunctionSectionsUniqID}
Get all job attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctionSections
Update a job attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctionSections/{publicSectorPersonJobFunctionSectionsUniqID}

Person Job Functions

The person job functions resource is used to view the list of job functions that are assigned to a person.

Create a set of employees: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions
Delete a job function: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}
Get a job function: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}
Get all employees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions
Update a job function: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}

Person Job Functions/Person Job Attributes

The person job attributes resource is used to list the job attributes and their values assigned to a person.

Create a job attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}/child/PersonJobFuncAssignments
Delete a job attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}
Get a job attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}
Get all job attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}/child/PersonJobFuncAssignments
Update a job attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}

Person Notifications

The person notifications resource is used to send notifications to the agency staff with the links to various mobile applications that they have access to.

Create a set of notifications: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonNotifications
Get a notification: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonNotifications/{PersonId}
Get all notifications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonNotifications
Update a notification: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonNotifications/{PersonId}

Person Roles

The person roles resource is used to view the list of roles assigned to a person.

Create a set of role assignments to the person: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles
Delete a role assigned to the person: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles/{publicSectorPersonRolesUniqID}
Get a role assigned to the person: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles/{publicSectorPersonRolesUniqID}
Get all roles assigned to the person: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles
Process person and associated roles.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles

Personal Profiles

The personal profiles resource is used to view, create, or modify a registered user personal profile.

Create a personal profile of a registered user: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles
Get a personal profile of a registered user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}
Get all personal profiles of a registered user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles
Update a personal profile of a registered user: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}

Personal Profiles/Profile Emails

The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.

Create a set of email contact points for the user profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileContactPointEmail
Get all email contact points for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileContactPointEmail
Get an email contact point for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileContactPointEmail/{ContactPtId}
Update an email contact point for the user profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileContactPointEmail/{ContactPtId}

Personal Profiles/Profile Locations

The profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.

Create a set of contact address for the user profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileLocation
Get a contact address for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileLocation/{LocationSiteId}
Get all contact addresses for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileLocation
Update a contact address for the user profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileLocation/{LocationSiteId}

Personal Profiles/Profile Phones

The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.

Create a set of phone contact points for the user profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileContactPointPhone
Get a phone contact point for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileContactPointPhone/{ContactPtId}
Get all phone contact points for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileContactPointPhone
Update a phone contact point for the user profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileContactPointPhone/{ContactPtId}

Persons

The persons resource is used to list all the persons in the agency.

Get a person: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersons/{publicSectorPersonsUniqID}
Get all persons: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersons

Persons/Person Job Attributes

The person job attributes resource is used to list the job attributes and their values assigned to a person.

Get a job function: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersons/{publicSectorPersonsUniqID}/child/PersonJobFuncAssignmentP/{PersonJobFuncAssignmentPUniqID}
Get all job functions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPersons/{publicSectorPersonsUniqID}/child/PersonJobFuncAssignmentP

Phone Country Codes

Use the phone country codes resource to view phone country codes.

Get a phone country code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPhoneCountryCodes/{publicSectorPhoneCountryCodesUniqID}
Get all phone country codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPhoneCountryCodes

Plan Review All Comments

The plan review all comments resource is used to return plan review comments, including those at the cycle and reviewer levels.

Get a plan review comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewAllComments/{CommentId}
Get all plan review comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewAllComments

Plan Review Comments

The plan review comments resource is used to view, create, delete, or modify plan review comments for a plan review.

Create a permit plan review comment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments
Delete a permit plan review comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments/{publicSectorPlanReviewCommentsUniqID}
Get a permit plan review comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments/{publicSectorPlanReviewCommentsUniqID}
Get all permit plan review comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments
Update a permit plan review comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments/{publicSectorPlanReviewCommentsUniqID}

Plan Review Communications

The plan review communications resource is used to capture attributes related to plan review communications.

Get a plan review communication item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewCommunications/{publicSectorPlanReviewCommunicationsUniqID}
Get all plan review workflow communication items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewCommunications

Plan Review Cycles

The plan review cycles resource is used to view cycles for a plan review.

Get a permit plan review's cycle information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewCycles/{PlanReviewKey}
Get all cycle information for a permit plan review: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewCycles

Plan Review Decisions

The plan review decisions resource is used to view and update plan review decisions. The plan review decision shows the decision of a plan review cycle or the decision made by a plan reviewer on a plan review cycle.

Get a plan review decision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDecisions/{publicSectorPlanReviewDecisionsUniqID}
Get all plan review decisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDecisions
Update a plan review decision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDecisions/{publicSectorPlanReviewDecisionsUniqID}

Plan Review Documents

The plan review documents resource is used to view plan review documents.

Get a plan review document: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDocuments/{DocumentFileKey}
Get all plan review documents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDocuments

Plan Review File Reviewers

Use the plan review file reviewers resource to view, update, create, and delete plan review file reviewers.

Create a plan review file reviewer: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFileReviewers
Get a plan review file reviewer: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFileReviewers/{DocumentUserKey}
Get all plan review file reviewers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFileReviewers
Update a plan review file reviewer: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFileReviewers/{DocumentUserKey}

Plan Review Files

Use the plan review files resource to view, update, create, and delete plan review files.

Create a plan review file: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles
Delete a plan review file: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}
Get a plan review file: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}
Get all plan review files: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles
Update a plan review file: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}

Plan Review Files/Plan Review File Reviewers

Use the plan review file users resource to view, update, create, and delete plan review file reviewers.

Create a plan review file reviewer: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser
Delete a plan review file reviewer: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser/{DocumentUserKey}
Get a plan review file reviewer: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser/{DocumentUserKey}
Get all plan review file reviewers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser
Update a plan review file reviewer: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser/{DocumentUserKey}

Plan Review Maximum Cycles

The plan review maximum cycles resource is used to view the most current plan review cycle for a plan review.

Get a permit plan review's most current cycle: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewMaximumCycles/{PlanReviewKey}
Get all cycle information for a permit plan review's most current cycle: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewMaximumCycles

Plan Review Statuses

The plan review status resource is used to view and update plan review statuses. A plan review status shows the status of a plan review cycle or the status made by a plan reviewer on a plan review cycle.

Get a plan review status: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewStatuses/{publicSectorPlanReviewStatusesUniqID}
Get all plan review statuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewStatuses
Update a plan review status: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewStatuses/{publicSectorPlanReviewStatusesUniqID}

Plan Review Workflow Tasks

The plan review workflow tasks resource is used to capture plan review attributes used in the workflow process.

Get a plan review workflow task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewWorkFlowTasks/{publicSectorPlanReviewWorkFlowTasksUniqID}
Get all plan review workflow task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewWorkFlowTasks

Plan Reviewer Comments

The plan reviewer comments resource is used to view, create, delete, or modify plan reviewer comments for a plan review.

Create a plan reviewer's comments for a permit plan review: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments
Delete a plan reviewer's comments for a permit plan review: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments/{publicSectorPlanReviewerCommentsUniqID}
Get a plan reviewer's comments for a permit plan review: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments/{publicSectorPlanReviewerCommentsUniqID}
Get all plan reviewer's comments for a permit plan review: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments
Update a plan reviewer's comments for a permit plan review: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments/{publicSectorPlanReviewerCommentsUniqID}

Plan Reviewer Departments

Use the plan reviewer departments resource to view plan reviewer departments that are assigned to an agency user. These values are user-defined.

Create a plan reviewer department: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments
Delete a plan reviewer department: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments/{publicSectorPlanReviewerDepartmentsUniqID}
Get a plan reviewer department: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments/{publicSectorPlanReviewerDepartmentsUniqID}
Get all plan reviewer departments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments
Update a plan reviewer department: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments/{publicSectorPlanReviewerDepartmentsUniqID}

Plan Reviewers

The plan reviewers resource is used to view, create, delete, or modify plan reviewers for a plan review.

Copy plan reviewers.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers
Create a plan reviewer for a permit plan review: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers
Delete a plan reviewer for a permit plan review: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers/{PlanReviewUserKey}
Get a plan reviewer for a permit plan review: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers/{PlanReviewUserKey}
Get all plan reviewers for a permit plan review: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers
Update a plan reviewer for a permit plan review: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers/{PlanReviewUserKey}

Plan Reviews

Use the plan reviews resource to view, update, create, and delete a plan review cycle.

Create a plan review cycle: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews
Delete a plan review cycle: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}
Get a plan review cycle: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}
Get all plan review cycles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews
Update a plan review cycle: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}

Plan Reviews/Markup Sessions

Use the markup sessions resource to view, update, create, and delete a markup session.

Create a markup session: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions
Delete a markup session: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions/{BluebeamSessionsUniqID}
Get a markup session: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions/{BluebeamSessionsUniqID}
Get all markup sessions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions
Update a markup session: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions/{BluebeamSessionsUniqID}

Planning and Zoning Application Expiry Communications

The planning and zoning application expiry communication resource is used to record attributes related to a planning and zoning application when an expiry communication request is received.

Get a planning and zoning application expiry communication item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPzExpiryCommunications/{LnpRecordKey}
Get all planning and zoning application expiry communication items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPzExpiryCommunications

Planning and Zoning Workflow Communications

The planning and zoning workflow communication resource is used to capture attributes related to workflow when a planning and zoning workflow communication request is received.

Get a planning and zoning workflow communication item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPzWorkflowCommunications/{LnpRecordKey}
Get all planning and zoning workflow communication items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPzWorkflowCommunications

Policies

The policies resource is used to capture all data security object policies. A policy uniquely identifies the combination of a data security object with an instance and a privilege. This combination is granted to a role. Data security policies secure the database objects of an enterprise application.

Create a data security policy: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPolicies
Delete a data security policy: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPolicies/{publicSectorPoliciesUniqID}
Get a data security policy: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPolicies/{publicSectorPoliciesUniqID}
Get all data security policies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPolicies
Update a data security policy: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPolicies/{publicSectorPoliciesUniqID}

Policy Dates

The policy dates resource is used to retrieve the next applicable date for the given time rule and its priority.

Create a set of time rule based policy dates: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementPolicyDates
Delete a time rule based policy date: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementPolicyDates/{publicSectorCodeEnforcementPolicyDatesUniqID}
Get a time rule based policy date: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementPolicyDates/{publicSectorCodeEnforcementPolicyDatesUniqID}
Get all time rule based policy dates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementPolicyDates
Update a time rule based policy date: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementPolicyDates/{publicSectorCodeEnforcementPolicyDatesUniqID}

Popular Applications

The popular applications resource is used to view the types of applications that were used most often in the past month.

Get all application types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPopularApplications
Get an application type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPopularApplications/{RecordTypeId}

Pre-Application Meeting Communications

Pre-Application meeting communications resource is used to configure the meeting notification templates.

Get a Pre-Application meeting attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingCommunications/{publicSectorPreappMeetingCommunicationsUniqID}
Get all Pre-Application meeting attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingCommunications

Pre-Application Meeting Configurations

The public sector Pre-application meeting configurations resource is used to configure the meeting setup for Planing and Zoning.

Create a set of Pre-application meeting setup attributes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs
Delete a Pre-application meeting setup attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs/{publicSectorPreappMeetingConfigsUniqID}
Get a Pre-application meeting setup attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs/{publicSectorPreappMeetingConfigsUniqID}
Get all Pre-application meeting setup attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs
Update a Pre-application meeting setup attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs/{publicSectorPreappMeetingConfigsUniqID}

Privileges

The privileges resource is used to capture all data security privileges. The data security privileges can be of these types: standard, custom, redaction, and column authorization.

Create a data security privilege: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPrivileges
Delete a data security privilege: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPrivileges/{publicSectorPrivilegesUniqID}
Get a data security privilege: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPrivileges/{publicSectorPrivilegesUniqID}
Get all data security privileges: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPrivileges
Update a data security privilege: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPrivileges/{publicSectorPrivilegesUniqID}

Process Audits

The process audits resource is used to retrieve all the workflow tasks pertaining to a process.

Get all audits for a process: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProcessAudits
Get an audit for a process: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProcessAudits/{taskId}

Process Audits/History Process Audits

The history process audits resource is used to retrieve the history of a particular workflow task.

Get all audit history for a process: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProcessAudits/{taskId}/child/ProcessAuditHistory
Get the audit history for a process: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProcessAudits/{taskId}/child/ProcessAuditHistory/{ProcessAuditHistoryUniqID}

Profile Emails

The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.

Create a set of email contact points for the user profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileContactEmails
Get all email contact points for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileContactEmails
Get an email contact point for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileContactEmails/{ContactPtId}
Update an email contact point for the user profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileContactEmails/{ContactPtId}

Profile Locations

The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.

Create a set of contact addresses for the user profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileLocations
Get a contact address for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileLocations/{LocationSiteId}
Get all contact addresses for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileLocations
Update a contact address for the user profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileLocations/{LocationSiteId}

Profile Notifications

Use the profile notifications resource to view registered public user profile information that can be used in notifications.

Get a single profile for a registered public user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileNotifications/{ProfileId}
Get all of a registered public user's profiles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileNotifications

Profile Phones

The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.

Create a set of phone contact points for the user profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileContactPhones
Get a phone contact point for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileContactPhones/{ContactPtId}
Get all phone contact points for the user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileContactPhones
Update a phone contact point for the user profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProfileContactPhones/{ContactPtId}

Programs

The program resource is used to view, create, delete or modify a program. Program identifies a set of activities performed by an agency to accomplish a specific goal which is associated with an accounting transaction.

Create a program: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPrograms
Delete a program: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPrograms/{publicSectorProgramsUniqID}
Get a program: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPrograms/{publicSectorProgramsUniqID}
Get all programs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPrograms
Update a program: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPrograms/{publicSectorProgramsUniqID}

Project APO Searches

The public sector project APO searches resource is used to get the project details from the APO search.

Get a project information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAPOSearches/{publicSectorProjectAPOSearchesUniqID}
Get all project information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAPOSearches

Project Addresses

The project addresses resource is used to create, view, and update the parcel address added to a project.

Create a set of project parcel addresses: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses
Delete a project parcel address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses/{AddressKey}
Get a project parcel address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses/{AddressKey}
Get all project parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses
Update a project parcel address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses/{AddressKey}

Project Attachments

The project attachments resource is used to add, update, view or delete an attachment to a project.

Create a set of project attachment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments
Delete a project attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}
Get a project attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}
Get all project attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments
Update a project attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}

Project Attachments/Project Attachment Accessors

The project attachment accessor resource is used for displaying file-related information such as file name and file URL.

Create a set of project attachment accessors: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor
Delete a project attachment accessor: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{AttachedDocumentId}
Get a project attachment accessor: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{AttachedDocumentId}
Get all project attachment accessors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor
Update a project attachment accessor: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{AttachedDocumentId}

Project Attachments/Project Attachment Accessors/Project Attachment Revisions

The project attachment revisions resource is used for displaying the historical information for an attachment.

Create a set of project attachment revisions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete a project attachment revision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get a project attachment revision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all project attachment revisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Update a project attachment revision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Project Contacts

The project contact resource is used to create, update, and view a contact that is added to a project.

Create a set of project contacts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts
Delete a project contact: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts/{ContactKey}
Get a project contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts/{ContactKey}
Get all project contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts
Update a project contact: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts/{ContactKey}

Project Fees

The project fees resource is used to view the list of permits that are assigned to a project.

Get a project permit fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectFees/{publicSectorProjectFeesUniqID}
Get all project permits fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectFees

Project Lists

The projects resource is used to create, view, or update a project. A project is an aggregrate of all the information related to a record for permits, planning and zoning, and so on.

Create a project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects
Get a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}
Get all projects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects
Update a project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}

Project Lists/Project Contacts

The project contacts resource is used to create, view, or update the contacts related to a project.

Create a project contact: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectContact
Get a project contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectContact/{ContactKey}
Get all project contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectContact
Update a project contact: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectContact/{ContactKey}

Project Lists/Project Parcels

The project parcels resource is used to create, view, or update the parcels related to a project.

Create a project parcel: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel
Delete a project parcel: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}
Get a project parcel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}
Get all project parcels: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel
Update a project parcel: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}

Project Lists/Project Parcels/Project Addresses

The resource is used to create, view, or update the project parcel addresses related to a project.

Create a project parcel address: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress
Delete a project parcel address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress/{AddressKey}
Get a project parcel address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress/{AddressKey}
Get all project parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress
Update a project parcel address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress/{AddressKey}

Project Lists/Project Parcels/Project Parcel Owners

The resource is used to create, view, or update the project parcel owners related to a project.

Create a project parcel owner: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner
Delete a project parcel owner: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}
Get a project parcel owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}
Get all project parcel owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner
Update a project parcel owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}

Project Parcel Owners

The project parcel owners resource is used to create, view, or update the parcel owners added to a project.

Create a set of project parcel owners: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcelOwners
Delete a project parcel owner: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcelOwners/{OwnerKey}
Get a project parcel owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcelOwners/{OwnerKey}
Get all project parcel owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcelOwners
Update a project parcel owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcelOwners/{OwnerKey}

Project Parcels

The project parcels resource is used to create, view, and update the parcels related to a project.

Create a set of project parcels: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels
Delete a project parcel: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}
Get a project parcel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}
Get all project parcels: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels
Update a project parcel: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}

Project Parcels/Project Addresses

The project addresses resource is used to create, view, and update the project parcel addresses related to a project.

Create a set of project parcel addresses: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress
Delete a project parcel address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress/{AddressKey}
Get a project parcel address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress/{AddressKey}
Get all project parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress
Update a project parcel address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress/{AddressKey}

Project Parcels/Project Parcel Owners

The project parcel owners resource is used to create, view, and update the project parcel owners related to a project.

Create a set of project parcel owners: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwner
Delete a project parcel owner: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}
Get a project parcel owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}
Get all project parcel owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwner
Update a project parcel owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}

Project Permit Lists

The public sector project permit lists resource is used to view the permits that are assigned to a project.

Get a permit assigned to a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitLists/{publicSectorProjectPermitListsUniqID}
Get all permits assigned to a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitLists

Project Permit Type Fees

Project permit type fees resource is used to get the details of permits and their types, along with the fees associated with each permit.

Create a set of fee details for a permit: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitTypeFees
Delete a fee detail for a permit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitTypeFees/{ProjectCode}
Get a permit associated with a particular permit type and its fee details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitTypeFees/{ProjectCode}
Get all permits associated with a particular permit type and their fee details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitTypeFees
Update a fee detail for a permit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitTypeFees/{ProjectCode}

Project Record Fee Payments

The project record fee payments resource is used to view the individual fee items of the transactions that are assigned to a project.

Get a fee for the project record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}
Get all fees for the project record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments

Project Record Fee Payments/Record Fee Payments

The resource contains all the details related to the transaction fee item.

Create a fee row for the project record: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay
Delete a fee row for the project record: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay/{FeeRecordKey}
Delete more than one record on the fee records display: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay
Get a fee for the project record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay/{FeeRecordKey}
Get all fees for the project record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay
Update a fee row for the project record: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay/{FeeRecordKey}

Project Record Inspections

The project record inspections resource is used to view the list of all the inspections that belong to the transactions assigned to a project.

Get a project record inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordInspections/{publicSectorProjectRecordInspectionsUniqID}
Get all the project record inspections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordInspections

Project Records

The project records resource is used to associate a record to a project.

Create a set of record assignments in the project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecords
Delete a record assignment from the project: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecords/{publicSectorProjectRecordsUniqID}
Get a record assignment from the project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecords/{publicSectorProjectRecordsUniqID}
Get all record assignments from the project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecords
Update a record assignment in the project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectRecords/{publicSectorProjectRecordsUniqID}

Project Types

The project types resource is used to create, view, and update a project type.

Create a set project types: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes
Delete a project type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes/{publicSectorProjectTypesUniqID}
Get a project type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes/{publicSectorProjectTypesUniqID}
Get all project types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes
Update a project type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes/{publicSectorProjectTypesUniqID}

Prompt Conditions

The prompt conditions resource is used to prompt the users with the available conditions that can be applied against a transaction.

Get a condition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPromptConditions/{publicSectorPromptConditionsUniqID}
Get all conditions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPromptConditions

Property Conditions

Use the property conditions resource to view, create, modify, or delete property conditions.

Create a property condition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPropertyConditions
Delete a property condition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPropertyConditions/{publicSectorPropertyConditionsUniqID}
Get a property condition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPropertyConditions/{publicSectorPropertyConditionsUniqID}
Get all property conditions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPropertyConditions
Update a property condition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPropertyConditions/{publicSectorPropertyConditionsUniqID}

Property Types

Use the property types resource to view, create, modify, or delete property types.

Create a property type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPropertyTypes
Delete a property type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPropertyTypes/{publicSectorPropertyTypesUniqID}
Get a property type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPropertyTypes/{publicSectorPropertyTypesUniqID}
Get all property types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPropertyTypes
Update a property type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPropertyTypes/{publicSectorPropertyTypesUniqID}

Proxy Setups

Use the proxy setups resource to view, update, create, and delete settings for accessing secure map services using a proxy user.

Create a proxy setup: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProxySetups
Delete a proxy setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProxySetups/{publicSectorProxySetupsUniqID}
Get a proxy setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProxySetups/{publicSectorProxySetupsUniqID}
Get all proxy setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProxySetups
Update a proxy setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorProxySetups/{publicSectorProxySetupsUniqID}

Qualified Inspectors

The qualified inspectors resource returns a list of time slots, in half hour increments, for a specified date. For each time slot returned, there is one or more qualified inspectors available. To be qualified, the inspector must already be assigned the specified inspection type and district. To be an available time slot, the specified date should not be defined on the holiday calendar, if one exists, and the time slot should be within the time range defined for any inspection calendars for the specified inspection type and district, if any exist. The individual inspector is considered available if the time slot is within the time range(s) defined on his or her assigned work schedule(s). A time slot and its associated inspector can then be used to schedule and assign an inspection with the specified inspection type and district.

Get a qualified available inspector is not supported: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorQualifiedInspectors/{publicSectorQualifiedInspectorsUniqID}
Get all qualified available inspectors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorQualifiedInspectors

Rating Method Details

The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.

Create a rating range of scores: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethodDetails
Delete a rating range of scores: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethodDetails/{publicSectorRatingMethodDetailsUniqID}
Get a rating range of scores: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethodDetails/{publicSectorRatingMethodDetailsUniqID}
Get all rating score ranges: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethodDetails
Update a rating range of scores: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethodDetails/{publicSectorRatingMethodDetailsUniqID}

Rating Methods

The rating methods resource is used to view, create, delete, or modify a rating method. A rating method identifies the ways in which the object of inspection can be rated. For a given rating method, there can be one or more rating ranges. When using scoring for inspections, rating methods are required. Rating methods are used at the inspection type level and are not required at the checklist or checklist item levels.

Create a rating method: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods
Delete a rating method: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}
Get a rating method: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}
Get all rating methods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods
Update a rating method: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}

Rating Methods/Rating Method Details

The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.

Create a rating range of scores: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail
Delete a rating range of scores: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail/{RatingMethodDetailUniqID}
Get a rating range of scores: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail/{RatingMethodDetailUniqID}
Get all rating score ranges: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail
Update a rating range of scores: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail/{RatingMethodDetailUniqID}

Ready for Inspection Permits

The ready for inspection permits resource is used to view a list of permits that are ready to be inspected. This includes permits in Permit Issued, Inspection or About to Expire statuses.

Get a permit ready for inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionConsolePermits/{publicSectorInspectionConsolePermitsUniqID}
Get all permits ready for inspection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionConsolePermits

Recent Applications

The recent applications resource is used to view the most recently used application types for the current user. For registered public users, these are the most recent application types for the current profile. Recent application types are limited to ones that were used within the last year.

Get all application types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecentApplications
Get an application type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecentApplications/{publicSectorRecentApplicationsUniqID}

Recommended Permit Results for Anonymous Users

The recommended permit results resource is used to search the list of recommended permits. A guest user saves recommended permits and searches the list by using an acknowledgment number and email ID.

Get a recommended permit list: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaAnonymousResultHeaders/{OpaResultId}
Get all recommended permit lists: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaAnonymousResultHeaders

Recommended Permit Results for Anonymous Users/Recommended Permits

The recommeded permits are the permits saved by a guest user for review.

Get a permit list: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaAnonymousResultHeaders/{OpaResultId}/child/OpaResultList/{OpaResultListId}
Get all permit lists: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaAnonymousResultHeaders/{OpaResultId}/child/OpaResultList

Recommended Permit Results for Registered Users

The recommended permit results resource is used to view the recommended permits that were saved by registered public users. Users can review the saved recommended permits before applying for a permit.

Create a set of recommendation lists: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders
Delete a recommended list: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}
Get a recommended list: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}
Get all recommended lists: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders
Update a recommended list: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}

Recommended Permit Results for Registered Users/Recommended Permits

The recommended permits are the permits saved by a registered public user for review.

Create a set of permit lists: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}/child/OpaResultList
Delete a permit list: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}/child/OpaResultList/{OpaResultListId}
Get a permit list: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}/child/OpaResultList/{OpaResultListId}
Get all permit lists: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}/child/OpaResultList
Update a permit list: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}/child/OpaResultList/{OpaResultListId}

Recommended Permit Transfer Requests

The recommended permit transfer requests resource is used to transfer the list of recommended permits that were saved earlier by a guest user to the registered user profile. A registered public user saves the list for review.

Get a recommended list: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultTransferRequests/{OpaResultId}
Get recommended lists: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultTransferRequests
Update a recommended list: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaResultTransferRequests/{OpaResultId}

Record Attachments

The record attachments resource is used to view, create, delete, or modify attachments on permit records.

Create an attachment for a permit: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments
Delete an attachment for a permit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}
Get all attachments for a permit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments
Get an attachment for a permit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}
Update an attachment for a permit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}

Record Attachments/Record Attachment Accessors

The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL.

Create a permit attachment's file-related information: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor
Delete a permit attachment's file-related information: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{AttachedDocumentId}
Get a permit attachment's file-related information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{AttachedDocumentId}
Get all attachment file-related information for a permit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor
Update a permit attachment's file-related information: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{AttachedDocumentId}

Record Attachments/Record Attachment Accessors/Record Attachment Revisions

The record attachments revisions resource is used for displaying the historical information for a permit attachment.

Create an record attachment revision: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete a record attachment revision: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get a permit attachment revision: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all record attachment revisions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Update a record attachment revision: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Record Comments

The record comments resource is used to add comments to a permit.

Create a set of record comments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordComments
Delete a record comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordComments/{publicSectorRecordCommentsUniqID}
Get a record comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordComments/{publicSectorRecordCommentsUniqID}
Get all record comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordComments
Update a record comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordComments/{publicSectorRecordCommentsUniqID}

Record Extensions

The record extensions resource is used to view or modify the expiration date and the status of the record. Status values can be Pending, Submitted, and so on.

Get a record extension: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordExtensions/{LnpRecordKey}
Get all record extensions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordExtensions
Update a record extension: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordExtensions/{LnpRecordKey}

Record Lists

The record lists resource is used to capture all application records and display the application information to the user, including application type, application ID, applicant name or the user who created the record, property and parcel information, fees and payments, and so on.

Get a record and record parcel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}
Get all records, record parcels, and parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists

Record Lists/Business Locations

The business locations resource is used to view the business locations.

Get a business location: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessLocation/{LnpBusinessLocationKey}
Get all business locations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessLocation

Record Lists/Business Owners

The business owners resource is used to view the business owners.

Get a business owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessOwner/{LnpBusinessOwnersKey}
Get all business owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessOwner

Record Lists/Parcel Addresses

The parcel addresses resource is used to view the parcel addresses.

Copies the parcel address information.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress
Create a set of record parcel addresses: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress
Delete a record parcel address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress/{AddressKey}
Get a record parcel address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress/{AddressKey}
Get all record parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress
Update a record parcel address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress/{AddressKey}

Record Lists/Parcels

The record parcels resource is used to view the parcels that are associated with the application.

Copies the parcel information.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel
Get a record parcel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
Get all record parcels: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel

Record Lists/Parcels/Parcel Addresses

The parcel addresses resource is used to view the parcel addresses.

Copies the parcel address information.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
Create a set of record parcel addresses: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
Delete a record parcel address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
Get a record parcel address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
Get all record parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
Update a record parcel address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}

Record Parcel Addresses

Copies the record parcel address information of the application.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses
Create a set of record parcel addresses: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses
Delete a record parcel address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses/{AddressKey}
Get a record parcel address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses/{AddressKey}
Get all record parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses
Update a record parcel address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses/{AddressKey}

Record Parcel Owners

The record parcel owners resource is used to view, create, modify, or delete a record parcel owner. Record parcel owners are the owners of parcels or plots of real estate associated with a record.

Create a record parcel owner: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners
Delete a record parcel owner: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners/{OwnerKey}
Get a record parcel owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners/{OwnerKey}
Get all record parcel owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners
Update a record parcel owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners/{OwnerKey}

Record Parcels

The record parcels resource is used to view, create, modify, or delete a record parcel. Record parcels are parcels or plots of real estate associated with a record.

Copies the parcel information of the application.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels
Create a set of record parcels: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels
Delete a record parcel: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}
Get a record parcel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}
Get all record parcels: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels
Update a record parcel: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}

Record Parcels with Parcel Addresses

The record parcels with parcel addresses resource is used to view a record parcel and its parcel address together.

Get a record parcel with its parcel address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressCrosses/{publicSectorRecordParcelAddressCrossesUniqID}
Get all record parcels with their parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressCrosses

Record Parcels/Record Parcel Addresses

Copies the record parcel address information of the application.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress
Create a record parcel address: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress
Delete a record parcel address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress/{AddressKey}
Get a record parcel address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress/{AddressKey}
Get all record parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress
Update a record parcel address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress/{AddressKey}

Record Parcels/Record Parcel Owners

The record parcel owners resource is used to view, create, modify, or delete a record parcel owner. Record parcel owners are the owners of parcels or plots of real estate associated with a record.

Create a record parcel owner: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelOwner
Delete a record parcel owner: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelOwner/{OwnerKey}
Get a record parcel owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelOwner/{OwnerKey}
Get all record parcel owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelOwner
Update a record parcel owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelOwner/{OwnerKey}

Record Queries

The record queries resource is used to capture all application records and display the application information to the user, including application type, application ID, applicant name or the user who created the record, workflow process ID, department, and so on.

Get a permit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}
Get all permits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries

Record Queries/Record Parcel Queries

The record parcel queries resource is used to view the parcels that are associated with the application.

Copy the parcel information of the application: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel
Create a permit parcel: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel
Delete a permit parcel: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
Get a permit parcel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
Get all permit parcels: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel
Update a permit parcel: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}

Record Statuses

The record statuses resource is used to view, create, modify, or delete a record status. A record status is a configurable status value that maps a meaningful status for the agency to a specific predefined system status for an application record. A record could be a permit, license, and so on.

Create a record status: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses
Delete a record status: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses/{publicSectorRecordStatusesUniqID}
Get a record status: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses/{publicSectorRecordStatusesUniqID}
Get all record statuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses
Update a record status: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses/{publicSectorRecordStatusesUniqID}

Record Type Display Group Lines

The record type display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line value indicates a record type included in a display group. A record type can be a permit or license.

Create a record type display group line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLines
Delete a record type display group line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLines/{publicSectorDisplayGroupLinesUniqID}
Get a record type display group line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLines/{publicSectorDisplayGroupLinesUniqID}
Get all record type display group lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLines
Update a record type display group line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLines/{publicSectorDisplayGroupLinesUniqID}

Record Type Display Groups

The display groups resource is used to view, create, modify, or delete a display group. A display group is a set of record types organized logically from which the public user can select the desired item. A record type can be a permit, a license, and so on.

Create a record type display group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups
Delete a record type display group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}
Get a record type display group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}
Get all record type display groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups
Update a record type display group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}

Record Type Display Groups/Record Type Display Group lines

The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group.

Create a record type display group line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine
Delete a record type display group line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine/{DisplayGroupLineUniqID}
Get a record type display group line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine/{DisplayGroupLineUniqID}
Get all record type display group lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine
Update a record type display group line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine/{DisplayGroupLineUniqID}

Record Type Plan Reviewer Departments

Use the record type plan reviewer departments resource to view plan reviewer departments that are assigned to an agency user. These values are user-defined.

Create a plan reviewer department for a permit type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePlanReviewerDepartments
Delete a plan reviewer department for a permit type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePlanReviewerDepartments/{publicSectorRecordTypePlanReviewerDepartmentsUniqID}
Get all plan reviewer departments for a permit type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePlanReviewerDepartments
Get plan reviewer departments for a permit type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePlanReviewerDepartments/{publicSectorRecordTypePlanReviewerDepartmentsUniqID}

Record Type Prompts

The record type prompts resource is used to list all the active types of permits, planning applications, and business licenses.

Get a record type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePrompts/{RecordTypeId}
Get all record types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePrompts

Record Types

The record type resource is used to view, create, modify, or delete a record type. A record type establishes the types of applications supported by an agency.

Create a record type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes
Get a record type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}
Get all record types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes
Update a record type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}

Record Types/Record Type Plan Reviewer Departments

The record type plan reviewer departments resource is used to view, create, modify, or delete a plan reviewer department associated with a record type. Plan reviewer departments are used for plan reviews.

Create a record type plan reviewer department: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment
Delete a record type plan reviewer department: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment/{RecordTypePlanReviewerDepartmentUniqID}
Get a record type plan reviewer department: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment/{RecordTypePlanReviewerDepartmentUniqID}
Get all record type plan reviewer departments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment
Update a record type plan reviewer department: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment/{RecordTypePlanReviewerDepartmentUniqID}

Record Types/Related Record Types

The related record types resource is used to view, create, modify, or delete a related record type. Related record types are record types that are associated with a main record type.

Create a related record type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec
Delete a related record type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec/{RelatedRecUniqID}
Get a related record type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec/{RelatedRecUniqID}
Get all related record types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec
Update a related record type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec/{RelatedRecUniqID}

Record Workflow Comments

The record workflow comment resource is used to capture all workflow comments and display the workflow comment information to the user.

Create a collection of records from workflow comments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordWorkflowComments
Delete a record from workflow comments: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordWorkflowComments/{publicSectorRecordWorkflowCommentsUniqID}
Get a record from workflow comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordWorkflowComments/{publicSectorRecordWorkflowCommentsUniqID}
Get all records from workflow comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordWorkflowComments
Patch a record from workflow comments: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordWorkflowComments/{publicSectorRecordWorkflowCommentsUniqID}

Records

The records resource is used to view, create, modify, or delete a record. Note: The standard actions are not available in the records resource. You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Create a record: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords
Delete a record: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}
Get a record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}
Get all records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords
Update a record: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}

Records/Contact Lists

The contact list resource is used to view, create, modify or delete a contact list. A contact list indicates the contact information associated with a record. Note: The standard actions are not available in the records resource. You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Create a contact: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList
Delete a contact: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
Get a contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
Get all contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList
Update a contact: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList/{ContactKey}

Records/Field Groups

The field groups resource is used to view, create, modify, or delete a child field of record. Note: The standard actions are not available in the records resource. You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Create a field group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/FieldGroups
Delete a field group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/FieldGroups/{LnpRecordKey2}
Get a field group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/FieldGroups/{LnpRecordKey2}
Get all field groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/FieldGroups
Update a field group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/FieldGroups/{LnpRecordKey2}

Records/Record Comments

The record comments resource is used to add comments to a permit. Note: The standard actions are not available in the records resource. You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Create a record comment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment
Delete a record comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}
Get a record comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}
Get all record comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment
Update a record comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}

Records/Record Parcel Address Owners

The record parcel owners resource is used to view, create, modify, or delete a record parcel address owner. Record parcel address owners are the owners of parcel address or plots of real estate associated with a record. Note: You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Create a set of records: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner
Delete a record parcel address owner: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}
Get a record parcel address owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}
Get all records of parcel address owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner
Update a record parcel address owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}

Records/Record Parcels

The record parcels resource is used to view, create, modify, or delete a record parcel. Record parcels are parcels or plots of real estate associated with a record. Note: The standard actions are not available in the records resource. You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Copies the parcel information.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel
Create a record parcel: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel
Delete a record parcel: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
Get a record parcel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
Get all record parcels: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel
Update a record parcel: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}

Records/Record Parcels/Record Parcel Addresses

The record parcel addresses resource is used to view, create, modify, or delete a record parcel address. Record parcel addresses are the street addresses of parcels or plots of real estate associated with a record. Note: The standard actions are not available in the records resource. You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Copies the parcel address information.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
Create a record parcel address: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
Delete a record parcel address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
Get a record parcel address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
Get all record parcel addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
Update a record parcel address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}

Records/Record Parcels/Record Parcel Owners

The record parcel owners resource is used to view, create, modify, or delete a record parcel owner. Record parcel owners are the owners of parcels or plots of real estate associated with a record. Note: The standard actions are not available in the records resource. You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Create a record parcel owner: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner
Delete a record parcel owner: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{OwnerKey}
Get a record parcel owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{OwnerKey}
Get all record parcel owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner
Update a record parcel owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{OwnerKey}

Records/RecordAuthorizedAgents

The record record authorized agent resource is used to view, create, modify, or delete a record authorized agent. Note: You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Create a set of authrorized agents: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent
Delete an authorized agent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent/{LnpAuthorizedAgntKey}
Get all records of authorized agents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent
Get an authorized agent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent/{LnpAuthorizedAgntKey}
Update an authorized agent: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent/{LnpAuthorizedAgntKey}

Records/RecordContractorLicenses

The record contractor license resource is used to view, create, modify, or delete a record contractor license. Note: You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Create a set of contractor license: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense
Delete a record contractor license: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}
Get all records of contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense
Get an record contractor license: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}
Update a record contractor license: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}

Records/RecordContractorLicenses/RecordContractorLicFacts

The record contractor license fact resource is used to view, create, modify, or delete a record contractor license fact. A contractor license fact indicates lincense fact information associated with contractor license. Note: You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Create a set of contractor license fact: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact
Delete a record contractor license fact: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact/{LnpLicenseFactKey}
Get all records of contractor license fact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact
Get an record contractor license fact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact/{LnpLicenseFactKey}
Update a record contractor license fact: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact/{LnpLicenseFactKey}

Records/RecordContractorLicenses/RecordContractorLicInsurances

The record contractor license Insurance resource is used to view, create, modify, or delete a record contractor license Insurance. A contractor license Insurance indicates lincense Insurance information associated with contractor license. Note: You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Create a set of contractor license insurance: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance
Delete a record contractor license insurance: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}
Get all records of contractor license insurance: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance
Get an record contractor license insurance: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}
Update a record contractor license insurance: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}

Records/Workflow References

The workflow references resource is used to view, create, modify, or delete a workflow reference. Workflow references are the references between process instances from Oracle Autonomous Integration Cloud and the Public Sector Community Development service. Note: The standard actions are not available in the records resource. You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Create a workflow reference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference
Delete a workflow reference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference/{WorkflowReferenceUniqID}
Get a workflow reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference/{WorkflowReferenceUniqID}
Get all workflow references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference
Update a workflow reference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference/{WorkflowReferenceUniqID}

Referral Bodies

The referral bodies resource is used to view the referral bodies that are configured for use within the agency.

Create a set of referral bodies: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorReferralBodies
Get a referral body: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorReferralBodies/{ReferralCode}
Get all related referral bodies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorReferralBodies
Update a referral body: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorReferralBodies/{ReferralCode}

Refund Records

The refunds records resource is used to view refund records.

Get a refund record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRefundRecords/{RefundHistoryKey}
Get all refund records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRefundRecords

Refund Records/Refund Lines

The refund lines resource is used to view refund detail lines.

Get a refund record line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRefundRecords/{RefundHistoryKey}/child/RefundRecordsLine/{RefundRecordsLineUniqID}
Get all refund record lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRefundRecords/{RefundHistoryKey}/child/RefundRecordsLine

Related Record Types

The related record type resource is used to view, create, modify, or delete a related record type. Related record types are record types that are related to a single record type.

Create a related record type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedRecordTypes
Delete a related record type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedRecordTypes/{publicSectorRelatedRecordTypesUniqID}
Get a related record type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedRecordTypes/{publicSectorRelatedRecordTypesUniqID}
Get all related record types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedRecordTypes
Update a related record type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedRecordTypes/{publicSectorRelatedRecordTypesUniqID}

Related Transaction Queries

The related transaction queries resource is used to get the list of all direct and indirect related transactions for an application.

Get a related transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactionQueries/{publicSectorRelatedTransactionQueriesUniqID}
Get all related transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactionQueries

Related Transactions

Related transactions resource is used to link and unlink transactions that are associated to a Pre-Application.

Create a set of related transactions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions
Delete a related transaction: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions/{publicSectorRelatedTransactionsUniqID}
Get a related transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions/{publicSectorRelatedTransactionsUniqID}
Get all related transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions
Update a related transaction: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions/{publicSectorRelatedTransactionsUniqID}

Review Summary Comments

The review summary comments resource is used to maintain the review comments of the pre-application.

Create a set of review summary comments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments
Delete a review summary comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments/{publicSectorReviewSummaryCommentsUniqID}
Get a review summary comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments/{publicSectorReviewSummaryCommentsUniqID}
Get all review summary comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments
Update a review summary comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments/{publicSectorReviewSummaryCommentsUniqID}

Role Definitions

The role definitions resource is used to view the list of roles that can be assigned in the system.

Create a set of role definitions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions
Delete a role definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions/{publicSectorRoleDefinitionsUniqID}
Get a role definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions/{publicSectorRoleDefinitionsUniqID}
Get all role definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions
Update a role definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions/{publicSectorRoleDefinitionsUniqID}

Scheduled Hearings

The scheduled hearing resource is used to view a scheduled hearing. Hearings are used in planning and zoning applications.

Get a scheduled hearing: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings/{publicSectorScheduledHearingsUniqID}
Get all scheduled hearings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings

Scheduled Hearings/Cancel Accesses

The cancel access resource is used to view the cancel access of a scheduled hearing. Cancel access is to let you know if you are allowed to cancel a scheduled hearing.

Get all cancel accesses of a scheduled hearing: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings/{publicSectorScheduledHearingsUniqID}/child/CancelAccess
Get cancel access of a scheduled hearing: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings/{publicSectorScheduledHearingsUniqID}/child/CancelAccess/{LnpRecordKey}

Scheduled Hearings/Manage Accesses

The manage access resource is used to view the manage access of a scheduled hearing. Manage access is to let you know your access to manage a scheduled hearing.

Get all manage accesses of a scheduled hearing: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings/{publicSectorScheduledHearingsUniqID}/child/ManageAccess
Get manage access of a scheduled hearing: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings/{publicSectorScheduledHearingsUniqID}/child/ManageAccess/{LnpRecordKey}

Scope Configuration Fields

The scope configuration fields resource is used to enable the filtration of setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.

Create a set of scope configurations for all scope configuration fields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurationFields
Delete a scope configuration field: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurationFields/{publicSectorScopeConfigurationFieldsUniqID}
Get a scope configuration field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurationFields/{publicSectorScopeConfigurationFieldsUniqID}
Get all scope configuration fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurationFields
Update a configuration field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurationFields/{publicSectorScopeConfigurationFieldsUniqID}

Scope Configurations

The scope configuration resource is used to enable the filtration of the setup data for the Functional Setup Manager export process. The resource shows the details of the filter criteria.

Create a set of scope configurations for all setup data: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations
Delete a scope configuration: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}
Get a scope configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}
Get all scope configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations
Update a scope configuration: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}

Scope Configurations/Scope Configuration Fields

The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.

Create a set of scope configurations for all scope configuration fields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField
Delete a scope configuration field: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField/{ScopeConfigurationFieldUniqID}
Get a scope configuration field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField/{ScopeConfigurationFieldUniqID}
Get all scope configuration fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField
Update a configuration field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField/{ScopeConfigurationFieldUniqID}

Search Code Technicians

The search code technician resource is used to view a code technician. Code technicians are users who handle Code Enforcement cases.

Get a code technician: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeTechnicians/{publicSectorSearchCodeTechniciansUniqID}
Get all code technicians: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeTechnicians

Search Hearing Applications

The search hearing applications resource is used to view a hearing application. Hearings are used in planning and zoning applications.

Get a hearing application: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSearchHearingApplications/{LnpRecordKey}
Get all hearing applications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSearchHearingApplications

Search Hearing Bodies

The search hearing body resource is used to view a hearing body. A hearing body is a group of individuals formed to evaluate the testimony presented by applicants of planning and zoning applications.

Get a hearing body: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSearchHearingBodies/{publicSectorSearchHearingBodiesUniqID}
Get all hearing bodies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSearchHearingBodies

Search Public User Profiles

Use the search public user profiles resource to view all registered public user profile information. Profile information such as the user's name, business name and contact information can be defaulted into a permit application.

Get a public user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSearchProfiles/{CurrProfileId}
Get all profiles for a public user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSearchProfiles

Search Violation Code References

The search violation code reference resource is used to view a violation code reference. Violation code references are used in Code Enforcement cases.

Get a violation code reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSearchViolationCodeReferences/{publicSectorSearchViolationCodeReferencesUniqID}
Get all violation code references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSearchViolationCodeReferences

ServiceTypes

The service types resource is used to view, add, modify, or delete the information associated with a REST endpoint.

Create a service type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorServiceTypes
Delete a service type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorServiceTypes/{ServiceType}
Get a service type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorServiceTypes/{ServiceType}
Get all service types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorServiceTypes
Update a service type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorServiceTypes/{ServiceType}

Solution Package Imports

The solution package import resource is used to enable attachments for the Solution Package Import process. Users can view the details of the imported files such as their status and the import history.

Create an import requests: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments
Delete an import request: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}
Get all import requests: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments
Get an import request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}
Update an import request: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}

Solution Package Imports/Attachments

The attachments resource is used to perform the file attachment functionality.

Create an imported attachments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor
Delete an imported attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{AttachedDocumentId}
Get all imported attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor
Get an imported attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{AttachedDocumentId}
Update an imported attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{AttachedDocumentId}

Solution Package Imports/Attachments/Attachment Revisions

The attachments revision child resource is used to access all the revision versions of the attachment.

Create a revision attachments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete a revision attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get a revision attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all revision attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Update a revision attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Standard Comments

The standard comments resource is used to view, create, or modify a standard comment. Standard comments are used to enter standard text while entering comments for a transaction such as permits, workflow, and inspection.

Create a standard comment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStandardComments
Delete a standard comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}
Get a standard comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}
Get all standard comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStandardComments
Update a standard comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}

Standard Comments/Favorite Comments

The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.

Create a favorite comment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment
Delete a favorite comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment/{FavoriteCommentUniqID}
Get a favorite comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment/{FavoriteCommentUniqID}
Get all favorite comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment
Update a favorite comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment/{FavoriteCommentUniqID}

States

The states resource is used to view, create, delete, or modify states. A state is a region within a country.

Create a state: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStates
Delete a state: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStates/{publicSectorStatesUniqID}
Get a state: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStates/{publicSectorStatesUniqID}
Get all states: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStates
Update a state: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStates/{publicSectorStatesUniqID}

Status Histories

The status histories resource records the status change history for permits, inspections, and plan reviews.

Create a status history event record: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories
Delete a status history event record: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{publicSectorStatusHistoriesUniqID}
Get a status history event record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{publicSectorStatusHistoriesUniqID}
Get all status history event records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories
Update a status history event record: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{publicSectorStatusHistoriesUniqID}

Subclasses

The subclasses resource is used to create new REST-enabled record types for subclassing. It creates both entity objects and view objects. It also creates the REST end point for new view objects, enables security on the REST end point, displays business objects in Data Composer, and enables sandboxing. The subclass resource is primarily used for internal Oracle development purposes only.

Create a subclass: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas
Delete a subclass: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas/{SubclassId}
Get a subclass: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas/{SubclassId}
Get all subclasses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas
Update a subclass: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas/{SubclassId}

Summary of Fees

The summary of fees resource is used to get fee summary which is displayed on the overview page in the permit details.

Get a record fee summary: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewFees/{publicSectorRecordOverviewFeesUniqID}
Get all record fee summaries: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewFees

Summary of Inspections

The summary of inspections resource is used to display the inspection summary on the overview page of the permit details.

Get all inspection summaries: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewInspectionSummaries
Get an inspection summary: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewInspectionSummaries/{publicSectorRecordOverviewInspectionSummariesUniqID}

Summary of Upcoming Inspections

The summary of upcoming inspections resource is used to get the upcoming inspections related to the current permit. The upcoming inspections are displayed on overview page in the permit details.

Get a summary of upcoming inspections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewUpcomings/{publicSectorRecordOverviewUpcomingsUniqID}
Get all summaries of upcoming inspections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewUpcomings

Synchronize Entity Models

The synchronize entity models resource is used to synchronize the Oracle Policy Automation configuration schema with the latest changes made to the application schema. The synchronization operation will update the configuration schema with the new objects, and any modifications or deletions made to the existing objects in the application schema.

Create a set of entity model objects to synchronize: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaSyncEntityModels
Delete an entity model object to synchronize: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaSyncEntityModels/{SyncId}
Get all entity model objects to synchronize: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaSyncEntityModels
Get an entity model object to synchronize: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaSyncEntityModels/{SyncId}
Synchronizes entity models: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaSyncEntityModels
Update an entity model object to synchronize: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorOpaSyncEntityModels/{SyncId}

System Defined Filters

The system defined filters resource is used to view, create, delete or modify application defined filter criteria to enable users to filter data in tables. The object stores the filter criteria identifier, name, and associating table name.

Get a filter criterion: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSystemDefinedFilters/{FilterId}
Get all filter criteria by table name: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorSystemDefinedFilters

The terms of use definitions resource is used to view, create, modify, or delete a terms of use definition. Terms of use definitions contain terms and conditions content that can be displayed for transactions such as user registration or a permit application.

Create a terms of use definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses
Delete a terms of use definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}
Get a terms of use definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}
Get all terms of use definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses
Update a terms of use definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}

The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.

Create a set of transaction types for a terms of use definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage
Delete a transaction type for a terms of use definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage/{TermsUsageUniqID}
Get a transaction type for a terms of use definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage/{TermsUsageUniqID}
Get all the transaction type details for a terms of use definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage
Update a transaction type for a terms of use definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage/{TermsUsageUniqID}

The terms of use keys resource is used to view a list of current effective dated terms of use IDs and descriptions.

Create a terms of use definition is not supported: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesKeys
Delete a terms of use definition is not supported: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesKeys/{publicSectorTermsOfUsesKeysUniqID}
Get a terms of use definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesKeys/{publicSectorTermsOfUsesKeysUniqID}
Get all terms of use definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesKeys
Update a terms of use definition is not supported: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesKeys/{publicSectorTermsOfUsesKeysUniqID}

The terms of use totals resource is used to view all effective dated rows for a terms of use definition.

Create a terms of use definition is not supported: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals
Delete a terms of use definition is not supported: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals/{publicSectorTermsOfUsesTotalsUniqID}
Get a terms of use definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals/{publicSectorTermsOfUsesTotalsUniqID}
Get all terms of use definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals
Update a terms of use definition is not supported: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals/{publicSectorTermsOfUsesTotalsUniqID}

Terms Usages

Create a set of transaction types for a terms of use definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsUsages
Delete a transaction type for a terms of use definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsUsages/{publicSectorTermsUsagesUniqID}
Get a transaction type for a terms of use definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsUsages/{publicSectorTermsUsagesUniqID}
Get all the transaction type details for a terms of use definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsUsages
Update a transaction type for a terms of use definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTermsUsages/{publicSectorTermsUsagesUniqID}

Theme Assignment Attributes

The theme assignment attributes resource is used to view, create, modify, or delete a theme assignment plan attribute.

Create a theme assignment plan attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignmentAttributes
Delete a theme assignment plan attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignmentAttributes/{publicSectorRegistryThemeAssignmentAttributesUniqID}
Get a theme assignment plan attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignmentAttributes/{publicSectorRegistryThemeAssignmentAttributesUniqID}
Get all theme assignment plan attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignmentAttributes
Update a theme assignment plan attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignmentAttributes/{publicSectorRegistryThemeAssignmentAttributesUniqID}

Theme Assignments

The theme assignments resource is used to view, create, modify, or delete a theme assignment plan.

Create a theme assignment plan: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments
Delete a theme assignment plan: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}
Get a theme assignment plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}
Get all theme assignment plans: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments
Update a theme assignment plan: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}

Theme Assignments/Theme Assignment Attributes

The theme assignment attributes resource is used to view, create, modify, or delete a theme assignment plan attribute.

Create a theme assignment plan attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/Attributes
Delete a theme assignment plan attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
Get a theme assignment plan attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
Get all theme assignment plan attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/Attributes
Update a theme assignment plan attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}

Theme Assignments/User Theme Assignments

The user theme assignments resource is used to view, create, modify, or delete a user level theme assignment plan.

Create a user level theme assignment plan: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments
Delete a user level theme assignment plan: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}
Get a user level theme assignment plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}
Get all user level theme assignment plans: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments
Update a user level theme assignment plan: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}

Theme Assignments/User Theme Assignments/Theme Assignment Attributes

The theme assignment attributes resource is used to view, create, modify, or delete a theme assignment plan attribute.

Create a theme assignment plan attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}/child/Attributes
Delete a theme assignment plan attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
Get a theme assignment plan attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
Get all theme assignment plan attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}/child/Attributes
Update a theme assignment plan attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}

Theme Attributes

The theme attributes resource is used to view, create, modify, or delete a branding theme attribute.

Create a branding theme attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitionAttributes
Delete a branding theme attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitionAttributes/{publicSectorThemeDefinitionAttributesUniqID}
Get a branding theme attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitionAttributes/{publicSectorThemeDefinitionAttributesUniqID}
Get all branding theme attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitionAttributes
Update a branding theme attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitionAttributes/{publicSectorThemeDefinitionAttributesUniqID}

Themes

The themes resource is used to view, create, modify, or delete a branding theme.

Create a branding theme: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions
Delete a branding theme: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}
Get a branding theme: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}
Get all branding themes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions
Update a branding theme: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}

Themes/Theme Attributes

The theme attributes resource is used to view, create, modify, or delete a branding theme attribute.

Create a branding theme attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}/child/Attributes
Delete a branding theme attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}/child/Attributes/{AttributesUniqID}
Get a branding theme attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}/child/Attributes/{AttributesUniqID}
Get all branding theme attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}/child/Attributes
Update a branding theme attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}/child/Attributes/{AttributesUniqID}

Time Rule Policies

The time rule policies resource is used to configure the time rule policies in the time rule definitions.

Create a set of time rule policies: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRulePolicies
Delete a time rule policy: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRulePolicies/{publicSectorCodeEnforcementTimeRulePoliciesUniqID}
Get a time rule policy: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRulePolicies/{publicSectorCodeEnforcementTimeRulePoliciesUniqID}
Get all time rule policies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRulePolicies
Update a time rule policy: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRulePolicies/{publicSectorCodeEnforcementTimeRulePoliciesUniqID}

Time Rule Triggers

The time rule triggers resource is used to configure the time rule definitions, which are used in the Code Enforcement process.

Create a set of trigger definitions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRuleTriggers
Delete a trigger definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRuleTriggers/{TriggerId}
Get a trigger definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRuleTriggers/{TriggerId}
Get all trigger definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRuleTriggers
Update a trigger definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRuleTriggers/{TriggerId}

Time Rules

The time rules resource is used to configure the time rule definitions for use in Code Enforcement.

Create a set of time rule definitions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules
Delete a time rule definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}
Get a time rule definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}
Get all time rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules
Update a time rule definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}

Time Rules/Time Rule Policies

The time rule policies resource is used to configure the time rule policies for use in the time rule definitions.

Create a set of time rule policies: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy
Delete a time rule policy: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy/{TimeRulePolicyUniqID}
Get a time rule policy: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy/{TimeRulePolicyUniqID}
Get all time rule policies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy
Update a time rule policy: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy/{TimeRulePolicyUniqID}

Tokens

The tokens resource is used to view, add, delete and modify token entries for the Token Framework.

Create a token: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTokens
Delete a token: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTokens/{ReqId}
Get a token: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTokens/{ReqId}
Get all tokens: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTokens
Update a token: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTokens/{ReqId}

Transaction Assignees

The transaction assignees resource is used to view, create, delete, or modify a transaction assignee. A transaction assignee identifies the agency staff assigned to the transaction.

Create a transaction assignee: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTransactionAssignees
Get a transaction assignee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTransactionAssignees/{publicSectorTransactionAssigneesUniqID}
Get all transaction assignees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTransactionAssignees
Update a transaction assignee: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTransactionAssignees/{publicSectorTransactionAssigneesUniqID}

Transaction Assignees Last Added

The latest transaction assignees resource is used to view the assignees last added to a transaction. A transaction assignee identifies the agency staff assigned to the transaction.

Get a latest transaction assignee.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTransactionLatestAssignees/{LnpRecordKey}
Get all latest transaction assignees.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTransactionLatestAssignees

Trust Account Notifications

Use the trust account notifications resource to view trust account information that can be used in notifications.

Get a trust account that is associated with a registered public user profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTrustAccountNotifications/{publicSectorTrustAccountNotificationsUniqID}
Get all trust accounts for a registered public user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorTrustAccountNotifications

Unit of Measure Conversions

The units of measure conversions resource is used to view, create, modify, or delete a conversion rate between two different units of measure.

Create a unit of measure conversion rate: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnitsConversions
Delete a unit of measure conversion rate: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnitsConversions/{publicSectorUnitsConversionsUniqID}
Get a unit of measure conversion rate: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnitsConversions/{publicSectorUnitsConversionsUniqID}
Get all unit of measure conversion rates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnitsConversions
Update a unit of measure conversion rate: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnitsConversions/{publicSectorUnitsConversionsUniqID}

Units of Measure

The units of measure resource is used to view, create, modify, or delete a unit of measure. A unit of measure is used to express measurements such as quantity or duration.

Create a unit of measure: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnits
Delete a unit of measure: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnits/{UnitOfMeasure}
Get a unit of measure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnits/{UnitOfMeasure}
Get all units of measure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnits
Update a unit of measure: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUnits/{UnitOfMeasure}

User Accesses

The user accesses resource is used to view user information and the number of pending verification requests for registered public users.

Get a single user's information and the number of pending verification requests for the user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserAccesses/{PscUserId}
Get all users' information and the number of pending verification requests for the users: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserAccesses

User Defined Filters

The user defined filters resource is used to view, create, delete or modify application defined filter criteria to enable users to filter data in tables. The object stores the filter criteria identifier, name, and associated table name.

Create a filter criterion: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters
Delete a filter criterion: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters/{FilterId}
Get a filter criterion: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters/{FilterId}
Get all filter cirteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters
Modify a filter criterion: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters/{FilterId}

User Preferences

The user preferencess resource is used to view or modify user preferences.

Get a set of user preferences: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserPreferences/{UserId}
Get all user preferences: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserPreferences
Update a set of user preferences: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserPreferences/{UserId}

User Profiles

The user profiles resource is used to view, create, or modify a registered public user account profile.

Clone user profile information from an existing profile.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles
Get a registered public user account profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles/{ProfileId}
Get all account profiles for a registered public user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles
Retrieves the general information of a registered public user's account profiles.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles
Update a registered public user account profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles/{ProfileId}

User References

The user references resource is used to view, create, or modify information for registered users.

Create a user's reference data: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserRefs
Get a user's reference data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserRefs/{PscUserId}
Get all users' reference data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserRefs
Update a user's reference data: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserRefs/{PscUserId}

User Requests

The user requests resource is used to view registered public user's pending verification requests such as requests for license verification or for payment account verification.

Get a single pending verification request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserRequests/{publicSectorUserRequestsUniqID}
Get all pending verification requests for a user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserRequests

User Roles

The user roles resource is used to view, add, modify or delete user roles. User roles determine which roles are assigned to public users when they register with the agency.

Create a user role: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserRoles
Delete a user role: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserRoles/{PblUserRoleSetupId}
Get a user role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserRoles/{PblUserRoleSetupId}
Get all user roles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserRoles
Update a user role: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserRoles/{PblUserRoleSetupId}

User Setup Settings

The public user setup settings resource is used to view and modify the public user setup settings. These settings are for options related to public user registration and account management.

Get a user setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserSetups/{UserSetupId}
Get all user setups is not supported: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserSetups
Update a user setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorUserSetups/{UserSetupId}

User Theme Assignment Attributes

The user theme assignment attributes resource is used to view, create, modify, or delete a user level theme assignment plan attribute.

Create a user level theme assignment plan attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignmentAttributes
Delete a user level theme assignment plan attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignmentAttributes/{publicSectorRegistryUserThemeAssignmentAttributesUniqID}
Get a user level theme assignment plan attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignmentAttributes/{publicSectorRegistryUserThemeAssignmentAttributesUniqID}
Get all user level theme assignment plan attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignmentAttributes
Update a user level theme assignment plan attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignmentAttributes/{publicSectorRegistryUserThemeAssignmentAttributesUniqID}

User Theme Assignments

The user theme assignments resource is used to view, create, modify, or delete a user level theme assignment plan.

Create a user level theme assignment plan: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments
Delete a user level theme assignment plan: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}
Get a user level theme assignment plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}
Get all user level theme assignment plans: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments
Update a user level theme assignment plan: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}

User Theme Assignments/User Theme Assignment Attributes

The user theme assignment attributes resource is used to view, create, modify, or delete a user level theme assignment plan attribute.

Create a user level theme assignment plan attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}/child/Attributes
Delete a user level theme assignment plan attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
Get a user level theme assignment plan attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
Get all user level theme assignment plan attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}/child/Attributes
Update a user level theme assignment plan attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}

Violation Code Reference Group Codes

The violation code reference group code resource is used to view, create, or modify a violation code reference in a violation code reference group. Violation code reference groups are used in Code Enforcement cases.

Create a violation code reference group code: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroupCodes
Delete a violation code reference group code: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroupCodes/{publicSectorViolationCodeReferenceGroupCodesUniqID}
Get a violation code reference group code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroupCodes/{publicSectorViolationCodeReferenceGroupCodesUniqID}
Get all violation code reference group codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroupCodes
Update a violation code reference group code: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroupCodes/{publicSectorViolationCodeReferenceGroupCodesUniqID}

Violation Code Reference Groups

The violation code reference group resource is used to view, create, or modify a violation code reference group. Violation code reference groups are used in Code Enforcement cases.

Create a violation code reference group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups
Delete a violation code reference group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}
Get a violation code reference group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}
Get all violation code reference groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups
Update a violation code reference group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}

Violation Code Reference Groups/Code References

The code reference resource is used to view, create, or modify a violation code reference. Violation code references are used in Code Enforcement cases.

Create a violation code reference in a violation code reference group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}/child/CodeReferences
Delete a violation code reference in a violation code reference group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}/child/CodeReferences/{CodeReferencesUniqID}
Get a violation code reference in a violation code reference group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}/child/CodeReferences/{CodeReferencesUniqID}
Get all violation code references in a violation code reference group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}/child/CodeReferences
Update a violation code reference in a violation code reference group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}/child/CodeReferences/{CodeReferencesUniqID}

Violation Code References

The violation code reference resource is used to view, create, or modify a violation code reference. Violation code references are used in Code Enforcement cases.

Create a violation code reference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences
Delete a violation code reference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences/{publicSectorViolationCodeReferencesUniqID}
Get a violation code reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences/{publicSectorViolationCodeReferencesUniqID}
Get all violation code references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences
Update a violation code reference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences/{publicSectorViolationCodeReferencesUniqID}

Violation Notice Groups

The violation notice group resource is used to view, create, or modify a violation notice group. Violation notice groups are used in Code Enforcement cases.

Create a violation notice group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups
Delete a violation notice group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}
Get a violation notice group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}
Get all violation notice groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups
Update a violation notice group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}

Violation Notice Groups/Violation Notice Type Mappings

The violation notice type mapping resource is used to view, create, or modify a violation notice type mapping in a violation notice group. Violation notice types are used in Code Enforcement cases.

Create a violation notice type in a violation notice group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/NoticeMappings
Delete a violation notice type from a violation notice group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/NoticeMappings/{NoticeMappingsUniqID}
Get a violation notice type from a violation notice group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/NoticeMappings/{NoticeMappingsUniqID}
Get all violation notice types from a violation notice group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/NoticeMappings
Update a violation notice type in a violation notice group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/NoticeMappings/{NoticeMappingsUniqID}

Violation Notice Type Mappings

The violation notice type mapping resource is used to view, create, or modify a violation notice type mapping in a violation notice group. Violation notice types are used in Code Enforcement cases.

Create a violation notice type in a violation notice group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeMappings
Delete a violation notice type from a violation notice group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeMappings/{publicSectorViolationNoticeMappingsUniqID}
Get a violation notice type from a violation notice group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeMappings/{publicSectorViolationNoticeMappingsUniqID}
Get all violation notice types from a violation notice group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeMappings
Update a violation notice type in a violation notice group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeMappings/{publicSectorViolationNoticeMappingsUniqID}

Violation Notice Types

The violation notice type resource is used to view, create, or modify a violation notice type. Violation notice types are used in Code Enforcement cases.

Create a violation notice type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeTypes
Delete a violation notice type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeTypes/{publicSectorViolationNoticeTypesUniqID}
Get a violation notice type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeTypes/{publicSectorViolationNoticeTypesUniqID}
Get all violation notice types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeTypes
Update a violation notice type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeTypes/{publicSectorViolationNoticeTypesUniqID}

Web Applications

The web application resource is used to view, create, modify, or delete a web application. A web application is a group of web pages of one product area. The term "web application" is also referred to as the "host node". The web applications resource is primarily intended to be used by internal development groups.

Create a web application: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions
Delete a web application: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions/{HostName}
Get a web application: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions/{HostName}
Get all web applications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions
Update a web application: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions/{HostName}

Web Form Attachments

The web form attachments resource is used to view, create, delete, or modify attachments provided by registered public user or agency users.

Create an attachment for a registered public user account: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments
Delete an attachment for a registered public user account: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}
Get all attachments for a registered public user account: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments
Get an attachment for a registered public user account: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}
Update an attachment for a registered public user account: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}

Web Form Responses

The web form responses resource is used to view all web form responses received against communications triggered through ad hoc email and ad hoc notification.

Get a web form response: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}
Get all web form responses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses
Update a web form response: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}

Web Form Responses/Web Forms

The web forms resource is used to view web form details associated with the communications triggered through ad hoc emails and ad hoc notifications.

Get a set of web form details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}/child/WebForms/{WebformId}
Get all web form details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}/child/WebForms
Update a web form: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}/child/WebForms/{WebformId}

Widgets

The widgets resource is used to add, update, or delete widgets created for application forms built in the designer utility. A widget can be a reusable element, a grid, a template, and so on. The widgets resource is intended to be used primarily by internal development teams within Oracle.

Create a widget: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWidgets
Delete a widget: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}
Get a widget: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}
Get all widgets: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWidgets
Update a widget: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}

Work Schedules

The work schedules resource is used to view, create, or modify a work schedule. A work schedule is used to define the days of the week and daily hours of operation for agency employees.

Create a work schedule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules
Delete a work schedule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules/{publicSectorWorkSchedulesUniqID}
Get a work schedule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules/{publicSectorWorkSchedulesUniqID}
Get all work schedules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules
Update a work schedule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules/{publicSectorWorkSchedulesUniqID}

Workflow Activities

The workflow activities resource is used to view, add, modify, or delete all REST requests to and from Oracle Integration Cloud (OIC).

Create a workflow activity: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities
Delete a workflow activity: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{TransactionId}
Get a workflow activity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{TransactionId}
Get all workflow activities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities
Update a workflow activity: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{TransactionId}

Workflow Attachments

The workflow attachments resource is used to enable attachments for workflow within a permit detail. Users can add, update, or delete attachments.

Create a set of workflow attachments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments
Delete a workflow attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}
Get a workflow attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}
Get all workflow attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments
Update a workflow attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}

Workflow Attachments/Attachments

The attachments resource is used to perform the file attachment functionality.

Create a set of workflow attachments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor
Delete an uploaded attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{AttachedDocumentId}
Get all workflow attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor
Get an uploaded attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{AttachedDocumentId}
Update an uploaded attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{AttachedDocumentId}

Workflow Attachments/Attachments/Attachment Revisions

The attachment revisions resource is used to access all the revision versions of the attachment.

Create a set of revision attachments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Delete a revision attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get a revision attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Get all revision attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision
Update a revision attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Workflow Comments

The workflow comments resource is used to retrieve all the comments corresponding to a workflow task within a transaction. Comments can be added, updated, or deleted.

Create a workflow comment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsComments
Delete a workflow comment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}
Get a workflow comment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}
Get all workflow comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsComments
Update a workflow comment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}

Workflow Communications

The workflow communication resource is used to capture attributes related to workflow when a workflow communication request is received.

Get a workflow communication item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkflowCommunications/{LnpRecordKey}
Get all workflow communication items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/publicSectorWorkflowCommunications