All REST Endpoints
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs
- Delete a payment adapter configuration
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs/{publicSectorAdapterConfigsUniqID}
- Get a payment adapter configuration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs/{publicSectorAdapterConfigsUniqID}
- Get all payment adapter configurations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs
- Update a payment adapter configuration
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs/{publicSectorAdapterConfigsUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterCurrencies
- Delete a payment adapter currency
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterCurrencies/{publicSectorAdapterCurrenciesUniqID}
- Get a payment adapter currency
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterCurrencies/{publicSectorAdapterCurrenciesUniqID}
- Get all payment adapter currencies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterCurrencies
- Update a payment adapter currency
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterCurrencies/{publicSectorAdapterCurrenciesUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods
- Delete a payment adapter payment method
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods/{publicSectorAdapterMethodsUniqID}
- Get a payment adapter payment method
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods/{publicSectorAdapterMethodsUniqID}
- Get all payment adapter payment methods
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods
- Update a payment adapter payment method
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods/{publicSectorAdapterMethodsUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapters
- Delete a payment adapter
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapters/{publicSectorAdaptersUniqID}
- Get a payment adapter
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapters/{publicSectorAdaptersUniqID}
- Get all payment adapters
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapters
- Update a payment adapter
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapters/{publicSectorAdaptersUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies
- Delete an agency payment option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies/{publicSectorPaymentOptionsAgenciesUniqID}
- Get all agency payment options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies
- Get an agency payment option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies/{publicSectorPaymentOptionsAgenciesUniqID}
- Update an agency payment option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies/{publicSectorPaymentOptionsAgenciesUniqID}
Billing and Payment/Bank Reconciliation Options
Resouce is used to view and create bank reconciliation options.
- Create a bank reconciliation options data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationOptions
- Delete a bank reconciliation options data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationOptions/{publicSectorBankReconciliationOptionsUniqID}
- Get all bank reconciliation options data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationOptions
- Get bank reconciliation options data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationOptions/{publicSectorBankReconciliationOptionsUniqID}
- Update a set of bank reconciliation options data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationOptions/{publicSectorBankReconciliationOptionsUniqID}
Billing and Payment/Bank Reconciliation Transactions
Resouce is used to view and update bank reconciliation activity.
- Create a bank reconciliation activity data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationTransactions
- Delete a bank reconciliation activity data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationTransactions/{ReconHistoryKey}
- Get all bank reconciliation activity data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationTransactions
- Get bank reconciliation activity data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationTransactions/{ReconHistoryKey}
- Update a set of bank reconciliation activity data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationTransactions/{ReconHistoryKey}
Billing and Payment/Bill Types
The bill types resource is used to view, create, delete, or modify bill types.
- Create a bill type
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBillTypes
- Delete a bill type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBillTypes/{publicSectorBillTypesUniqID}
- Get a bill type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBillTypes/{publicSectorBillTypesUniqID}
- Get all bill types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBillTypes
- Update a bill type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBillTypes/{publicSectorBillTypesUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments
- Delete a cash drawer payment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments/{publicSectorCashDrawerPaymentsUniqID}
- Get a cash drawer payment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments/{publicSectorCashDrawerPaymentsUniqID}
- Get all cash drawer payments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments
- Update a cash drawer payment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments/{publicSectorCashDrawerPaymentsUniqID}
Billing and Payment/Cash Drawer Reconciliations
The cash drawer reconciliations resource is used to view or create cash drawer reconciliation information.
- Create a cash drawer reconciliation
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcils
- Delete a cash drawer reconciliation
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcils/{ReconcileId}
- Get a cash drawer reconciliation
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcils/{ReconcileId}
- Get all cash drawer reconciliations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcils
- Update a cash drawer reconciliation
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcils/{ReconcileId}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessionTimes
- Get a cash drawer session time
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessionTimes/{publicSectorCashDrawerSessionTimesUniqID}
- Get all cash drawer session times
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessionTimes
- Update a cash drawer session time
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessionTimes/{publicSectorCashDrawerSessionTimesUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions
- Get a cash drawer session
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}
- Get all cash drawer sessions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions
- Update a cash drawer session
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}/child/BnpCashDrawerSessionTimeView
- Get a cash drawer session time line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}/child/BnpCashDrawerSessionTimeView/{BnpCashDrawerSessionTimeViewUniqID}
- Get all cash drawer session time lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}/child/BnpCashDrawerSessionTimeView
- Update a cash drawer session time line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions/{publicSectorCashDrawerSessionsUniqID}/child/BnpCashDrawerSessionTimeView/{BnpCashDrawerSessionTimeViewUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers
- Delete a cash drawer
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers/{publicSectorCashDrawersUniqID}
- Get a cash drawer
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers/{publicSectorCashDrawersUniqID}
- Get all cash drawers
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers
- Update a cash drawer
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers/{publicSectorCashDrawersUniqID}
Billing and Payment/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashReconcileAcctgs
- Get cash drawer reconciliation shortage/overage amount
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashReconcileAcctgs/{TransactionId}
- Update a cash drawer reconciliation shortage/overage amount
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashReconcileAcctgs/{TransactionId}
Billing and Payment/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReconcileDetailViews/{publicSectorReconcileDetailViewsUniqID}
- Get all cashier session reconciliation details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReconcileDetailViews
Billing and Payment/Checkouts
The checkouts resource is used to view, create, delete, or update checkout data.
- Create a set of payment checkout data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts
- Delete a set of payment checkout data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}
- Get a set of payment checkout data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}
- Get all payment checkout data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts
- Update a set of payment checkout data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}
Billing and Payment/Checkouts/Checkout Lines
The checkout lines resource is used to view, create, delete, or update checkout lines.
- Create a payment checkout line
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin
- Delete a payment checkout line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin/{CheckoutLinUniqID}
- Get a payment checkout line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin/{CheckoutLinUniqID}
- Get all payment checkout lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin
- Update a payment checkout line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin/{CheckoutLinUniqID}
Billing and Payment/Checkouts/Checkout Payments
The checkout lines resource is used to view, create, delete, or update checkout payments.
- Create a checkout payment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutPmt
- Delete a set of checkout payment data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutPmt/{CheckoutPmtUniqID}
- Get a set of checkout payment data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutPmt/{CheckoutPmtUniqID}
- Get all checkout payments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutPmt
- Update a set of checkout payment data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutPmt/{CheckoutPmtUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsDepartments
- Delete a department payment option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsDepartments/{publicSectorPaymentOptionsDepartmentsUniqID}
- Get a department payment option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsDepartments/{publicSectorPaymentOptionsDepartmentsUniqID}
- Get all department payment options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsDepartments
- Update a department payment option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsDepartments/{publicSectorPaymentOptionsDepartmentsUniqID}
Billing and Payment/Deposit Account Access
The deposit account access resource is used to grant or revoke access to authorized users for a deposit account.
- Create a set of deposit account access data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAccess
- Delete a deposit account access data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAccess/{DepositPermissionKey}
- Get a deposit account access data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAccess/{DepositPermissionKey}
- Get all deposit account access data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAccess
- Update a deposit account access data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAccess/{DepositPermissionKey}
Billing and Payment/Deposit Account Activities
The deposit account activities resource is used to list deposit account activities.
- Create a set of deposit account activity data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountActivities
- Delete a deposit account activity data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountActivities/{DepositActivityKey}
- Get a deposit account activity data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountActivities/{DepositActivityKey}
- Get all deposit account activity data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountActivities
- Update a deposit account activity data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountActivities/{DepositActivityKey}
Billing and Payment/Deposit Account Activity Summaries
The deposit account activity summaries resource is used to get a summary of deposit account activity.
- Get a deposit account activity summary data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountActivitySummaries/{publicSectorDepositAccountActivitySummariesUniqID}
- Get all deposit account activity summary data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountActivitySummaries
Billing and Payment/Deposit Account Associations
The deposit account associations resource is used to list deposit accounts and assigned users, projects, and transactions for each deposit account.
- Get a deposit account and its associations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAcccountAssociations/{publicSectorDepositAcccountAssociationsUniqID}
- Get all deposit accounts and their associations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAcccountAssociations
Billing and Payment/Deposit Account Attachments
The deposit account attachments resource is used to attach documents to a deposit account.
- Create a set of deposit account attachment data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments
- Delete a deposit account attachment data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}
- Get a deposit account attachment data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}
- Get all deposit account attachment data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments
- Update a deposit account attachment data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}
Billing and Payment/Deposit Account Attachments/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor
- Delete an attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}
- Get all attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor
- Get an attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}
- Update an attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}
Billing and Payment/Deposit Account Attachments/Attachments/Attachment Revisions
The attachmentsRevision resource is used to view attachment revisions.
- Create a set of attachment revision data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete a attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}/child/AttachmentsRevision
- Get an attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update a attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Billing and Payment/Deposit Account Attachments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}/enclosure/FileContents
Billing and Payment/Deposit Account Attachments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/child/DepositAccountAttachmentAccessor/{DepositAccountAttachmentAccessorUniqID}/enclosure/FileWebImage
Billing and Payment/Deposit Account Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}/enclosure/Preview
Billing and Payment/Deposit Account Authorized To Pay Transactions
The deposit account authorized to pay transactions resource is used to list deposit accounts and transactions that the user is authorized to pay.
- Get a deposit account and transactions that the user is authorized to pay
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAcccountAuthorizedToPayTransactions/{publicSectorDepositAcccountAuthorizedToPayTransactionsUniqID}
- Get all deposit accounts and transactions that the user is authorized to pay
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAcccountAuthorizedToPayTransactions
Billing and Payment/Deposit Account Authorized To Pay Users
The deposit account authorized to pay users resource is used to list users authorized to pay fees with funds in deposit accounts.
- Get a deposit account and users authorized to pay fees with funds in the deposit account
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAcccountAuthorizedToPayUsers/{publicSectorDepositAcccountAuthorizedToPayUsersUniqID}
- Get all deposit accounts and users authorized to pay fees with funds in each deposit account
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAcccountAuthorizedToPayUsers
Billing and Payment/Deposit Account Authorized Users
The deposit account authorized users resource is used to assign authorized users to a deposit account.
- Create a set of deposit account authorized user data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers
- Delete a deposit account authorized user data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}
- Get a deposit account authorized user data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}
- Get all deposit account authorized user data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers
- Update a deposit account authorized user data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}
Billing and Payment/Deposit Account Authorized Users/Deposit Account Access
The deposit account access resource is used to grant or revoke access of authorized users for a deposit account.
- Create a set of deposit account access data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess
- Delete a deposit account access data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}
- Get a deposit account access data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}
- Get all deposit account access data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess
- Update a deposit account access data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}
Billing and Payment/Deposit Account Authorized Users/Deposit Account Access/Deposit Account Users
The deposit account users resource is used to invite users to a deposit account.
- Create a deposit account invited user
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}/child/DepositAccountUser/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id}
- Create a set of deposit account invited user data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}/child/DepositAccountUser
- Delete a deposit account invited user
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}/child/DepositAccountUser/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id}
- Get a deposit account invited user
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}/child/DepositAccountUser/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id}
- Get all deposit account invited user data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}/child/DepositAccountUser
Billing and Payment/Deposit Account Authorized Users/Deposit Account Access/Deposit Account Users/Deposit Account User Access
The deposit account access resource is used to provide access to invited users for a deposit account.
- Create a set of deposit account access data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}/child/DepositAccountUser/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id}/child/DepositAccountAccess
- Delete a deposit account access data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}/child/DepositAccountUser/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id}/child/DepositAccountAccess/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_DepositAccountAccess_Id}
- Get a deposit account access data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}/child/DepositAccountUser/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id}/child/DepositAccountAccess/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_DepositAccountAccess_Id}
- Get all deposit account access data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}/child/DepositAccountUser/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id}/child/DepositAccountAccess
- Update a deposit account access data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}/child/DepositAccountUser/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id}/child/DepositAccountAccess/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_DepositAccountAccess_Id}
Billing and Payment/Deposit Account Balance Communications
The deposit account balance communications resource is used to request for additional funds into an account.
- Get a deposit account
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountBalanceCommunications/{DepositAccountKey}
- Get all deposit accounts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountBalanceCommunications
Billing and Payment/Deposit Account Bank Transfers
The deposit account bank transfers resource is used to list all calculated bank transferrable amounts for deposit accounts.
- Get a calculated bank transferrable amount
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountBankTransfers/{BankAccount}
- Get all calculated bank transferrable amounts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountBankTransfers
Billing and Payment/Deposit Account Communications
The communications resource is used when a new account has been established.
- Get all deposit accounts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountCommunications
- Get deposit account
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountCommunications/{DepositAccountKey}
Billing and Payment/Deposit Account Funds
The deposit account funds resource is used to set up deposit account funds.
- Create a set of deposit account fund data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountFunds
- Delete a deposit account fund data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountFunds/{DepositFundKey}
- Get a deposit account fund data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountFunds/{DepositFundKey}
- Get all deposit account fund data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountFunds
- Update a deposit account fund data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountFunds/{DepositFundKey}
Billing and Payment/Deposit Account Lists
The deposit account lists resource is used to list deposit accounts.
- Get a deposit account list data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountLists/{DepositAccountKey}
- Get all deposit account list data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountLists
Billing and Payment/Deposit Account Options
The deposit account option resource is used to set up options for deposit accounts at the agency level.
- Create a set of deposit account options data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOptions
- Delete a deposit account options data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOptions/{AgencyId}
- Get a deposit account options data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOptions/{AgencyId}
- Get all deposit account options data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOptions
- Update a deposit account options data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOptions/{AgencyId}
Billing and Payment/Deposit Account Owners
The deposit account owners resource is used to assign owners to a deposit account.
- Create a set of deposit account owner data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOwners
- Delete a deposit account owner data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOwners/{DepositOwnershipKey}
- Get a deposit account owner data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOwners/{DepositOwnershipKey}
- Get all deposit account owner data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOwners
- Update a deposit account owner data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOwners/{DepositOwnershipKey}
Billing and Payment/Deposit Account Projects
The deposit account projects resource is used to assign projects to deposit account.
- Create a set of deposit account project data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountProjects
- Delete a deposit account project data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountProjects/{DepositProjectKey}
- Get a deposit account project data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountProjects/{DepositProjectKey}
- Get all deposit account project data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountProjects
- Update a deposit account project data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountProjects/{DepositProjectKey}
Billing and Payment/Deposit Account Records
The deposit account records resource is used to assign transactions to a deposit account.
- Create a deposit account record data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountRecords/{DepositRecordKey}
- Create a set of deposit account record data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountRecords
- Delete deposit account record data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountRecords/{DepositRecordKey}
- Get a deposit account record data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountRecords/{DepositRecordKey}
- Get all deposit account record data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountRecords
Billing and Payment/Deposit Account Related Fee Dues
The deposit account related fee dues resource is used to list fees payable by authorized users with funds in the deposit account.
- Get a deposit account and fees payable by authorized users with funds in the deposit account
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountRelatedFeeDues/{FeeRecordKey}
- Get all deposit accounts and fees payable by authorized users with funds in each deposit account
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountRelatedFeeDues
Billing and Payment/Deposit Account User Access Communications
The deposit account user access communications resource is used to send a communication on modification of user access.
- Get a deposit account user access communication record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountUserAccessCommunications/{DepositApplicantKey}
- Get all deposit account user access communication records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountUserAccessCommunications
Billing and Payment/Deposit Account User Invite Communications
The communication resource is used to invite a person to access a deposit account.
- Get a deposit account user invite communication record.
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountUserInviteCommunications/{InviteKey}
- Get all deposit account user invite communication records.
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountUserInviteCommunications
Billing and Payment/Deposit Account User Invites
The deposit account user invites resource is used to get a list of users invited to access deposit accounts.
- Create a set of deposit account user invite records
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountUserInvites
- Delete a deposit account user invite record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountUserInvites/{InviteKey}
- Get a deposit account user invite record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountUserInvites/{InviteKey}
- Get all deposit account user invite records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountUserInvites
- Update a deposit account user invite record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountUserInvites/{InviteKey}
Billing and Payment/Deposit Accounts
The deposit accounts resource is used to set up deposit accounts.
- Create a set of deposit account data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts
- Delete a deposit account
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}
- Get a deposit account data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}
- Get all deposit account data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts
- Update a deposit account data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}
Billing and Payment/Deposit Accounts/Deposit Account Activities
The deposit account activities resource is used to list activities for a deposit account.
- Delete a deposit account activity data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountActivities/{DepositActivityKey}
- Get a deposit account activity data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountActivities/{DepositActivityKey}
- Get all deposit account activity data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountActivities
Billing and Payment/Deposit Accounts/Deposit Account Funds
The deposit account funds resource is used to assign fund information to a deposit account.
- Create a set of deposit account fund data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountFund
- Delete a deposit account fund data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountFund/{DepositFundKey}
- Get a deposit account fund data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountFund/{DepositFundKey}
- Get all deposit account fund data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountFund
- Update a deposit account fund data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountFund/{DepositFundKey}
Billing and Payment/Deposit Accounts/Deposit Account Owners
The deposit account owners resource is used to assign owners to a deposit account.
- Create a set of deposit account owner data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountOwner
- Delete a deposit account owner data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountOwner/{DepositOwnershipKey}
- Get a deposit account owner data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountOwner/{DepositOwnershipKey}
- Get all deposit account owner data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountOwner
- Update a deposit account owner data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountOwner/{DepositOwnershipKey}
Billing and Payment/Deposit Accounts/Deposit Account Projects
The deposit account projects resource is used to assign projects to a deposit account.
- Delete a deposit account project data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountProject/{DepositProjectKey}
- Get a deposit account project data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountProject/{DepositProjectKey}
- Get all deposit account project data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountProject
Billing and Payment/Deposit Accounts/Deposit Account Records
The deposit account records resource is used to assign transactions to a deposit account.
- Delete a deposit account record data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountRecord/{DepositRecordKey}
- Get a deposit account record data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountRecord/{DepositRecordKey}
- Get all deposit account record data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountRecord
Billing and Payment/Deposit Accounts/Deposit Account User Invites
The deposit account authorized user invites resource is used to get list of invited users.
- Delete a deposit account user invite data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUserInvite/{InviteKey}
- Get a deposit account user invite data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUserInvite/{InviteKey}
- Get all deposit account user invite data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUserInvite
Billing and Payment/Deposit Accounts/Deposit Account Users
The deposit account users resource is used to assign users to a deposit account.
- Create a set of deposit account user data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUser
- Delete a deposit account user data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUser/{DepositApplicantKey}
- Get a deposit account user data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUser/{DepositApplicantKey}
- Get all deposit account user data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUser
- Update a deposit account user data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUser/{DepositApplicantKey}
Billing and Payment/Deposit Accounts/Deposit Account Users/Deposit Account Access
The deposit account access resource is used to grant access to users for a deposit account.
- Create a set of deposit account access data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUser/{DepositApplicantKey}/child/DepositAccountAccess
- Get a deposit account access data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUser/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}
- Get all deposit account access data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUser/{DepositApplicantKey}/child/DepositAccountAccess
- Update a deposit account access data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountUser/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}
Billing and Payment/Deposit Received Communications
The Deposit Received Communications resource is used to get communications about deposits received.
- Get a received deposit communication data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositReceivedCommunications/{publicSectorDepositReceivedCommunicationsUniqID}
- Get all received deposit communication data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepositReceivedCommunications
Billing and Payment/ERP Receipt Options
The receipt options resource is used to view, create, or update options for various invoice receipts.
- Create a set of receipt options data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorERPReceiptOptions
- Delete a set of receipt options data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorERPReceiptOptions/{publicSectorERPReceiptOptionsUniqID}
- Get a set receipt options data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorERPReceiptOptions/{publicSectorERPReceiptOptionsUniqID}
- Get all receipt options data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorERPReceiptOptions
- Update a set of receipt options data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorERPReceiptOptions/{publicSectorERPReceiptOptionsUniqID}
Billing and Payment/Fee Item Memo Lines
The fee item memo lines resource is used to view, create, or update record type mapping of fee items to memo lines.
- Create a fee item memo line
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeItemMemoLines
- Delete a fee item memo line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeItemMemoLines/{publicSectorFeeItemMemoLinesUniqID}
- Get a fee item memo line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeItemMemoLines/{publicSectorFeeItemMemoLinesUniqID}
- Get all fee item memo lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeItemMemoLines
- Update a fee item memo line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeItemMemoLines/{publicSectorFeeItemMemoLinesUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs
- Delete a payment gateway configuration
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs/{publicSectorGatewayConfigsUniqID}
- Get a payment gateway configuration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs/{publicSectorGatewayConfigsUniqID}
- Get all payment gateway configurations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs
- Update a payment gateway configuration
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs/{publicSectorGatewayConfigsUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGatewayNamePros
- Delete a payment gateway name
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorGatewayNamePros/{GatewayName}
- Get a payment gateway name
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGatewayNamePros/{GatewayName}
- Get all payment gateway names
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGatewayNamePros
- Update a payment gateway name
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGatewayNamePros/{GatewayName}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGateways
- Delete a payment gateway
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorGateways/{publicSectorGatewaysUniqID}
- Get a payment gateway
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGateways/{publicSectorGatewaysUniqID}
- Get all payment gateways
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGateways
- Update a payment gateway
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGateways/{publicSectorGatewaysUniqID}
Billing and Payment/Invoice Forms
The invoice forms resource is used to view, create, delete, or modify invoice forms.
- Create an invoice form
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoiceForms
- Delete an invoice form
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoiceForms/{publicSectorInvoiceFormsUniqID}
- Get all invoice forms
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoiceForms
- Get an invoice form
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoiceForms/{publicSectorInvoiceFormsUniqID}
- Update an invoice form
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoiceForms/{publicSectorInvoiceFormsUniqID}
Billing and Payment/Invoices
The invoices resource is used to view, create or update invoices.
- Create an invoice data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices
- Create invoices
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices/action/createInvoices
- Get all invoice data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices
- Get an invoice data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}
- Update an invoice data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}
Billing and Payment/Invoices/Bill Lines
The bill lines resource is used to view, create or update invoice lines.
- Create an invoice line
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLine
- Get all invoice lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLine
- Get an invoice line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLine/{BillLineUniqID}
- Update an invoice line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLine/{BillLineUniqID}
Billing and Payment/On Account Payments
The on account payments resource is used to view or create on account payment records.
- Create an on account payment data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOnAccountPayments
- Get a set of on account payment data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOnAccountPayments/{OnaccountHistoryKey}
- Get all on account payment data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOnAccountPayments
- Update a set of on account payments data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOnAccountPayments/{OnaccountHistoryKey}
Billing and Payment/Payment Cart Items
The payment cart Items resource is used by public users to load the fees for payment by adding permits to the cart that are ready for checkout and removing permits from the cart as needed.
- Get a payment cart item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCartItems/{CartId}
- Get all payment cart items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCartItems
Billing and Payment/Payment Cart Items/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCartItems/{CartId}/child/AssociatedProject
- Get one project associated with permit
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCartItems/{CartId}/child/AssociatedProject/{AssociatedProjectUniqID}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/action/checkout
- Delete an item from payment cart
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}
- Delete an item from payment cart.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/action/deleteFromCart
- Get a payment cart item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}
- Get all payment cart items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts
- Send confirmation of the payment status to payment cart.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/action/confirmPayment
- Update an item in the payment cart
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}
Billing and Payment/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}/child/AssociatedProject
- Get one project associated with permit
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}/child/AssociatedProject/{AssociatedProjectUniqID}
Billing and Payment/Payment Groups
The payment groups resource is used to view the payment history groups.
- Get a payment group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentGroups/{PaymentHistoryKey}
- Get all payment groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentGroups
Billing and Payment/Payment Line Communications
The payment line communications resource is used to view payment line data in payment notifications.
- Get a payment line data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentLineCommunications/{PaymentHistoryKey}
- Get all payment lines data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentLineCommunications
Billing and Payment/Payment Records
The payment records resource is used to view the payment records.
- Get a payment record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRecords/{publicSectorPaymentRecordsUniqID}
- Get all payment records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRecords
Billing and Payment/Payment Refunds
The payment refunds resource is used to view or create payment refunds.
- Create a set of refund data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds
- Get a set of refund data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}
- Get all refund data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds
- Update a payment refund
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}
Billing and Payment/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}/child/RefundHistoryLine
- Get a refund line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}/child/RefundHistoryLine/{RefundHistoryLineUniqID}
- Get all refund lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}/child/RefundHistoryLine
Billing and Payment/Payment Reversals
The payment reversals resource is used to reverse fee or deposit activity associated with a deposit account.
- Create a reversal record
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentReversals
- Get a fee or deposit to be reversed
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentReversals/{PaymentReversalKey}
- Get all fees or deposits to be reversed
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentReversals
- Update a fee or deposit to be reversed
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentReversals/{PaymentReversalKey}
Billing and Payment/Payments
The payments resource is used to view or create payment records.
- Create a payment data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayments
- Get all payment data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayments
- Get payment data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}
- Update a set of payments line data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}
Billing and Payment/Payments/Payment Lines
The payment lines resource is used to view or create payment detail lines.
- Create a payment line
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLine
- Get a payment line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLine/{PaymentHistoryLineUniqID}
- Get all payment lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLine
- Update a set of payments line data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLine/{PaymentHistoryLineUniqID}
Billing and Payment/Receivable Options
The receivable options resource is used to view, create, or update options for various transaction sources.
- Create a set of receivable options data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReceivableOptions
- Delete a set of receivable options data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorReceivableOptions/{AgencyId}
- Get a set receivable options data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReceivableOptions/{AgencyId}
- Get all receivable options data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReceivableOptions
- Update a set of ReceivableOptions data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReceivableOptions/{AgencyId}
Billing and Payment/Receivable Receipts
The receivable receipt resource is used to view receivable receipts.
- Get a receivable receipt record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReceivableReceipts/{ReceiptHistoryKey}
- Get all receivable receipt records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReceivableReceipts
Billing and Payment/Record Type Memo Lines
The record type memo lines resource is used to view, create, or update record type mapping of the record type to memo lines.
- Create a record type memo line
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypeMemoLines
- Delete a record type memo line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypeMemoLines/{publicSectorRecordTypeMemoLinesUniqID}
- Get a record type memo line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypeMemoLines/{publicSectorRecordTypeMemoLinesUniqID}
- Get all record type memo lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypeMemoLines
- Update a record type memo line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypeMemoLines/{publicSectorRecordTypeMemoLinesUniqID}
Billing and Payment/SearchDues
The search resource is to get the fee items as the search result.
- Get a search result
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchDues/{SearchId}
- Get all search result
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchDues
Billing and Payment/ThirdPartyPaymentOptions
The third party payment options resource is used to view or create third party payment options.
- Create a third party payment options
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPaymentOptions
- Delete a third party payment options
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPaymentOptions/{AgencyId}
- Get a third party payment options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPaymentOptions/{AgencyId}
- Get all third party payment options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPaymentOptions
- Update a third party payment options
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPaymentOptions/{AgencyId}
Billing and Payment/ThirdPartyPayments
The third party payments resource is used to view or create third party payment records.
- Create a third party payment methods
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments
- Delete a third party payments
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}
- Get a third party payments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}
- Get all third party payment methods
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments
- Update a third party payments
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}
Billing and Payment/ThirdPartyPayments/ThirdPartyPaymentLines
The third party payment lines resource is used to view or create third party payment records.
- Create a third party payment lines
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentLine
- Delete a third party payment lines
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentLine/{PaymentLineKey}
- Get a third party payments lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentLine/{PaymentLineKey}
- Get all third party payment lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentLine
- Update a third party payment lines
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentLine/{PaymentLineKey}
Billing and Payment/ThirdPartyPayments/ThirdPartyPaymentMethods
The third party payment methods resource is used to view or create third party payment records.
- Create a third party payment methods
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentMethod
- Delete a third party payment methods
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentMethod/{PaymentMethodKey}
- Get a third party payment methods
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentMethod/{PaymentMethodKey}
- Get all third party payment methods
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentMethod
- Update a third party payment methods
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentMethod/{PaymentMethodKey}
Business License/About To Expire Business Licenses
This resource is used by agencies to send communications for the business licenses that are about to expire.
- Create a business license record
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAboutToExpireBlLocationLicenses
- Delete a business license record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAboutToExpireBlLocationLicenses/{BusinessLocationKey}
- Get a business license record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAboutToExpireBlLocationLicenses/{BusinessLocationKey}
- Get all business license records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAboutToExpireBlLocationLicenses
- Update a business license record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAboutToExpireBlLocationLicenses/{BusinessLocationKey}
Business License/BL Activity Attachments
The activity attachment resource is used to view attachments on business license records.
- Get all attachments for a business license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments
- Get an attachment for a business license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}
Business License/BL Activity Attachments/Attachments
The attachment resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/child/LnpAttachmentAccessor
- Delete an attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}
- Get all attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/child/LnpAttachmentAccessor
- Get an attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}
- Update an attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}
Business License/BL Activity Attachments/Attachments/Attachment Revisions
The attachment revision resource is used to view attachment revisions.
- Get all attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/child/AttachmentsRevision
- Get an attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Business License/BL Activity Attachments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/enclosure/FileContents
Business License/BL Activity Attachments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/enclosure/FileWebImage
Business License/BL Activity Attachments/Large Object (LOB) Attributes - Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}/enclosure/Preview
Business License/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}
- Get all BL records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords
Business License/BL Records/BL Naics
The bl naics resource is used to view the naics code associated with the license.
- Create a set of Naics codes
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlNaics
- Delete a Naics code
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlNaics/{publicSectorBlRecords_BlNaics_Id}
- Get a Naics code
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlNaics/{publicSectorBlRecords_BlNaics_Id}
- Get all Naics codes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlNaics
- Update a Naics code
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlNaics/{publicSectorBlRecords_BlNaics_Id}
Business License/BL Records/BlFieldGroups
The business field groups resource is used to view, create, modify, or delete a business field group information. This is the Field groups 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.
- Create a field group
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlFieldGroups
- Delete a BL field group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlFieldGroups/{LnpRecordKey2}
- Get a field group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlFieldGroups/{LnpRecordKey2}
- Get all field groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlFieldGroups
- Update a field group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlFieldGroups/{LnpRecordKey2}
Business License/BL Records/BlGlobalCustoms
The business global custom resource is used to view, create, modify, or delete a business global custom information. This is the global custom 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.
- Create a set of global custom attributes
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlGlobalCustom
- Delete a global custom attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlGlobalCustom/{LnpRecordKey3}
- Get a global custom attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlGlobalCustom/{LnpRecordKey3}
- Get all global custom attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlGlobalCustom
- Update a global custom attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlGlobalCustom/{LnpRecordKey3}
Business License/BL Records/Business Locations
The business location resource is used to view, create, modify, or delete a business location. 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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BusinessLocation/{LnpBusinessLocationKey}
- Get all locations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BusinessLocation
Business License/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BusinessOwner
- Get an owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BusinessOwner/{LnpBusinessOwnersKey}
Business License/BL Records/ContactLists
The contact list resource is used to view, create, modify, or delete a contact list. A contact list shows the contact 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.
- Create a set of contact lists
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/ContactList
- Delete a contact list
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
- Get a contact list
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
- Get all contact lists
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/ContactList
- Update a contact list
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
Business License/BL Records/Credentials
The credential resource is used to view, create, modify, or delete a credential. A credential shows the credential 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.
- Create a set of credentials
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/Credential
- Delete a credential
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/Credential/{publicSectorBlRecords_Credential_Id}
- Get a credential
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/Credential/{publicSectorBlRecords_Credential_Id}
- Get all credentials
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/Credential
- Update a credential
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/Credential/{publicSectorBlRecords_Credential_Id}
Business License/BL Records/Large Object (LOB) Attributes - Esignature
- Delete an Esignature
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/enclosure/Esignature
- Get an Esignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/enclosure/Esignature
- Replace an Esignature
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/enclosure/Esignature
Business License/BL Records/Record Comments
The record comment resource is used to view the comments of a record.
- Create a set of comments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordComment
- Delete a record comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordComment/{publicSectorBlRecords_RecordComment_Id}
- Get a record comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordComment/{publicSectorBlRecords_RecordComment_Id}
- Get all record comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordComment
- Update a record comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordComment/{publicSectorBlRecords_RecordComment_Id}
Business License/BL Records/Record Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordComment/{publicSectorBlRecords_RecordComment_Id}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordComment/{publicSectorBlRecords_RecordComment_Id}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordComment/{publicSectorBlRecords_RecordComment_Id}/enclosure/CommentText
Business License/BL Records/Record Contractor Licenses
The record contractor license resource is used to view, create, modify, or delete a record contractor license. You must use the agency???s dynamic REST. API: /fscmRestApi/resources/11.13.18.05/LNP_c.
- Create a set of contractor licenses
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense
- Delete a contractor license
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}
- Get a contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}
- Get all contractor licenses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense
- Update a contractor license
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}
Business License/BL Records/Record Contractor Licenses/Record Contractor License Facts
The record contractor license fact resource is used to view, create, modify, or delete a record contractor license fact. A contractor license fact indicates license fact information associated with contractor license. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
- Create a set of contractor license facts
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicFact
- Delete a contractor license fact
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicFact/{publicSectorBlRecords_RecordContractorLicense_RecordContractorLicFact_Id}
- Get a contractor license fact
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicFact/{publicSectorBlRecords_RecordContractorLicense_RecordContractorLicFact_Id}
- Get all contractor license facts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicFact
- Update a contractor license fact
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicFact/{publicSectorBlRecords_RecordContractorLicense_RecordContractorLicFact_Id}
Business License/BL Records/Record Contractor Licenses/Record Contractor License Insurances
The record contractor license Insurance resource is used to view, create, modify, or delete a record contractor license Insurance. A contractor license Insurance indicates license Insurance information associated with contractor license. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
- Create a set of contractor license insurances
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicInsurance
- Delete a contractor license insurance
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicInsurance/{publicSectorBlRecords_RecordContractorLicense_RecordContractorLicInsurance_Id}
- Get a contractor license insurance
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicInsurance/{publicSectorBlRecords_RecordContractorLicense_RecordContractorLicInsurance_Id}
- Get all contractor license insurances
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicInsurance
- Update a contractor license insurance
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicInsurance/{publicSectorBlRecords_RecordContractorLicense_RecordContractorLicInsurance_Id}
Business License/BL Records/Record Contractor Licenses/Record Contractor License Insurances/Large Object (LOB) Attributes - Exemptlongdesc
- Delete an Exemptlongdesc
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicInsurance/{publicSectorBlRecords_RecordContractorLicense_RecordContractorLicInsurance_Id}/enclosure/Exemptlongdesc
- Get an Exemptlongdesc
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicInsurance/{publicSectorBlRecords_RecordContractorLicense_RecordContractorLicInsurance_Id}/enclosure/Exemptlongdesc
- Replace an Exemptlongdesc
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense/{publicSectorBlRecords_RecordContractorLicense_Id}/child/RecordContractorLicInsurance/{publicSectorBlRecords_RecordContractorLicense_RecordContractorLicInsurance_Id}/enclosure/Exemptlongdesc
Business License/BL Records/Record Parcel Address Owners
The record parcel address owner resource is used to view the owners of a parcel.
- Create a set of parcel address owners
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordParcelAddressOwner
- Delete a parcel address owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{publicSectorBlRecords_RecordParcelAddressOwner_Id}
- Get a parcel address owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{publicSectorBlRecords_RecordParcelAddressOwner_Id}
- Get all parcel address owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordParcelAddressOwner
- Update a parcel address owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{publicSectorBlRecords_RecordParcelAddressOwner_Id}
Business License/BL Records/Record Parcel Address Owners/Large Object (LOB) Attributes - GeometryJson
- Delete a GeometryJson
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{publicSectorBlRecords_RecordParcelAddressOwner_Id}/enclosure/GeometryJson
- Get a GeometryJson
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{publicSectorBlRecords_RecordParcelAddressOwner_Id}/enclosure/GeometryJson
- Replace a GeometryJson
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{publicSectorBlRecords_RecordParcelAddressOwner_Id}/enclosure/GeometryJson
Business License/BL Records/Record Parcel Address Owners/Large Object (LOB) Attributes - SketchJson
- Delete a SketchJson
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{publicSectorBlRecords_RecordParcelAddressOwner_Id}/enclosure/SketchJson
- Get a SketchJson
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{publicSectorBlRecords_RecordParcelAddressOwner_Id}/enclosure/SketchJson
- Replace a SketchJson
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{publicSectorBlRecords_RecordParcelAddressOwner_Id}/enclosure/SketchJson
Business License/BL Records/RecordGISAttr
- Create
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordGISAttr
- Delete
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordGISAttr/{publicSectorBlRecords_RecordGISAttr_Id}
- Get
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordGISAttr/{publicSectorBlRecords_RecordGISAttr_Id}
- Get all
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordGISAttr
- Update
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordGISAttr/{publicSectorBlRecords_RecordGISAttr_Id}
Business License/BL Records/Tax Details
The tax details resource is used to view the tax details of a record.
- Create a set of tax details
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/TaxDetails
- Delete a tax detail
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/TaxDetails/{publicSectorBlRecords_TaxDetails_Id}
- Get a tax detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/TaxDetails/{publicSectorBlRecords_TaxDetails_Id}
- Get all tax details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/TaxDetails
- Update a tax detail
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/TaxDetails/{publicSectorBlRecords_TaxDetails_Id}
Business License/BL Records/Workflow References
The workflow reference resource is used to view the workflow reference of a record.
- Create a set of workflow references
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/WorkflowReference
- Delete a workflow reference
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/WorkflowReference/{publicSectorBlRecords_WorkflowReference_Id}
- Get a workflow reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/WorkflowReference/{publicSectorBlRecords_WorkflowReference_Id}
- Get all workflow references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/WorkflowReference
- Update a workflow reference
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/WorkflowReference/{publicSectorBlRecords_WorkflowReference_Id}
Business License/Bus Entity Statuses
The business entity statuses resource is used to inactivate the status of a business entity.
- Get a business entity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusEntityStatuses/{publicSectorBusEntityStatusesUniqID}
- Get all business entities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusEntityStatuses
- Update a business entity
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusEntityStatuses/{publicSectorBusEntityStatusesUniqID}
Business License/Bus Location Statuses
The business location statuses resource is used to inactivate the status of a business location.
- Get a business location
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusLocationStatuses/{publicSectorBusLocationStatusesUniqID}
- Get all business locations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusLocationStatuses
- Update a business location
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusLocationStatuses/{publicSectorBusLocationStatusesUniqID}
Business License/Business Attachments
The business attachment resource is used to view, create and update business attachments.
- Create a business attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments
- Delete a business attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}
- Get a business attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}
- Get all business attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments
- Update a business attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}
Business License/Business Attachments/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor
- Delete an attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}
- Get all attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor
- Get an attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}
- Update an attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}
Business License/Business Attachments/Attachments/Attachment Revisions
The attachmentsRevision resource is used to view attachment revisions.
- Create an attachment revision
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete an attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}/child/AttachmentsRevision
- Get an attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update an attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Business License/Business Attachments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}/enclosure/FileContents
Business License/Business Attachments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/child/BusinessAttachmentAccessor/{BusinessAttachmentAccessorUniqID}/enclosure/FileWebImage
Business License/Business Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessAttachments/{BusAttachmentKey}/enclosure/Preview
Business License/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories
- Delete a business category
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}
- Get a business category
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}
- Get all business categories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories
- Update a business category
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}
Business License/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}/child/BusinessSubcategory
- Delete a business subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}/child/BusinessSubcategory/{BusinessSubcategoryUniqID}
- Get a business subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}/child/BusinessSubcategory/{BusinessSubcategoryUniqID}
- Get all business subcategories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}/child/BusinessSubcategory
- Update a business subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}/child/BusinessSubcategory/{BusinessSubcategoryUniqID}
Business License/Business Entities
The business entities resource is used to update specific attributes of a business entity.
- Get a business entity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntities/{publicSectorBusinessEntitiesUniqID}
- Get all business entities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntities
- Update a business entity
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntities/{publicSectorBusinessEntitiesUniqID}
Business License/Business Entity Audits
This resource fetches Business Entity Audits data.
- Get a business entity audit
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityAudits/{publicSectorBusinessEntityAuditsUniqID}
- Get all business entity audits
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityAudits
Business License/Business Entity List Details
The business entity list details resource is used to view detailed information about business entities.
- Get a business entity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails/{BusinessEntityKey}
- Get all business entities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails
Business License/Business Entity List Details/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails/{BusinessEntityKey}/child/BusLocationListDetails/{BusinessLocationKey}
- Get all business locations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails/{BusinessEntityKey}/child/BusLocationListDetails
Business License/Business Entity List Details/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails/{BusinessEntityKey}/child/BusOwnersLists/{ReferenceKey}
- Get all business owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails/{BusinessEntityKey}/child/BusOwnersLists
Business License/Business Entity Lists
The business entity lists resource is used to view business entities.
- Get a business entity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityLists/{BusinessEntityKey}
- Get all business entities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityLists
Business License/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlExpiryCommunications/{LnpRecordKey}
- Get all business license expiry communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlExpiryCommunications
Business License/Business License Fees Dues
The business license fees due resource is used to fetch fees due amount for business licenses.
- Get a single business license total fee due amount
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLicenseFeesDues/{publicSectorBusinessLicenseFeesDuesUniqID}
- Get all business licenses fees dues
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLicenseFeesDues
Business License/Business License Workflow Communications
This resource is used to read attributes related to the business license workflow when a workflow communication request is received.
- Create a set of BL workflow communication items
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlWorkflowCommunications
- Delete a BL workflow communication item
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlWorkflowCommunications/{LnpRecordKey}
- Get a BL workflow communication item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlWorkflowCommunications/{LnpRecordKey}
- Get all BL workflow communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlWorkflowCommunications
- Update a BL workflow communication item
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlWorkflowCommunications/{LnpRecordKey}
Business License/Business Licenses
The business license resource is used fetch the license details to send communication to users of inactivated or reactivated business licenses.
- Get a Business License item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLicenses/{LnpRecordId}
- Get all Business License items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLicenses
Business License/Business Location Communications
Used to get the business location attributes along with few business entity attributes. It is used in the business location based communication.
- Get a business location communication related attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationCommunications/{publicSectorBusinessLocationCommunicationsUniqID}
- Get all business location communication related attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationCommunications
Business License/Business Location Contact Types
Used to get all active contacts details of a business location. It is used in business location communication.
- Get a business location contact details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationContactTypes/{BusinessLocationKey}
- Get all business location contact details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationContactTypes
Business License/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationListDetails/{BusinessLocationKey}
- Get all business locations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationListDetails
Business License/Business Location Lists
The business location lists resource is used to view the locations associated with a business entity.
- Get a business location
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationLists/{BusinessLocationKey}
- Get all business locations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationLists
Business License/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessOwnerListDetails/{ReferenceKey}
- Get all business owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessOwnerListDetails
Business License/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessSubcategories
- Delete a business subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessSubcategories/{publicSectorBusinessSubcategoriesUniqID}
- Get a business subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessSubcategories/{publicSectorBusinessSubcategoriesUniqID}
- Get all business subcategories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessSubcategories
- Update a business subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessSubcategories/{publicSectorBusinessSubcategoriesUniqID}
Business License/Business Tax Class Columns
The business tax class column resource is used to view, create, or modify a business tax class column. Business tax classes are used in business license applications.
- Create a set of business tax class columns
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClassColumns
- Delete a business tax class column
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClassColumns/{publicSectorTaxClassColumnsUniqID}
- Get a business tax class column
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClassColumns/{publicSectorTaxClassColumnsUniqID}
- Get all business tax class columns
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClassColumns
- Update a business tax class column
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClassColumns/{publicSectorTaxClassColumnsUniqID}
Business License/Business Tax Classes
The business tax class resource is used to view, create, or modify a business tax class. Business tax classes are used in business license applications.
- Create a set of business tax classes
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses
- Delete a business tax class
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses/{publicSectorTaxClassesUniqID}
- Get a business tax class
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses/{publicSectorTaxClassesUniqID}
- Get all business tax classes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses
- Update a business tax class
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses/{publicSectorTaxClassesUniqID}
Business License/Business Tax Classes/Business Tax Class Columns
The business tax class column resource is used to view, create, or modify a business tax class column.
- Create a set of business tax class columns
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses/{publicSectorTaxClassesUniqID}/child/TaxClassColumns
- Delete a business tax class column
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses/{publicSectorTaxClassesUniqID}/child/TaxClassColumns/{TaxClassColumnsUniqID}
- Get a business tax class column
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses/{publicSectorTaxClassesUniqID}/child/TaxClassColumns/{TaxClassColumnsUniqID}
- Get all business tax class columns
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses/{publicSectorTaxClassesUniqID}/child/TaxClassColumns
- Update a business tax class column
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxClasses/{publicSectorTaxClassesUniqID}/child/TaxClassColumns/{TaxClassColumnsUniqID}
Business License/Business Tax Details
The business tax detail resource is used to view, create, or modify a business tax detail. Business tax details are used in business license applications.
- Create a set of business tax details
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxDetails
- Delete a business tax detail
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxDetails/{BlTaxDetailKey}
- Get a business tax detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxDetails/{BlTaxDetailKey}
- Get all business tax details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxDetails
- Update a business tax detail
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxDetails/{BlTaxDetailKey}
Business License/Business license entities
Agencies use this resource for sending communications to the business entity.
- Get a business license record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlEntityLicenses/{BusinessEntityKey}
- Get all business license records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlEntityLicenses
Business License/Business license locations
This resource is used by agencies to send communications for Business Entity or Business Location.
- Get a business license record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlLocationLicenses/{BusinessLocationKey}
- Get all business license records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlLocationLicenses
Business License/Calculate Business Tax Fees
The calculate business tax fees is used to view the calculation details of the business tax fee.
- Get a business tax detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateBusinessTaxFees/{BlTaxDetailKey}
- Get all business tax details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateBusinessTaxFees
Business License/Expired Business Licenses
This resource is used by agencies to send communications for the business licenses that are expired.
- Create a business license record
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpiredBlLocationLicenses
- Delete a business license record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpiredBlLocationLicenses/{BusinessLocationKey}
- Get a business license record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpiredBlLocationLicenses/{BusinessLocationKey}
- Get all business license records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpiredBlLocationLicenses
- Update a business license record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpiredBlLocationLicenses/{BusinessLocationKey}
Business License/Grace Business Licenses
Grace Business Licenses resource is used by agencies to send communications for the business licenses that can be extended based on the expiration grace date.
- Create a business license record
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGraceBlLocationLicenses
- Delete a business license record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorGraceBlLocationLicenses/{BusinessLocationKey}
- Get a business license record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGraceBlLocationLicenses/{BusinessLocationKey}
- Get all business license records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGraceBlLocationLicenses
- Update a business license record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGraceBlLocationLicenses/{BusinessLocationKey}
Business License/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSCodes
- Delete a NAICS code
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSCodes/{publicSectorNAICSCodesUniqID}
- Get a NAICS code
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSCodes/{publicSectorNAICSCodesUniqID}
- Get all NAICS codes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSCodes
- Update a NAICS code
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSCodes/{publicSectorNAICSCodesUniqID}
Business License/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodes
- Delete a NAICS group code
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodes/{publicSectorNAICSGroupCodesUniqID}
- Get a NAICS group code
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodes/{publicSectorNAICSGroupCodesUniqID}
- Get all NAICS group codes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodes
- Update a NAICS group code
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodes/{publicSectorNAICSGroupCodesUniqID}
Business License/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups
- Delete a NAICS group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}
- Get a NAICS group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}
- Get all NAICS groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups
- Update a NAICS group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}
Business License/NAICS Groups/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor
- Delete a NAICS group code
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor/{NAICSGroupCodeAccessorUniqID}
- Get a NAICS group code
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor/{NAICSGroupCodeAccessorUniqID}
- Get all NAICS group codes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor
- Update a NAICS group code
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor/{NAICSGroupCodeAccessorUniqID}
Business License/Ready for renewal and in process Business Licenses
This resource is used to get all business licenses ready for renewal and renewal in progress.
- Get a license ready for renewal or in process of renewal
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBLRenewalReadyLicenses/{LnpRecordId}
- Get all the licenses ready for renewal and in progress of renewal
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBLRenewalReadyLicenses
Business License/Tax Attributes
The tax attributes resource is used to list the tax attributes used in tax class.
- Create all tax attributes
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxAttributes
- Get a tax attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxAttributes/{AttributeName}
- Get all tax attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxAttributes
- Update a tax attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaxAttributes/{AttributeName}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupAgencies
- Delete a code reference group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupAgencies/{publicSectorCodeGroupAgenciesUniqID}
- Get a code reference group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupAgencies/{publicSectorCodeGroupAgenciesUniqID}
- Get all code reference groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupAgencies
- Update a code reference group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupAgencies/{publicSectorCodeGroupAgenciesUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimeRules
- Delete an agency time rule
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimeRules/{publicSectorAgencyTimeRulesUniqID}
- Get all agency time rules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimeRules
- Get an agency time rule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimeRules/{publicSectorAgencyTimeRulesUniqID}
- Update an agency time rule
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimeRules/{publicSectorAgencyTimeRulesUniqID}
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAllowCaseAppeals/{CaseKey}
- Get all case appeal allowances
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAllowCaseAppeals
Code Enforcement/Appeal Attachments
The appeal attachment resource is used to view, create, or modify an attachment associated to a case appeal. Case appeals are used in Code Enforcement cases.
- Create a set of appeal attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments
- Delete an appeal attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}
- Get all appeal attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments
- Get an appeal attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}
- Update an appeal attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}
Code Enforcement/Appeal Attachments/Attachments
The attachment resource is used to view, create, and update attachments.
- Create a set of attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor
- Delete an attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}
- Get all attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor
- Get an attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}
- Update an attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}
Code Enforcement/Appeal Attachments/Attachments/Attachment Revisions
The attachment revision resource is used to view attachment revisions.
- Create a set of attachment revisions
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}/child/AttachmentsRevision
- Delete an attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}/child/AttachmentsRevision
- Get an attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update an attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Code Enforcement/Appeal Attachments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}/enclosure/FileContents
Code Enforcement/Appeal Attachments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/child/AppealAttachmentsAccessor/{AppealAttachmentsAccessorUniqID}/enclosure/FileWebImage
Code Enforcement/Appeal Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealAttachments/{AttachmentKey}/enclosure/Preview
Code Enforcement/Appeal Corrective Actions
The appeal corrective action resource is used to view, create, or modify a corrective action that is associated to a case hearing. Case hearings are used in Code Enforcement cases. This resource will be deprecated in a future release and should not be used.
- Create a set of corrective actions
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealCorrectiveActions
- Delete a corrective action
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealCorrectiveActions/{AplCrtvKey}
- Get a corrective action
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealCorrectiveActions/{AplCrtvKey}
- Get a set of corrective actions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealCorrectiveActions
- Update a corrective action
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealCorrectiveActions/{AplCrtvKey}
Code Enforcement/Appeal Corrective Actions/Large Object (LOB) Attributes - CorrectiveActionDescription
- Delete a CorrectiveActionDescription
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealCorrectiveActions/{AplCrtvKey}/enclosure/CorrectiveActionDescription
- Get a CorrectiveActionDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealCorrectiveActions/{AplCrtvKey}/enclosure/CorrectiveActionDescription
- Replace a CorrectiveActionDescription
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAppealCorrectiveActions/{AplCrtvKey}/enclosure/CorrectiveActionDescription
Code Enforcement/Assess Case Fees
The assess case fees resource is used to invoke fee calculation for a case.
- Get a case fee record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessCaseFees/{CaseKey}
- Get all case fee records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessCaseFees
- Update a case fee record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessCaseFees/{CaseKey}
Code Enforcement/Assess Notice Fees
The assess notice fee resource is used to invoke the notice fee calculation.
- Get a notice fee record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessNoticeFees/{CaseNoticeKey}
- Get all notice fee records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessNoticeFees
- Update a notice fee record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessNoticeFees/{CaseNoticeKey}
Code Enforcement/CE Parcel Address Owner
The CE parcel, address and owner resource is used to create or modify the parcel, address and owner details associated with incident or case.
- Create a set of parcel, address and owner
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeParcelAddressOwners
- Get a parcel, address and owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeParcelAddressOwners/{publicSectorCeParcelAddressOwnersUniqID}
- Get all parcels, addresses and owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeParcelAddressOwners
- Update a parcel, address and owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeParcelAddressOwners/{publicSectorCeParcelAddressOwnersUniqID}
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateCitationFees/{publicSectorCalculateCitationFeesUniqID}
- Get all citation fee records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateCitationFees
Code Enforcement/Calculate Code Violation Fees
The calculate code violation fees resource is used to view a list of code violation fees that are associated to cases.
- Get a code violation fee
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateCodeViolationFees/{SourceTransactionKey}
- Get all code violation fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateCodeViolationFees
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAppeals
- Get a case appeal
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAppeals/{CaseAppealKey}
- Get all case appeals
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAppeals
- Update a case appeal
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAppeals/{CaseAppealKey}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments
- Delete a case attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}
- Get a case attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}
- Get all case attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments
- Update a case attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor
- Delete a case attachment content
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}
- Get a case attachment content
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}
- Get all case attachment contents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor
- Update a case attachment content
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete a case attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get a case attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all case attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}/child/AttachmentsRevision
- Update a case attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Code Enforcement/Case Attachments/Case Attachment Contents/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}/enclosure/FileContents
Code Enforcement/Case Attachments/Case Attachment Contents/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor/{CaseAttachmentAccessorUniqID}/enclosure/FileWebImage
Code Enforcement/Case Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/enclosure/Preview
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitations
- Delete a case citation
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}
- Get a case citation
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}
- Get all case citations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitations
- Update a case citation
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}/child/PayCitation/{CitationKey2}
- Get all citation payments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}/child/PayCitation
Code Enforcement/Case Citations/Citation Payments/Fee Records
The fee records resource is used to view fee records associated with a citation.
- Get a fee record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}/child/PayCitation/{CitationKey2}/child/FeeRecords/{FeeRecordKey}
- Get all fee records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}/child/PayCitation/{CitationKey2}/child/FeeRecords
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences
- Delete a case code reference
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}
- Get a case code reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}
- Get all case code references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences
- Update a case code reference
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}
Code Enforcement/Case Code References/Case Fee Records
The case fee record resource is used to view, create, or modify a case code violation. Case fee records are used in Code Enforcement cases.
- Create a set of case fee records
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/child/FeeRecords
- Delete a case fee record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/child/FeeRecords/{FeeRecordsUniqID}
- Get a case fee record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/child/FeeRecords/{FeeRecordsUniqID}
- Get all case fee records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/child/FeeRecords
- Update a case fee record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/child/FeeRecords/{FeeRecordsUniqID}
Code Enforcement/Case Code References/Large Object (LOB) Attributes - CodeReferenceDescription
- Delete a CodeReferenceDescription
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/enclosure/CodeReferenceDescription
- Get a CodeReferenceDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/enclosure/CodeReferenceDescription
- Replace a CodeReferenceDescription
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/enclosure/CodeReferenceDescription
Code Enforcement/Case Code References/Large Object (LOB) Attributes - CorrectiveActionDescription
- Delete a CorrectiveActionDescription
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/enclosure/CorrectiveActionDescription
- Get a CorrectiveActionDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/enclosure/CorrectiveActionDescription
- Replace a CorrectiveActionDescription
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/enclosure/CorrectiveActionDescription
Code Enforcement/Case Code Violation History Records
The case code violation history record resource is used to create or view the code violation history records. Case code violation history records are used in Code Enforcement cases.
- Create a case code violation history record
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferenceHistoryRecords
- Get a case code violation history record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferenceHistoryRecords/{CodeReferenceHistoryKey}
- Get all case code violation history records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferenceHistoryRecords
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseComments
- Delete a case comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseComments/{CommentKey}
- Get a case comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseComments/{CommentKey}
- Get all case comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseComments
- Update a case comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseComments/{CommentKey}
Code Enforcement/Case Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseComments/{CommentKey}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseComments/{CommentKey}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseComments/{CommentKey}/enclosure/CommentText
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts
- Delete a case contact
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts/{CaseContactKey}
- Get a case contact
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts/{CaseContactKey}
- Get all case contacts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts
- Update a case contact
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts/{CaseContactKey}
Code Enforcement/Case Details
The case detail resource is used to view a list of cases. Case detail is used to view code enforcement cases.
- Get a case
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseDetails/{CaseKey}
- Get all cases
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseDetails
Code Enforcement/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.
- Create a set of case fee records
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords
- Delete a case fee record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords/{FeeRecordKey}
- Get a case fee record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords/{FeeRecordKey}
- Get all case fee records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords
- Update a case fee record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords/{FeeRecordKey}
Code Enforcement/Case Fee Records/Case Fee Search Requests
The case fee search request resource is used to search Code Enforcement case fees that are in due status.
- Get a case fee request
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords/{FeeRecordKey}/child/CaseFeeSearchRequests/{SearchRequestKey}
- Get all case fee requests
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords/{FeeRecordKey}/child/CaseFeeSearchRequests
Code Enforcement/Case Fee Search Requests
The case fee search request resource is used to search Code Enforcement case fees which are in due status.
- Create a set of case fee requests
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeSearchRequests
- Delete a case fee request
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeSearchRequests/{SearchRequestKey}
- Get a case fee request
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeSearchRequests/{SearchRequestKey}
- Get all case fee requests
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeSearchRequests
- Update a case fee request
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeSearchRequests/{SearchRequestKey}
Code Enforcement/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.
- Create a set of case history records
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseHistoryRecords
- Get a case history record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseHistoryRecords/{CaseHistoryKey}
- Get all case history records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseHistoryRecords
Code Enforcement/Case Inspection Time Recording Fees
The case inspection time recording fees resource is used to get the fees attribute for a case inspection.
- Get a case inspection time recording fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateCEInspectionTimeRecordingFees/{TeEntryKey}
- Get all case inspection time recording fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateCEInspectionTimeRecordingFees
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments
- Delete a case notice attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}
- Get a case notice attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}
- Get all case notice attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments
- Update a case notice attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor
- Delete a case notice attachment content
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}
- Get a case notice attachment content
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}
- Get all case notice attachment contents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor
- Update a case notice attachment content
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete a case notice attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get a case notice attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all case notice attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}/child/AttachmentsRevision
- Update a case notice attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Code Enforcement/Case Notice Attachments/Case Notice Attachment Contents/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}/enclosure/FileContents
Code Enforcement/Case Notice Attachments/Case Notice Attachment Contents/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/child/CaseNoticeAttachmentAccessor/{CaseNoticeAttachmentAccessorUniqID}/enclosure/FileWebImage
Code Enforcement/Case Notice Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}/enclosure/Preview
Code Enforcement/Case Notices
The list notices resource is used to view the details of a case notice. Notices are used in Code Enforcement cases.
- Create a case notice
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices
- Delete a case notice
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices/{CaseNoticeKey}
- Get a case notice
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices/{CaseNoticeKey}
- Get a case notice
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListNotices/{CaseNoticeKey}
- Get all case notices
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices
- Get all case notices
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListNotices
- Update a case notice
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices/{CaseNoticeKey}
Code Enforcement/Case Notices/Case Contacts
The case contact resource is used to view the contact information of a case notice. Case notices are used in Code Enforcement cases.
- Get a case contact for a case notice
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListNotices/{CaseNoticeKey}/child/CaseContacts/{CaseContactKey}
- Get all case contacts for a case notice
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListNotices/{CaseNoticeKey}/child/CaseContacts
Code Enforcement/Case Overview Fees
The case overview fee request resource is used to list Code Enforcement case fees.
- Get a case overview fee
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseOverviewFees/{CaseKey}
- Get all case overview fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseOverviewFees
Code Enforcement/Case Time Recording Fees
The case time recording fees resource is used to get the fee attributes for a case.
- Get a case time recording fee
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateCaseTimeRecordingFees/{TeEntryKey}
- Get all case time recording fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateCaseTimeRecordingFees
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}
- Get all cases
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases
- Update a case
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}
Code Enforcement/Cases/Code Violation
The code violation resource is used to view the code violation associated with a case.
- Create a code violation
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference
- Delete a code violation
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference/{publicSectorCases_CaseCodeReference_Id}
- Get a code violation
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference/{publicSectorCases_CaseCodeReference_Id}
- Get all code violations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference
- Update a code violation
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference/{publicSectorCases_CaseCodeReference_Id}
Code Enforcement/Cases/Code Violation/Large Object (LOB) Attributes - CodeReferenceDescription
- Delete a CodeReferenceDescription
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference/{publicSectorCases_CaseCodeReference_Id}/enclosure/CodeReferenceDescription
- Get a CodeReferenceDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference/{publicSectorCases_CaseCodeReference_Id}/enclosure/CodeReferenceDescription
- Replace a CodeReferenceDescription
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference/{publicSectorCases_CaseCodeReference_Id}/enclosure/CodeReferenceDescription
Code Enforcement/Cases/Code Violation/Large Object (LOB) Attributes - CorrectiveActionDescription
- Delete a CorrectiveActionDescription
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference/{publicSectorCases_CaseCodeReference_Id}/enclosure/CorrectiveActionDescription
- Get a CorrectiveActionDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference/{publicSectorCases_CaseCodeReference_Id}/enclosure/CorrectiveActionDescription
- Replace a CorrectiveActionDescription
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference/{publicSectorCases_CaseCodeReference_Id}/enclosure/CorrectiveActionDescription
Code Enforcement/Citation Code Violations
The citation code violation resource is used to view and link code violations and citations in a case.
- Create a set of citation code violations
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitationCodeViolations
- Get a citation code violation
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitationCodeViolations/{CitationCoderefKey}
- Get all citation code violations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCitationCodeViolations
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayCitations/{CitationKey}
- Get all citation payments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayCitations
Code Enforcement/Citation Payments/Fee Records
The fee records resource is used to view fee records associated with a citation.
- Get a fee record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayCitations/{CitationKey}/child/FeeRecords/{FeeRecordKey}
- Get all fee records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayCitations/{CitationKey}/child/FeeRecords
Code Enforcement/Claim Cases
The claim case resource is used to create a claimant for a case.
- Get a case
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorClaimCases/{CaseKey}
- Get all cases
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorClaimCases
- Update a case claimant
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorClaimCases/{CaseKey}
Code Enforcement/Code Enforcement Agency Options
The code enforcement agency option 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions
- Delete an agency's code enforcement options
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions/{AgencyId}
- Get all agencies' code enforcement options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions
- Get an agency's code enforcement options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions/{AgencyId}
- Update an agency's code enforcement options
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions/{AgencyId}
Code Enforcement/Code Enforcement Agency Options/Large Object (LOB) Attributes - LongDescription
- Delete a LongDescription
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions/{AgencyId}/enclosure/LongDescription
- Get a LongDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions/{AgencyId}/enclosure/LongDescription
- Replace a LongDescription
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions/{AgencyId}/enclosure/LongDescription
Code Enforcement/Code Enforcement Code Violations
The code enforcement code violation resource is used to view code violations along with the related corrective actions. Code violations are used in code enforcement cases.
- Get a code reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeEnforcementCodeReferences/{publicSectorSearchCodeEnforcementCodeReferencesUniqID}
- Get all code references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeEnforcementCodeReferences
Code Enforcement/Code Enforcement Code Violations/Large Object (LOB) Attributes - CorrectiveActionDescription
- Get a CorrectiveActionDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeEnforcementCodeReferences/{publicSectorSearchCodeEnforcementCodeReferencesUniqID}/enclosure/CorrectiveActionDescription
Code Enforcement/Code Enforcement Code Violations/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeEnforcementCodeReferences/{publicSectorSearchCodeEnforcementCodeReferencesUniqID}/enclosure/Description
- Get a Description
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeEnforcementCodeReferences/{publicSectorSearchCodeEnforcementCodeReferencesUniqID}/enclosure/Description
- Replace a Description
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeEnforcementCodeReferences/{publicSectorSearchCodeEnforcementCodeReferencesUniqID}/enclosure/Description
Code Enforcement/Code Enforcement Fee Line Models
The code enforcement fee line models resource is used to view the issue subtype, fee schedule, and fee line-related information for fee line mappings. It will retrieve the fee schedule for the current date.
- Get a code enforcement fee line decision model
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementFeeLineModels/{publicSectorCodeEnforcementFeeLineModelsUniqID}
- Get all code enforcement fee line decision models
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementFeeLineModels
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents
- Delete an incident
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}
- Get all incidents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents
- Get an incident
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}
- Update an incident
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment
- Delete a comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment/{CommentKey}
- Get a comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment/{CommentKey}
- Get all comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment
- Update a comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment/{CommentKey}
Code Enforcement/Code Enforcement Incidents/Incident Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment/{CommentKey}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment/{CommentKey}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment/{CommentKey}/enclosure/CommentText
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments
- Delete a code enforcement inspection attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}
- Get a code enforcement inspection attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}
- Get all code enforcement inspection attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments
- Update a code enforcement inspection attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor
- Delete a code enforcement inspection attachment accessor
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}
- Get a code enforcement inspection attachment accessor
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}
- Get all code enforcement inspection attachment accessors
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor
- Update a code enforcement inspection attachment accessor
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}
Code Enforcement/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 inspection attachment revisions
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}/child/AttachmentsRevision
- Delete an inspection attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all inspection attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}/child/AttachmentsRevision
- Get an inspection attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update an inspection attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Code Enforcement/Code Enforcement Inspection Attachments/Code Enforcement Inspection Attachment Accessors/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}/enclosure/FileContents
Code Enforcement/Code Enforcement Inspection Attachments/Code Enforcement Inspection Attachment Accessors/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/child/InspectionAttachmentViewAccessor/{InspectionAttachmentViewAccessorUniqID}/enclosure/FileWebImage
Code Enforcement/Code Enforcement Inspection Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}/enclosure/Preview
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments
- Delete a code enforcement inspection comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{publicSectorCodeEnforcementInspectionCommentsUniqID}
- Get a code enforcement inspection comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{publicSectorCodeEnforcementInspectionCommentsUniqID}
- Get all code enforcement inspection comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments
- Update a code enforcement inspection comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{publicSectorCodeEnforcementInspectionCommentsUniqID}
Code Enforcement/Code Enforcement Inspection Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{publicSectorCodeEnforcementInspectionCommentsUniqID}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{publicSectorCodeEnforcementInspectionCommentsUniqID}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{publicSectorCodeEnforcementInspectionCommentsUniqID}/enclosure/CommentText
Code Enforcement/Code Enforcement Inspection Counts
The code enforcement inspection counts resource is used to get the count of inspections that are conducted as a part of the Code Enforcement process.
- Get all inspection counts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCountInspections
- Get an inspection count
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCountInspections/{SourceTransactionKey}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections
- Delete an inspection
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections/{publicSectorCodeEnforcementInspectionsUniqID}
- Get all inspections
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections
- Get an inspection
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections/{publicSectorCodeEnforcementInspectionsUniqID}
- Update an inspection
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections/{publicSectorCodeEnforcementInspectionsUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses
- Delete a code enforcement status
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses/{publicSectorCodeEnforcementStatusesUniqID}
- Get a code enforcement status
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses/{publicSectorCodeEnforcementStatusesUniqID}
- Get code enforcement statuses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses
- Update a code enforcement status
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses/{publicSectorCodeEnforcementStatusesUniqID}
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeOfficerLists/{PersonId}
- Get all code officers
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeOfficerLists
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions
- Delete a corrective action
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions/{publicSectorCorrectiveActionsUniqID}
- Get a corrective action
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions/{publicSectorCorrectiveActionsUniqID}
- Get all corrective actions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions
- Update a corrective action
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions/{publicSectorCorrectiveActionsUniqID}
Code Enforcement/Corrective Actions/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions/{publicSectorCorrectiveActionsUniqID}/enclosure/Description
- Get a Description
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions/{publicSectorCorrectiveActionsUniqID}/enclosure/Description
- Replace a Description
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions/{publicSectorCorrectiveActionsUniqID}/enclosure/Description
Code Enforcement/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.
- Get a due date type definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementDueDateTypes/{publicSectorCodeEnforcementDueDateTypesUniqID}
- Get all due date type definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementDueDateTypes
Code Enforcement/Early Inspection Requests
The early inspection request resource is used to store code enforcement inspection requests that are ready for early inspection.
- Create a set of early inspection requests
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEarlyInspectionRequests
- Delete an early inspection request
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorEarlyInspectionRequests/{EarlyInsKey}
- Get all early inspection requests
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEarlyInspectionRequests
- Get an early inspection request
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEarlyInspectionRequests/{EarlyInsKey}
- Update an early inspection request
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEarlyInspectionRequests/{EarlyInsKey}
Code Enforcement/Early Inspection Requests/Large Object (LOB) Attributes - ExtnAttributeClobOne
- Delete an ExtnAttributeClobOne
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorEarlyInspectionRequests/{EarlyInsKey}/enclosure/ExtnAttributeClobOne
- Get an ExtnAttributeClobOne
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEarlyInspectionRequests/{EarlyInsKey}/enclosure/ExtnAttributeClobOne
- Replace an ExtnAttributeClobOne
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEarlyInspectionRequests/{EarlyInsKey}/enclosure/ExtnAttributeClobOne
Code Enforcement/Incident Comments
The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.
- Create a comment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments
- Delete a comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments/{CommentKey}
- Get a comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments/{CommentKey}
- Get all comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments
- Update a comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments/{CommentKey}
Code Enforcement/Incident Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments/{CommentKey}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments/{CommentKey}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments/{CommentKey}/enclosure/CommentText
Code Enforcement/Incident Status Histories
Use the incident status histories resource to view status change histories for incidents.
- Get all incident status history records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncStatusHistories
- Get an incident status history record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncStatusHistories/{publicSectorIncStatusHistoriesUniqID}
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegIncStatusHistories
- Get an incident status history record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegIncStatusHistories/{publicSectorRegIncStatusHistoriesUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementSetupInspectionCounts
- Delete an inspection count
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementSetupInspectionCounts/{publicSectorCodeEnforcementSetupInspectionCountsUniqID}
- Get all inspection counts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementSetupInspectionCounts
- Get an inspection count
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementSetupInspectionCounts/{publicSectorCodeEnforcementSetupInspectionCountsUniqID}
- Update an inspection count
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementSetupInspectionCounts/{publicSectorCodeEnforcementSetupInspectionCountsUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachmentCrossReferences
- Delete an attachment cross-reference
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachmentCrossReferences/{publicSectorIntakeAttachmentCrossReferencesUniqID}
- Get all attachment cross-references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachmentCrossReferences
- Get an attachment cross-reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachmentCrossReferences/{publicSectorIntakeAttachmentCrossReferencesUniqID}
- Update an attachment cross-reference
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachmentCrossReferences/{publicSectorIntakeAttachmentCrossReferencesUniqID}
Code Enforcement/Intake Attachments
The intake attachments resource is used to view, create, and update intake attachments.
- Create an attachment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments
- Delete an attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}
- Get all attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments
- Get an attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}
- Update an attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}
Code Enforcement/Intake Attachments/Attachment View Accessors
The attachment view accessors resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor
- Delete an attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}
- Get all attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor
- Get an attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}
- Update an attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}
Code Enforcement/Intake Attachments/Attachment View Accessors/Attachment Revisions
The attachment revisions resource is used to view attachment revisions.
- Create an attachment revision
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/child/AttachmentsRevision
- Delete an attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/child/AttachmentsRevision
- Get an attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update an attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Code Enforcement/Intake Attachments/Attachment View Accessors/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/enclosure/FileContents
Code Enforcement/Intake Attachments/Attachment View Accessors/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/enclosure/FileWebImage
Code Enforcement/Intake Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/enclosure/Preview
Code Enforcement/Intake Global Fields
The intake global fields 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/CE_c.
- Get all intake global fields records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields
- Get an intake global fields record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}
Code Enforcement/Intake Global Fields/Global Customs
The case resource is used to view, create, modify, or delete case information.
- Create a case
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case
- Create a set of global custom records
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/CeGlobalCustom
- Create an incident
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Incident
- Delete a case
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}
- Delete an incident
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Incident/{publicSectorCeIntakeGlobalFields_Incident_Id}
- Delete an intake global fields record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/CeGlobalCustom/{IntakeKey2}
- Get a case
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}
- Get a global custom record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/CeGlobalCustom/{IntakeKey2}
- Get all cases
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case
- Get all global custom records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/CeGlobalCustom
- Get all incidents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Incident
- Get an incident
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Incident/{publicSectorCeIntakeGlobalFields_Incident_Id}
- Update a case
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}
- Update an incident
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Incident/{publicSectorCeIntakeGlobalFields_Incident_Id}
- Update an intake global fields record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/CeGlobalCustom/{IntakeKey2}
Code Enforcement/Intake Global Fields/Global Customs/Global Customs
The case code reference resource is used to view, create, modify, or delete case code references.
- Create a case code reference
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}/child/CaseCodeReference
- Delete a case code reference
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}/child/CaseCodeReference/{publicSectorCeIntakeGlobalFields_Case_CaseCodeReference_Id}
- Get a case code references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}/child/CaseCodeReference/{publicSectorCeIntakeGlobalFields_Case_CaseCodeReference_Id}
- Get all case code references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}/child/CaseCodeReference
- Update a case code reference
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}/child/CaseCodeReference/{publicSectorCeIntakeGlobalFields_Case_CaseCodeReference_Id}
Code Enforcement/Intake Global Fields/Global Customs/Global Customs/Large Object (LOB) Attributes - CodeReferenceDescription
- Delete a CodeReferenceDescription
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}/child/CaseCodeReference/{publicSectorCeIntakeGlobalFields_Case_CaseCodeReference_Id}/enclosure/CodeReferenceDescription
- Get a CodeReferenceDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}/child/CaseCodeReference/{publicSectorCeIntakeGlobalFields_Case_CaseCodeReference_Id}/enclosure/CodeReferenceDescription
- Replace a CodeReferenceDescription
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}/child/CaseCodeReference/{publicSectorCeIntakeGlobalFields_Case_CaseCodeReference_Id}/enclosure/CodeReferenceDescription
Code Enforcement/Intake Global Fields/Global Customs/Global Customs/Large Object (LOB) Attributes - CorrectiveActionDescription
- Delete a CorrectiveActionDescription
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}/child/CaseCodeReference/{publicSectorCeIntakeGlobalFields_Case_CaseCodeReference_Id}/enclosure/CorrectiveActionDescription
- Get a CorrectiveActionDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}/child/CaseCodeReference/{publicSectorCeIntakeGlobalFields_Case_CaseCodeReference_Id}/enclosure/CorrectiveActionDescription
- Replace a CorrectiveActionDescription
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case/{publicSectorCeIntakeGlobalFields_Case_Id}/child/CaseCodeReference/{publicSectorCeIntakeGlobalFields_Case_CaseCodeReference_Id}/enclosure/CorrectiveActionDescription
Code Enforcement/Intake Proxy Attachments
The intake proxy attachments resource is used to view intake attachments added by an anonymous public user.
- Create an attachment action is not supported
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments
- Delete an attachment action is not supported
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}
- Get all attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments
- Get an attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}
- Update an attachment action is not supported
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}
Code Enforcement/Intake Proxy Attachments/Attachments
The attachments resource is used to view attachments.
- Get all attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor
- Get an attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}
Code Enforcement/Intake Proxy Attachments/Attachments/Attachment Revisions
The attachment revisions resource is used to view, create, update, and delete attachment revisions.
- Get all attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/child/AttachmentsRevision
- Get an attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Remove an attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Replace an attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Upload an attachment revision
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/child/AttachmentsRevision
Code Enforcement/Intake Proxy Attachments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/enclosure/FileContents
Code Enforcement/Intake Proxy Attachments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor/{IntakeAttachmentViewAccessorUniqID}/enclosure/FileWebImage
Code Enforcement/Intake Proxy Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeProxyAttachments/{AttachmentKey}/enclosure/Preview
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupSubtypes
- Delete a code reference group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupSubtypes/{publicSectorCodeGroupSubtypesUniqID}
- Get a code reference group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupSubtypes/{publicSectorCodeGroupSubtypesUniqID}
- Get all code reference groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupSubtypes
- Update a code reference group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupSubtypes/{publicSectorCodeGroupSubtypesUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypeTimeRules
- Delete a time rule definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypeTimeRules/{publicSectorIssueSubtypeTimeRulesUniqID}
- Get a time rule definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypeTimeRules/{publicSectorIssueSubtypeTimeRulesUniqID}
- Get all time rule definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypeTimeRules
- Update a time rule definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypeTimeRules/{publicSectorIssueSubtypeTimeRulesUniqID}
Code Enforcement/Issue Subtypes
The issue subtypes resource is used to view, create, or modify issue subtypes.
- Create an issue subtype
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes
- Get all issue subtypes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes
- Get an issue subtype
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes/{publicSectorIssueSubtypesUniqID}
- Update an issue subtype
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes/{publicSectorIssueSubtypesUniqID}
Code Enforcement/Issue Subtypes/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes/{publicSectorIssueSubtypesUniqID}/enclosure/Description
- Get a Description
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes/{publicSectorIssueSubtypesUniqID}/enclosure/Description
- Replace a Description
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes/{publicSectorIssueSubtypesUniqID}/enclosure/Description
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupTypes
- Delete a code reference group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupTypes/{publicSectorCodeGroupTypesUniqID}
- Get a code reference group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupTypes/{publicSectorCodeGroupTypesUniqID}
- Get all code reference groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupTypes
- Update a code reference group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeGroupTypes/{publicSectorCodeGroupTypesUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypeTimeRules
- Delete a time rule definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypeTimeRules/{publicSectorIssueTypeTimeRulesUniqID}
- Get a time rule definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypeTimeRules/{publicSectorIssueTypeTimeRulesUniqID}
- Get all time rule definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypeTimeRules
- Update a time rule definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypeTimeRules/{publicSectorIssueTypeTimeRulesUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes
- Get all issue types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes
- Get an issue type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes/{publicSectorIssueTypesUniqID}
- Update an issue type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes/{publicSectorIssueTypesUniqID}
Code Enforcement/Issue Types/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes/{publicSectorIssueTypesUniqID}/enclosure/Description
- Get a Description
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes/{publicSectorIssueTypesUniqID}/enclosure/Description
- Replace a Description
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes/{publicSectorIssueTypesUniqID}/enclosure/Description
Code Enforcement/List Case Access Requests
The list case access requests resource is used to view and update case access requests. Case access requests can be made by public users to get access to a case.
- Get a case access request
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCaseAccessRequests/{CaseContactKey}
- Get all case access requests
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCaseAccessRequests
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCaseAppeals/{CaseAppealKey}
- Get all case appeals
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCaseAppeals
Code Enforcement/List Case Appeals/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCaseAppeals/{CaseAppealKey}/enclosure/Description
- Get a Description
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCaseAppeals/{CaseAppealKey}/enclosure/Description
- Replace a Description
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCaseAppeals/{CaseAppealKey}/enclosure/Description
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCitationNotices/{publicSectorListCitationNoticesUniqID}
- Get all citation notices
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCitationNotices
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCitationNotices/{publicSectorListCitationNoticesUniqID}/child/CaseContacts/{CaseContactKey}
- Get all case contacts for a citation notice
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCitationNotices/{publicSectorListCitationNoticesUniqID}/child/CaseContacts
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListViolationNotices/{CaseNoticeKey}
- Get all violation notices
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListViolationNotices
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListViolationNotices/{CaseNoticeKey}/child/CaseContacts/{CaseContactKey}
- Get all case contacts of a violation notice
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListViolationNotices/{CaseNoticeKey}/child/CaseContacts
Code Enforcement/Overdue Code Violations
The overdue code violation resource is used to view a list of code violations that have exceeded the compliance date.
- Get all overdue code violations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOverdueCodeViolations
- Get an overdue code violation
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOverdueCodeViolations/{SourceTransactionKey}
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayCaseFees/{FeeRecordKey}
- Get all case fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayCaseFees
- Update a case fee
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayCaseFees/{FeeRecordKey}
Code Enforcement/Pay Cases
The pay case resource is used to view or modify a case fee. Case fees are used in Code Enforcement cases.
- Get a case fee
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayCases/{CaseKey}
- Get all case fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayCases
- Update a case fee
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPayCases/{CaseKey}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementPolicyDates
- Delete a time rule based policy date
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementPolicyDates/{publicSectorCodeEnforcementPolicyDatesUniqID}
- Get a time rule based policy date
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementPolicyDates/{publicSectorCodeEnforcementPolicyDatesUniqID}
- Get all time rule based policy dates
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementPolicyDates
- Update a time rule based policy date
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementPolicyDates/{publicSectorCodeEnforcementPolicyDatesUniqID}
Code Enforcement/Process Definition Group Histories
The process definition group histories resource is used to view the case history details about the process definition groups.
- Get a process group history record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowProcessGroupHistories/{publicSectorWorkflowProcessGroupHistoriesUniqID}
- Get all process group history records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowProcessGroupHistories
Code Enforcement/Process Definition Groups
The process definition groups resource is used to view, create, delete or modify process definition groups.
- Create process groups
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowProcessGroups
- Delete a process group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowProcessGroups/{publicSectorWorkflowProcessGroupsUniqID}
- Get a process group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowProcessGroups/{publicSectorWorkflowProcessGroupsUniqID}
- Get all process groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowProcessGroups
- Update a process group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowProcessGroups/{publicSectorWorkflowProcessGroupsUniqID}
Code Enforcement/Recalculate Code Violation Fees
The recalculate code violation fees resource is used to view a list of code violation fees that are associated to cases.
- Get a recalculated code violation fee
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecalculateCodeViolationFees/{CodeReferenceKey}
- Get all recalculated code violation fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecalculateCodeViolationFees
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReferralBodies
- Get a referral body
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReferralBodies/{publicSectorReferralBodiesUniqID}
- Get all related referral bodies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReferralBodies
- Update a referral body
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReferralBodies/{publicSectorReferralBodiesUniqID}
Code Enforcement/Search Code Technicians
The search code technician resource is used to view a code technician. Code technicians are the users who handle Code Enforcement cases.
- Create a set of code technicians
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeTechnicians
- Delete a code technician
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeTechnicians/{publicSectorSearchCodeTechniciansUniqID}
- Get a code technician
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeTechnicians/{publicSectorSearchCodeTechniciansUniqID}
- Get all code technicians
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeTechnicians
- Update a code technician
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeTechnicians/{publicSectorSearchCodeTechniciansUniqID}
Code Enforcement/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchViolationCodeReferences/{publicSectorSearchViolationCodeReferencesUniqID}
- Get all violation code references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchViolationCodeReferences
Code Enforcement/Search Violation Code References/Large Object (LOB) Attributes - CodeReferenceDescription
- Delete a CodeReferenceDescription
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchViolationCodeReferences/{publicSectorSearchViolationCodeReferencesUniqID}/enclosure/CodeReferenceDescription
- Get a CodeReferenceDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchViolationCodeReferences/{publicSectorSearchViolationCodeReferencesUniqID}/enclosure/CodeReferenceDescription
- Replace a CodeReferenceDescription
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchViolationCodeReferences/{publicSectorSearchViolationCodeReferencesUniqID}/enclosure/CodeReferenceDescription
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRulePolicies
- Delete a time rule policy
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRulePolicies/{publicSectorCodeEnforcementTimeRulePoliciesUniqID}
- Get a time rule policy
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRulePolicies/{publicSectorCodeEnforcementTimeRulePoliciesUniqID}
- Get all time rule policies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRulePolicies
- Update a time rule policy
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRulePolicies/{publicSectorCodeEnforcementTimeRulePoliciesUniqID}
Code Enforcement/Time Rule Triggers
The time rule triggers resource is used to configure the time rule definitions, which are used in the Code Enforcement process.
- Get a trigger definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRuleTriggers/{TriggerId}
- Get all trigger definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRuleTriggers
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules
- Delete a time rule definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}
- Get a time rule definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}
- Get all time rules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules
- Update a time rule definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy
- Delete a time rule policy
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy/{TimeRulePolicyUniqID}
- Get a time rule policy
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy/{TimeRulePolicyUniqID}
- Get all time rule policies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy
- Update a time rule policy
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy/{TimeRulePolicyUniqID}
Code Enforcement/User Case Appeals
The user case appeal resource is used to create an appeal for a case by a user. Appeals can be created against a violation or a citation issued for a case.
- Create a set of appeals
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCaseAppeals
- Get all appeals
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCaseAppeals
- Get an appeal
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCaseAppeals/{CaseAppealKey}
Code Enforcement/User Cases
The user case resource is used to view a case that has been claimed by a user.
- Get a case
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}
- Get all cases
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases
Code Enforcement/User Cases/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}/child/AllowCaseAppeals/{CaseKey2}
- Get all case appeal allowances
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}/child/AllowCaseAppeals
Code Enforcement/User Cases/Case Fee Payments
The user case fee payment resource is used to view the fee payments of the case.
- Get a case fee payment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}/child/UserCaseFeePayments/{CaseKey3}
- Get all case fee payments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}/child/UserCaseFeePayments
Code Enforcement/User Cases/Code Violations
The code violation resource is used to view a code violation of the case.
- Get a case code violation
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}/child/CaseCodeReference/{CoderefKey}
- Get all case code violations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}/child/CaseCodeReference
Code Enforcement/User Cases/Code Violations/Large Object (LOB) Attributes - CodeRefDescription
- Get a CodeRefDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}/child/CaseCodeReference/{CoderefKey}/enclosure/CodeRefDescription
Code Enforcement/User Cases/Code Violations/Large Object (LOB) Attributes - CorrectiveActionDescription
- Get a CorrectiveActionDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}/child/CaseCodeReference/{CoderefKey}/enclosure/CorrectiveActionDescription
Code Enforcement/User Cases/User Notices
The user notice resource is used to view a notice issued to a user. Notices can be issued for code enforcement violations or citations.
- Get a notice
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}/child/UserNotices/{CaseNoticeKey}
- Get all notices
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}/child/UserNotices
Code Enforcement/Violation Ad Hoc Notices
The violation ad hoc notice resource is used to view, create, or modify a violation ad hoc notice type mapping in a violation notice group. Violation ad hoc notice types are used in Code Enforcement cases.
- Create a set of ad hoc violation notice types in a violation notice group
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationAdhocNotices
- Delete an ad hoc violation notice type from a violation notice group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationAdhocNotices/{publicSectorViolationAdhocNoticesUniqID}
- Get all ad hoc violation notice types from a violation notice group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationAdhocNotices
- Get an ad hoc violation notice type from a violation notice group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationAdhocNotices/{publicSectorViolationAdhocNoticesUniqID}
- Update an ad hoc violation notice type in a violation notice group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationAdhocNotices/{publicSectorViolationAdhocNoticesUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroupCodes
- Delete a violation code reference group code
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroupCodes/{publicSectorViolationCodeReferenceGroupCodesUniqID}
- Get a violation code reference group code
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroupCodes/{publicSectorViolationCodeReferenceGroupCodesUniqID}
- Get all violation code reference group codes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroupCodes
- Update a violation code reference group code
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroupCodes/{publicSectorViolationCodeReferenceGroupCodesUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups
- Delete a violation code reference group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}
- Get a violation code reference group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}
- Get all violation code reference groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups
- Update a violation code reference group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}/child/CodeReferences
- Delete a violation code reference in a violation code reference group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}/child/CodeReferences/{CodeReferencesUniqID}
- Get a violation code reference in a violation code reference group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}/child/CodeReferences/{CodeReferencesUniqID}
- Get all violation code references in a violation code reference group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}/child/CodeReferences
- Update a violation code reference in a violation code reference group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}/child/CodeReferences/{CodeReferencesUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences
- Delete a violation code reference
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences/{publicSectorViolationCodeReferencesUniqID}
- Get a violation code reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences/{publicSectorViolationCodeReferencesUniqID}
- Get all violation code references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences
- Update a violation code reference
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences/{publicSectorViolationCodeReferencesUniqID}
Code Enforcement/Violation Code References/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences/{publicSectorViolationCodeReferencesUniqID}/enclosure/Description
- Get a Description
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences/{publicSectorViolationCodeReferencesUniqID}/enclosure/Description
- Replace a Description
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences/{publicSectorViolationCodeReferencesUniqID}/enclosure/Description
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups
- Delete a violation notice group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}
- Get a violation notice group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}
- Get all violation notice groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups
- Update a violation notice group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}
Code Enforcement/Violation Notice Groups/Violation Ad Hoc Notices
The violation ad hoc notice resource is used to view, create, or modify a violation ad hoc notice type mapping within a violation notice group. Violation ad hoc notice types are used in Code Enforcement cases.
- Create a set of ad hoc violation notice types in a violation notice group
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/AdhocNotices
- Delete an ad hoc violation notice type from a violation notice group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/AdhocNotices/{AdhocNoticesUniqID}
- Get all ad hoc violation notice types from a violation notice group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/AdhocNotices
- Get an ad hoc violation notice type from a violation notice group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/AdhocNotices/{AdhocNoticesUniqID}
- Update an ad hoc violation notice type in a violation notice group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/AdhocNotices/{AdhocNoticesUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/NoticeMappings
- Delete a violation notice type from a violation notice group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/NoticeMappings/{NoticeMappingsUniqID}
- Get a violation notice type from a violation notice group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/NoticeMappings/{NoticeMappingsUniqID}
- Get all violation notice types from a violation notice group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/NoticeMappings
- Update a violation notice type in a violation notice group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/NoticeMappings/{NoticeMappingsUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeMappings
- Delete a violation notice type from a violation notice group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeMappings/{publicSectorViolationNoticeMappingsUniqID}
- Get a violation notice type from a violation notice group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeMappings/{publicSectorViolationNoticeMappingsUniqID}
- Get all violation notice types from a violation notice group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeMappings
- Update a violation notice type in a violation notice group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeMappings/{publicSectorViolationNoticeMappingsUniqID}
Code Enforcement/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeTypes
- Delete a violation notice type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeTypes/{publicSectorViolationNoticeTypesUniqID}
- Get a violation notice type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeTypes/{publicSectorViolationNoticeTypesUniqID}
- Get all violation notice types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeTypes
- Update a violation notice type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeTypes/{publicSectorViolationNoticeTypesUniqID}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApSearches
- Get an address parcel row
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApSearches/{publicSectorApSearchesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApValueSearches/action/bulkDelete
- Get all address parcel rows
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApValueSearches
- Get an address parcel row
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApValueSearches/{ParcelId}
Common Setup/APO Attachments
The APO attachments resource is used for adding and viewing the attachments for addresses, parcels, and owners.
- Create an APO attachment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments
- Delete an APO attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}
- Get all APO attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments
- Get an APO attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}
- Update an APO attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor
- Delete an APO attachment accessor
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}
- Get all APO attachment accessors
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor
- Get an APO attachment accessor
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}
- Update an APO attachment accessor
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete an APO attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all APO attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}/child/AttachmentsRevision
- Get an APO attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update an APO attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Common Setup/APO Attachments/APO Attachment Accessors/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}/enclosure/FileContents
Common Setup/APO Attachments/APO Attachment Accessors/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/child/ApoAttachmentAccessor/{ApoAttachmentAccessorUniqID}/enclosure/FileWebImage
Common Setup/APO Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}/enclosure/Preview
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoSearches
- Get an address parcel owner row
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoSearches/{publicSectorApoSearchesUniqID}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoValueSearches
- Get an address parcel owner row
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoValueSearches/{ParcelId}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingEventFields
- Get an accounting event field
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingEventFields/{publicSectorAccountingEventFieldsUniqID}
- Update an accounting event field
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingEventFields/{publicSectorAccountingEventFieldsUniqID}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents
- Get an accounting event
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents/{AccountingEventId}
- Update an accounting event
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents/{AccountingEventId}
Common Setup/Accounting Events/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents/{AccountingEventId}/child/AccountingEventFields
- Get an accounting event field
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents/{AccountingEventId}/child/AccountingEventFields/{AccountingEventFieldsUniqID}
- Update an accounting event field
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents/{AccountingEventId}/child/AccountingEventFields/{AccountingEventFieldsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleCriteria
- Delete an accounting rule criterion
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleCriteria/{publicSectorAccountingRuleCriteriaUniqID}
- Get all accounting rule criteria
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleCriteria
- Get an accounting rule criterion
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleCriteria/{publicSectorAccountingRuleCriteriaUniqID}
- Update an accounting rule criterion
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleCriteria/{publicSectorAccountingRuleCriteriaUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleFieldValues
- Delete an accounting rule field value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleFieldValues/{publicSectorAccountingRuleFieldValuesUniqID}
- Get all accounting rule field values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleFieldValues
- Get an accounting rule field value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleFieldValues/{publicSectorAccountingRuleFieldValuesUniqID}
- Update an accounting rule field value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleFieldValues/{publicSectorAccountingRuleFieldValuesUniqID}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRulesKeys
- Get an accounting rule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRulesKeys/{publicSectorAccountingRulesKeysUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines
- Delete an accounting rule line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines/{publicSectorAccountingRuleLinesUniqID}
- Get all accounting rule lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines
- Get an accounting rule line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines/{publicSectorAccountingRuleLinesUniqID}
- Update an accounting rule line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines/{publicSectorAccountingRuleLinesUniqID}
Common Setup/Accounting Rule Totals
The accounting rule totals resource is used to get all accounting rules for effective date functionality.
- Get all accounting rules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRulesTotals
- Get an accounting rule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRulesTotals/{publicSectorAccountingRulesTotalsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules
- Delete an accounting rule
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules/{publicSectorAccountingRulesUniqID}
- Get all accounting rules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules
- Get an accounting rule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules/{publicSectorAccountingRulesUniqID}
- Update an accounting rule
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules/{publicSectorAccountingRulesUniqID}
- Validate the integrity of the accounting rule
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules/{publicSectorAccountingRulesUniqID}/action/validateAccountingRule
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccounts
- Delete an account
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccounts/{publicSectorAccountsUniqID}
- Get all accounts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccounts
- Get an account
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccounts/{publicSectorAccountsUniqID}
- Update an account
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccounts/{publicSectorAccountsUniqID}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActiveAgencyLanguages/{LanguageCd}
- Get all agency supported languages
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActiveAgencyLanguages
Common Setup/Activities
The activities resource is used to create, update, and delete an activity associated with a planning and zoning application.
- Create an activity
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivities
- Delete an activity
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivities/{publicSectorActivitiesUniqID}
- Get all activities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivities
- Get an activity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivities/{publicSectorActivitiesUniqID}
- Update an activity
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivities/{publicSectorActivitiesUniqID}
Common Setup/Activity Group Details
The activity group details resource is used to view the activities defined in the system along with activity group id information.
- Get all activity group details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroupDetails
- Get an activity group detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroupDetails/{publicSectorActivityGroupDetailsUniqID}
Common Setup/Activity Group Lines
The activity group lines resource is used to create, update, and delete the activity group lines associated with a planning and zoning application.
- Create all activity group lines
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroupLines
- Delete an activity group line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroupLines/{publicSectorActivityGroupLinesUniqID}
- Get all activity group lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroupLines
- Get an activity group line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroupLines/{publicSectorActivityGroupLinesUniqID}
- Update an activity group line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroupLines/{publicSectorActivityGroupLinesUniqID}
Common Setup/Activity Groups
The activity groups resource is used to create, update, and delete an activity group associated with a planning and zoning application.
- Create an activity group
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups
- Delete an activity group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}
- Get all activity groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups
- Get an activity group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}
- Update an activity group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}
Common Setup/Activity Groups/Activity Group Lines
The activity group lines resource is used to create, update, and delete an activity group line associated with a planning and zoning application.
- Create an activity group line
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}/child/ActivityGroupLine
- Delete an activity group line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}/child/ActivityGroupLine/{ActivityGroupLineUniqID}
- Get all activity group lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}/child/ActivityGroupLine
- Get an activity group line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}/child/ActivityGroupLine/{ActivityGroupLineUniqID}
- Update an activity group line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}/child/ActivityGroupLine/{ActivityGroupLineUniqID}
Common Setup/Activity Statuses
The activity statuses resource is used to create, update, and delete the activity status associated with a planning and zoning application.
- Create an activity status
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityStatuses
- Delete an activity status
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityStatuses/{publicSectorActivityStatusesUniqID}
- Get all activity statuses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityStatuses
- Get an activity status
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityStatuses/{publicSectorActivityStatusesUniqID}
- Update an activity status
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityStatuses/{publicSectorActivityStatusesUniqID}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressDistrictsCrosses
- Get an address district
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressDistrictsCrosses/{publicSectorAddressDistrictsCrossesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressDistricts
- Delete an address district
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressDistricts/{publicSectorAddressDistrictsUniqID}
- Get all address districts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressDistricts
- Get an address district
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressDistricts/{publicSectorAddressDistrictsUniqID}
Common Setup/Agencies
The agencies resource is used to view, create, or modify an agency. An agency has a unique identifier and stores the default country, currency, and timezone along with name and description. Agencies are entities which own transaction data like permit applications.
- Create an agency
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies
- Delete an agency
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}
- Get all agencies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies
- Get an agency
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}
- Update an agency
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress
- Delete an agency address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress/{AgencyAddressUniqID}
- Get all agency addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress
- Get an agency address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress/{AgencyAddressUniqID}
- Update an agency address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress/{AgencyAddressUniqID}
Common Setup/Agencies/Agency Languages
The agency languages resource is used to view, create, or modify the languages the agency supports.
- Create an agency language
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang
- Delete an agency language
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang/{AgencyLangUniqID}
- Get all agency languages
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang
- Get an agency language
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang/{AgencyLangUniqID}
- Update an agency language
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang/{AgencyLangUniqID}
Common Setup/Agencies/Agency Options
The agency options resource is used to view and enable or disable product offerings as well as any optional features for an agency.
- Create an agency offering
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions
- Delete an agency offering
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions/{AgencyOptionsUniqID}
- Get all agency offerings
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions
- Get an agency offering
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions/{AgencyOptionsUniqID}
- Update an agency offering
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions/{AgencyOptionsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses
- Delete an agency address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses/{publicSectorAgencyAddressesUniqID}
- Get all agency addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses
- Get an agency address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses/{publicSectorAgencyAddressesUniqID}
- Update an agency address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses/{publicSectorAgencyAddressesUniqID}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyDetails
- Get an OPA policy ID for an agency
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyDetails/{AgencyId}
Common Setup/Agency Email Options
Agency Email Options setup is used to create, update, and delete Email ids required for the adhoc communication.
- Create an agency email option
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyEmailOptions
- Delete an agency email option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyEmailOptions/{publicSectorAgencyEmailOptionsUniqID}
- Get all record agency options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyEmailOptions
- Get an agency email option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyEmailOptions/{publicSectorAgencyEmailOptionsUniqID}
- update agency option record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyEmailOptions/{publicSectorAgencyEmailOptionsUniqID}
Common Setup/Agency Features
The agency feature resource is used to list all the feature uptakes for the agency.
- Create all agency features
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyFeatures
- Get all agency features
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyFeatures
- Get an agency feature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyFeatures/{publicSectorAgencyFeaturesUniqID}
- Remove an agency feature
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyFeatures/{publicSectorAgencyFeaturesUniqID}
- Update an agency feature
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyFeatures/{publicSectorAgencyFeaturesUniqID}
Common Setup/Agency Language Lists
The agency language lists resource is used to view the languages that the agency supports.
- Delete selected agency language.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguageLists/action/bulkDelete
- Get all agency languages
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguageLists
- Get an agency language
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguageLists/{publicSectorAgencyLanguageListsUniqID}
Common Setup/Agency Languages
The agency languages resource is used to view, create or modify a language that the agency supports.
- Create an agency language
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages
- Delete an agency language
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages/{publicSectorAgencyLanguagesUniqID}
- Get all agency languages
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages
- Get an agency language
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages/{publicSectorAgencyLanguagesUniqID}
- Update an agency language
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages/{publicSectorAgencyLanguagesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions
- Delete an agency offering
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions/{publicSectorAgencyOptionsUniqID}
- Get all agency offerings
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions
- Get an agency offering
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions/{publicSectorAgencyOptionsUniqID}
- Update an agency offering
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions/{publicSectorAgencyOptionsUniqID}
Common Setup/Agency Search Features
Use the agency search features resource to view searchable fields.
- Get a searchable field
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencySearchFeatures/{publicSectorAgencySearchFeaturesUniqID}
- Get all searchable fields
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencySearchFeatures
Common Setup/Agency Search Options
Use the agency search options resource to access user selection of searchable fields for an agency.
- Create a user selection for all searchable fields
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencySearchOptions
- Get a user selection for a searchable field
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencySearchOptions/{publicSectorAgencySearchOptionsUniqID}
- Get all searchable fields user selection
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencySearchOptions
- The DELETE action isn't supported for this resource.
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencySearchOptions/{publicSectorAgencySearchOptionsUniqID}
- Update a user selection for a searchable field
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencySearchOptions/{publicSectorAgencySearchOptionsUniqID}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimezones/{publicSectorAgencyTimezonesUniqID}
- Get all time zones
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimezones
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCategories
- Delete an application category
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCategories/{publicSectorCategoriesUniqID}
- Get all application categories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCategories
- Get an application category
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCategories/{publicSectorCategoriesUniqID}
- Update an application category
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCategories/{publicSectorCategoriesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplGroups
- Delete an application group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplGroups/{publicSectorApplGroupsUniqID}
- Get all application groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplGroups
- Get an application group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplGroups/{publicSectorApplGroupsUniqID}
- Update an application group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplGroups/{publicSectorApplGroupsUniqID}
Common Setup/Application Packages
The application packages resource is used to maintain the general information data.
- Create an application package
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages
- Delete an application package
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages/{publicSectorApplicationPackagesUniqID}
- Get all the application packages
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages
- Get an application package
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages/{publicSectorApplicationPackagesUniqID}
- Update an application package
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages/{publicSectorApplicationPackagesUniqID}
Common Setup/Application Packages/Application Package Lines
The application package lines resource is used to store the application specific information.
- Create an application package line
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages/{publicSectorApplicationPackagesUniqID}/child/ApplicationPackageLine
- Delete an application package line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages/{publicSectorApplicationPackagesUniqID}/child/ApplicationPackageLine/{ApplicationPackageLineUniqID}
- Get all the application package lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages/{publicSectorApplicationPackagesUniqID}/child/ApplicationPackageLine
- Get an application package line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages/{publicSectorApplicationPackagesUniqID}/child/ApplicationPackageLine/{ApplicationPackageLineUniqID}
- Update an application package line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages/{publicSectorApplicationPackagesUniqID}/child/ApplicationPackageLine/{ApplicationPackageLineUniqID}
Common Setup/Application Packages/Large Object (LOB) Attributes - GeneralData
- Delete a GeneralData
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages/{publicSectorApplicationPackagesUniqID}/enclosure/GeneralData
- Get a GeneralData
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages/{publicSectorApplicationPackagesUniqID}/enclosure/GeneralData
- Replace a GeneralData
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages/{publicSectorApplicationPackagesUniqID}/enclosure/GeneralData
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSubcategories
- Delete an application subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSubcategories/{publicSectorSubcategoriesUniqID}
- Get all application subcategories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSubcategories
- Get an application subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSubcategories/{publicSectorSubcategoriesUniqID}
- Update an application subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSubcategories/{publicSectorSubcategoriesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers
- Delete an autonumber rule
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers/{RuleId}
- Get all autonumber rules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers
- Get an autonumber rule
- Method: getPath:
/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers/{RuleId}/action/getNextNumber
- Update an autonumber rule
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers/{RuleId}
Common Setup/Business Licenses, Credentials, and Conditions
The business licenses, credentials, and conditions resource is used to view information for the business licenses, credentials, and associated conditions.
- Get a business license, credential, and associated condition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLicenseCredentials/{publicSectorBusinessLicenseCredentialsUniqID}
- Get all business licenses, credentials, and associated conditions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLicenseCredentials
Common Setup/Business Registrations
The business registrations resource is used to create and update business entities.
- Create a business entity
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations
- Get a business entity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}
- Get all business entities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations
- Update a business entity
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}
Common Setup/Business Registrations/Business Locations
The business locations resource is used to create and update business locations.
- Create a business location
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessLocation
- Get a business location
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessLocation/{BusinessLocationKey}
- Get all business locations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessLocation
- Update a business location
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessLocation/{BusinessLocationKey}
Common Setup/Business Registrations/Business Owners
The business owners resource is used to create and update business owners.
- Create a business owner
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessOwner
- Get a business owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessOwner/{ReferenceKey}
- Get all business owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessOwner
- Update a business owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessOwner/{ReferenceKey}
Common Setup/Business Rules Framework Action Logs
Use the Business Ruless Framework action logs resource to view the transaction action logs to confirm rule actions and to troubleshoot potential issues.
- Get all the action logs
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions
- Get an action log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions/{ActionLogId}
- Update an action log
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions/{ActionLogId}
Common Setup/Business Rules Framework Action Logs/Large Object (LOB) Attributes - ActionApiPayload
- Delete an ActionApiPayload
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions/{ActionLogId}/enclosure/ActionApiPayload
- Get an ActionApiPayload
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions/{ActionLogId}/enclosure/ActionApiPayload
- Replace an ActionApiPayload
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions/{ActionLogId}/enclosure/ActionApiPayload
Common Setup/Business Rules Framework Action Logs/Large Object (LOB) Attributes - ActionResponsePayload
- Delete an ActionResponsePayload
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions/{ActionLogId}/enclosure/ActionResponsePayload
- Get an ActionResponsePayload
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions/{ActionLogId}/enclosure/ActionResponsePayload
- Replace an ActionResponsePayload
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions/{ActionLogId}/enclosure/ActionResponsePayload
Common Setup/Business Rules Framework Action Logs/Large Object (LOB) Attributes - Log
- Delete a Log
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions/{ActionLogId}/enclosure/Log
- Get a Log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions/{ActionLogId}/enclosure/Log
- Replace a Log
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogActions/{ActionLogId}/enclosure/Log
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions
- Delete an action
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions/{ActionId}
- Get all actions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions
- Get an action
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions/{ActionId}
- Update an action
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions/{ActionId}
Common Setup/Business Rules Framework Actions/Large Object (LOB) Attributes - Action Parameters
A field for storing action parameter values required by the resource action associated with this action.
- Delete an Action Parameters
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions/{ActionId}/enclosure/ActionParameters
- Get an Action Parameters
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions/{ActionId}/enclosure/ActionParameters
- Replace an Action Parameters
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions/{ActionId}/enclosure/ActionParameters
Common Setup/Business Rules Framework Attachments
Use the Business Rules Framework attachments resource to generate reports for attachments at runtime for communications.
- Create a Business Rules Framework attachment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments
- Delete an attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}
- Get a row of attachment details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}
- Get all Business Rules Framework attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments
- Update an attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}
Common Setup/Business Rules Framework Attachments/Attachments
The attachments resource is used to view, create, and update attachments with the Business Rules Framework.
- Create an attachment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor
- Delete an attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}
- Get all attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor
- Get an attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}
- Update an attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}
Common Setup/Business Rules Framework Attachments/Attachments/Attachment Revisions
The attachment revisions resource is used to view attachment revisions within the Business Rules Framework.
- Create an attachment revision
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete an attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}/child/AttachmentsRevision
- Get an attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update an attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Common Setup/Business Rules Framework Attachments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}/enclosure/FileContents
Common Setup/Business Rules Framework Attachments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/child/EventMgmtAttachmentAccessor/{EventMgmtAttachmentAccessorUniqID}/enclosure/FileWebImage
Common Setup/Business Rules Framework Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkAttachments/{BrfAttachmentKey}/enclosure/Preview
Common Setup/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. This resource will be deprecated in a future release and should not be used.
- Create a condition
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions
- Delete a condition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions/{ConditionId}
- Get a condition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions/{ConditionId}
- Get all conditions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions
- Update a condition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions/{ConditionId}
Common Setup/Business Rules Framework Conditions/Large Object (LOB) Attributes - Condition Clob
The tenth additional comparison value entered or selected by the user for this condition.
- Delete a Condition Clob
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions/{ConditionId}/enclosure/ConditionClob
- Get a Condition Clob
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions/{ConditionId}/enclosure/ConditionClob
- Replace a Condition Clob
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions/{ConditionId}/enclosure/ConditionClob
Common Setup/Business Rules Framework Criteria
The business rules framework criteria resource is used to view, create, or modify the criteria defined for a rule. The criteria reflects fields on a resource that are evaluated against a user-entered value.
- Create a criterion
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkCriteria
- Delete a criterion
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkCriteria/{ConditionId}
- Get a criterion
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkCriteria/{ConditionId}
- Get all criteria
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkCriteria
- Update a criterion
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkCriteria/{ConditionId}
Common Setup/Business Rules Framework Criteria/Large Object (LOB) Attributes - Condition Clob
The tenth additional comparison value entered or selected by the user when defining criteria.
- Delete a Condition Clob
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkCriteria/{ConditionId}/enclosure/ConditionClob
- Get a Condition Clob
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkCriteria/{ConditionId}/enclosure/ConditionClob
- Replace a Condition Clob
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkCriteria/{ConditionId}/enclosure/ConditionClob
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkEvents
- Get an event
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkEvents/{EventId}
- Update an event
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkEvents/{EventId}
Common Setup/Business Rules Framework Logs
Use the Business Ruless Framework logs resource to view the transaction logs to confirm rule activation and to troubleshoot potential issues.
- Get all the logs record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogs
- Get the single logs record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogs/{LogId}
Common Setup/Business Rules Framework Requests
The business rules framework requests resource is used to trigger the business rules framework to evaluate rules and perform actions.
- Create a business rules framework request
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests
- Get a business rules framework request
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests/{LogId}
- Get all business rules framework requests
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests
- Update an existing business rules framework request
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests/{LogId}
Common Setup/Business Rules Framework Requests/Large Object (LOB) Attributes - Log
The log message associated with this log.
- Delete a Log
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests/{LogId}/enclosure/Log
- Get a Log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests/{LogId}/enclosure/Log
- Replace a Log
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests/{LogId}/enclosure/Log
Common Setup/Business Rules Framework Requests/Large Object (LOB) Attributes - RequestPayload
- Delete a RequestPayload
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests/{LogId}/enclosure/RequestPayload
- Get a RequestPayload
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests/{LogId}/enclosure/RequestPayload
- Replace a RequestPayload
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests/{LogId}/enclosure/RequestPayload
Common Setup/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. This resource will be deprecated in a future release and should not be used.
- Get a resource action
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResourceActions/{ResourceActionId}
- Get all resource actions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResourceActions
Common Setup/Business Rules Framework Resource Actions/Large Object (LOB) Attributes - Required Parameters
A field for storing the parameters required for this resource action.
- Delete a Required Parameters
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResourceActions/{ResourceActionId}/enclosure/RequiredParameters
- Get a Required Parameters
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResourceActions/{ResourceActionId}/enclosure/RequiredParameters
- Replace a Required Parameters
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResourceActions/{ResourceActionId}/enclosure/RequiredParameters
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResources/{ResourceId}
- Get all resources
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResources
Common Setup/Business Rules Framework Rule Logs
Use the Business Ruless Framework rule logs resource to view the transaction logs to confirm rule activation, rule details, and to troubleshoot potential issues.
- Get all the rule log records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogRules
- Get the single row of rule log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogRules/{RuleLogId}
- Update a rule log
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogRules/{RuleLogId}
Common Setup/Business Rules Framework Rule Logs/Large Object (LOB) Attributes - Log
- Delete a Log
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogRules/{RuleLogId}/enclosure/Log
- Get a Log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogRules/{RuleLogId}/enclosure/Log
- Replace a Log
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkLogRules/{RuleLogId}/enclosure/Log
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRules
- Delete a rule
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRules/{RuleId}
- Get a rule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRules/{RuleId}
- Get all rules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRules
- Update a rule
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRules/{RuleId}
Common Setup/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. This resource will be deprecated in a future release and should not be used.
- Create a schedule
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkSchedules
- Delete a schedule
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkSchedules/{ScheduleId}
- Get a schedule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkSchedules/{ScheduleId}
- Get all schedules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkSchedules
- Update a schedule
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkSchedules/{ScheduleId}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalendars
- Delete a period
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalendars/{publicSectorCalendarsUniqID}
- Get a period
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalendars/{publicSectorCalendarsUniqID}
- Get all periods
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalendars
- Update a period
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalendars/{publicSectorCalendarsUniqID}
Common Setup/Cities
The cities resource is used to view, create, delete, or modify cities. A city is a large human settlement.
- Create a city
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCities
- Delete a city
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCities/{publicSectorCitiesUniqID}
- Get a city
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCities/{publicSectorCitiesUniqID}
- Get all cities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCities
- Update a city
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCities/{publicSectorCitiesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences
- Delete a code reference
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences/{publicSectorCodeReferencesUniqID}
- Get a code reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences/{publicSectorCodeReferencesUniqID}
- Get all code references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences
- Update a code reference
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences/{publicSectorCodeReferencesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesKeys
- Delete a code reference key is not supported
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesKeys/{publicSectorCodeReferencesKeysUniqID}
- Get a code reference key
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesKeys/{publicSectorCodeReferencesKeysUniqID}
- Get all code reference keys
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesKeys
- Update a code reference key is not supported
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesKeys/{publicSectorCodeReferencesKeysUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesTotals
- Delete a code reference is not supported
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesTotals/{publicSectorCodeReferencesTotalsUniqID}
- Get a code reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesTotals/{publicSectorCodeReferencesTotalsUniqID}
- Get all code references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesTotals
- Update a code reference is not supported
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesTotals/{publicSectorCodeReferencesTotalsUniqID}
Common Setup/Code References Totals/Large Object (LOB) Attributes - CodeRefContent
- Get a CodeRefContent
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesTotals/{publicSectorCodeReferencesTotalsUniqID}/enclosure/CodeRefContent
Common Setup/Code References/Large Object (LOB) Attributes - CodeRefContent
- Delete a CodeRefContent
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences/{publicSectorCodeReferencesUniqID}/enclosure/CodeRefContent
- Get a CodeRefContent
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences/{publicSectorCodeReferencesUniqID}/enclosure/CodeRefContent
- Replace a CodeRefContent
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences/{publicSectorCodeReferencesUniqID}/enclosure/CodeRefContent
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeTypes
- Delete a code type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeTypes/{publicSectorCodeTypesUniqID}
- Get a code type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeTypes/{publicSectorCodeTypesUniqID}
- Get all code types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeTypes
- Update a code type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeTypes/{publicSectorCodeTypesUniqID}
Common Setup/Comment Application Group Options
The comment application group option resource is used to view or modify a comment application group option. You can set a default value for the comment visibility option.
- Get a comment application group option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroupOptions/{publicSectorCommentApplicationGroupOptionsUniqID}
- Get all comment application group options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroupOptions
- Update a comment application group option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroupOptions/{publicSectorCommentApplicationGroupOptionsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroups
- Delete a comment application group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroups/{publicSectorCommentApplicationGroupsUniqID}
- Get a comment application group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroups/{publicSectorCommentApplicationGroupsUniqID}
- Get all comment application groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroups
- Update a comment application group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroups/{publicSectorCommentApplicationGroupsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories
- Delete a comment category
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}
- Get a comment category
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}
- Get all comment categories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories
- Update a comment category
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentApplicationGroups
- Delete a comment application group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentApplicationGroups/{CommentApplicationGroupsUniqID}
- Get a comment application group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentApplicationGroups/{CommentApplicationGroupsUniqID}
- Get all comment application groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentApplicationGroups
- Update a comment application group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentApplicationGroups/{CommentApplicationGroupsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentSubCategories
- Delete a comment subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentSubCategories/{CommentSubCategoriesUniqID}
- Get a comment subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentSubCategories/{CommentSubCategoriesUniqID}
- Get all comment subcategories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentSubCategories
- Update a comment subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentSubCategories/{CommentSubCategoriesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentSetups
- Delete a comment setup
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentSetups/{AgencyId}
- Get a comment setup
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentSetups/{AgencyId}
- Get all comment setups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentSetups
- Update a comment setup
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentSetups/{AgencyId}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentSubCategories
- Delete a comment subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentSubCategories/{publicSectorCommentSubCategoriesUniqID}
- Get a comment subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentSubCategories/{publicSectorCommentSubCategoriesUniqID}
- Get all comment subcategories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentSubCategories
- Update a comment subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommentSubCategories/{publicSectorCommentSubCategoriesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionListDetails/action/validate
- Create a set of conditions against a transaction
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionListDetails
- Get a condition applied against a transaction
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionListDetails/{ConditionKey}
- Get all conditions applied against a transaction
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionListDetails
Common Setup/Condition Lists
The condition list 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionLists
- Get a condition applied against a record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionLists/{ConditionKey}
- Get all conditions applied against a record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionLists
- Update a condition applied against a record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionLists/{ConditionKey}
Common Setup/Conditions
The conditions resource is used to create, view, or update a condition setup.
- Create a set of conditions
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditions
- Delete a condition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditions/{publicSectorConditionsUniqID}
- Get a condition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditions/{publicSectorConditionsUniqID}
- Get all conditions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditions
- Update a condition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditions/{publicSectorConditionsUniqID}
Common Setup/Contact Types
Use the contact types resource to view, create, modify, or delete contact types.
- Create a contact type
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContactTypes
- Delete a contact type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContactTypes/{publicSectorContactTypesUniqID}
- Get a contact type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContactTypes/{publicSectorContactTypesUniqID}
- Get all contact types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContactTypes
- Update a contact type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContactTypes/{publicSectorContactTypesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps
- Delete a contextual help entry
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}
- Get a contextual help entry
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}
- Get all contextual help entries
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps
- Update a contextual help entry
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails
- Delete a set contextual help details
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails/{publicSectorContextHelpDetailsUniqID}
- Get a set of contextual help details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails/{publicSectorContextHelpDetailsUniqID}
- Get all contextual help details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails
- Update a set of contextual help details
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails/{publicSectorContextHelpDetailsUniqID}
Common Setup/Contextual Help Details/Large Object (LOB) Attributes - ContxthlpClob
- Delete a ContxthlpClob
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails/{publicSectorContextHelpDetailsUniqID}/enclosure/ContxthlpClob
- Get a ContxthlpClob
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails/{publicSectorContextHelpDetailsUniqID}/enclosure/ContxthlpClob
- Replace a ContxthlpClob
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails/{publicSectorContextHelpDetailsUniqID}/enclosure/ContxthlpClob
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail
- Delete a set contextual help details
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail/{ContextHelpDetailUniqID}
- Get a set of contextual help details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail/{ContextHelpDetailUniqID}
- Get all contextual help details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail
- Update a set of contextual help details
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail/{ContextHelpDetailUniqID}
Common Setup/Contextual Help/Contextual Help Details/Large Object (LOB) Attributes - ContxthlpClob
- Delete a ContxthlpClob
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail/{ContextHelpDetailUniqID}/enclosure/ContxthlpClob
- Get a ContxthlpClob
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail/{ContextHelpDetailUniqID}/enclosure/ContxthlpClob
- Replace a ContxthlpClob
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail/{ContextHelpDetailUniqID}/enclosure/ContxthlpClob
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCounties
- Delete a county
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCounties/{publicSectorCountiesUniqID}
- Get a county
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCounties/{publicSectorCountiesUniqID}
- Get all counties
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCounties
- Update a county
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCounties/{publicSectorCountiesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCountries
- Delete a country
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCountries/{CountryCode}
- Get a country
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCountries/{CountryCode}
- Get all countries
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCountries
- Update a country
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCountries/{CountryCode}
Common Setup/Credential Attributes
The credential attributes resource is used to view, add, delete, and modify information for a credential attribute.
- Create a set of credential attributes
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialAttributes
- Delete a credential attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialAttributes/{publicSectorCredentialAttributesUniqID}
- Get a credential attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialAttributes/{publicSectorCredentialAttributesUniqID}
- Get all credential attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialAttributes
- Update a credential attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialAttributes/{publicSectorCredentialAttributesUniqID}
Common Setup/Credential Exemption Reasons
The credential exemption reasons resource is used to view, add, delete, and modify information for credential exemption reasons.
- Create a set of credential exemption reasons
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptionReasons
- Delete a credential exemption reason
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptionReasons/{publicSectorCredentialExemptionReasonsUniqID}
- Get a credential exemption reason
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptionReasons/{publicSectorCredentialExemptionReasonsUniqID}
- Get all credential exemption reasons
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptionReasons
- Update a credential exemption reason
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptionReasons/{publicSectorCredentialExemptionReasonsUniqID}
Common Setup/Credential Exemptions
The credential exemptions resource is used to view, add, delete, and modify information for credential exemptions.
- Create a set of credential exemptions
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptions
- Delete a credential exemption
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptions/{publicSectorCredentialExemptionsUniqID}
- Get a credential exemption
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptions/{publicSectorCredentialExemptionsUniqID}
- Get all credential exemptions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptions
- Update a credential exemption
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptions/{publicSectorCredentialExemptionsUniqID}
Common Setup/Credential Exemptions/Credential Exemption Reasons
The credential exemption reasons resource is used to view, add, delete, and modify information for credential exemption reasons.
- Create a set of credential exemption reasons
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptions/{publicSectorCredentialExemptionsUniqID}/child/CredentialExemptReason
- Delete a credential exemption reason
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptions/{publicSectorCredentialExemptionsUniqID}/child/CredentialExemptReason/{CredentialExemptReasonUniqID}
- Get a credential exemption reason
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptions/{publicSectorCredentialExemptionsUniqID}/child/CredentialExemptReason/{CredentialExemptReasonUniqID}
- Get all credential exemption reasons
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptions/{publicSectorCredentialExemptionsUniqID}/child/CredentialExemptReason
- Update a credential exemption reason
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialExemptions/{publicSectorCredentialExemptionsUniqID}/child/CredentialExemptReason/{CredentialExemptReasonUniqID}
Common Setup/Credential Group Details
The credential group details resource is used to view, add, delete, and modify information for a credential group details.
- Create a set of credential group details
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupDetails
- Delete a credential group detail
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupDetails/{publicSectorCredentialGroupDetailsUniqID}
- Get a credential group detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupDetails/{publicSectorCredentialGroupDetailsUniqID}
- Get all credential group details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupDetails
- Update a credential group detail
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupDetails/{publicSectorCredentialGroupDetailsUniqID}
Common Setup/Credential Group Keys
The credential group keys resource is used to view a list of current effective dated credential group details.
- Create a set of credential group details
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsKeys
- Delete a credential group detail
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsKeys/{publicSectorCredentialGroupsKeysUniqID}
- Get a credential group detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsKeys/{publicSectorCredentialGroupsKeysUniqID}
- Get all credential group details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsKeys
- Update a credential group detail
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsKeys/{publicSectorCredentialGroupsKeysUniqID}
Common Setup/Credential Group Totals
The credential group totals resource is used to view all effective dated rows for a credential group.
- Create a set of credential group definitions
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsTotals
- Delete a credential group definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsTotals/{publicSectorCredentialGroupsTotalsUniqID}
- Get a credential group definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsTotals/{publicSectorCredentialGroupsTotalsUniqID}
- Get all credential group definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsTotals
- Update a credential group definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroupsTotals/{publicSectorCredentialGroupsTotalsUniqID}
Common Setup/Credential Groups
The credential groups resource is used to view, add, delete, and modify information for a credential group.
- Create a set of credential groups
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroups
- Delete a credential group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroups/{publicSectorCredentialGroupsUniqID}
- Get a credential group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroups/{publicSectorCredentialGroupsUniqID}
- Get all credential groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroups
- Update a credential group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroups/{publicSectorCredentialGroupsUniqID}
Common Setup/Credential Groups/Credential Group Details
The credential group details resource is used to view, add, delete, and modify information for a credential group details.
- Create a set of credential group details
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroups/{publicSectorCredentialGroupsUniqID}/child/CredentialGroupDetail
- Delete a credential group detail
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroups/{publicSectorCredentialGroupsUniqID}/child/CredentialGroupDetail/{CredentialGroupDetailUniqID}
- Get a credential group detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroups/{publicSectorCredentialGroupsUniqID}/child/CredentialGroupDetail/{CredentialGroupDetailUniqID}
- Get all credential group details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroups/{publicSectorCredentialGroupsUniqID}/child/CredentialGroupDetail
- Update a credential group detail
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroups/{publicSectorCredentialGroupsUniqID}/child/CredentialGroupDetail/{CredentialGroupDetailUniqID}
Common Setup/Credential Layouts
The credential layouts resource is used to view, add, delete, and modify attributes for credential layout.
- Create a set of credential layout attributes
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialLayouts
- Delete a credential layout attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialLayouts/{publicSectorCredentialLayoutsUniqID}
- Get a credential layout attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialLayouts/{publicSectorCredentialLayoutsUniqID}
- Get all credential layout attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialLayouts
- Update a credential layout attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialLayouts/{publicSectorCredentialLayoutsUniqID}
Common Setup/Credentials
The credentials resource is used to view, add, delete, and modify information for a credential.
- Create a set of credentials
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentials
- Delete a credential
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentials/{publicSectorCredentialsUniqID}
- Get a credential
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentials/{publicSectorCredentialsUniqID}
- Get all credentials
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentials
- Update a credential
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentials/{publicSectorCredentialsUniqID}
Common Setup/Credentials/Credential Attributes
The credential attributes resource is used to view, add, delete, and modify information for a credential attribute.
- Create a set of credential attributes
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentials/{publicSectorCredentialsUniqID}/child/CredentialAttribute
- Delete a credential attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentials/{publicSectorCredentialsUniqID}/child/CredentialAttribute/{CredentialAttributeUniqID}
- Get a credential attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentials/{publicSectorCredentialsUniqID}/child/CredentialAttribute/{CredentialAttributeUniqID}
- Get all credential attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentials/{publicSectorCredentialsUniqID}/child/CredentialAttribute
- Update a credential attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCredentials/{publicSectorCredentialsUniqID}/child/CredentialAttribute/{CredentialAttributeUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrencies
- Delete a currency
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrencies/{CurrencyCode}
- Get a currency
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrencies/{CurrencyCode}
- Get all currencies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrencies
- Update a currency
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrencies/{CurrencyCode}
Common Setup/Departments
The departments resource is used to view, create, delete or modify a department. A department identifies the financial entity or management unit that is responsible for an accounting transaction.
- Create a department
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepartments
- Delete a department
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepartments/{publicSectorDepartmentsUniqID}
- Get a department
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepartments/{publicSectorDepartmentsUniqID}
- Get all departments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepartments
- Update a department
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDepartments/{publicSectorDepartmentsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups
- Delete a digital assistant setup
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups/{AgencyId}
- Get a digital assistant setup
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups/{AgencyId}
- Get all digital assistant setups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups
- Update a digital assistant setup
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups/{AgencyId}
Common Setup/Digital Assistant Setups/Large Object (LOB) Attributes - CustomOptionsObject
- Delete a CustomOptionsObject
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups/{AgencyId}/enclosure/CustomOptionsObject
- Get a CustomOptionsObject
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups/{AgencyId}/enclosure/CustomOptionsObject
- Replace a CustomOptionsObject
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups/{AgencyId}/enclosure/CustomOptionsObject
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDivisions
- Delete a division
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDivisions/{publicSectorDivisionsUniqID}
- Get a division
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDivisions/{publicSectorDivisionsUniqID}
- Get all divisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDivisions
- Update a division
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDivisions/{publicSectorDivisionsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories
- Delete a document category
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}
- Get a document category
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}
- Get all document categories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories
- Update a document category
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory
- Delete a document subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory/{DocumentSubcategoryUniqID}
- Get a document subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory/{DocumentSubcategoryUniqID}
- Get all document subcategories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory
- Update a document subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory/{DocumentSubcategoryUniqID}
Common Setup/Document Categories/Document Subcategories/Large Object (LOB) Attributes - UserAssistanceText
- Delete an UserAssistanceText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory/{DocumentSubcategoryUniqID}/enclosure/UserAssistanceText
- Get an UserAssistanceText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory/{DocumentSubcategoryUniqID}/enclosure/UserAssistanceText
- Replace an UserAssistanceText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory/{DocumentSubcategoryUniqID}/enclosure/UserAssistanceText
Common Setup/Document Categories/Large Object (LOB) Attributes - UserAssistanceText
- Delete an UserAssistanceText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/enclosure/UserAssistanceText
- Get an UserAssistanceText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/enclosure/UserAssistanceText
- Replace an UserAssistanceText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/enclosure/UserAssistanceText
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategories
- Delete a document group category
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategories/{publicSectorDocumentGroupCategoriesUniqID}
- Get a document group category
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategories/{publicSectorDocumentGroupCategoriesUniqID}
- Get all document group categories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategories
- Update a document group category
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategories/{publicSectorDocumentGroupCategoriesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups
- Delete a document group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}
- Get a document group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}
- Get all document groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups
- Update a document group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}
Common Setup/Document Groups/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory
- Delete a document group category
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory/{DocumentGroupCategoryUniqID}
- Get a document group category
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory/{DocumentGroupCategoryUniqID}
- Get all document group categories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory
- Update a document group category
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory/{DocumentGroupCategoryUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories
- Delete a document subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories/{publicSectorDocumentSubcategoriesUniqID}
- Get a document subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories/{publicSectorDocumentSubcategoriesUniqID}
- Get all document subcategories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories
- Update a document subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories/{publicSectorDocumentSubcategoriesUniqID}
Common Setup/Document Subcategories/Large Object (LOB) Attributes - UserAssistanceText
- Delete an UserAssistanceText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories/{publicSectorDocumentSubcategoriesUniqID}/enclosure/UserAssistanceText
- Get an UserAssistanceText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories/{publicSectorDocumentSubcategoriesUniqID}/enclosure/UserAssistanceText
- Replace an UserAssistanceText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories/{publicSectorDocumentSubcategoriesUniqID}/enclosure/UserAssistanceText
Common Setup/Expiration Groups
The expiration group resource is used to create, update, or remove an expiration group.
- Create an expiration group
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups
- Delete an expiration group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}
- Get all expiration groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups
- Get an expiration group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}
- Update an expiration group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}/child/ExpirationRuleD
- Delete an expiration rule from an expiration group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}/child/ExpirationRuleD/{ExpirationRuleDUniqID}
- Get all expiration rules from an expiration group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}/child/ExpirationRuleD
- Get an expiration rule from an expiration group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}/child/ExpirationRuleD/{ExpirationRuleDUniqID}
- Update an expiration rule in an expiration group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}/child/ExpirationRuleD/{ExpirationRuleDUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules
- Delete an expiration rule from an expiration group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules/{publicSectorExpirationRulesUniqID}
- Get all expiration rules from an expiration group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules
- Get an expiration rule from an expiration group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules/{publicSectorExpirationRulesUniqID}
- Update an expiration rule in an expiration group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules/{publicSectorExpirationRulesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments
- Delete a favorite comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments/{publicSectorFavoriteCommentsUniqID}
- Get a favorite comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments/{publicSectorFavoriteCommentsUniqID}
- Get all favorite comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments
- Update a favorite comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments/{publicSectorFavoriteCommentsUniqID}
Common Setup/Favorite Comments/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments/{publicSectorFavoriteCommentsUniqID}/enclosure/Comments
- Get a Comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments/{publicSectorFavoriteCommentsUniqID}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments/{publicSectorFavoriteCommentsUniqID}/enclosure/Comments
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeItems
- Delete a fee item
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeItems/{publicSectorFeeItemsUniqID}
- Get a fee item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeItems/{publicSectorFeeItemsUniqID}
- Get all fee items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeItems
- Update a fee item
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeItems/{publicSectorFeeItemsUniqID}
Common Setup/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.
- Clears the application cache containing the decision model information.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps/action/clearApplicationCache
- Copies the fee line mappings from a particular version.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps/action/copy
- Create a set of fee line mappings
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps
- Delete a fee line mapping
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps/{publicSectorFeeLineMapsUniqID}
- Get a fee line mapping
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps/{publicSectorFeeLineMapsUniqID}
- Get all fee line mappings
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps
- Update a fee line mapping
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps/{publicSectorFeeLineMapsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLines/action/copy
- Create a set of fee lines
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLines
- Delete a fee line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLines/{publicSectorFeeLinesUniqID}
- Get a fee line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLines/{publicSectorFeeLinesUniqID}
- Get all fee lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLines
- Update a fee line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLines/{publicSectorFeeLinesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/action/calculateFees
- Confirm payment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/action/confirmPayment
- Create a fee record
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords
- Delete a fee record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/{FeeRecordKey}
- Get a fee record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/{FeeRecordKey}
- Get all fee records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords
- Initiate external payment processing for the fee items
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/action/initExtFeeProcessing
- Initiate the workflow when there are no due fees
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/action/initiateWorkflow
- Perform the payment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/action/payNow
- The reconcile appeal fee.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/action/reconcileAppealFees
- Update a fee record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/{FeeRecordKey}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds
- Delete a fee refund record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/{FeeRecordKey}
- Get a fee refund record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/{FeeRecordKey}
- Get all fee refund records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds
- Initiate confirmation for refunding the fee items
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/action/confirmRefund
- Initiate refund for the fee items
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/action/voidRefund
- Initiate refund processing for the fee items
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/action/refundPayment
- Update a fee refund record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/{FeeRecordKey}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeScheduleMaps
- Delete a fee schedule map
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeScheduleMaps/{publicSectorFeeScheduleMapsUniqID}
- Get a fee schedule map
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeScheduleMaps/{publicSectorFeeScheduleMapsUniqID}
- Get all fee schedule maps
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeScheduleMaps
- Update a fee schedule map
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeScheduleMaps/{publicSectorFeeScheduleMapsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules
- Delete a fee schedule
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}
- Get a fee schedule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}
- Get all fee schedules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules
- Update a fee schedule
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/action/copy
- Create a fee line
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine
- Delete a fee line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}
- Get a fee line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}
- Get all fee lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine
- Update a fee line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD
- Delete a fee schedule map
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD/{FeeScheduleMapDUniqID}
- Get a fee schedule map
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD/{FeeScheduleMapDUniqID}
- Get all fee schedule maps
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD
- Update a fee schedule map
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD/{FeeScheduleMapDUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFunctions
- Delete a function
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFunctions/{publicSectorFunctionsUniqID}
- Get a function
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFunctions/{publicSectorFunctionsUniqID}
- Get all functions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFunctions
- Update a function
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFunctions/{publicSectorFunctionsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFunds
- Delete a fund
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFunds/{publicSectorFundsUniqID}
- Get a fund
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFunds/{publicSectorFundsUniqID}
- Get all funds
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFunds
- Update a fund
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFunds/{publicSectorFundsUniqID}
Common Setup/GIS Attribute Mappings
The GIS attribute mappings resource is used to view, update, create, and delete GIS attribute mappings. A GIS attribute mapping is used to specify information about your map service layers, including layers for parcels, addresses, owners, and so forth.
- Create an attribute mapping
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoMappings
- Delete a GIS attribute mapping
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoMappings/{AgencyId}
- Get a GIS attribute mapping
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoMappings/{AgencyId}
- Get all GIS attribute mappings
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoMappings
- Update a GIS attribute mapping
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApoMappings/{AgencyId}
Common Setup/Grid Personalizations
The grid personalization resource is used to capture all grid personalization configurations applied to a grid including the user, grid name, configuration data and so on.
- Create a grid personalization
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGridPersonalizations
- Delete a grid personalization
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorGridPersonalizations/{PersonalizationKey}
- Get a grid personalization
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGridPersonalizations/{PersonalizationKey}
- Get all grid personalizations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGridPersonalizations
- Update a grid personalization
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGridPersonalizations/{PersonalizationKey}
Common Setup/Grid Personalizations/Large Object (LOB) Attributes - Configuration
- Delete a Configuration
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorGridPersonalizations/{PersonalizationKey}/enclosure/Configuration
- Get a Configuration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGridPersonalizations/{PersonalizationKey}/enclosure/Configuration
- Replace a Configuration
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGridPersonalizations/{PersonalizationKey}/enclosure/Configuration
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies
- Delete a hearing body
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}
- Get a hearing body
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}
- Get all hearing bodies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies
- Update a hearing body
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/DayRecurrences
- Delete a hearing body day recurrence
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/DayRecurrences/{DayRecurrencesUniqID}
- Get a hearing body day recurrence
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/DayRecurrences/{DayRecurrencesUniqID}
- Get all hearing body day recurrences
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/DayRecurrences
- Update a hearing body day recurrence
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/DayRecurrences/{DayRecurrencesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences
- Delete a hearing body week recurrence
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences/{WeekRecurrencesUniqID}
- Get a hearing body week recurrence
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences/{WeekRecurrencesUniqID}
- Get all hearing body week recurrences
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences
- Update a hearing body week recurrence
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}/child/WeekRecurrences/{WeekRecurrencesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyDayRecurrences
- Delete a hearing body day recurrence
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyDayRecurrences/{publicSectorHearingBodyDayRecurrencesUniqID}
- Get a hearing body day recurrence
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyDayRecurrences/{publicSectorHearingBodyDayRecurrencesUniqID}
- Get all hearing body day recurrences
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyDayRecurrences
- Update a hearing body day recurrence
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyDayRecurrences/{publicSectorHearingBodyDayRecurrencesUniqID}
Common Setup/Hearing Body Schedule Dates
The hearing body schedule dates resource is used to view, add, or remove custom hearing dates for hearing bodies. This resource is used when a custom date is needed outside of the hearing bodies recurrence pattern.
- Create a set of custom dates
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyScheduleDates
- Delete a custom date
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyScheduleDates/{publicSectorHearingBodyScheduleDatesUniqID}
- Get a custom date
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyScheduleDates/{publicSectorHearingBodyScheduleDatesUniqID}
- Get all custom dates
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyScheduleDates
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyWeekRecurrences
- Delete a hearing body week recurrence
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyWeekRecurrences/{publicSectorHearingBodyWeekRecurrencesUniqID}
- Get a hearing body week recurrence
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyWeekRecurrences/{publicSectorHearingBodyWeekRecurrencesUniqID}
- Get all hearing body week recurrences
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyWeekRecurrences
- Update a hearing body week recurrence
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyWeekRecurrences/{publicSectorHearingBodyWeekRecurrencesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingDecisions
- Delete a hearing body day decision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingDecisions/{publicSectorHearingDecisionsUniqID}
- Get a hearing body day decision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingDecisions/{publicSectorHearingDecisionsUniqID}
- Get all hearing body day decisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingDecisions
- Update a hearing body day decision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingDecisions/{publicSectorHearingDecisionsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHelpSetups
- Delete a help setup
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHelpSetups/{AgencyId}
- Get a help setup
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHelpSetups/{AgencyId}
- Get all help setups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHelpSetups
- Update a help setup
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHelpSetups/{AgencyId}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidCalEvents
- Delete a holiday calendar event
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidCalEvents/{publicSectorHolidCalEventsUniqID}
- Get a holiday calendar event
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidCalEvents/{publicSectorHolidCalEventsUniqID}
- Get a set of holiday calendar events
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidCalEvents
- Update a holiday calendar event
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidCalEvents/{publicSectorHolidCalEventsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars
- Delete a holiday calendar
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}
- Get a holiday calendar
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}
- Get all holiday calendars
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars
- Update a holiday calendar
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails
- Delete a holiday calendar event
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails/{publicSectorCalWithDetailsUniqID}
- Delete the holiday calendar event.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails/action/bulkDelete
- Get a holiday calendar event
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails/{publicSectorCalWithDetailsUniqID}
- Get a set of holiday calendar events
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails
- Update a holiday calendar event
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails/{publicSectorCalWithDetailsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail
- Delete a set of holiday calendar events
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail/{HolidayCalendarDetailUniqID}
- Get a set of holiday calendar events
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail/{HolidayCalendarDetailUniqID}
- Get all holiday calendar events
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail
- Update a set of holiday calendar events
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail/{HolidayCalendarDetailUniqID}
Common Setup/Instructional Text Totals
The instructional text totals resource is used to view all effective date rows for an instructional text.
- Create a set of instructional text definitions
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTextsTotals
- Delete an instructional text definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTextsTotals/{publicSectorInstructionalTextsTotalsUniqID}
- Get all instructional text definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTextsTotals
- Get an instructional text definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTextsTotals/{publicSectorInstructionalTextsTotalsUniqID}
- Update an instructional text definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTextsTotals/{publicSectorInstructionalTextsTotalsUniqID}
Common Setup/Instructional Text Totals/Large Object (LOB) Attributes - TextContent
- Get a TextContent
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTextsTotals/{publicSectorInstructionalTextsTotalsUniqID}/enclosure/TextContent
Common Setup/Instructional Texts
The Instructional texts resource is used to view, add, delete, and modify information for an instructional text.
- Create a set of instructional texts
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTexts
- Delete an Instructional text
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTexts/{publicSectorInstructionalTextsUniqID}
- Get all Instructional texts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTexts
- Get an Instructional text
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTexts/{publicSectorInstructionalTextsUniqID}
- Update an Instructional text
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTexts/{publicSectorInstructionalTextsUniqID}
Common Setup/Instructional Texts Keys
The instructional texts keys resource is used to view a list of current effective dated instructional texts details.
- Create a set of instructional text details
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTextsKeys
- Delete an instructional text detail
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTextsKeys/{publicSectorInstructionalTextsKeysUniqID}
- Get all instructional text details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTextsKeys
- Get an instructional text detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTextsKeys/{publicSectorInstructionalTextsKeysUniqID}
- Update an instructional text detail
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTextsKeys/{publicSectorInstructionalTextsKeysUniqID}
Common Setup/Instructional Texts/Large Object (LOB) Attributes - TextContent
- Delete a TextContent
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTexts/{publicSectorInstructionalTextsUniqID}/enclosure/TextContent
- Get a TextContent
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTexts/{publicSectorInstructionalTextsUniqID}/enclosure/TextContent
- Replace a TextContent
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTexts/{publicSectorInstructionalTextsUniqID}/enclosure/TextContent
Common Setup/Integration Setups
The integration setups resource is used to capture integration related fields.
- Create an integration setup
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntegrationSetups
- Delete an integration setup
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntegrationSetups/{publicSectorIntegrationSetupsUniqID}
- Get all integration setup
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntegrationSetups
- Get an integration setup
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntegrationSetups/{publicSectorIntegrationSetupsUniqID}
- Update an integration setup
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIntegrationSetups/{publicSectorIntegrationSetupsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLedgers
- Delete a ledger
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLedgers/{publicSectorLedgersUniqID}
- Get a ledger
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLedgers/{publicSectorLedgersUniqID}
- Get all ledgers
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLedgers
- Update a ledger
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLedgers/{publicSectorLedgersUniqID}
Common Setup/List of Values/Agency Information Search Defaults
Used to view the default search filter and type.
- Get all agency information search defaults
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyInformations
- Get an agency information search default
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyInformations/{AgencyId}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLocalities
- Delete a locality
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLocalities/{publicSectorLocalitiesUniqID}
- Get a locality
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLocalities/{publicSectorLocalitiesUniqID}
- Get all localities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLocalities
- Update a locality
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLocalities/{publicSectorLocalitiesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes
- Delete a lookup type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}
- Get a lookup type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}
- Get all lookup types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes
- Update a lookup type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}/child/PscLookupValue
- Delete a lookup value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}/child/PscLookupValue/{PscLookupValueUniqID}
- Get a lookup value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}/child/PscLookupValue/{PscLookupValueUniqID}
- Get all lookup values associated with a lookup type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}/child/PscLookupValue
- Update a lookup value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}/child/PscLookupValue/{PscLookupValueUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupValues
- Delete a lookup value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupValues/{publicSectorLookupValuesUniqID}
- Get a lookup value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupValues/{publicSectorLookupValuesUniqID}
- Get all lookup values associated with a lookup type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupValues
- Update a lookup value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLookupValues/{publicSectorLookupValuesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles
- Delete a map profile
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}
- Get a map profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}
- Get all map profiles
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles
- Update a map profile
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}
Common Setup/Map Profiles/Large Object (LOB) Attributes - MapPreview
- Delete a MapPreview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/enclosure/MapPreview
- Get a MapPreview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/enclosure/MapPreview
- Replace a MapPreview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/enclosure/MapPreview
Common Setup/Map Profiles/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences
- Delete a map profile reference
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}
- Get a map profile reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}
- Get all map profile references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences
- Update a map profile reference
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}
Common Setup/Map Profiles/Map Profile References/Map Service Attributes
Use the map service attributes resource to view, create, update, and delete map service layer attributes.
- Create a map service attribute configuration
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}/child/MapServiceAttributes
- Delete a map service attribute configuration
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}/child/MapServiceAttributes/{MapServiceAttributesUniqID}
- Get a map service attribute configuration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}/child/MapServiceAttributes/{MapServiceAttributesUniqID}
- Get all map service attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}/child/MapServiceAttributes
- Update a map service attribute configuration
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}/child/MapServiceAttributes/{MapServiceAttributesUniqID}
Common Setup/Mapping Attachments
The mapping attachments resource is used to store Data Format Exchange mapping attachments.
- Create a set of mapping attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments
- Delete a mapping attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}
- Get a mapping attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}
- Get all mapping attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments
- Replace a mapping attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}
Common Setup/Mapping Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/enclosure/Preview
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor
- Delete a mapping attachment's file-related information
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}
- Get a mapping attachment's file-related information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}
- Get all mapping attachment file-related information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor
- Update a mapping attachment's file-related information
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}
Common Setup/Mapping Attachments/Mapping Attachment Accessors/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}/enclosure/FileContents
Common Setup/Mapping Attachments/Mapping Attachment Accessors/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}/enclosure/FileWebImage
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete a mapping attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get a mapping attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all mapping attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}/child/AttachmentsRevision
- Update a mapping attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingDetails
- Delete a mapping pair
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingDetails/{publicSectorMappingDetailsUniqID}
- Get a mapping pair
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingDetails/{publicSectorMappingDetailsUniqID}
- Get all mapping pairs
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingDetails
- Update a mapping pair
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingDetails/{publicSectorMappingDetailsUniqID}
Common Setup/Mapping Headers
The sector mapping headers resource is used to store Data Format Exchange header information.
- Create a mapping header definition
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders
- Delete a mapping header definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}
- Get a mapping header definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}
- Get all mapping header definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders
- Update a mapping header definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}
Common Setup/Mapping Headers/Large Object (LOB) Attributes - MappingXml
- Delete a MappingXml
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/enclosure/MappingXml
- Get a MappingXml
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/enclosure/MappingXml
- Replace a MappingXml
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/enclosure/MappingXml
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetail
- Delete a mapping pair
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetail/{MappingDetailUniqID}
- Get a mapping pair
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetail/{MappingDetailUniqID}
- Get all mapping pairs
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetail
- Update a mapping pair
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetail/{MappingDetailUniqID}
Common Setup/Mapping Headers/Mapping Navigators
The mapping navigators resource is used to store the status of the setup wizard.
- Create a mapping navigator
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigator
- Delete a mapping navigator
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigator/{MappingNavigatorUniqID}
- Get a mapping navigator
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigator/{MappingNavigatorUniqID}
- Get all mapping navigators
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigator
- Update a mapping navigator
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigator/{MappingNavigatorUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource
- Delete a mapping source
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource/{MappingSourceUniqID}
- Get a mapping source
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource/{MappingSourceUniqID}
- Get all mapping sources
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource
- Update a mapping source
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource/{MappingSourceUniqID}
Common Setup/Mapping Headers/Mapping Sources/Large Object (LOB) Attributes - CsvTemplate
- Delete a CsvTemplate
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource/{MappingSourceUniqID}/enclosure/CsvTemplate
- Get a CsvTemplate
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource/{MappingSourceUniqID}/enclosure/CsvTemplate
- Replace a CsvTemplate
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource/{MappingSourceUniqID}/enclosure/CsvTemplate
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget
- Delete a mapping target
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget/{MappingTargetUniqID}
- Get a mapping target
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget/{MappingTargetUniqID}
- Get all mapping targets
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget
- Update a mapping target
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget/{MappingTargetUniqID}
Common Setup/Mapping Headers/Mapping Targets/Large Object (LOB) Attributes - CsvTemplate
- Delete a CsvTemplate
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget/{MappingTargetUniqID}/enclosure/CsvTemplate
- Get a CsvTemplate
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget/{MappingTargetUniqID}/enclosure/CsvTemplate
- Replace a CsvTemplate
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget/{MappingTargetUniqID}/enclosure/CsvTemplate
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingNavigators
- Delete a mapping navigator
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingNavigators/{publicSectorMappingNavigatorsUniqID}
- Get a mapping navigator
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingNavigators/{publicSectorMappingNavigatorsUniqID}
- Get all mapping navigators
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingNavigators
- Update a mapping navigator
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingNavigators/{publicSectorMappingNavigatorsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSourceFields
- Delete a mapping source field
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSourceFields/{publicSectorMappingSourceFieldsUniqID}
- Get a mapping source field
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSourceFields/{publicSectorMappingSourceFieldsUniqID}
- Get all mapping source fields
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSourceFields
- Update a mapping source field
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSourceFields/{publicSectorMappingSourceFieldsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSources
- Delete a mapping source
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSources/{publicSectorMappingSourcesUniqID}
- Get a mapping source
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSources/{publicSectorMappingSourcesUniqID}
- Get all mapping sources
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSources
- Update a mapping source
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSources/{publicSectorMappingSourcesUniqID}
Common Setup/Mapping Sources/Large Object (LOB) Attributes - CsvTemplate
- Delete a CsvTemplate
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSources/{publicSectorMappingSourcesUniqID}/enclosure/CsvTemplate
- Get a CsvTemplate
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSources/{publicSectorMappingSourcesUniqID}/enclosure/CsvTemplate
- Replace a CsvTemplate
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSources/{publicSectorMappingSourcesUniqID}/enclosure/CsvTemplate
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargetFields
- Delete a mapping target field
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargetFields/{publicSectorMappingTargetFieldsUniqID}
- Get a mapping target field
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargetFields/{publicSectorMappingTargetFieldsUniqID}
- Get all mapping target fields
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargetFields
- Update a mapping target field
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargetFields/{publicSectorMappingTargetFieldsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets
- Delete a mapping target
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets/{publicSectorMappingTargetsUniqID}
- Get a mapping target
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets/{publicSectorMappingTargetsUniqID}
- Get all mapping targets
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets
- Update a mapping target
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets/{publicSectorMappingTargetsUniqID}
Common Setup/Mapping Targets/Large Object (LOB) Attributes - CsvTemplate
- Delete a CsvTemplate
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets/{publicSectorMappingTargetsUniqID}/enclosure/CsvTemplate
- Get a CsvTemplate
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets/{publicSectorMappingTargetsUniqID}/enclosure/CsvTemplate
- Replace a CsvTemplate
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets/{publicSectorMappingTargetsUniqID}/enclosure/CsvTemplate
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingViewObjects
- Delete a mapping view object
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingViewObjects/{VoCode}
- Get a mapping view object
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingViewObjects/{VoCode}
- Get all mapping view objects
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingViewObjects
- Update a mapping view object
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMappingViewObjects/{VoCode}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorModules/{ModuleId}
- Get all modules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorModules
Common Setup/Ownership Types
The ownership types resource is used to view, create, delete or modify ownership types.
- Create an ownership type
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOwnershipTypes
- Delete an ownership type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOwnershipTypes/{publicSectorOwnershipTypesUniqID}
- Get all ownership types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOwnershipTypes
- Get an ownership type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOwnershipTypes/{publicSectorOwnershipTypesUniqID}
- Update an ownership type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOwnershipTypes/{publicSectorOwnershipTypesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses
- Delete a parcel address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses/{publicSectorParcelAddressesUniqID}
- Get a parcel address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses/{publicSectorParcelAddressesUniqID}
- Get all parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses
- Update a parcel address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses/{publicSectorParcelAddressesUniqID}
Common Setup/Parcel Comments
The parcel comments resource is used to create comments on the parcels for agency users.
- Create a parcel comment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelComments
- Delete a parcel comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelComments/{CommentKey}
- Get a parcel comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelComments/{CommentKey}
- Get all parcel comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelComments
- Update a parcel comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelComments/{CommentKey}
Common Setup/Parcel Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelComments/{CommentKey}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelComments/{CommentKey}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelComments/{CommentKey}/enclosure/CommentText
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelDistricts
- Delete a parcel district
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelDistricts/{publicSectorParcelDistrictsUniqID}
- Get a parcel district
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelDistricts/{publicSectorParcelDistrictsUniqID}
- Get all parcel districts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelDistricts
- Update a parcel district
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelDistricts/{publicSectorParcelDistrictsUniqID}
Common Setup/Parcel Import Options
The parcel import options resource is used to view, create, delete, or modify parcel import options.
- Create parcel import options
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelImportOptions
- Delete parcel import options
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelImportOptions/{AgencyId}
- Get all parcel import options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelImportOptions
- Get parcel import options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelImportOptions/{AgencyId}
- Update parcel import options
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelImportOptions/{AgencyId}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners
- Delete a parcel owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners/{publicSectorParcelOwnersUniqID}
- Get a parcel owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners/{publicSectorParcelOwnersUniqID}
- Get all parcel owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners
- Update a parcel owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners/{publicSectorParcelOwnersUniqID}
Common Setup/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 value
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelValues
- Delete a parcel value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelValues/{publicSectorParcelValuesUniqID}
- Get a parcel value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelValues/{publicSectorParcelValuesUniqID}
- Get all parcel values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelValues
- Update a parcel value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelValues/{publicSectorParcelValuesUniqID}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelValuesKeys/{publicSectorParcelValuesKeysUniqID}
- Get all parcel values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelValuesKeys
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcels
- Delete a parcel
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcels/{ParcelId}
- Get a parcel
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcels/{ParcelId}
- Get all parcels
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcels
- Update a parcel
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcels/{ParcelId}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPrograms
- Delete a program
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPrograms/{publicSectorProgramsUniqID}
- Get a program
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPrograms/{publicSectorProgramsUniqID}
- Get all programs
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPrograms
- Update a program
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPrograms/{publicSectorProgramsUniqID}
Common Setup/Property Conditions
Use the property conditions resource to view, create, modify, or delete property conditions.
- Create a property condition
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPropertyConditions
- Delete a property condition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPropertyConditions/{publicSectorPropertyConditionsUniqID}
- Get a property condition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPropertyConditions/{publicSectorPropertyConditionsUniqID}
- Get all property conditions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPropertyConditions
- Update a property condition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPropertyConditions/{publicSectorPropertyConditionsUniqID}
Common Setup/Property Types
Use the property types resource to view, create, modify, or delete property types.
- Create a property type
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPropertyTypes
- Delete a property type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPropertyTypes/{publicSectorPropertyTypesUniqID}
- Get a property type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPropertyTypes/{publicSectorPropertyTypesUniqID}
- Get all property types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPropertyTypes
- Update a property type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPropertyTypes/{publicSectorPropertyTypesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProxySetups
- Delete a proxy setup
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProxySetups/{publicSectorProxySetupsUniqID}
- Get a proxy setup
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProxySetups/{publicSectorProxySetupsUniqID}
- Get all proxy setups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProxySetups
- Update a proxy setup
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProxySetups/{publicSectorProxySetupsUniqID}
Common Setup/Record Credentials
The record credentials resource is used to view information about the business license credentials.
- Get a business license credential
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentials/{publicSectorRecordCredentialsUniqID}
- Get all business license credentials
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentials
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses
- Delete a record status
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses/{publicSectorRecordStatusesUniqID}
- Get a record status
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses/{publicSectorRecordStatusesUniqID}
- Get all record statuses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses
- Update a record status
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordStatuses/{publicSectorRecordStatusesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLines
- Delete a record type display group line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLines/{publicSectorDisplayGroupLinesUniqID}
- Get a record type display group line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLines/{publicSectorDisplayGroupLinesUniqID}
- Get all record type display group lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLines
- Update a record type display group line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLines/{publicSectorDisplayGroupLinesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups
- Delete a record type display group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}
- Get a record type display group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}
- Get all record type display groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups
- Update a record type display group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine
- Delete a record type display group line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine/{DisplayGroupLineUniqID}
- Get a record type display group line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine/{DisplayGroupLineUniqID}
- Get all record type display group lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine
- Update a record type display group line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine/{DisplayGroupLineUniqID}
Common Setup/Record Type Plan Reviewer Departments
The record type plan reviewer departments resource is used 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePlanReviewerDepartments
- Delete a plan reviewer department for a permit type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePlanReviewerDepartments/{publicSectorRecordTypePlanReviewerDepartmentsUniqID}
- Get all plan reviewer departments for a permit type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePlanReviewerDepartments
- Get plan reviewer departments for a permit type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePlanReviewerDepartments/{publicSectorRecordTypePlanReviewerDepartmentsUniqID}
- Update a plan reviewer department for a permit type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePlanReviewerDepartments/{publicSectorRecordTypePlanReviewerDepartmentsUniqID}
Common Setup/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePrompts/{RecordTypeId}
- Get all record types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePrompts
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes
- Get a record type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}
- Get all record types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes
- Update a record type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment
- Delete a record type plan reviewer department
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment/{RecordTypePlanReviewerDepartmentUniqID}
- Get a record type plan reviewer department
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment/{RecordTypePlanReviewerDepartmentUniqID}
- Get all record type plan reviewer departments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment
- Update a record type plan reviewer department
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment/{RecordTypePlanReviewerDepartmentUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec
- Delete a related record type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec/{RelatedRecUniqID}
- Get a related record type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec/{RelatedRecUniqID}
- Get all related record types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec
- Update a related record type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec/{RelatedRecUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurationFields
- Delete a scope configuration field
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurationFields/{publicSectorScopeConfigurationFieldsUniqID}
- Get a scope configuration field
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurationFields/{publicSectorScopeConfigurationFieldsUniqID}
- Get all scope configuration fields
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurationFields
- Update a configuration field
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurationFields/{publicSectorScopeConfigurationFieldsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations
- Delete a scope configuration
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}
- Get a scope configuration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}
- Get all scope configurations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations
- Update a scope configuration
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField
- Delete a scope configuration field
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField/{ScopeConfigurationFieldUniqID}
- Get a scope configuration field
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField/{ScopeConfigurationFieldUniqID}
- Get all scope configuration fields
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField
- Update a configuration field
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField/{ScopeConfigurationFieldUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments
- Delete an import request
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}
- Get all import requests
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments
- Get an import request
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}
- Update an import request
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}
Common Setup/Solution Package Imports/Attachments
The attachments resource is used to perform the file attachment functionality.
- Create an imported attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor
- Delete an imported attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}
- Get all imported attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor
- Get an imported attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}
- Update an imported attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete a revision attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get a revision attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all revision attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}/child/AttachmentsRevision
- Update a revision attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Common Setup/Solution Package Imports/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}/enclosure/FileContents
Common Setup/Solution Package Imports/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/child/SlAttachmentAccessor/{SlAttachmentAccessorUniqID}/enclosure/FileWebImage
Common Setup/Solution Package Imports/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSolutionPackageAttachments/{publicSectorSolutionPackageAttachmentsUniqID}/enclosure/Preview
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments
- Delete a standard comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}
- Get a standard comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}
- Get all standard comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments
- Update a standard comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment
- Delete a favorite comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment/{FavoriteCommentUniqID}
- Get a favorite comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment/{FavoriteCommentUniqID}
- Get all favorite comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment
- Update a favorite comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment/{FavoriteCommentUniqID}
Common Setup/Standard Comments/Favorite Comments/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment/{FavoriteCommentUniqID}/enclosure/Comments
- Get a Comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment/{FavoriteCommentUniqID}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment/{FavoriteCommentUniqID}/enclosure/Comments
Common Setup/Standard Comments/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/enclosure/Comments
- Get a Comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/enclosure/Comments
Common Setup/Standard Comments/Large Object (LOB) Attributes - CommentsPlain
- Get a CommentsPlain
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/enclosure/CommentsPlain
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStates
- Delete a state
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorStates/{publicSectorStatesUniqID}
- Get a state
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStates/{publicSectorStatesUniqID}
- Get all states
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStates
- Update a state
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStates/{publicSectorStatesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas
- Delete a subclass
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas/{SubclassId}
- Get a subclass
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas/{SubclassId}
- Get all subclasses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas
- Update a subclass
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas/{SubclassId}
Common Setup/Terms Of Use Definitions
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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses
- Delete a terms of use definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}
- Get a terms of use definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}
- Get all terms of use definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses
- Update a terms of use definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}
Common Setup/Terms Of Use Definitions/Large Object (LOB) Attributes - TermsContent
- Delete a TermsContent
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/enclosure/TermsContent
- Get a TermsContent
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/enclosure/TermsContent
- Replace a TermsContent
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/enclosure/TermsContent
Common Setup/Terms Of Use Definitions/Terms Usages
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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage
- Delete a transaction type for a terms of use definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage/{TermsUsageUniqID}
- Get a transaction type for a terms of use definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage/{TermsUsageUniqID}
- Get all the transaction type details for a terms of use definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage
- Update a transaction type for a terms of use definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage/{TermsUsageUniqID}
Common Setup/Terms Of Use Keys
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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesKeys
- Delete a terms of use definition is not supported
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesKeys/{publicSectorTermsOfUsesKeysUniqID}
- Get a terms of use definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesKeys/{publicSectorTermsOfUsesKeysUniqID}
- Get all terms of use definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesKeys
- Update a terms of use definition is not supported
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesKeys/{publicSectorTermsOfUsesKeysUniqID}
Common Setup/Terms Of Use Totals
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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals
- Delete a terms of use definition is not supported
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals/{publicSectorTermsOfUsesTotalsUniqID}
- Get a terms of use definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals/{publicSectorTermsOfUsesTotalsUniqID}
- Get all terms of use definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals
- Update a terms of use definition is not supported
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals/{publicSectorTermsOfUsesTotalsUniqID}
Common Setup/Terms Of Use Totals/Large Object (LOB) Attributes - TermsContent
- Get a TermsContent
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals/{publicSectorTermsOfUsesTotalsUniqID}/enclosure/TermsContent
Common Setup/Terms Usages
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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsUsages
- Delete a transaction type for a terms of use definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsUsages/{publicSectorTermsUsagesUniqID}
- Get a transaction type for a terms of use definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsUsages/{publicSectorTermsUsagesUniqID}
- Get all the transaction type details for a terms of use definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsUsages
- Update a transaction type for a terms of use definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTermsUsages/{publicSectorTermsUsagesUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUnitsConversions
- Delete a unit of measure conversion rate
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorUnitsConversions/{publicSectorUnitsConversionsUniqID}
- Get a unit of measure conversion rate
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUnitsConversions/{publicSectorUnitsConversionsUniqID}
- Get all unit of measure conversion rates
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUnitsConversions
- Update a unit of measure conversion rate
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUnitsConversions/{publicSectorUnitsConversionsUniqID}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUnits
- Delete a unit of measure
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorUnits/{UnitOfMeasure}
- Get a unit of measure
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUnits/{UnitOfMeasure}
- Get all units of measure
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUnits
- Update a unit of measure
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUnits/{UnitOfMeasure}
Common Setup/Update Primary Records
The primary records update resource is used to update the primary flag of applications.
- Get all applications
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUpdatePrimaryRecords
- Get an application
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUpdatePrimaryRecords/{LnpRecordKey}
- Update an application
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUpdatePrimaryRecords/{LnpRecordKey}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters
- Delete a filter criterion
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters/{FilterId}
- Get a filter criterion
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters/{FilterId}
- Get all filter cirteria
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters
- Update a filter criterion
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters/{FilterId}
Common Setup/User Defined Filters/Large Object (LOB) Attributes - Criteria
- Delete a Criteria
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters/{FilterId}/enclosure/Criteria
- Get a Criteria
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters/{FilterId}/enclosure/Criteria
- Replace a Criteria
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters/{FilterId}/enclosure/Criteria
Common Setup/User Preferences
The user preferencess resource is used to view or modify user preferences.
- Get a set of user preferences
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserPreferences/{UserId}
- Get all user preferences
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserPreferences
- Update a set of user preferences
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserPreferences/{UserId}
Common Setup/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets
- Delete a widget
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}
- Get a widget
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}
- Get all widgets
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets
- Update a widget
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}
Common Setup/Widgets/Large Object (LOB) Attributes - LayoutMetadata
- Delete a LayoutMetadata
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}/enclosure/LayoutMetadata
- Get a LayoutMetadata
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}/enclosure/LayoutMetadata
- Replace a LayoutMetadata
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}/enclosure/LayoutMetadata
Common Setup/Widgets/Large Object (LOB) Attributes - LayoutView
- Delete a LayoutView
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}/enclosure/LayoutView
- Get a LayoutView
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}/enclosure/LayoutView
- Replace a LayoutView
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}/enclosure/LayoutView
Communications/Activity Communications
The activity communications resource is used to capture communications related to entitlement activities.
- Get all activity communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityCommunications
- Get an activity communication item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityCommunications/{publicSectorActivityCommunicationsUniqID}
Communications/Case Responsible Parties
The responsible party resource is used to view the details of the responsible party. Responsible party is the person responsible for the code violation.
- Get a responsible party
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorResponsibleParties/{publicSectorResponsiblePartiesUniqID}
- Get all responsible parties
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorResponsibleParties
Communications/Code Enforcement Incident Communications
The incident communications resource is used to view the code enforcement incidents.
- Get all incidents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidentCommunications
- Get an incident
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIncidentCommunications/{publicSectorIncidentCommunicationsUniqID}
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails/{publicSectorCommunicationRecordDetailsUniqID}
- Get all communication details logs
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails
Communications/Communication Record Details/Large Object (LOB) Attributes - Body
- Get a Body
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails/{publicSectorCommunicationRecordDetailsUniqID}/enclosure/Body
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails/{publicSectorCommunicationRecordDetailsUniqID}/child/WebForms/{WebformId}
- Get all web form details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails/{publicSectorCommunicationRecordDetailsUniqID}/child/WebForms
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateInvitationNotifications/{DelegateHeaderId}
- Get all delegates' information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateInvitationNotifications
Communications/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications
- Delete a delegate's information
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications/{DelegateHeaderId}
- Get a delegate's information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications/{DelegateHeaderId}
- Get all delegate information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications
- Update a delegate's information
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications/{DelegateHeaderId}
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeCommunications/{publicSectorFeeCommunicationsUniqID}
- Get all fee records for a fee communication event
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeCommunications
Communications/Fee Dues
The fee due resource is used to display the application fee items with a status of due.
- Get a fee due detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeDues/{publicSectorFeeDuesUniqID}
- Get all fee dues detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeDues
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingNotifications/{publicSectorHearingNotificationsUniqID}
- Get all hearing notifications
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingNotifications
Communications/Inspection Communications
The inspection communications resource is used to view permit information related to inspections for inspection communications.
- Get all inspection communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCommunications
- Get an inspection communication item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCommunications/{publicSectorInspectionCommunicationsUniqID}
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}
- Get all cases
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCases
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/AdministerCaseStatusAccess
- Get an administer case status access
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/AdministerCaseStatusAccess/{CaseKey2}
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/UpdateCaseStatusAccess
- Get an update case status access
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/UpdateCaseStatusAccess/{CaseKey4}
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/UpdateAccess
- Get an update case access
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}/child/UpdateAccess/{CaseKey3}
Communications/Payment Communications
The payment communications resource is used to view payment data used in payment notifications.
- Get all payment data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCommunications
- Get payment data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCommunications/{PaymentHistoryKey}
Communications/Permit Attachment Communications
The permit attachment communications resource is used to capture attributes related to permit attachment communications.
- Get a permit attachment communication item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAttachmentCommunications/{publicSectorPermitAttachmentCommunicationsUniqID}
- Get all permit attachment communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAttachmentCommunications
Communications/Permit Cycle Due Date Plan Reviews
The permit cycle due date plan reviews resource is used to capture attributes related to permit application plan reviews with a cycle due date defined.
- Get a permit plan review cycle due date item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitCycleDueDatePlanReviews/{LnpRecordKey}
- Get all permit plan review cycle due date items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitCycleDueDatePlanReviews
Communications/Permit Department Due Date Plan Reviews
The permit department due date plan reviews resource is used to capture attributes related to permit application plan reviews with plan reviewer department due dates defined.
- Get a permit plan review department due date item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitDepartmentDueDatePlanReviews/{publicSectorPermitDepartmentDueDatePlanReviewsUniqID}
- Get all permit plan review department due date items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitDepartmentDueDatePlanReviews
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitExpiryCommunications/{LnpRecordKey}
- Get all permit expiry communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitExpiryCommunications
Communications/Permit Inspection Attachment Communications
The permit inspection attachment communications resource is used to capture attributes related to permit inspection attachment communications.
- Get a permit inspection attachment communications item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitInspectionAttachmentCommunications/{publicSectorPermitInspectionAttachmentCommunicationsUniqID}
- Get all permit inspection attachment communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitInspectionAttachmentCommunications
Communications/Permit Plan Review Attachment Communications
The permit plan review attachment communications resource is used to capture attributes related to permit plan reviewer attachment communications.
- Get a permit plan review attachment communications item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitPlanReviewAttachmentCommunications/{publicSectorPermitPlanReviewAttachmentCommunicationsUniqID}
- Get all permit plan review attachment communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitPlanReviewAttachmentCommunications
Communications/Permit Plan Review Coordinator Attachment Communications
The permit plan review coordinator attachment communications resource is used to capture attributes related to permit plan review coordinator communications.
- Get a permit plan review coordinator attachment communications item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitPlanCoordinatorAttachmentCommunications/{publicSectorPermitPlanCoordinatorAttachmentCommunicationsUniqID}
- Get all permit plan review coordinator attachment communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitPlanCoordinatorAttachmentCommunications
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewCommunications/{publicSectorPlanReviewCommunicationsUniqID}
- Get all plan review workflow communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewCommunications
Communications/Plan Review Planning Communications
The plan review planning communications resource is used to capture attributes related to planning plan review communications.
- Get a planning plan review communication item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewPlanningCommunications/{publicSectorPlanReviewPlanningCommunicationsUniqID}
- Get all planning plan review workflow communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewPlanningCommunications
Communications/Planning Application Cycle Due Date Plan Reviews
The planning cycle due date plan reviews resource is used to capture attributes related to planning application plan reviews with a cycle due date defined.
- Get a planning application plan review cycle due date item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanningCycleDueDatePlanReviews/{LnpRecordKey}
- Get all planning application plan review cycle due date items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanningCycleDueDatePlanReviews
Communications/Planning Department Due Date Plan Reviews
The planning department due date plan reviews resource is used to capture attributes related to planning application plan reviews with plan reviewer department due dates defined.
- Get a planning application plan review department due date item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanningDepartmentDueDatePlanReviews/{publicSectorPlanningDepartmentDueDatePlanReviewsUniqID}
- Get all planning application plan review department due date items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanningDepartmentDueDatePlanReviews
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzExpiryCommunications/{LnpRecordKey}
- Get all planning and zoning application expiry communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzExpiryCommunications
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzWorkflowCommunications/{LnpRecordKey}
- Get all planning and zoning workflow communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzWorkflowCommunications
Communications/Pre-application Meeting Communications
Pre-application meeting communications resource is used to configure the meeting notification templates.
- Get a pre-application meeting attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingCommunications/{publicSectorPreappMeetingCommunicationsUniqID}
- Get all pre-application meeting attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingCommunications
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileNotifications/{ProfileId}
- Get all of a registered public user's profiles
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileNotifications
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaAnonymousResultHeaders/{OpaResultId}
- Get all recommended permit lists
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaAnonymousResultHeaders
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaAnonymousResultHeaders/{OpaResultId}/child/OpaResultList/{OpaResultListId}
- Get all permit lists
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaAnonymousResultHeaders/{OpaResultId}/child/OpaResultList
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}
- Get all permits
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries
Communications/Record Queries/Record Contact Lists
The contact list resource is used to find attributes related to the contacts that are added to the permit application.
- Create a permit contact
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/ContactLists
- Delete a permit contact
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/ContactLists/{ContactKey}
- Get a permit contact
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/ContactLists/{ContactKey}
- Get all permit contacts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/ContactLists
- Update a permit contact
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/ContactLists/{ContactKey}
Communications/Record Queries/Record GIS Objects
The record GIS object resource is used to view the gis objects that are associated with the application.
- Create a record GIS object
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordGISObjects
- Delete a record GIS object
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordGISObjects/{GisObjKey}
- Get a record GIS object
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordGISObjects/{GisObjKey}
- Get all record GIS objects
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordGISObjects
- Update a record GIS object
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordGISObjects/{GisObjKey}
Communications/Record Queries/Record GIS Objects/Large Object (LOB) Attributes - GeometryJson
- Delete a GeometryJson
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordGISObjects/{GisObjKey}/enclosure/GeometryJson
- Get a GeometryJson
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordGISObjects/{GisObjKey}/enclosure/GeometryJson
- Replace a GeometryJson
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordGISObjects/{GisObjKey}/enclosure/GeometryJson
Communications/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/action/copyRecParcelInfo
- Create a permit parcel
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel
- Delete a permit parcel
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
- Get a permit parcel
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
- Get all permit parcels
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel
- Update a permit parcel
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
Communications/Record Queries/Record Parcel Queries/Parcel Addresses
The parcel addresses resource is used to view the parcel addresses.
- Copy address information from Common parcel address to LNP parcel address.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/action/copyParcelAddressInfo
- Create a set of record parcel addresses
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
- Delete a record parcel address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{publicSectorRecordQueries_RecordParcel_ParcelAddress_Id}
- Get a record parcel address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{publicSectorRecordQueries_RecordParcel_ParcelAddress_Id}
- Get all record parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
- Update a record parcel address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{publicSectorRecordQueries_RecordParcel_ParcelAddress_Id}
Communications/Record Queries/Record Parcel Queries/Parcel Owners
The parcel owners resource is used to view the parcel owners.
- Create a set of record parcel owners
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner
- Delete a record parcel owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{publicSectorRecordQueries_RecordParcel_ParcelOwner_Id}
- Get a parcel owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{publicSectorRecordQueries_RecordParcel_ParcelOwner_Id}
- Get all parcel owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner
- Update a record parcel owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{publicSectorRecordQueries_RecordParcel_ParcelOwner_Id}
Communications/Refund Records
The refund records resource is used to view refund records.
- Get a refund record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRefundRecords/{RefundHistoryKey}
- Get all refund records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRefundRecords
Communications/Refund Records/Refund Lines
The refund lines resource is used to view refund detail lines.
- Get a refund record line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRefundRecords/{RefundHistoryKey}/child/RefundRecordsLine/{RefundRecordsLineUniqID}
- Get all refund record lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRefundRecords/{RefundHistoryKey}/child/RefundRecordsLine
Communications/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowCommunications/{LnpRecordKey}
- Get all workflow communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowCommunications
Designer/Custom Callbacks
The custom callbacks resource is used for completing a variety of tasks when creating custom objects related to intake forms, 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCustomCallbacks
- Delete a custom callback is not supported
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCustomCallbacks/{SubClassId}
- Get a custom callback is not supported
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCustomCallbacks/{SubClassId}
- Get all custom callbacks is not supported
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCustomCallbacks
- Update a custom callback is not supported
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCustomCallbacks/{SubClassId}
Designer/Designer Layout Totals
The designer layout totals resource stores application form design totals 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals
- Delete a designer layout
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}
- Get a designer layout
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}
- Get all designer layouts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals
- Update a designer layout
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}
Designer/Designer Layout Totals/Large Object (LOB) Attributes - ExportLayout
- Delete an ExportLayout
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/ExportLayout
- Get an ExportLayout
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/ExportLayout
- Replace an ExportLayout
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/ExportLayout
Designer/Designer Layout Totals/Large Object (LOB) Attributes - LayoutMetadata
- Delete a LayoutMetadata
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutMetadata
- Get a LayoutMetadata
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutMetadata
- Replace a LayoutMetadata
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutMetadata
Designer/Designer Layout Totals/Large Object (LOB) Attributes - LayoutMetadataSb
- Delete a LayoutMetadataSb
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutMetadataSb
- Get a LayoutMetadataSb
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutMetadataSb
- Replace a LayoutMetadataSb
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutMetadataSb
Designer/Designer Layout Totals/Large Object (LOB) Attributes - LayoutView
- Delete a LayoutView
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutView
- Get a LayoutView
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutView
- Replace a LayoutView
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutView
Designer/Designer Layout Totals/Large Object (LOB) Attributes - LayoutViewSb
- Delete a LayoutViewSb
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutViewSb
- Get a LayoutViewSb
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutViewSb
- Replace a LayoutViewSb
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/LayoutViewSb
Designer/Designer Layout Totals/Large Object (LOB) Attributes - RecordDescribe
- Delete a RecordDescribe
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/RecordDescribe
- Get a RecordDescribe
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/RecordDescribe
- Replace a RecordDescribe
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals/{publicSectorConfiguratorLayoutsTotalsUniqID}/enclosure/RecordDescribe
Designer/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts
- Delete a deisgner layout
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}
- Get a designer layout
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}
- Get all designer layouts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts
- Update a designer layout type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}
Designer/Designer Layouts/Large Object (LOB) Attributes - ExportLayout
- Delete an ExportLayout
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/ExportLayout
- Get an ExportLayout
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/ExportLayout
- Replace an ExportLayout
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/ExportLayout
Designer/Designer Layouts/Large Object (LOB) Attributes - LayoutMetadata
- Delete a LayoutMetadata
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutMetadata
- Get a LayoutMetadata
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutMetadata
- Replace a LayoutMetadata
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutMetadata
Designer/Designer Layouts/Large Object (LOB) Attributes - LayoutMetadataSb
- Delete a LayoutMetadataSb
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutMetadataSb
- Get a LayoutMetadataSb
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutMetadataSb
- Replace a LayoutMetadataSb
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutMetadataSb
Designer/Designer Layouts/Large Object (LOB) Attributes - LayoutView
- Delete a LayoutView
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutView
- Get a LayoutView
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutView
- Replace a LayoutView
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutView
Designer/Designer Layouts/Large Object (LOB) Attributes - LayoutViewSb
- Delete a LayoutViewSb
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutViewSb
- Get a LayoutViewSb
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutViewSb
- Replace a LayoutViewSb
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/LayoutViewSb
Designer/Designer Layouts/Large Object (LOB) Attributes - RecordDescribe
- Delete a RecordDescribe
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/RecordDescribe
- Get a RecordDescribe
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/RecordDescribe
- Replace a RecordDescribe
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{publicSectorConfiguratorLayoutsUniqID}/enclosure/RecordDescribe
Inspections/All Inspection Dependencies
The All Inspection Dependency resource is used to retrieve all the inspection dependencies defined across applications.
- Get all Inspection Dependencies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAllDependencies
- Get an Inspection Dependency
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAllDependencies/{InspectionDepKey}
Inspections/Application Inspection Dependencies
The application inspection dependencies resource is used to capture the inspection dependencies defined across applications.
- Create an inspection dependency
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionApplicationDependencies
- Delete an inspection dependency
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionApplicationDependencies/{InspectionDepKey}
- Get all inspection dependencies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionApplicationDependencies
- Get an inspection dependency
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionApplicationDependencies/{InspectionDepKey}
- Update an inspection dependency
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionApplicationDependencies/{InspectionDepKey}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentDetails
- Delete an assessment definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentDetails/{publicSectorAssessmentDetailsUniqID}
- Get all assessment definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentDetails
- Get an assessment definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentDetails/{publicSectorAssessmentDetailsUniqID}
- Update an assessment definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentDetails/{publicSectorAssessmentDetailsUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes
- Delete an assessment type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}
- Get all assessment types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes
- Get an assessment type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}
- Update an assessment type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail
- Delete an assessment code
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail/{AssessmentDetailUniqID}
- Get all assessment codes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail
- Get an assessment code
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail/{AssessmentDetailUniqID}
- Update an assessment code
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssessmentTypes/{publicSectorAssessmentTypesUniqID}/child/AssessmentDetail/{AssessmentDetailUniqID}
Inspections/Business License Inspection Communications
The business license inspection communications resource is used to view business license information related to inspections for business license inspection communications.
- Get a business license inspection communication item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlInspectionCommunications/{publicSectorBlInspectionCommunicationsUniqID}
- Get all business license inspection communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlInspectionCommunications
Inspections/IVR Inspections
The IVR (interactive voice response) inspections resource is used to capture all 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections
- Delete an IVR inspection
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections/{InspectionKey}
- Get all IVR inspections
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections
- Get an IVR inspection
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections/{InspectionKey}
- Update an IVR Inspection
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections/{InspectionKey}
Inspections/IVR Record Conditions
The IVR (Interactive Voice Response) record conditions resource is used to view conditions applied to a record and application information including application type, application ID, and applicant profile ID.
- Get all IVR record conditions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordConditions
- Get an IVR record condition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordConditions/{ConditionKey}
Inspections/IVR Record Lists
The IVR (interactive voice response) 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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordLists
- Get an IVR record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordLists/{LnpRecordKey}
Inspections/IVR Record Types
The IVR (interactive voice response) 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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordTypes
- Get an IVR record type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordTypes/{RecordTypeId}
Inspections/Inspection Attachments
The inspection attachments resource is used to view, create, modify, or delete an inspection attachment.
- Create an inspection attachment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments
- Delete an inspection attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}
- Get all inspection attachment records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments
- Get an inspection attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}
- Update an inspection attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}
Inspections/Inspection Attachments/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an inspection attachment accessor
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor
- Delete an inspection attachment accessor
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}
- Get all inspection attachment accessor records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor
- Get an inspection attachment accessor
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}
- Update an inspection attachment accessor
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}
Inspections/Inspection Attachments/Attachments/Attachment Revisions
The attachmentsRevision resource is used to view attachment revisions.
- Create an attachment revision
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete an attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all attachment revision records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}/child/AttachmentsRevision
- Get an attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update an attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Inspections/Inspection Attachments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}/enclosure/FileContents
Inspections/Inspection Attachments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/child/InspectionAttachmentAccessor/{InspectionAttachmentAccessorUniqID}/enclosure/FileWebImage
Inspections/Inspection Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionAttachments/{InsAttachmentKey}/enclosure/Preview
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars
- Delete an inspection calendar
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars/{publicSectorInspectionCalendarsUniqID}
- Get all inspection calendars
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars
- Get an inspection calendar
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars/{publicSectorInspectionCalendarsUniqID}
- Update an inspection calendar
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars/{publicSectorInspectionCalendarsUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories
- Delete a checklist category
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}
- Get a checklist category
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}
- Get all checklist categories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories
- Update a checklist category
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}/child/ChecklistSubcategory
- Delete a checklist subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}/child/ChecklistSubcategory/{ChecklistSubcategoryUniqID}
- Get a checklist subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}/child/ChecklistSubcategory/{ChecklistSubcategoryUniqID}
- Get all checklist subcategories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}/child/ChecklistSubcategory
- Update a checklist subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}/child/ChecklistSubcategory/{ChecklistSubcategoryUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups
- Delete an inspection checklist group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}
- Get all inspection checklist groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups
- Get an inspection checklist group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}
- Update an inspection checklist group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}/child/ChecklistGroupLine
- Delete an inspection checklist group line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}/child/ChecklistGroupLine/{ChecklistGroupLineUniqID}
- Get all inspection checklist group lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}/child/ChecklistGroupLine
- Get an inspection checklist group line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}/child/ChecklistGroupLine/{ChecklistGroupLineUniqID}
- Update an inspection checklist group line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}/child/ChecklistGroupLine/{ChecklistGroupLineUniqID}
Inspections/Inspection Checklist Items
The inspection checklist item resource is used to capture all inspection checklist items and display checklist item information such as inspection ID, checklist ID, checklist item ID, checklist item name, checklist item score, checklist item result, and so on.
- Create a checklist item
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems
- Delete a checklist item
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}
- Get a checklist item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}
- Get all checklist items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems
- Get all inspection checklist items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItems
- Get an inspection checklist item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItems/{InspectionClItemKey}
- Update a checklist item
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}
- Update an inspection checklist item
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItems/{InspectionClItemKey}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}/child/Instruction
- Delete a checklist item's instructions
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}/child/Instruction/{InstructionUniqID}
- Get a checklist item's instructions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}/child/Instruction/{InstructionUniqID}
- Get all checklist items' instructions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}/child/Instruction
- Update a checklist item's instructions
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistItems/{publicSectorInspectionChecklistItemsUniqID}/child/Instruction/{InstructionUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistSubcategories
- Delete a checklist subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistSubcategories/{publicSectorChecklistSubcategoriesUniqID}
- Get a checklist subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistSubcategories/{publicSectorChecklistSubcategoriesUniqID}
- Get all checklist subcategories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistSubcategories
- Update a checklist subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistSubcategories/{publicSectorChecklistSubcategoriesUniqID}
Inspections/Inspection Checklists
The inspection checklists resource is used to view, create, delete, or modify an inspection checklist. An inspection checklist identifies the scope of inspections that an inspector must perform during an inspection. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on.
- Create a checklist
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists
- Delete a checklist
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}
- Get a checklist
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}
- Get all checklists
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists
- Get all inspection checklists
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkLists
- Get an inspection checklist
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkLists/{InspectionChklistKey}
- Update a checklist
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}
- Update an inspection checklist
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkLists/{InspectionChklistKey}
Inspections/Inspection Checklists/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem
- Delete a checklist item
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}
- Get a checklist item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}
- Get all checklist items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem
- Update a checklist item
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}/child/Instruction
- Delete a checklist item's instructions
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}/child/Instruction/{InstructionUniqID}
- Get a checklist item's instructions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}/child/Instruction/{InstructionUniqID}
- Get all checklist items' instructions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}/child/Instruction
- Update a checklist item's instructions
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}/child/Instruction/{InstructionUniqID}
Inspections/Inspection Dependencies
The inspection dependencies resource is used to identify the prerequisite inspections for each inspection type.
- Create an inspection dependency
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionDependencies
- Delete an inspection dependency
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionDependencies/{publicSectorInspectionDependenciesUniqID}
- Get all inspection dependencies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionDependencies
- Get an inspection dependency
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionDependencies/{publicSectorInspectionDependenciesUniqID}
Inspections/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 inspection types associated with a permit.
- Create an inspection group line
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines
- Delete an inspection group line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}
- Get all inspection group lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines
- Get an inspection group line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}
- Update an inspection group line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}
Inspections/Inspection Group Lines/Inspection Type Dependencies
The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.
- Create an inspection group line dependency
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}/child/InspectionGrpLnDependency
- Delete an inspection group line dependency
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}/child/InspectionGrpLnDependency/{InspectionGrpLnDependencyUniqID}
- Get all inspection group line dependencies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}/child/InspectionGrpLnDependency
- Get an inspection group line dependency
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}/child/InspectionGrpLnDependency/{InspectionGrpLnDependencyUniqID}
- Update an inspection group line dependency
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}/child/InspectionGrpLnDependency/{InspectionGrpLnDependencyUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups
- Delete an inspection group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}
- Get all inspection groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups
- Get an inspection group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}
- Update an inspection group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}/child/InspectionGroupLine
- Delete an inspection group line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}/child/InspectionGroupLine/{InspectionGroupLineUniqID}
- Get all inspection group lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}/child/InspectionGroupLine
- Get an inspection group line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}/child/InspectionGroupLine/{InspectionGroupLineUniqID}
- Update an inspection group line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}/child/InspectionGroupLine/{InspectionGroupLineUniqID}
Inspections/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionMobileChkListItems
- Get an inspection checklist item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionMobileChkListItems/{publicSectorInspectionMobileChkListItemsUniqID}
- Update an inspection checklist item
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionMobileChkListItems/{publicSectorInspectionMobileChkListItemsUniqID}
Inspections/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionStatuses
- Get an inspection status
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionStatuses/{publicSectorInspectionStatusesUniqID}
- Update an inspection status
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionStatuses/{publicSectorInspectionStatusesUniqID}
Inspections/Inspection Type Dependencies
The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.
- Create a dependent inspection type
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLineDependencies
- Delete a dependent inspection type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLineDependencies/{publicSectorInspectionGroupLineDependenciesUniqID}
- Get a dependent inspection type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLineDependencies/{publicSectorInspectionGroupLineDependenciesUniqID}
- Get all dependent inspection types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLineDependencies
- Update a dependent inspection type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLineDependencies/{publicSectorInspectionGroupLineDependenciesUniqID}
Inspections/Inspection Types
The inspection types 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes
- Delete an inspection type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes/{publicSectorInspectionTypesUniqID}
- Get all inspection types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes
- Get an inspection type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes/{publicSectorInspectionTypesUniqID}
- Update an inspection type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes/{publicSectorInspectionTypesUniqID}
Inspections/Inspection Worklists
The inspections worklists resource is used to return all inspections and display the inspection information to the worklist user, including inspection type, inspection ID, scheduling time, the user who created the inspection, and so on.
- Get all inspection worklists
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionWorklists
- Get an inspection worklist
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionWorklists/{InspectionKey}
Inspections/Inspection Worklists/Large Object (LOB) Attributes - ContractorSignature
- Get a ContractorSignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionWorklists/{InspectionKey}/enclosure/ContractorSignature
Inspections/Inspection Worklists/Large Object (LOB) Attributes - InspectorSignature
- Get an InspectorSignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionWorklists/{InspectionKey}/enclosure/InspectorSignature
Inspections/Inspection Worklists/Large Object (LOB) Attributes - OwnerSignature
- Get an OwnerSignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionWorklists/{InspectionKey}/enclosure/OwnerSignature
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructions
- Delete a checklist item's instructions
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructions/{publicSectorInstructionsUniqID}
- Get a checklist item's instructions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructions/{publicSectorInstructionsUniqID}
- Get all checklist items' instructions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructions
- Update a checklist item's instructions
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstructions/{publicSectorInstructionsUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRuleDetails
- Delete a scoring range
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRuleDetails/{publicSectorPassingRuleDetailsUniqID}
- Get a scoring range
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRuleDetails/{publicSectorPassingRuleDetailsUniqID}
- Get all scoring range
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRuleDetails
- Update a scoring range
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRuleDetails/{publicSectorPassingRuleDetailsUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules
- Delete a passing rule
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}
- Get a passing rule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}
- Get all passing rules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules
- Update a passing rule
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}/child/PassingRuleDetail
- Delete a passing rule scoring range
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}/child/PassingRuleDetail/{PassingRuleDetailUniqID}
- Get a passing rule scoring range
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}/child/PassingRuleDetail/{PassingRuleDetailUniqID}
- Get all passing rule scoring ranges
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}/child/PassingRuleDetail
- Update a passing rule scoring range
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules/{publicSectorPassingRulesUniqID}/child/PassingRuleDetail/{PassingRuleDetailUniqID}
Inspections/Permit Inspection Supervisor Attachment Communications
The permit inspection supervisor attachment communications resource is used to capture attributes related to permit inspection supervisor attachment communications.
- Get a permit inspection supervisor attachment communications item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitInspectionSupervisorAttachmentCommunications/{publicSectorPermitInspectionSupervisorAttachmentCommunicationsUniqID}
- Get all permit inspection supervisor attachment communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitInspectionSupervisorAttachmentCommunications
Inspections/Permit Inspections
The permit 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections
- Get all inspections
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections
- Get an inspection
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionKey}
- Update an inspection
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionKey}
Inspections/Permit Inspections/Large Object (LOB) Attributes - ContractorSignature
- Delete a ContractorSignature
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionKey}/enclosure/ContractorSignature
- Get a ContractorSignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionKey}/enclosure/ContractorSignature
- Replace a ContractorSignature
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionKey}/enclosure/ContractorSignature
Inspections/Permit Inspections/Large Object (LOB) Attributes - InspectorSignature
- Delete an InspectorSignature
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionKey}/enclosure/InspectorSignature
- Get an InspectorSignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionKey}/enclosure/InspectorSignature
- Replace an InspectorSignature
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionKey}/enclosure/InspectorSignature
Inspections/Permit Inspections/Large Object (LOB) Attributes - OwnerSignature
- Delete an OwnerSignature
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionKey}/enclosure/OwnerSignature
- Get an OwnerSignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionKey}/enclosure/OwnerSignature
- Replace an OwnerSignature
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspections/{InspectionKey}/enclosure/OwnerSignature
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethodDetails
- Delete a rating range of scores
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethodDetails/{publicSectorRatingMethodDetailsUniqID}
- Get a rating range of scores
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethodDetails/{publicSectorRatingMethodDetailsUniqID}
- Get all rating score ranges
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethodDetails
- Update a rating range of scores
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethodDetails/{publicSectorRatingMethodDetailsUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods
- Delete a rating method
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}
- Get a rating method
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}
- Get all rating methods
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods
- Update a rating method
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail
- Delete a rating range of scores
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail/{RatingMethodDetailUniqID}
- Get a rating range of scores
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail/{RatingMethodDetailUniqID}
- Get all rating score ranges
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail
- Update a rating range of scores
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail/{RatingMethodDetailUniqID}
Inspections/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules
- Delete a work schedule
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules/{publicSectorWorkSchedulesUniqID}
- Get a work schedule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules/{publicSectorWorkSchedulesUniqID}
- Get all work schedules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules
- Update a work schedule
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules/{publicSectorWorkSchedulesUniqID}
LOV/List of Values/Application Contact Types
The application contact type resource is used to list the contact types of a permit, business license, or planning and zoning application.
- Get all application contact details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationContactTypes
- Get an application contact details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationContactTypes/{publicSectorApplicationContactTypesUniqID}
LOV/List of Values/District Prompts
The district prompts resource is used to display districts and the associated district types. This resource is used as a prompt table.
- Get a district
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistrictPrompts/{DistrictId}
- Get all districts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistrictPrompts
LOV/List of Values/Inspector Inspection Counts
The inspector inspection counts resource is used to retrieve the number of inspections scheduled and assigned to an inspector for each date in the specified date range.
- Get all inspections assigned to inspectors for a given period
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectorInspectionCounts
- Get the count of Inspections assigned for an available inspector is not supported
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectorInspectionCounts/{InspectorId}
LOV/List of Values/Record Types Inspection Types Cross
The record types inspection types cross resource is used to view inspection types within an inspection group associated with a record type.
- Get all inspection types for a record type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypesInspectionTypesCross
- Get an inspection type for a record type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypesInspectionTypesCross/{publicSectorRecordTypesInspectionTypesCrossUniqID}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActiveLanguages
- Get an active language
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActiveLanguages/{LanguageId}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethodCodePros/{PaymentMethodCode}
- Get all payment method codes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethodCodePros
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressGeographies/{GeographyIdentifierId}
- Get all geographies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressGeographies
List of Values/Available Calendar Inspection Dates
The available calendar inspection dates resource is used to return the next 7 available inspection dates for a given record and inspection type. The dates are based on any applicable holiday calendars. They also adhere to the inspection calendar associated with the inspection type and the inspection district as derived from the record's primary parcel address, if applicable, or the address district if the record is associated with an address with no parcel.
- Get all available inspection dates by calendar
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRCalendarAvailableDates
- Get an available inspection date by calendar
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRCalendarAvailableDates/{Possibledate}
List of Values/Available Inspection Dates
The available inspection dates resource is used to return the next 7 available inspection dates for a given record and inspection type, based on any applicable holiday calendars.
- Get all available inspection dates
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRAvailableDates
- Get an available inspection date
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRAvailableDates/{Possibledate}
List of Values/Billing and Payment Drillbacks
The billing and payment drillbacks resource is used to access data to construct drillback URLs to the source application to view details about billing and payment History.
- Get a drillback value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBnpDrillbacks/{publicSectorBnpDrillbacksUniqID}
- Get all drillback values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBnpDrillbacks
List of Values/Business Rules Framework Rule Details
The business rules framework rule details resource is used to view the details of the business rules used to store criteria and actions related to a resource and an event.
- Get all of the details for every rule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRuleDetails
- Get details for a rule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRuleDetails/{RuleId}
List of Values/Calculate Hearing Appeal Fees
The calculate hearing appeal fees resource is used to view the calculation details of the hearing appeal fee.
- Get a hearing appeal detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateHearingAppealFees/{HearingAppealKey}
- Get all hearing appeal details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateHearingAppealFees
List of Values/Calculate Notice Fees
The calculate notice fee resource is used to provide input attributes for fee calculation.
- Get a fee attribute for a case
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateNoticeFees/{CaseKey}
- Get all fee attributes for a case
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateNoticeFees
List of Values/Case Citation Counts
The count citations resource is used to view the total number of citations in a case or inspection. This resource is used to get the count value that is required to calculate the compliance due date using time rules.
- Get a case citation count
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCountCitations/{CaseKey}
- Get all case citations count
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCountCitations
List of Values/Case Timeline Events
The case timeline event resource is used to view the timeline events related to a case.
- Get a timeline event for a case
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseTimelineEvents/{TimelineKey}
- Get all timeline events for all cases
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseTimelineEvents
List of Values/Case Transaction Lists
The case transaction list resource is used to register all code enforcement cases in the system.
- Get a case
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseTransactionLists/{CaseKey}
- Get all cases
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCaseTransactionLists
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDiscrepTypes/{DiscrepancyType}
- Get all cash discrepany types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDiscrepTypes
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcilViews/{SessionId}
- Get all cash drawer reconciliation views
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcilViews
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashSessionPrompts/{publicSectorCashSessionPromptsUniqID}
- Get all cash session prompts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashSessionPrompts
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashierSessions/{SessionId}
- Get all cashier sessions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashierSessions
- Gets the current server time and cashier session auto number rule name.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashierSessions/action/getCashierSessionSeqAndServerTime
- Gets the current server time.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCashierSessions/action/getCurrentServerTime
List of Values/Category and Condition Sequences
The category and condition sequence resource lists the condition types, categories, and their print sequences.
- Get a condition type or category print sequence
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListConditionTypesCategories/{publicSectorListConditionTypesCategoriesUniqID}
- Get all condition types or category print sequences
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListConditionTypesCategories
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCEDistricts/{DistrictId}
- Get all code enforcement districts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCEDistricts
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionLists/{publicSectorCodeEnforcementInspectionListsUniqID}
- Get all code enforcement inspections
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionLists
List of Values/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 a recent issue
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementRecentIssues/{CaseKey}
- Get all recent issues
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementRecentIssues
List of Values/Condition of Approval Template Item Details
The condition of approval template item detail resource is used to list the template item details available in the conditions of approval templates.
- Get a template item for the conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplateItemDetails/{publicSectorConditionOfApprovalTemplateItemDetailsUniqID}
- Get all template items for the conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplateItemDetails
List of Values/Condition of Approval Template Item Details/Large Object (LOB) Attributes - Condition
- Get a Condition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplateItemDetails/{publicSectorConditionOfApprovalTemplateItemDetailsUniqID}/enclosure/Condition
List of Values/Condition of Approval Template Item Details/Large Object (LOB) Attributes - ConditionPlain
- Get a ConditionPlain
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplateItemDetails/{publicSectorConditionOfApprovalTemplateItemDetailsUniqID}/enclosure/ConditionPlain
List of Values/Conditions of Approval Details
The conditions of approval detail resource lists the details of the conditions of approval.
- Get a condition of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalDetails/{TransactionKey}
- Get all conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalDetails
List of Values/Conditions of Approval Details/Large Object (LOB) Attributes - Condition
- Get a Condition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalDetails/{TransactionKey}/enclosure/Condition
List of Values/Conditions of Approval Details/Large Object (LOB) Attributes - ConditionPlain
- Get a ConditionPlain
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalDetails/{TransactionKey}/enclosure/ConditionPlain
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrentContextHelps/{publicSectorCurrentContextHelpsUniqID}
- Get all current contextual help entries
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrentContextHelps
List of Values/Current Contextual Help/Large Object (LOB) Attributes - ContxthlpClob
- Delete a ContxthlpClob
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrentContextHelps/{publicSectorCurrentContextHelpsUniqID}/enclosure/ContxthlpClob
- Get a ContxthlpClob
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrentContextHelps/{publicSectorCurrentContextHelpsUniqID}/enclosure/ContxthlpClob
- Replace a ContxthlpClob
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrentContextHelps/{publicSectorCurrentContextHelpsUniqID}/enclosure/ContxthlpClob
List of Values/Current Date and Time Values
The current date and time value resource is used to get the current date and time values from the server.
- Get all current date and time values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrentDateTime
- Get the current date and time values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCurrentDateTime/{CurrentDateTime}
List of Values/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLinesCross/action/bulkDelete
- Get a display group line with its related record type information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLinesCross/{publicSectorDisplayGroupLinesCrossUniqID}
- Get all display group lines and their related record type information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroupLinesCross
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategoryPrompts/{publicSectorDocumentGroupCategoryPromptsUniqID}
- Get all document group categories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategoryPrompts
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroupsKeys
- Get an expiration group key
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroupsKeys/{publicSectorExpirationGroupsKeysUniqID}
List of Values/Expiration Groups Totals
The expiration groups total resource is used to list all the expiration groups.
- Get all expiration groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroupsTotals
- Get an expiration group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroupsTotals/{publicSectorExpirationGroupsTotalsUniqID}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExploreCityPermits/{LnpRecordKey}
- Get all permits, planning applications, and business license parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorExploreCityPermits
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineModels/{publicSectorFeeLineModelsUniqID}
- Get all fee line decision models
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineModels
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedulesTotals/{publicSectorFeeSchedulesTotalsUniqID}
- Get all fee schedules by effective date
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedulesTotals
List of Values/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedulesKeys/action/bulkDelete
- Get a fee schedule
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedulesKeys/{publicSectorFeeSchedulesKeysUniqID}
- Get all fee schedules
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedulesKeys
List of Values/Hearing Applications
The hearing applications resource is used to view a planning and zoning application that requires hearing.
- Get a hearing application
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingApplications/{publicSectorHearingApplicationsUniqID}
- Get all hearing applications
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingApplications
List of Values/IVR Inspection Group Lines
The IVR (Interactive Voice Response) inspection group lines resource is used to return all inspection types for a given inspection group.
- Get all IVR inspection groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRInspectionGroupLines
- Get an IVR inspection group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIVRInspectionGroupLines/{publicSectorIVRInspectionGroupLinesUniqID}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListCounts
- Get an inspection checklist with count information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListCounts/{InspectionId}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListDetails
- Get an inspection checklist with details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListDetails/{publicSectorInspectionChkListDetailsUniqID}
List of Values/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLinesCross/action/bulkDelete
- Get a checklist group line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLinesCross/{publicSectorChecklistGroupLinesCrossUniqID}
- Get all checklist group lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLinesCross
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItemDetails
- Get an inspection checklist item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItemDetails/{publicSectorInspectionChkListItemDetailsUniqID}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistResultCodes/{publicSectorInspectionChecklistResultCodesUniqID}
- Get all checklist result codes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklistResultCodes
List of Values/Inspection Console Permits
The inspection console permits resource is used for agencies to view a list of permits that are ready to be inspected. This includes permits in About to Expire, Accepted, Delinquent, Expired, In Process, Inspection, Permit Issued, Plan Review, and Submitted statuses and isn't affected by inspection scheduling methods.
- Get all inspection-ready permits
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionConsolePermits
- Get an inspection-ready permit
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionConsolePermits/{publicSectorInspectionConsolePermitsUniqID}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionResultCodes
- Get an inspection result code
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionResultCodes/{publicSectorInspectionResultCodesUniqID}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionTabFilters
- Get an inspection tab filer count
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionTabFilters/{TabId}
List of Values/List Due Case Fees
The list due case fee resource is used to view a list of the fees due for a case.
- Get a due case fee record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListDueCaseFees/{FeeRecordKey}
- Get all due case fee records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorListDueCaseFees
List of Values/Login Profiles
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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLoginProfiles
- Get an account profile for the currently signed in registered public user
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLoginProfiles/{ProfileId}
List of Values/Lookups
The lookups resource is used to view standard lookup codes.
- Get a lookup.
- Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups/{fndStaticLookupsUniqID}
- Get all lookups.
- Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups
List of Values/My Permits Ready for Inspections
The my permits ready for inspections resource is used for registered public users to view a list of inspection-ready permits for which they are the applicant. This includes permits in Permit Issued, Inspection, or About to Expire statuses and isn't affected by inspection scheduling methods.
- Get all my inspection-ready permits
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMyInspectionsPermits
- Get my inspection-ready permit
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMyInspectionsPermits/{publicSectorMyInspectionsPermitsUniqID}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodePrompts/{publicSectorNAICSGroupCodePromptsUniqID}
- Get all NAICS group codes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodePrompts
List of Values/Overdue Case Fees
The overdue case fees resource is used to view a list of the overdue fee records for a case.
- Get all overdue case fee records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOverdueCaseFees
- Get an overdue case fee record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOverdueCaseFees/{FeeRecordKey}
List of Values/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelDistrictsCrosses/action/bulkDelete
- Get a parcel district
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelDistrictsCrosses/{publicSectorParcelDistrictsCrossesUniqID}
- Get all parcel districts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelDistrictsCrosses
List of Values/Parcel District Fees
The parcel district fees resource is used to list districts based on the parcel ID. Fee calculations are based on this district list.
- Get a parcel district fee
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelDistrictFees/{publicSectorParcelDistrictFeesUniqID}
- Get all parcel district fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelDistrictFees
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelValuesTotals/{publicSectorParcelValuesTotalsUniqID}
- Get all parcel value totals
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelValuesTotals
List of Values/Parcel genealogy transactions
The parcel genealogy transactions resource is used to view, create, modify, or delete parcel genealogy transactions.
- Get a parcel genealogy transaction
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactions/{publicSectorParcelTransactionsUniqID}
- Get all parcel genealogy transactions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactions
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCarts
- Get an item from the cart record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCarts/{LnpRecordKey}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptions/{publicSectorPaymentOptionsUniqID}
- Get all payment options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptions
List of Values/Period of Compliances
The period of compliance resource is used to list the period of compliances associated with the conditions of approval.
- Get a period of compliance definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPeriodOfComplianceDefinitions/{publicSectorPeriodOfComplianceDefinitionsUniqID}
- Get all period of compliance definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPeriodOfComplianceDefinitions
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitContacts/{publicSectorPermitContactsUniqID}
- Get all lists of permit contacts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitContacts
List of Values/Permit Inspection Time Entry Fees
The permit inspection time entry fees resource is used to identify the mapping attributes for DMN to calculate the fees for inspection time recording entries.
- Get a set of mapping attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateInspectionFees/{publicSectorCalculateInspectionFeesUniqID}
- Get all mapping attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateInspectionFees
List of Values/Phone Country Codes
Use the phone country codes resource to view phone country codes.
- Get a phone country code
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPhoneCountryCodes/{publicSectorPhoneCountryCodesUniqID}
- Get all phone country codes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPhoneCountryCodes
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewMaximumCycles/{PlanReviewKey}
- Get all cycle information for a permit plan review's most current cycle
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewMaximumCycles
List of Values/Plan Reviewer Workloads
The plan reviewer workloads resource is used to view plan reviewer assignments by department.
- Get a plan reviewer's workload
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerWorkloads/{publicSectorPlanReviewerWorkloadsUniqID}
- Get all plan reviewers' workloads
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerWorkloads
List of Values/Planner Activities
The planner activities resource is used to view the pending activities for planning and zoning applications.
- Get all activities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlannerActivities
- Get an activity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlannerActivities/{ActivityLogKey}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPopularApplications
- Get an application type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPopularApplications/{RecordTypeId}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectFees/{publicSectorProjectFeesUniqID}
- Get all project permits fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectFees
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPromptConditions/{publicSectorPromptConditionsUniqID}
- Get all conditions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPromptConditions
List of Values/Provisional Parcel Lists
The Provisional Parcel Lists resource is used to get the provisional parcels .
- Get a provisional parcel row
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProvisionalParcelLists/{ParcelId}
- Get all provisional parcel row
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProvisionalParcelLists
List of Values/Proxy Resources
The proxy resource is used to list the available REST resources assigned to the anonymous user.
- Get a REST resource
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPudsResources/{ResourceCode}
- Get all REST resources
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPudsResources
List of Values/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 are 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 ranges defined on his or her assigned work schedules. 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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorQualifiedInspectors/{publicSectorQualifiedInspectorsUniqID}
- Get all qualified available inspectors
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorQualifiedInspectors
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: getPath:
/crmRestApi/resources/11.13.18.05/ratedCurrencies/{CurrencyCode}
- Get all rated currencies
- Method: getPath:
/crmRestApi/resources/11.13.18.05/ratedCurrencies
List of Values/Recalculate Case Fees
The recalculate case fees resource is used to view the calculation details of the late fee for a case fee record.
- Get a case fee record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecalculateCaseFees/{FeeRecordKey}
- Get case fee records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecalculateCaseFees
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecentApplications
- Get an application type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecentApplications/{publicSectorRecentApplicationsUniqID}
List of Values/Reconciled Parcel Lists
The Reconciled Parcel Lists resource is used to get the parcels that have been reconciled with the provisional parcel.
- Get a reconciled parcel row
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReconciledParcelLists/{ParcelId}
- Get all reconciled parcel row
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReconciledParcelLists
List of Values/Search Ad hoc Reports
The search ad hoc report resource is used to view an ad hoc report. Ad hoc reports are used in application records.
- Get all ad hoc reports
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchAdhocReports
- Get an ad hoc report
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchAdhocReports/{publicSectorSearchAdhocReportsUniqID}
List of Values/Search Business Tax Classes
The search tax class resource is used to view a business tax class. Business tax classes are used in business license applications.
- Get a business tax class
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchTaxClasses/{publicSectorSearchTaxClassesUniqID}
- Get all business tax classes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchTaxClasses
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchHearingBodies/{publicSectorSearchHearingBodiesUniqID}
- Get all hearing bodies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchHearingBodies
List of Values/Search Violation Ad Hoc Notices
The search violation ad hoc notice type resource is used to view a violation ad hoc notice type. Ad hoc violation notice types are used in Code Enforcement cases.
- Get all ad hoc violation notice types from all violation notice groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchViolationAdhocNotices
- Get an ad hoc violation notice type from all violation notice groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchViolationAdhocNotices/{publicSectorSearchViolationAdhocNoticesUniqID}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewFees/{publicSectorRecordOverviewFeesUniqID}
- Get all record fee summaries
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewFees
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewInspectionSummaries
- Get an inspection summary
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewInspectionSummaries/{publicSectorRecordOverviewInspectionSummariesUniqID}
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewUpcomings/{publicSectorRecordOverviewUpcomingsUniqID}
- Get all summaries of upcoming inspections
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordOverviewUpcomings
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSystemDefinedFilters/{FilterId}
- Get all filter criteria by table name
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSystemDefinedFilters
List of Values/System Defined Filters/Large Object (LOB) Attributes - Criteria
- Delete a Criteria
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSystemDefinedFilters/{FilterId}/enclosure/Criteria
- Get a Criteria
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSystemDefinedFilters/{FilterId}/enclosure/Criteria
- Replace a Criteria
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSystemDefinedFilters/{FilterId}/enclosure/Criteria
List of Values/Time Recording Unassessed Entries
The time recording unassessed entries resource is used to retrieve all time recording entries that are unassessed.
- Get all unassessed time recording entries
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingUnassessedEntries
- Get an unassessed time recording entry
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingUnassessedEntries/{publicSectorTimeRecordingUnassessedEntriesUniqID}
List of Values/Time Transaction Type Prompts
Use the time transaction type prompts resource to retrieve time transaction type information along with associated category and subcategory information.
- Get a time transaction type prompt
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeTransactionTypePrompts/{publicSectorTimeTransactionTypePromptsUniqID}
- Get all time transaction type prompts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeTransactionTypePrompts
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTransactionLatestAssignees/{TransAssignKey}
- Get all latest transaction assignees.
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTransactionLatestAssignees
List of Values/Transaction Lists
The transaction list resource is used to get a list of available applications that are ready for linking as related transactions.
- Get a transaction
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTransactionLists/{LnpRecordKey}
- Get all transactions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTransactionLists
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserAccesses/{PscUserId}
- Get all users' information and the number of pending verification requests for the users
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserAccesses
List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserRequests/{publicSectorUserRequestsUniqID}
- Get all pending verification requests for a user
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserRequests
Permits/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}
- Get all permit attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments
Permits/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor
- Get file-related information for the permit attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor/{LnpAllAttachmentAccessorUniqID}
Permits/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor/{LnpAllAttachmentAccessorUniqID}/child/AttachmentsRevision
- Get an attachment revision for permit attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor/{LnpAllAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Permits/All Permit Attachments/All Permit Attachment Accessors/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor/{LnpAllAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor/{LnpAllAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor/{LnpAllAttachmentAccessorUniqID}/enclosure/FileContents
Permits/All Permit Attachments/All Permit Attachment Accessors/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/child/LnpAllAttachmentAccessor/{LnpAllAttachmentAccessorUniqID}/enclosure/FileWebImage
Permits/All Permit Attachments/Large Object (LOB) Attributes - Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}/enclosure/Preview
Permits/Application Lists
The application list resource is used to capture all the application records that are owned by the applicant or in case the applicant is added as a contact. It displays the application information to the user including the 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 parcel address detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}
- Get all records with parcel address and business location details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists
Permits/Application Lists/Business Locations
The business location resource is used to view the business locations that are associated with the business license application.
- Create a set of business locations for the associated application
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/BusinessLocation
- Delete a business location for the associated application
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/BusinessLocation/{LnpBusinessLocationKey}
- Get a business location detail for the associated application
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/BusinessLocation/{LnpBusinessLocationKey}
- Get all business locations for the associated application
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/BusinessLocation
- Update a business location for the associated application
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/BusinessLocation/{LnpBusinessLocationKey}
Permits/Application Lists/Parcel Addresses
The parcel address resource is used to view the parcel addresses.
- Copies the parcel address information.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/ParcelAddress/action/copyParcelAddressInfo
- Create a set of parcel addresses for the associated application
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/ParcelAddress
- Delete a parcel address for the associated application
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/ParcelAddress/{AddressKey}
- Get a parcel address for the associated application
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/ParcelAddress/{AddressKey}
- Get all parcel address records for the associated application
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/ParcelAddress
- Update a parcel address for the associated application
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/ParcelAddress/{AddressKey}
Permits/BL Global Searches
The business license global search resource is used to view and search limited fields for business license applications based on the agency configured search fields. This is restricted to only public users.
- Get a business license application based on the searched value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBLGlobalSearches/{LnpRecordId}
- Get all business license applications based on the searched value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBLGlobalSearches
Permits/Calculate District Fees Mapping
The calculate district fees mapping resource is used to list attributes that can be used for fee line mappings. 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 then used for fee calculation.
- Create a set of parcel district fees
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateDistrictFees
- Delete a parcel district fee
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateDistrictFees/{publicSectorCalculateDistrictFeesUniqID}
- Get a parcel district fee
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateDistrictFees/{publicSectorCalculateDistrictFeesUniqID}
- Get all parcel district fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateDistrictFees
- Update a parcel district fee
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculateDistrictFees/{publicSectorCalculateDistrictFeesUniqID}
Permits/Credential Attachments
The credential attachment resource is used to view, create and update the attachments.
- Create a set of credential attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments
- Delete a credential attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}
- Get a credential attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}
- Get all credential attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments
- Update a credential attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}
Permits/Credential Attachments/Attachments
The attachments resource is used to view, create, and update attachments.
- Create a set of credential attachment accessors
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor
- Delete a credential attachment accessor
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}
- Get a credential attachment accessor
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}
- Get all credential attachments accessor
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor
- Update a credential attachment accessor
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}
Permits/Credential Attachments/Attachments/Attachment Revisions
The attachmentsRevision resource is used to view attachment revisions.
- Create a set of credential attachment revisions
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete a credential attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get a credential attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all credential attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}/child/AttachmentsRevision
- Update a credential attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Permits/Credential Attachments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}/enclosure/FileContents
Permits/Credential Attachments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/child/CredentialAttachmentAccessor/{CredentialAttachmentAccessorUniqID}/enclosure/FileWebImage
Permits/Credential Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments/{LnpCredentialAtchKey}/enclosure/Preview
Permits/Due Fees
The record due fees resource is used to display due fee amounts, number of due applications, and to add due applications to the payment cart.
- Add due applications to the public user cart.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordDueFees/action/addDueAppToCart
- Create an entry for missing due fee application in payment cart
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordDueFees
- Get all due fee details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordDueFees
- Get due fee detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordDueFees/{TotalApplicationCount}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayFeeRecords/action/bulkDelete
- Get a fee record with fee and department descriptions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayFeeRecords/{FeeRecordKey}
- Get all fee records with fee and department descriptions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayFeeRecords
Permits/GIS Attributes
The GIS attributes resource is used to update and return all GIS attributes for a given application record.
- Get a GIS attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordGISAttributes/{publicSectorRecordGISAttributesUniqID}
- Get all GIS attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordGISAttributes
- Refreshes the list and values of GIS attributes for the application.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordGISAttributes/action/refreshGISAttributes
- Update a GIS attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordGISAttributes/{publicSectorRecordGISAttributesUniqID}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLines
- Delete a checklist group line
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLines/{publicSectorChecklistGroupLinesUniqID}
- Get a checklist group line
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLines/{publicSectorChecklistGroupLinesUniqID}
- Get all checklist group lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLines
- Update a checklist group line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroupLines/{publicSectorChecklistGroupLinesUniqID}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments
- Delete an inspection comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments/{publicSectorInspectionCommentsUniqID}
- Get all inspection comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments
- Get an inspection comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments/{publicSectorInspectionCommentsUniqID}
- Update an inspection comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments/{publicSectorInspectionCommentsUniqID}
Permits/Inspection Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments/{publicSectorInspectionCommentsUniqID}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments/{publicSectorInspectionCommentsUniqID}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments/{publicSectorInspectionCommentsUniqID}/enclosure/CommentText
Permits/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties/{ParcelKey}
- Get all record parcels and related parcel information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties
- Gets the record parcel count information.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties/action/getParcelCountInformation
- Update a record parcel and related parcel information
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties/{ParcelKey}
Permits/Payments By Transactions
The payments by transactions resource returns Application details along with Fee details, which will be used by BRF team to advance workflow after successful payments.
- Create a set of application payment details records
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentsByTransactions
- Delete an application payment details record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentsByTransactions/{publicSectorPaymentsByTransactionsUniqID}
- Get all application payment details records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentsByTransactions
- Get an application payment details record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentsByTransactions/{publicSectorPaymentsByTransactionsUniqID}
- Update an application payment details record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentsByTransactions/{publicSectorPaymentsByTransactionsUniqID}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions
- Delete a permit agency options definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions/{publicSectorPermitAgencyOptionsUniqID}
- Get a permit agency options definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions/{publicSectorPermitAgencyOptionsUniqID}
- Get all permit agency options definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions
- Update a permit agency options definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions/{publicSectorPermitAgencyOptionsUniqID}
Permits/Permit Agency Options/Large Object (LOB) Attributes - LongDescription
- Delete a LongDescription
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions/{publicSectorPermitAgencyOptionsUniqID}/enclosure/LongDescription
- Get a LongDescription
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions/{publicSectorPermitAgencyOptionsUniqID}/enclosure/LongDescription
- Replace a LongDescription
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAgencyOptions/{publicSectorPermitAgencyOptionsUniqID}/enclosure/LongDescription
Permits/Permit Application Contacts
The permit application contact resource is used to find attributes related to the contacts that are added to the permit application.
- Get a permit application contact item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitApplicationContacts/{publicSectorPermitApplicationContactsUniqID}
- Get all permit application contact items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitApplicationContacts
Permits/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordConditions/{ConditionKey}
- Get all permit conditions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordConditions
Permits/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDecisions/{publicSectorPlanReviewDecisionsUniqID}
- Get all plan review decisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDecisions
- Update a plan review decision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDecisions/{publicSectorPlanReviewDecisionsUniqID}
Permits/Record Activation Requests
The record activation request resource is used to inactivate or reactivate business license records and cancel all the ongoing activities and inspections related to that license.
- Create a set of all license inactivation or reactivation request records
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordActivationRequests
- Delete a license inactivation or reactivation request record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordActivationRequests/{RequestKey}
- Get a license inactivation or reactivation request record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordActivationRequests/{RequestKey}
- Get all license inactivation or reactivation request records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordActivationRequests
- Update a license inactivation or reactivation request record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordActivationRequests/{RequestKey}
Permits/Record Activities
The record activities resource returns renewal permit activity details.
- Get a record activity record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordActivities/{LnpRecordKey}
- Get all record activity records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordActivities
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments
- Delete an attachment for a permit
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}
- Get all attachments for a permit
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments
- Get an attachment for a permit
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}
- Update an attachment for a permit
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}
Permits/Record Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/enclosure/Preview
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor
- Delete a permit attachment's file-related information
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}
- Get a permit attachment's file-related information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}
- Get all attachment file-related information for a permit
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor
- Update a permit attachment's file-related information
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}
Permits/Record Attachments/Record Attachment Accessors/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/enclosure/FileContents
Permits/Record Attachments/Record Attachment Accessors/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/enclosure/FileWebImage
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete a record attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get a permit attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all record attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/child/AttachmentsRevision
- Update a record attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor/{LnpAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Permits/Record Comments
The record comments resource is used to add comments to a permit.
- Create a set of record comments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordComments
- Delete a record comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordComments/{publicSectorRecordCommentsUniqID}
- Get a record comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordComments/{publicSectorRecordCommentsUniqID}
- Get all record comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordComments
- Update a record comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordComments/{publicSectorRecordCommentsUniqID}
Permits/Record Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordComments/{publicSectorRecordCommentsUniqID}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordComments/{publicSectorRecordCommentsUniqID}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordComments/{publicSectorRecordCommentsUniqID}/enclosure/CommentText
Permits/Record Contractor Licenses
The record contractor licenses resource is used to view application contractor licenses.
- Get all application contractor licenses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordContractorLicenses
- Get an application contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordContractorLicenses/{LnpLicenseKey}
Permits/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordExtensions/{LnpRecordKey}
- Get all record extensions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordExtensions
- Update a record extension
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordExtensions/{LnpRecordKey}
Permits/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}
- Get all records, record parcels, and parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists
Permits/Record Lists/Business Locations
The business locations resource is used to view the business locations.
- Get a business location
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessLocation/{LnpBusinessLocationKey}
- Get all business locations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessLocation
Permits/Record Lists/Business Owners
The business owners resource is used to view the business owners.
- Get a business owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessOwner/{LnpBusinessOwnersKey}
- Get all business owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessOwner
Permits/Record Lists/Parcel Addresses
The parcel addresses resource is used to view the parcel addresses.
- Copies the parcel address information.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress/action/copyParcelAddressInfo
- Create a set of record parcel addresses
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress
- Delete a record parcel address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress/{AddressKey}
- Get a record parcel address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress/{AddressKey}
- Get all record parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress
- Update a record parcel address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/ParcelAddress/{AddressKey}
Permits/Record Lists/Parcels
The record parcels resource is used to view the parcels that are associated with the application.
- Copies the parcel information.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/action/copyRecParcelInfo
- Get a record parcel
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
- Get all record parcels
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel
Permits/Record Lists/Parcels/Parcel Addresses
The parcel addresses resource is used to view the parcel addresses.
- Copies the parcel address information.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/action/copyParcelAddressInfo
- Get a record parcel address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
- Get all record parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
Permits/Record Lists/Parcels/Parcel Owners
The parcel owner resource is used to view the parcel owners.
- Create a set of record parcel owners
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner
- Delete a record parcel owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{publicSectorRecordLists_RecordParcel_ParcelOwner_Id}
- Get a parcel owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{publicSectorRecordLists_RecordParcel_ParcelOwner_Id}
- Get all parcel owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner
- Update a record parcel owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{publicSectorRecordLists_RecordParcel_ParcelOwner_Id}
Permits/Record Parcel Address Search Queries
The Record Parcel Address Search Queries resource is used to perform search all application records 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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressSearchQueries/{publicSectorRecordParcelAddressSearchQueriesUniqID}
- Get all permits
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressSearchQueries
Permits/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.
- Copies the record parcel address information of the application.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses/action/copyParcelAddressInfo
- Create a set of record parcel addresses
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses
- Delete a record parcel address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses/{AddressKey}
- Get a record parcel address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses/{AddressKey}
- Get all record parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses
- Update a record parcel address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelAddresses/{AddressKey}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners
- Delete a record parcel owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners/{OwnerKey}
- Get a record parcel owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners/{OwnerKey}
- Get all record parcel owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners
- Update a record parcel owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners/{OwnerKey}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/action/copyRecParcelInfo
- Create a set of record parcels
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels
- Delete a record parcel
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}
- Get a record parcel
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}
- Get all record parcels
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels
- Update a record parcel
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}
Permits/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressCrosses/{publicSectorRecordParcelAddressCrossesUniqID}
- Get all record parcels with their parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressCrosses
Permits/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.
- Copies the record parcel address information of the application.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress/action/copyParcelAddressInfo
- Create a record parcel address
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress
- Delete a record parcel address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress/{AddressKey}
- Get a record parcel address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress/{AddressKey}
- Get all record parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress
- Update a record parcel address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress/{AddressKey}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelOwner
- Delete a record parcel owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelOwner/{OwnerKey}
- Get a record parcel owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelOwner/{OwnerKey}
- Get all record parcel owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelOwner
- Update a record parcel owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelOwner/{OwnerKey}
Permits/Record Type Inspection Options
The record type inspection options resource is used to view, create, or modify options associated with a record type and inspection type.
- Create a record type inspection option
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypeInspectionOptions
- Delete a record type inspection option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypeInspectionOptions/{publicSectorRecordTypeInspectionOptionsUniqID}
- Get a record type inspection option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypeInspectionOptions/{publicSectorRecordTypeInspectionOptionsUniqID}
- Get all record type inspection options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypeInspectionOptions
- Update a record type inspection option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypeInspectionOptions/{publicSectorRecordTypeInspectionOptionsUniqID}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords
- Delete a record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}
- Get a record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}
- Get all records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords
- Refreshes the list and values of GIS attributes for the application.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/action/refreshGISAttributes
- Update a record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList
- Delete a contact
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
- Get a contact
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
- Get all contacts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList
- Update a contact
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/FieldGroups
- Delete a field group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/FieldGroups/{LnpRecordKey2}
- Get a field group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/FieldGroups/{LnpRecordKey2}
- Get all field groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/FieldGroups
- Update a field group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/FieldGroups/{LnpRecordKey2}
Permits/Records/Global Customs
The global custom 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 global custom record
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/LnpGlobalCustom
- Delete a global custom record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/LnpGlobalCustom/{LnpRecordKey3}
- Get a global custom record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/LnpGlobalCustom/{LnpRecordKey3}
- Get all global custom records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/LnpGlobalCustom
- Update a global custom record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/LnpGlobalCustom/{LnpRecordKey3}
Permits/Records/Large Object (LOB) Attributes - Esignature
- Delete an Esignature
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/enclosure/Esignature
- Get an Esignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/enclosure/Esignature
- Replace an Esignature
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/enclosure/Esignature
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment
- Delete a record comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}
- Get a record comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}
- Get all record comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment
- Update a record comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}
Permits/Records/Record Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}/enclosure/CommentText
Permits/Records/Record GIS Objects
The record GIS objects resource is used to view, create, modify, or delete a record GIS object. Record GIS Objects are any object defined in a map service that is not associated with a parcel, address, or owner. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
- Create a set of record GIS objects
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISObject
- Delete a record GIS object
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISObject/{GisObjKey}
- Get a record GIS object
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISObject/{GisObjKey}
- Get all record GIS objects
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISObject
- Update a record GIS object
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISObject/{GisObjKey}
Permits/Records/Record GIS Objects/Large Object (LOB) Attributes - GeometryJson
- Delete a GeometryJson
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISObject/{GisObjKey}/enclosure/GeometryJson
- Get a GeometryJson
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISObject/{GisObjKey}/enclosure/GeometryJson
- Replace a GeometryJson
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISObject/{GisObjKey}/enclosure/GeometryJson
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner
- Delete a record parcel address owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}
- Get a record parcel address owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}
- Get all records of parcel address owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner
- Update a record parcel address owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}
Permits/Records/Record Parcel Address Owners/Large Object (LOB) Attributes - GeometryJson
- Delete a GeometryJson
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/GeometryJson
- Get a GeometryJson
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/GeometryJson
- Replace a GeometryJson
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/GeometryJson
Permits/Records/Record Parcel Address Owners/Large Object (LOB) Attributes - SketchJson
- Delete a SketchJson
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/SketchJson
- Get a SketchJson
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/SketchJson
- Replace a SketchJson
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/SketchJson
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/action/copyRecParcelInfo
- Create a record parcel
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel
- Delete a record parcel
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
- Get a record parcel
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
- Get all record parcels
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel
- Update a record parcel
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/action/copyParcelAddressInfo
- Create a record parcel address
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
- Delete a record parcel address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
- Get a record parcel address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
- Get all record parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
- Update a record parcel address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner
- Delete a record parcel owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{OwnerKey}
- Get a record parcel owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{OwnerKey}
- Get all record parcel owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner
- Update a record parcel owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{OwnerKey}
Permits/Records/RecordAuthorizedAgents
The 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 authorized agents
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent
- Delete an authorized agent
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent/{LnpAuthorizedAgntKey}
- Get all records of authorized agents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent
- Get an authorized agent
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent/{LnpAuthorizedAgntKey}
- Update an authorized agent
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent/{LnpAuthorizedAgntKey}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense
- Delete a record contractor license
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}
- Get all records of contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense
- Get an record contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}
- Update a record contractor license
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}
Permits/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 license 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact
- Delete a record contractor license fact
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact/{LnpLicenseFactKey}
- Get all records of contractor license fact
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact
- Get an record contractor license fact
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact/{LnpLicenseFactKey}
- Update a record contractor license fact
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact/{LnpLicenseFactKey}
Permits/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 license 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance
- Delete a record contractor license insurance
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}
- Get all records of contractor license insurance
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance
- Get an record contractor license insurance
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}
- Update a record contractor license insurance
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}
Permits/Records/RecordContractorLicenses/RecordContractorLicInsurances/Large Object (LOB) Attributes - Exemptlongdesc
- Delete an Exemptlongdesc
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}/enclosure/Exemptlongdesc
- Get an Exemptlongdesc
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}/enclosure/Exemptlongdesc
- Replace an Exemptlongdesc
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}/enclosure/Exemptlongdesc
Permits/Records/RecordGISAttr
- Create
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISAttr
- Delete
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISAttr/{publicSectorRecords_RecordGISAttr_Id}
- Get
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISAttr/{publicSectorRecords_RecordGISAttr_Id}
- Get all
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISAttr
- Update
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordGISAttr/{publicSectorRecords_RecordGISAttr_Id}
Permits/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference
- Delete a workflow reference
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference/{WorkflowReferenceUniqID}
- Get a workflow reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference/{WorkflowReferenceUniqID}
- Get all workflow references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference
- Update a workflow reference
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference/{WorkflowReferenceUniqID}
Permits/Status Histories
The status histories resource records the status change history for permits, inspections, and plan reviews.
- Create a status history event record
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories
- Delete a status history event record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{StatusHistoryKey}
- Get a status history event record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{StatusHistoryKey}
- Get all status history event records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories
- Update a status history event record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{StatusHistoryKey}
Permits/Summary of Fees by Activities
This resource is used to get fee summary of an activity which is displayed on the consolidated fees and payments page.
- Create a fee record summary by activity
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordFeeSummaryByActivities
- Delete a fee record summary by activity
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordFeeSummaryByActivities/{LnpRecordKey}
- Get a fee record summary by activity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordFeeSummaryByActivities/{LnpRecordKey}
- Get all fee record summaries by activity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordFeeSummaryByActivities
- Update a fee record summary by activity
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordFeeSummaryByActivities/{LnpRecordKey}
Permits/Time Expense Categories
Use the Time Expense Categories resource to view, create, edit, and delete time expense categories.
- Create a time expense category
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseCategories
- Delete a time expense category
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseCategories/{publicSectorTimeExpenseCategoriesUniqID}
- Get a time expense category
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseCategories/{publicSectorTimeExpenseCategoriesUniqID}
- Get all time expense categories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseCategories
- Update a time expense category
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseCategories/{publicSectorTimeExpenseCategoriesUniqID}
Permits/Time Expense Categories/Time Expense Subcategories
Time Expense Subcategories associated with this Time Expense Category.
- Create an associated time expense subcategory
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseCategories/{publicSectorTimeExpenseCategoriesUniqID}/child/TimeExpenseSubcategory
- Delete a time expense subcategory associated with this time expense category
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseCategories/{publicSectorTimeExpenseCategoriesUniqID}/child/TimeExpenseSubcategory/{TimeExpenseSubcategoryUniqID}
- Get a time expense subcategory associated with this time expense category
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseCategories/{publicSectorTimeExpenseCategoriesUniqID}/child/TimeExpenseSubcategory/{TimeExpenseSubcategoryUniqID}
- Get all time expense subcategories associated with this time expense category
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseCategories/{publicSectorTimeExpenseCategoriesUniqID}/child/TimeExpenseSubcategory
- Update a time expense subcategory associated with this time expense category
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseCategories/{publicSectorTimeExpenseCategoriesUniqID}/child/TimeExpenseSubcategory/{TimeExpenseSubcategoryUniqID}
Permits/Time Expense Subcategories
Use the time expense subcategories resource to view, create, edit, and delete time expense subcategories.
- Create a time expense subcategory
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseSubcategories
- Delete a time expense subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseSubcategories/{publicSectorTimeExpenseSubcategoriesUniqID}
- Get a time expense subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseSubcategories/{publicSectorTimeExpenseSubcategoriesUniqID}
- Get all time expense subcategories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseSubcategories
- Update a time expense subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseSubcategories/{publicSectorTimeExpenseSubcategoriesUniqID}
Planning and Zoning/Activity Comments
The activity comments resource is used to capture comments related to entitlement activities.
- Create an entitlement activity comment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityComments
- Delete an entitlement activity comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityComments/{CommentKey}
- Get all entitlement activity comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityComments
- Get an entitlement activity comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityComments/{CommentKey}
- Update an entitlement activity comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityComments/{CommentKey}
Planning and Zoning/Activity Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityComments/{CommentKey}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityComments/{CommentKey}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityComments/{CommentKey}/enclosure/CommentText
Planning and Zoning/Activity Logs
The activity logs resource is used to create, update, and delete the activity logs associated with a planning and zoning application.
- Create an activity log
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityLogs
- Get all activity logs
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityLogs
- Get an activity log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityLogs/{ActivityLogKey}
- Update an activity log
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorActivityLogs/{ActivityLogKey}
Planning and Zoning/Category Sequences
The category sequence resource is used to add print sequences for the categories set up in the system.
- Create a set of print sequences for categories
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionCategorySequences
- Delete a category print sequence
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionCategorySequences/{publicSectorConditionCategorySequencesUniqID}
- Get a category print sequence
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionCategorySequences/{publicSectorConditionCategorySequencesUniqID}
- Get all categories and their print sequences
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionCategorySequences
- Update a category print sequence
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionCategorySequences/{publicSectorConditionCategorySequencesUniqID}
Planning and Zoning/Condition Type Print Sequences
The condition type print sequence resource is used to create, update, and delete the condition types and their print sequences.
- Create a set of print sequences for the condition types
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionTypeSequences
- Delete a print sequence of the condition type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionTypeSequences/{publicSectorConditionTypeSequencesUniqID}
- Get a print sequence of the condition type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionTypeSequences/{publicSectorConditionTypeSequencesUniqID}
- Get all print sequences of the condition type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionTypeSequences
- Update a print sequence of the condition type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionTypeSequences/{publicSectorConditionTypeSequencesUniqID}
Planning and Zoning/Condition of Approval Comments
The condition of approval comment resource is used to create, update, and delete comments associated with the conditions of approval.
- Create a set of comments for the conditions of approval
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalComments
- Delete a comment for the conditions of approval
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalComments/{CommentKey}
- Get a comment for the conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalComments/{CommentKey}
- Get all comments for the conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalComments
- Update a comment for the conditions of approval
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalComments/{CommentKey}
Planning and Zoning/Condition of Approval Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalComments/{CommentKey}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalComments/{CommentKey}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalComments/{CommentKey}/enclosure/CommentText
Planning and Zoning/Condition of Approval Compliance Transactions
The condition of approval compliance transaction resource is used to associate compliances with a condition of approval transaction.
- Create a set of compliances associated with the conditions of approval
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionComplyTransactions
- Delete a compliance associated with the conditions of approval
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionComplyTransactions/{CoaTransComplyKey}
- Get a compliance associated with the conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionComplyTransactions/{CoaTransComplyKey}
- Get all compliances associated with the conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionComplyTransactions
- Update a compliance associated with the conditions of approval
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionComplyTransactions/{CoaTransComplyKey}
Planning and Zoning/Condition of Approval Compliances
The condition of approval compliance resource is used to create and update various compliances associated with a condition of approval.
- Create a set of condition of approval compliances
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionCompliances
- Delete a condition of approval compliance
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionCompliances/{publicSectorConditionCompliancesUniqID}
- Get a condition of approval compliance
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionCompliances/{publicSectorConditionCompliancesUniqID}
- Get all condition of approval compliances
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionCompliances
- Update a condition of approval compliance
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionCompliances/{publicSectorConditionCompliancesUniqID}
Planning and Zoning/Condition of Approval Subcategories
The condition of approval subcategory resource is used to create, update, and delete subcategories of the conditions of approval.
- Create a set of conditions of approval subcategories
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalSubcategories
- Delete a conditions of approval subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalSubcategories/{publicSectorConditionsOfApprovalSubcategoriesUniqID}
- Get a conditions of approval subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalSubcategories/{publicSectorConditionsOfApprovalSubcategoriesUniqID}
- Get all conditions of approval subcategories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalSubcategories
- Update a conditions of approval subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalSubcategories/{publicSectorConditionsOfApprovalSubcategoriesUniqID}
Planning and Zoning/Condition of Approval Template Items
The condition of approval template item resource is used to create, update, and delete the template items that are used in the templates associated with the conditions of approval.
- Create a set of conditions of approval template items
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplateItems
- Delete a template item from the conditions of approval
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplateItems/{publicSectorConditionOfApprovalTemplateItemsUniqID}
- Get a template item from the conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplateItems/{publicSectorConditionOfApprovalTemplateItemsUniqID}
- Get all conditions of approval template items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplateItems
- Update a template item in the conditions of approval
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplateItems/{publicSectorConditionOfApprovalTemplateItemsUniqID}
Planning and Zoning/Conditions of Approval Attachments
The conditions of approval attachment resource is used to view, create, and update the attachments for conditions of approval.
- Create a set of the versions of conditions of approval attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments
- Delete a conditions of approval attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}
- Get a conditions of approval attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}
- Get all conditions of approval attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments
- Update a conditions of approval attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}
Planning and Zoning/Conditions of Approval Attachments/Attachments
The attachments resource is used to view, create, and update attachments.
- Create a set of attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor
- Delete an attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}
- Get all attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor
- Get an attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}
- Update an attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}
Planning and Zoning/Conditions of Approval Attachments/Attachments/Attachment Revisions
The attachment revision resource is used to view attachment revisions.
- Create a set of conditions of approval attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete a version of the conditions of approval attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}/child/AttachmentsRevision
- Get an attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update a version of conditions of approval attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Planning and Zoning/Conditions of Approval Attachments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}/enclosure/FileContents
Planning and Zoning/Conditions of Approval Attachments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/child/COAAttachmentAccessor/{COAAttachmentAccessorUniqID}/enclosure/FileWebImage
Planning and Zoning/Conditions of Approval Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}/enclosure/Preview
Planning and Zoning/Conditions of Approval Categories
The conditions of approval category resource is used to create, update, and delete the categories of the conditions of approval.
- Create a set of conditions of approval categories
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalCategories
- Delete a conditions of approval category
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalCategories/{publicSectorConditionsOfApprovalCategoriesUniqID}
- Get a conditions of approval category
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalCategories/{publicSectorConditionsOfApprovalCategoriesUniqID}
- Get all conditions of approval categories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalCategories
- Update a conditions of approval category
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalCategories/{publicSectorConditionsOfApprovalCategoriesUniqID}
Planning and Zoning/Conditions of Approval Categories/Conditions of Approval Subcategories
The conditions of approval subcategory resource is used to create, update, and delete the subcategories of the conditions of approval.
- Create a set of conditions of approval subcategories
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalCategories/{publicSectorConditionsOfApprovalCategoriesUniqID}/child/COASubcategorySetup
- Delete a conditions of approval subcategory
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalCategories/{publicSectorConditionsOfApprovalCategoriesUniqID}/child/COASubcategorySetup/{COASubcategorySetupUniqID}
- Get a conditions of approval subcategory
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalCategories/{publicSectorConditionsOfApprovalCategoriesUniqID}/child/COASubcategorySetup/{COASubcategorySetupUniqID}
- Get all conditions of approval sub categories
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalCategories/{publicSectorConditionsOfApprovalCategoriesUniqID}/child/COASubcategorySetup
- Update a conditions of approval subcategory
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalCategories/{publicSectorConditionsOfApprovalCategoriesUniqID}/child/COASubcategorySetup/{COASubcategorySetupUniqID}
Planning and Zoning/Conditions of Approval Templates
The conditions of approval template resource is used to create, update, and delete the templates used in the conditions of approval.
- Create a set of conditions of approval templates
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates
- Delete a conditions of approval template
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates/{publicSectorConditionOfApprovalTemplatesUniqID}
- Get a conditions of approval template
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates/{publicSectorConditionOfApprovalTemplatesUniqID}
- Get all conditions of approval templates
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates
- Update a conditions of approval template
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates/{publicSectorConditionOfApprovalTemplatesUniqID}
Planning and Zoning/Conditions of Approval Templates/Conditions of Approval Template Items
The conditions of approval template item resource is used to create, update, and delete the template items used in the conditions of approval.
- Create a set of conditions of approval template items
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates/{publicSectorConditionOfApprovalTemplatesUniqID}/child/COATemplateItems
- Delete a conditions of approval template item
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates/{publicSectorConditionOfApprovalTemplatesUniqID}/child/COATemplateItems/{COATemplateItemsUniqID}
- Get a conditions of approval template item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates/{publicSectorConditionOfApprovalTemplatesUniqID}/child/COATemplateItems/{COATemplateItemsUniqID}
- Get all conditions of approval template items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates/{publicSectorConditionOfApprovalTemplatesUniqID}/child/COATemplateItems
- Update a conditions of approval template item
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates/{publicSectorConditionOfApprovalTemplatesUniqID}/child/COATemplateItems/{COATemplateItemsUniqID}
Planning and Zoning/Conditions of Approval Transactions
The conditions of approval transaction resource is used to create, update, and delete the conditions of approval associated with a planning and zoning application.
- Create a set of conditions of approvals
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions
- Delete a condition of approval
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}
- Get a condition of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}
- Get all conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions
- Update a condition of approval
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}
Planning and Zoning/Conditions of Approval Transactions/Conditions of Approval Compliance Periods
The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application.
- Create a set of compliance periods associated with the conditions of approval
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}/child/COAConditionComplyPeriods
- Delete a compliance period from the conditions of approval
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}/child/COAConditionComplyPeriods/{CoaTransComplyKey}
- Get a compliance period from the conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}/child/COAConditionComplyPeriods/{CoaTransComplyKey}
- Get all compliance periods associated with the conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}/child/COAConditionComplyPeriods
- Update a compliance period in the conditions of approval
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}/child/COAConditionComplyPeriods/{CoaTransComplyKey}
Planning and Zoning/Conditions of Approval Transactions/Large Object (LOB) Attributes - Condition
- Delete a Condition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}/enclosure/Condition
- Get a Condition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}/enclosure/Condition
- Replace a Condition
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}/enclosure/Condition
Planning and Zoning/Conditions of Approval Transactions/Large Object (LOB) Attributes - ConditionPlain
- Get a ConditionPlain
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}/enclosure/ConditionPlain
Planning and Zoning/Conditions of Approvals
The conditions od approval resource is used to create, update, and delete the conditions of approval.
- Create a set of conditions of approval
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals
- Delete a condition of approval
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}
- Get a condition of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}
- Get all conditions of approval
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals
- Update a condition of approval
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}
Planning and Zoning/Conditions of Approvals/Conditions of Approval Compliances
The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval.
- Create a set of conditions of approval compliances
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}/child/COAConditionCompliance
- Delete a condition of approval compliance
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}/child/COAConditionCompliance/{COAConditionComplianceUniqID}
- Get a condition of approval compliance
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}/child/COAConditionCompliance/{COAConditionComplianceUniqID}
- Get all conditions of approval compliances
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}/child/COAConditionCompliance
- Update a condition of approval compliance
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}/child/COAConditionCompliance/{COAConditionComplianceUniqID}
Planning and Zoning/Conditions of Approvals/Large Object (LOB) Attributes - Condition
- Delete a Condition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}/enclosure/Condition
- Get a Condition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}/enclosure/Condition
- Replace a Condition
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}/enclosure/Condition
Planning and Zoning/Conditions of Approvals/Large Object (LOB) Attributes - ConditionPlain
- Get a ConditionPlain
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}/enclosure/ConditionPlain
Planning and Zoning/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments
- Delete a hearing appeal attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}
- Get a hearing appeal attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}
- Get all hearing appeal attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments
- Update a hearing appeal attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}
Planning and Zoning/Hearing Appeal Attachments/Appeal Attachments
The appeal attachments resource is used to view, create, and update attachments.
- Create a set of appeal attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor
- Delete an appeal attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}
- Get all appeal attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor
- Get an appeal attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}
- Update an appeal attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}
Planning and Zoning/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete an appeal attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all appeal attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}/child/AttachmentsRevision
- Get an appeal attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update an appeal attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Planning and Zoning/Hearing Appeal Attachments/Appeal Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}/enclosure/FileContents
Planning and Zoning/Hearing Appeal Attachments/Appeal Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/child/HearingAppealAttachmentAccessor/{HearingAppealAttachmentAccessorUniqID}/enclosure/FileWebImage
Planning and Zoning/Hearing Appeal Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}/enclosure/Preview
Planning and Zoning/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals
- Delete a hearing appeal
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals/{HearingAppealKey}
- Get a hearing appeal
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals/{HearingAppealKey}
- Get all hearing appeals
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals
- Update a hearing appeal
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals/{HearingAppealKey}
Planning and Zoning/Hearing Appeals/Hearing Appeal Fees
The hearing appeal fees resource is used to view hearing appeal fees.
- Get a hearing appeal fee
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals/{HearingAppealKey}/child/HearingAppealFees/{HearingAppealFeeKey}
- Get all hearing appeal fees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals/{HearingAppealKey}/child/HearingAppealFees
Planning and Zoning/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingEvents
- Get a hearing event
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingEvents/{HearingEventKey}
- Get all hearing events
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingEvents
- Update a hearing event
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingEvents/{HearingEventKey}
Planning and Zoning/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies
- Delete a hearing hierarchy
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}
- Get a hearing hierarchy
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}
- Get all hearing hierarchies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies
- Update a hearing hierarchy
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}
Planning and Zoning/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/Bodies
- Delete a hearing hierarchy body
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/Bodies/{BodiesUniqID}
- Get a hearing hierarchy body
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/Bodies/{BodiesUniqID}
- Get all hearing hierarchy bodies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/Bodies
- Update a hearing hierarchy body
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/Bodies/{BodiesUniqID}
Planning and Zoning/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchyBodies
- Delete a hearing hierarchy body
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchyBodies/{publicSectorHearingHierarchyBodiesUniqID}
- Get a hearing hierarchy body
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchyBodies/{publicSectorHearingHierarchyBodiesUniqID}
- Get all hearing hierarchy bodies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchyBodies
- Update a hearing hierarchy body
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchyBodies/{publicSectorHearingHierarchyBodiesUniqID}
Planning and Zoning/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingSequences
- Get a hearing sequence
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingSequences/{publicSectorHearingSequencesUniqID}
- Get all hearing sequences
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearingSequences
Planning and Zoning/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearings
- Get a hearing
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearings/{publicSectorHearingsUniqID}
- Get all hearings
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHearings
Planning and Zoning/Parcel genealogy transaction addresses
The parcel genealogy transaction addresses resource is used to view, create, delete, or modify parcel genealogy transaction addresses and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction address
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionAddresses
- Delete a parcel genealogy transaction address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionAddresses/{ParcelTrxAddKey}
- Get a parcel genealogy transaction address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionAddresses/{ParcelTrxAddKey}
- Get all parcel genealogy transaction addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionAddresses
- Update a parcel genealogy transaction address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionAddresses/{ParcelTrxAddKey}
Planning and Zoning/Parcel genealogy transaction conditions
The parcel genealogy transaction conditions resource is used to view, create, delete, or modify parcel genealogy transaction conditions and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction condition
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionConditions
- Delete a parcel genealogy transaction condition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionConditions/{ParcelTrxCdtKey}
- Get a parcel genealogy transaction condition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionConditions/{ParcelTrxCdtKey}
- Get all parcel genealogy transaction conditions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionConditions
- Update a parcel genealogy transaction condition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionConditions/{ParcelTrxCdtKey}
Planning and Zoning/Parcel genealogy transaction details
The parcel genealogy transaction details resource is used to view, create, delete or modify parcel genealogy transaction details and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction detail
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails
- Delete a parcel genealogy transaction detail
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}
- Get a parcel genealogy transaction detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}
- Get all parcel genealogy transaction details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails
- Update a parcel genealogy transaction detail
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}
Planning and Zoning/Parcel genealogy transaction details/Parcel genealogy transaction addresses
The parcel genealogy transaction addresses resource is used to view, create, delete or modify parcel genealogy transaction addresses and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction addresse
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionAddress
- Delete a parcel genealogy transaction address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionAddress/{ParcelTrxAddKey}
- Get a parcel genealogy transaction address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionAddress/{ParcelTrxAddKey}
- Get all parcel genealogy transaction addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionAddress
- Update a parcel genealogy transaction address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionAddress/{ParcelTrxAddKey}
Planning and Zoning/Parcel genealogy transaction details/Parcel genealogy transaction conditions
The parcel genealogy transaction conditions resource is used to view, create, delete or modify parcel genealogy transaction conditions and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction condition
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionCondition
- Delete a parcel genealogy transaction condition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionCondition/{ParcelTrxCdtKey}
- Get a parcel genealogy transaction condition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionCondition/{ParcelTrxCdtKey}
- Get all parcel genealogy transaction conditions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionCondition
- Update a parcel genealogy transaction condition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionCondition/{ParcelTrxCdtKey}
Planning and Zoning/Parcel genealogy transaction details/Parcel genealogy transaction districts
The parcel genealogy transaction districts resource is used to view, create, delete or modify parcel genealogy transaction districts and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction district
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionDistrict
- Delete a parcel genealogy transaction district
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionDistrict/{ParcelTrxDstKey}
- Get a parcel genealogy transaction district
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionDistrict/{ParcelTrxDstKey}
- Get all parcel genealogy transaction districts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionDistrict
- Update a parcel genealogy transaction district
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionDistrict/{ParcelTrxDstKey}
Planning and Zoning/Parcel genealogy transaction details/Parcel genealogy transaction owners
The parcel genealogy transaction owners resource is used to view, create, delete or modify parcel genealogy transaction owners and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction owner
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionOwner
- Delete a parcel genealogy transaction owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionOwner/{ParcelTrxOwnKey}
- Get a parcel genealogy transaction owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionOwner/{ParcelTrxOwnKey}
- Get all parcel genealogy transaction owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionOwner
- Update a parcel genealogy transaction owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionOwner/{ParcelTrxOwnKey}
Planning and Zoning/Parcel genealogy transaction details/Parcel genealogy transaction parcels
The parcel genealogy transaction parcels resource is used to view, create, delete or modify parcel genealogy transaction parcels and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction parcel
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionParcel
- Delete a parcel genealogy transaction parcel
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionParcel/{ParcelTrxMstKey}
- Get a parcel genealogy transaction parcel
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionParcel/{ParcelTrxMstKey}
- Get all parcel genealogy transaction parcels
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionParcel
- Update a parcel genealogy transaction parcel
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionParcel/{ParcelTrxMstKey}
Planning and Zoning/Parcel genealogy transaction districts
The parcel genealogy transaction districts resource is used to view, create, delete or modify parcel genealogy transaction districts and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction district
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDistricts
- Delete a parcel genealogy transaction district
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDistricts/{ParcelTrxDstKey}
- Get a parcel genealogy transaction district
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDistricts/{ParcelTrxDstKey}
- Get all parcel genealogy transaction districts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDistricts
- Update a parcel genealogy transaction district
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDistricts/{ParcelTrxDstKey}
Planning and Zoning/Parcel genealogy transaction headers
The parcel genealogy transaction headers resource is used to view, create, delete, or modify parcel genealogy transaction headers and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction header
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders
- Delete a parcel genealogy transaction header
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders/{ParcelTrxKey}
- Get a parcel genealogy transaction header
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders/{ParcelTrxKey}
- Get all parcel genealogy transaction headers
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders
- Update a parcel genealogy transaction header
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders/{ParcelTrxKey}
Planning and Zoning/Parcel genealogy transaction headers/Parcel genealogy transaction details
The parcel genealogy transaction detail resource is used to view, create, delete, or modify parcel genealogy transaction details and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction detail
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders/{ParcelTrxKey}/child/ParcelTransactionDetail
- Delete a parcel genealogy transaction detail
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders/{ParcelTrxKey}/child/ParcelTransactionDetail/{ParcelTrxDtlKey}
- Get a parcel genealogy transaction detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders/{ParcelTrxKey}/child/ParcelTransactionDetail/{ParcelTrxDtlKey}
- Get all parcel genealogy transaction details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders/{ParcelTrxKey}/child/ParcelTransactionDetail
- Update a parcel genealogy transaction detail
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders/{ParcelTrxKey}/child/ParcelTransactionDetail/{ParcelTrxDtlKey}
Planning and Zoning/Parcel genealogy transaction owners
The parcel genealogy transaction owners resource is used to view, create, delete, or modify parcel genealogy transaction owners and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction owner
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionOwners
- Delete a parcel genealogy transaction owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionOwners/{ParcelTrxOwnKey}
- Get a parcel genealogy transaction owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionOwners/{ParcelTrxOwnKey}
- Get all parcel genealogy transaction owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionOwners
- Update a parcel genealogy transaction owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionOwners/{ParcelTrxOwnKey}
Planning and Zoning/Parcel genealogy transaction parcels
The parcel genealogy transaction parcels resource is used to view, create, delete or modify parcel genealogy transaction parcels and associate them with a parcel genealogy transaction.
- Create a parcel genealogy transaction parcel
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionNewParcels
- Delete a parcel genealogy transaction parcel
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionNewParcels/{ParcelTrxMstKey}
- Get a parcel genealogy transaction parcel
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionNewParcels/{ParcelTrxMstKey}
- Get all parcel genealogy transaction parcels
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionNewParcels
- Update a parcel genealogy transaction parcel
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionNewParcels/{ParcelTrxMstKey}
Planning and Zoning/Planner Assignment Communications
The planner assignment communication resource is used in the communication template for sending messages and email alerts to the assigned planners.
- Get a planning application
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlannerAssignmentCommunications/{LnpRecordKey}
- Get all planning applications
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlannerAssignmentCommunications
Planning and Zoning/Planning Application Attachment Communications
The planning application attachment communications resource is used to capture attributes related to planning application attachment communications.
- Get a planning application attachment communications item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanningAttachmentCommunications/{publicSectorPlanningAttachmentCommunicationsUniqID}
- Get all planning application attachment communications items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanningAttachmentCommunications
Planning and Zoning/Planning Application Plan Review Attachment Communications
The planning application plan review attachment communications resource is used to capture attributes related to planning application plan review attachment communications.
- Get a planning application plan review attachment communications item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanningPlanReviewAttachmentCommunications/{publicSectorPlanningPlanReviewAttachmentCommunicationsUniqID}
- Get all planning application plan review attachment communications items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanningPlanReviewAttachmentCommunications
Planning and Zoning/Planning and Zoning Application Contacts
The planning and zoning application contact resource is used to find attributes related to the contacts that are added to the planning and zoning application.
- Get a planning and zoning application contact detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPZApplicationContacts/{publicSectorPZApplicationContactsUniqID}
- Get all planning and zoning application contacts details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPZApplicationContacts
Planning and Zoning/Preapplication and Planning and Zoning Time Entry Fees
The preapplication and planning and zoning time entry fees resource is used to identify the mapping attributes for DMN to calculate the fees for preapplication or planning and zoning time recording entries.
- Get a set of mapping attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculatePlanningZoningFees/{publicSectorCalculatePlanningZoningFeesUniqID}
- Get all mapping attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculatePlanningZoningFees
Planning and Zoning/Reconcile Parcels
The Reconcile Parcels resource is used for reconciling and unreconciling parcels.
- Create a non-provisional parcel during reconciliation and modify the values of the corresponding provisional parcel
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReconcileParcels
- Delete a non-provisional parcel during unreconciliation and reset the values of the corresponding provisional parcel
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorReconcileParcels/{ParcelReconTransId}
- Get a reconciled or unreconciled parcel row
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReconcileParcels/{ParcelReconTransId}
- Get all reconciled and unreconciled parcel rows
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReconcileParcels
- Update a column in the recon table on unreconciliation of a provisional parcel and a matching non-provisional parcel
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReconcileParcels/{ParcelReconTransId}
Planning and Zoning/Record Reports
The record report resource is used to view, create, or modify a report for an application record.
- Create a record report
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordReports
- Get a record report
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordReports/{ReportKey}
- Get all record reports
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordReports
- Update a record report
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordReports/{ReportKey}
Planning and Zoning/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 set of planning and zoning records
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords
- Delete a record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}
- Get a record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}
- Get all planning and zoning records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords
- Update a record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}
Planning and Zoning/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 set of contacts
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/ContactList
- Delete a contact
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
- Get a contact
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
- Get all contacts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/ContactList
- Update a contact
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
Planning and Zoning/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 set of field groups
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/FieldGroups
- Delete a field group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/FieldGroups/{LnpRecordKey2}
- Get a field group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/FieldGroups/{LnpRecordKey2}
- Get all field groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/FieldGroups
- Update a field group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/FieldGroups/{LnpRecordKey2}
Planning and Zoning/Records/Global Customs
The global custom 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 set of global custom records
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/PzGlobalCustom
- Delete a global custom record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/PzGlobalCustom/{LnpRecordKey3}
- Get a global custom record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/PzGlobalCustom/{LnpRecordKey3}
- Get all global custom records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/PzGlobalCustom
- Update a global custom record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/PzGlobalCustom/{LnpRecordKey3}
Planning and Zoning/Records/Large Object (LOB) Attributes - Esignature
- Delete an Esignature
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/enclosure/Esignature
- Get an Esignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/enclosure/Esignature
- Replace an Esignature
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/enclosure/Esignature
Planning and Zoning/Records/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcelAddressOwner
- Delete a record parcel address owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}
- Get a record parcel address owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}
- Get all records of parcel address owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcelAddressOwner
- Update a record parcel address owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}
Planning and Zoning/Records/Parcel Address Owners/Large Object (LOB) Attributes - GeometryJson
- Delete a GeometryJson
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/GeometryJson
- Get a GeometryJson
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/GeometryJson
- Replace a GeometryJson
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/GeometryJson
Planning and Zoning/Records/Parcel Address Owners/Large Object (LOB) Attributes - SketchJson
- Delete a SketchJson
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/SketchJson
- Get a SketchJson
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/SketchJson
- Replace a SketchJson
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcelAddressOwner/{RecordParcelAddressOwnerUniqID}/enclosure/SketchJson
Planning and Zoning/Records/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/action/copyRecParcelInfo
- Create a set of record parcels
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel
- Delete a record parcel
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
- Get a record parcel
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
- Get all record parcels
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel
- Update a record parcel
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}
Planning and Zoning/Records/Parcels/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/action/copyParcelAddressInfo
- Create a set of record parcel addresses
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
- Delete a record parcel address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
- Get a record parcel address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
- Get all record parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
- Update a record parcel address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
Planning and Zoning/Records/Parcels/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 set of record parcel owners
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner
- Delete a record parcel owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{OwnerKey}
- Get a record parcel owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{OwnerKey}
- Get all record parcel owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner
- Update a record parcel owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner/{OwnerKey}
Planning and Zoning/Records/Record Authorized Agents
The 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 authorized agents
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordAuthorizedAgent
- Delete an authorized agent
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordAuthorizedAgent/{LnpAuthorizedAgntKey}
- Get all records of authorized agents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordAuthorizedAgent
- Get an authorized agent
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordAuthorizedAgent/{LnpAuthorizedAgntKey}
- Update an authorized agent
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordAuthorizedAgent/{LnpAuthorizedAgntKey}
Planning and Zoning/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 set of record comments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordComment
- Delete a record comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}
- Get a record comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}
- Get all record comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordComment
- Update a record comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}
Planning and Zoning/Records/Record Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordComment/{RecordCommentUniqID}/enclosure/CommentText
Planning and Zoning/Records/Record Contractor Licenses
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 licenses
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense
- Delete a record contractor license
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}
- Get all records of contractor licenses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense
- Get an record contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}
- Update a record contractor license
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}
Planning and Zoning/Records/Record Contractor Licenses/Record Contractor License Facts
The record contractor license fact resource is used to view, create, modify, or delete a record contractor license fact. A contractor license fact indicates license 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 facts
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact
- Delete a record contractor license fact
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact/{LnpLicenseFactKey}
- Get all records of contractor license facts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact
- Get an record contractor license fact
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact/{LnpLicenseFactKey}
- Update a record contractor license fact
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact/{LnpLicenseFactKey}
Planning and Zoning/Records/Record Contractor Licenses/Record Contractor License Insurances
The record contractor license Insurance resource is used to view, create, modify, or delete a record contractor license Insurance. A contractor license Insurance indicates license 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 insurances
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance
- Delete a record contractor license insurance
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}
- Get all records of contractor license insurances
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance
- Get an record contractor license insurance
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}
- Update a record contractor license insurance
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}
Planning and Zoning/Records/Record Contractor Licenses/Record Contractor License Insurances/Large Object (LOB) Attributes - Exemptlongdesc
- Delete an Exemptlongdesc
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}/enclosure/Exemptlongdesc
- Get an Exemptlongdesc
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}/enclosure/Exemptlongdesc
- Replace an Exemptlongdesc
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}/enclosure/Exemptlongdesc
Planning and Zoning/Records/RecordGISAttr
- Create
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordGISAttr
- Delete
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordGISAttr/{publicSectorPzRecords_RecordGISAttr_Id}
- Get
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordGISAttr/{publicSectorPzRecords_RecordGISAttr_Id}
- Get all
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordGISAttr
- Update
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordGISAttr/{publicSectorPzRecords_RecordGISAttr_Id}
Planning and Zoning/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 set of workflow references
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/WorkflowReference
- Delete a workflow reference
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/WorkflowReference/{WorkflowReferenceUniqID}
- Get a workflow reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/WorkflowReference/{WorkflowReferenceUniqID}
- Get all workflow references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/WorkflowReference
- Update a workflow reference
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/WorkflowReference/{WorkflowReferenceUniqID}
Planning and Zoning/Resubmit Activity Logs
The resubmit activity logs resource is used to create an activity log associated with a planning and zoning application when the activity is resubmitted.
- Create an activity log
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorResubmitActivityLogs
- Get all activity logs
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorResubmitActivityLogs
- Get an activity log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorResubmitActivityLogs/{ActivityLogKey}
Planning and Zoning/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings/{publicSectorScheduledHearingsUniqID}
- Get all scheduled hearings
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings
Planning and Zoning/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings/{publicSectorScheduledHearingsUniqID}/child/CancelAccess
- Get cancel access of a scheduled hearing
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings/{publicSectorScheduledHearingsUniqID}/child/CancelAccess/{LnpRecordKey}
Planning and Zoning/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings/{publicSectorScheduledHearingsUniqID}/child/ManageAccess
- Get manage access of a scheduled hearing
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings/{publicSectorScheduledHearingsUniqID}/child/ManageAccess/{LnpRecordKey}
Planning and Zoning/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchHearingApplications/{LnpRecordKey}
- Get all hearing applications
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchHearingApplications
Projects/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAPOSearches/{publicSectorProjectAPOSearchesUniqID}
- Get all project information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAPOSearches
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses
- Delete a project parcel address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses/{AddressKey}
- Get a project parcel address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses/{AddressKey}
- Get all project parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses
- Update a project parcel address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses/{AddressKey}
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments
- Delete a project attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}
- Get a project attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}
- Get all project attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments
- Update a project attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}
Projects/Project Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/enclosure/Preview
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor
- Delete a project attachment accessor
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}
- Get a project attachment accessor
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}
- Get all project attachment accessors
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor
- Update a project attachment accessor
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}
Projects/Project Attachments/Project Attachment Accessors/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}/enclosure/FileContents
Projects/Project Attachments/Project Attachment Accessors/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}/enclosure/FileWebImage
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete a project attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get a project attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all project attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}/child/AttachmentsRevision
- Update a project attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor/{ProjectAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts
- Delete a project contact
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts/{ContactKey}
- Get a project contact
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts/{ContactKey}
- Get all project contacts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts
- Update a project contact
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts/{ContactKey}
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects
- Get a project
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}
- Get all projects
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects
- Update a project
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectContact
- Get a project contact
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectContact/{ContactKey}
- Get all project contacts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectContact
- Update a project contact
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectContact/{ContactKey}
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel
- Delete a project parcel
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}
- Get a project parcel
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}
- Get all project parcels
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel
- Update a project parcel
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress
- Delete a project parcel address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress/{AddressKey}
- Get a project parcel address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress/{AddressKey}
- Get all project parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress
- Update a project parcel address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress/{AddressKey}
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner
- Delete a project parcel owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}
- Get a project parcel owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}
- Get all project parcel owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner
- Update a project parcel owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcelOwners
- Delete a project parcel owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcelOwners/{OwnerKey}
- Get a project parcel owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcelOwners/{OwnerKey}
- Get all project parcel owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcelOwners
- Update a project parcel owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcelOwners/{OwnerKey}
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels
- Delete a project parcel
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}
- Get a project parcel
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}
- Get all project parcels
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels
- Update a project parcel
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress
- Delete a project parcel address
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress/{AddressKey}
- Get a project parcel address
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress/{AddressKey}
- Get all project parcel addresses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress
- Update a project parcel address
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress/{AddressKey}
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwner
- Delete a project parcel owner
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}
- Get a project parcel owner
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}
- Get all project parcel owners
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwner
- Update a project parcel owner
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwner/{OwnerKey}
Projects/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitLists/{publicSectorProjectPermitListsUniqID}
- Get all permits assigned to a project
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitLists
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitTypeFees
- Delete a fee detail for a permit
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitTypeFees/{ProjectCode}
- Get a permit associated with a particular permit type and its fee details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitTypeFees/{ProjectCode}
- Get all permits associated with a particular permit type and their fee details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitTypeFees
- Update a fee detail for a permit
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitTypeFees/{ProjectCode}
Projects/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}
- Get all fees for the project record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay
- Delete a fee row for the project record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay/{FeeRecordKey}
- Delete more than one record on the fee records display
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay/action/bulkDelete
- Get a fee for the project record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay/{FeeRecordKey}
- Get all fees for the project record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay
- Update a fee row for the project record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay/{FeeRecordKey}
Projects/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordInspections/{publicSectorProjectRecordInspectionsUniqID}
- Get all the project record inspections
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordInspections
Projects/Project Record Inspections/Large Object (LOB) Attributes - ContractorSignature
- Get a ContractorSignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordInspections/{publicSectorProjectRecordInspectionsUniqID}/enclosure/ContractorSignature
Projects/Project Record Inspections/Large Object (LOB) Attributes - InspectorSignature
- Get an InspectorSignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordInspections/{publicSectorProjectRecordInspectionsUniqID}/enclosure/InspectorSignature
Projects/Project Record Inspections/Large Object (LOB) Attributes - OwnerSignature
- Get an OwnerSignature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordInspections/{publicSectorProjectRecordInspectionsUniqID}/enclosure/OwnerSignature
Projects/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecords
- Delete a record assignment from the project
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecords/{publicSectorProjectRecordsUniqID}
- Get a record assignment from the project
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecords/{publicSectorProjectRecordsUniqID}
- Get all record assignments from the project
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecords
- Update a record assignment in the project
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecords/{publicSectorProjectRecordsUniqID}
Projects/Project Types
The project types resource is used to create, view, and update a project type.
- Create a set project types
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes
- Delete a project type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes/{publicSectorProjectTypesUniqID}
- Get a project type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes/{publicSectorProjectTypesUniqID}
- Get all project types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes
- Update a project type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes/{publicSectorProjectTypesUniqID}
Property/All Districts
The all districts resource is used to view all districts created in the system. A district is an administrative region that, in some countries, is managed by the local government.
- Get a district
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAllDistricts/{DistrictId}
- Get all districts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAllDistricts
Property/Parcel Reconciliation Matches
The Parcel Reconciliation Matches resource is used to get the provisional parcel auto matches.
- Get a provisional parcel and matching non-provisional parcel row
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelReconMatches/{ParcelId}
- Get all provisional parcel and matching non-provisional parcel rows
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorParcelReconMatches
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments
- Delete an attachment for a registered public user account
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}
- Get all attachments for a registered public user account
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments
- Get an attachment for a registered public user account
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}
- Update an attachment for a registered public user account
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor
- Delete an account attachment accessor
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}
- Get all account attachment accessors
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor
- Get an account attachment accessor
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}
- Update an account attachment accessor
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete an account attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all account attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}/child/AttachmentsRevision
- Get an account attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update an account attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Public User/Account Attachments/Account Attachment Accessors/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}/enclosure/FileContents
Public User/Account Attachments/Account Attachment Accessors/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor/{PblAttachmentAccessorUniqID}/enclosure/FileWebImage
Public User/Account Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/enclosure/Preview
Public User/Address Style Formats
The address style formats resource is used to view the different styles in which an address can be formatted.
- Get all address style formats
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressStyleFormats
- Get an address style format
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressStyleFormats/{CountryCode}
Public User/Address Style Formats/Address Style Format Layouts
The address style format layouts resource is used to view the layout of an address format. The address format layout is determined using the components in the address and their position in the layout.
- Get all address format layouts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressStyleFormats/{CountryCode}/child/AddressStyleFormatLayout
- Get an address format layout
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAddressStyleFormats/{CountryCode}/child/AddressStyleFormatLayout/{AddressStyleFormatLayoutUniqID}
Public User/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicantProfiles
- Get an applicant profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicantProfiles/{CurrProfileId}
Public User/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssignedDelegates/{DelegateHeaderId}
- Get all delegates' contact information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAssignedDelegates
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles
- Get a business profile of a registered public user
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}
- Get all business profiles of a registered public user
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles
- Update a business profile of a registered public user
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointEmail
- Get all email contact points for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointEmail
- Get an email contact point for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointEmail/{ContactPtId}
- Update an email contact point for the user profile
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointEmail/{ContactPtId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileLocation
- Get a contact address for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileLocation/{LocationSiteId}
- Get all contact addresses for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileLocation
- Update a contact address for the user profile
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileLocation/{LocationSiteId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointPhone
- Get a phone contact point for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointPhone/{ContactPtId}
- Get all phone contact points for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointPhone
- Update a phone contact point for the user profile
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointPhone/{ContactPtId}
Public User/Contact Lists
Use the contact lists resource to view, create, modify, or delete a contact person on your list.
- Create a contact person
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContactLists
- Delete a contact person
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContactLists/{ContactId}
- Get a contact person
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContactLists/{ContactId}
- Get all contact persons
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContactLists
- Update a contact person
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContactLists/{ContactId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateDetails
- Delete a delegate's detail information
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateDetails/{DelegateDetailId}
- Get a delegate's detail information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateDetails/{DelegateDetailId}
- Get all delegates' detail information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateDetails
- Update a delegate's detail information
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateDetails/{DelegateDetailId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateHistories
- Delete a delegate's history information
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateHistories/{DelegateHistoryId}
- Get a delegate's history information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateHistories/{DelegateHistoryId}
- Get all delegates' history information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateHistories
- Update a delegate's history information
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegateHistories/{DelegateHistoryId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates
- Decline an invitation based on the given delegation ID
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/action/declineInvitation
- Delete a delegate's information
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}
- Get a delegate's information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}
- Get all delegate information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates
- Get the delegation privilege based on a given profile ID or Transaction ID
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/action/getProfileDelegationPrivilege
- Send an invitation based on the given delegation ID
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/action/sendInvitation
- Update a delegate's information
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail
- Delete a delegate's detail information
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail/{DelegateDetailId}
- Get a delegate's detail information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail/{DelegateDetailId}
- Get all delegate detail information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail
- Update a delegate's detail information
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail/{DelegateDetailId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory
- Delete a delegate's history information
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory/{DelegateHistoryId}
- Get a delegate's history information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory/{DelegateHistoryId}
- Get all delegate history information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory
- Update a delegate's history information
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory/{DelegateHistoryId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLicenses
- Delete a license
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLicenses/{LicenseReferenceId}
- Get a license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLicenses/{LicenseReferenceId}
- Get all licenses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLicenses
- Update a license
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLicenses/{LicenseReferenceId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles
- Get a personal profile of a registered user
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}
- Get all personal profiles of a registered user
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles
- Update a personal profile of a registered user
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileContactPointEmail
- Get all email contact points for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileContactPointEmail
- Get an email contact point for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileContactPointEmail/{ContactPtId}
- Update an email contact point for the user profile
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileContactPointEmail/{ContactPtId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileLocation
- Get a contact address for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileLocation/{LocationSiteId}
- Get all contact addresses for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileLocation
- Update a contact address for the user profile
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileLocation/{LocationSiteId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileContactPointPhone
- Get a phone contact point for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileContactPointPhone/{ContactPtId}
- Get all phone contact points for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileContactPointPhone
- Update a phone contact point for the user profile
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileContactPointPhone/{ContactPtId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileContactEmails
- Get all email contact points for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileContactEmails
- Get an email contact point for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileContactEmails/{ContactPtId}
- Update an email contact point for the user profile
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileContactEmails/{ContactPtId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileLocations
- Get a contact address for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileLocations/{LocationSiteId}
- Get all contact addresses for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileLocations
- Update a contact address for the user profile
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileLocations/{LocationSiteId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileContactPhones
- Get a phone contact point for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileContactPhones/{ContactPtId}
- Get all phone contact points for the user profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileContactPhones
- Update a phone contact point for the user profile
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProfileContactPhones/{ContactPtId}
Public User/Search Cases
The search case resource is used to view a case. It is used to search a case before claiming it.
- Get a case
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCases/{CaseKey}
- Get all cases
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCases
Public User/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchProfiles/{CurrProfileId}
- Get all profiles for a public user
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchProfiles
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles/action/cloneProfile
- Get a registered public user account profile
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles/{ProfileId}
- Get all account profiles for a registered public user
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles
- Retrieves the general information of a registered public user's account profiles.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles/action/getGeneralInfoByUserId
- Update a registered public user account profile
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles/{ProfileId}
Public User/User References
The user references resource is used to view, create, or modify information for registered users.
- Create a user's reference data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserRefs
- Get a user's reference data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserRefs/{PscUserId}
- Get all users' reference data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserRefs
- Update a user's reference data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserRefs/{PscUserId}
Public User/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserRoles
- Delete a user role
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserRoles/{PblUserRoleSetupId}
- Get a user role
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserRoles/{PblUserRoleSetupId}
- Get all user roles
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserRoles
- Update a user role
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserRoles/{PblUserRoleSetupId}
Public User/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserSetups/{UserSetupId}
- Get all user setups is not supported
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserSetups
- Update a user setup
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorUserSetups/{UserSetupId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts
- Delete an ad hoc alert
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts/{LogId}
- Get all ad hoc alerts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts
- Get an ad hoc alert
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts/{LogId}
- Update an ad hoc alert
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts/{LogId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocCommunications
- Get all ad hoc communications
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocCommunications
- Get an ad hoc communication
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocCommunications/{LogId}
Shared Services/Ad Hoc Communications/Large Object (LOB) Attributes - Log
- Delete a Log
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocCommunications/{LogId}/enclosure/Log
- Get a Log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocCommunications/{LogId}/enclosure/Log
- Replace a Log
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocCommunications/{LogId}/enclosure/Log
Shared Services/Ad Hoc Emails
The ad hoc emails resource is used to trigger ad hoc emails for targeted recipients using the email composer.
- Create an ad hoc email
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocEmails
- Get all ad hoc emails
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocEmails
- Get an ad hoc email
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocEmails/{LogId}
Shared Services/Ad Hoc Emails/Large Object (LOB) Attributes - Log
- Get a Log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocEmails/{LogId}/enclosure/Log
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocNotifications
- Get all ad hoc notifications
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocNotifications
- Get an ad hoc notification
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocNotifications/{LogId}
Shared Services/Ad Hoc Notifications/Large Object (LOB) Attributes - Log
- Get a Log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocNotifications/{LogId}/enclosure/Log
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts
- Delete an ad hoc text
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts/{LogId}
- Get all ad hoc texts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts
- Get an ad hoc text
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts/{LogId}
- Update an ad hoc text
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts/{LogId}
Shared Services/Ad Hoc Texts/Large Object (LOB) Attributes - Log
- Get a Log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts/{LogId}/enclosure/Log
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobSectionByAgencies
- Delete a job attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobSectionByAgencies/{publicSectorJobSectionByAgenciesUniqID}
- Get a job attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobSectionByAgencies/{publicSectorJobSectionByAgenciesUniqID}
- Get all job attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobSectionByAgencies
- Update a job attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobSectionByAgencies/{publicSectorJobSectionByAgenciesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncByAgencies
- Delete a job function
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncByAgencies/{JobFuncId}
- Get a job function
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncByAgencies/{JobFuncId}
- Get all job functions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncByAgencies
- Update a job function
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncByAgencies/{JobFuncId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges
- Delete a data security aggregate privilege
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges/{publicSectorAggrprivilegesUniqID}
- Get a data security aggregate privilege
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges/{publicSectorAggrprivilegesUniqID}
- Get all data security aggregate privileges
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges
- Update a data security aggregate privilege
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges/{publicSectorAggrprivilegesUniqID}
Shared Services/Aggregate Privileges/Large Object (LOB) Attributes - Attributelist
- Delete an Attributelist
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges/{publicSectorAggrprivilegesUniqID}/enclosure/Attributelist
- Get an Attributelist
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges/{publicSectorAggrprivilegesUniqID}/enclosure/Attributelist
- Replace an Attributelist
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAggrprivileges/{publicSectorAggrprivilegesUniqID}/enclosure/Attributelist
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes
- Delete an application ID type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}
- Get all application ID types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes
- Get an application ID type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}
- Update an application ID type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}
Shared Services/Application ID Types/Catalogs
The catalogs resource contains API catalog information.
- Create a catalog resource
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs
- Delete a catalog resource
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs/{ResourceName}
- Get a catalog resource
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs/{ResourceName}
- Get all catalog resources
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs
- Gets endpoint for a resource name.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs/action/getEndPointForResourceNames
- Update a catalog resource
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs/{ResourceName}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationInstallLinks
- Get all agency staff for notifications
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationInstallLinks
- Get an agency staff for notification
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationInstallLinks/{publicSectorApplicationInstallLinksUniqID}
- Update an agency staff for notification
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationInstallLinks/{publicSectorApplicationInstallLinksUniqID}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTasks
- Get an assigned task
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTasks/{taskId}
Shared Services/Available User Roles
The available user roles resource is used to get the available application security roles.
- Get all application security roles
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAvailableUserRoles
- Get an application security role
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAvailableUserRoles/{roleGUID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters
- Delete a report configuration parameter
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters/{publicSectorBIPReportParametersUniqID}
- Get a report configuration parameter
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters/{publicSectorBIPReportParametersUniqID}
- Get all report configuration parameters
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters
- Update a report configuration parameter
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters/{publicSectorBIPReportParametersUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports
- Get a report configuration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}
- Get all report configurations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports
- Update a report configuration
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}/child/ReportMapParameters
- Delete a report configuration parameter
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}/child/ReportMapParameters/{ReportMapParametersUniqID}
- Get a report configuration parameter
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}/child/ReportMapParameters/{ReportMapParametersUniqID}
- Get all report configuration parameters
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}/child/ReportMapParameters
- Update a report configuration parameter
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}/child/ReportMapParameters/{ReportMapParametersUniqID}
Shared Services/Business License Attachment Communications
The business license attachment communications resource is used to capture attributes related to business license attachment communications.
- Get a business license attachment communications item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlAttachmentCommunications/{publicSectorBlAttachmentCommunicationsUniqID}
- Get all business license attachment communications items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlAttachmentCommunications
Shared Services/Business License Inspection Attachment Communications
The business license inspection attachment communications resource is used to capture attributes related to business license inspection attachment communications.
- Get a business license inspection attachment communications item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlInspectionAttachmentCommunications/{publicSectorBlInspectionAttachmentCommunicationsUniqID}
- Get all business license permit inspection attachment communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlInspectionAttachmentCommunications
Shared Services/Business License Required Document Communications
The business license required document communications resource is used to view business license information related to required documents.
- Get a business license required document communication item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRequiredDocumentCommunications/{LnpRecordKey}
- Get all business license required document communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBlRequiredDocumentCommunications
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits
- Delete a business unit
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits/{publicSectorBusinessUnitsUniqID}
- Get a business unit
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits/{publicSectorBusinessUnitsUniqID}
- Get all related business units
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits
- Update a business unit
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits/{publicSectorBusinessUnitsUniqID}
Shared Services/Catalog Resources
The catalog resources resource contains API catalog information.
- Create a catalog resource
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources
- Delete a catalog resource
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources/{ResourceName}
- Get a catalog resource
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources/{ResourceName}
- Get all catalog resources
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources
- Get endpoints for a resource name.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources/action/getEndPointForResourceNames
- Update a catalog resource
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources/{ResourceName}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData
- Delete a checkpoint data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/{CheckpointId}
- Get a checkpoint data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/{CheckpointId}
- Get a checkpoint data.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/action/getCheckPointData
- Get all checkpoint data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData
- Set a checkpoint data.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/action/setCheckPointData
- Update a checkpoint data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/{CheckpointId}
Shared Services/Checkpoints/Large Object (LOB) Attributes - CheckpointData
- Delete a CheckpointData
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/{CheckpointId}/enclosure/CheckpointData
- Get a CheckpointData
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/{CheckpointId}/enclosure/CheckpointData
- Replace a CheckpointData
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/{CheckpointId}/enclosure/CheckpointData
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationAlerts/{publicSectorCommunicationAlertsUniqID}
- Get all communication alerts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationAlerts
Shared Services/Communication Attachments
The communication attachments resource is used to insert, get, and update attachments for the communication email and notifications channel types.
- Create all communication attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments
- Delete a communication attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}
- Get a communication attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}
- Get all communication attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments
- Update a communication attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}
Shared Services/Communication Attachments/Communication Attachment Accessor
The communication attachment accessors resource is used for displaying communication attachment file related information such as the file name and its URL.
- Create a communication attachment's file related information
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor
- Delete a communication attachment's file related information
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}
- Get a communication attachment's file related information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}
- Get all attachment file-related information for a communication
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor
- Update a communication attachment's file related information
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}
Shared Services/Communication Attachments/Communication Attachment Accessor/Attachment Rivisions
The attachment revision resource is used to view attachment revisions.
- Create a set of revision attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}/child/AttachmentsRevision
- Delete a revision attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}/child/AttachmentsRevision/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_AttachmentsRevision_Id}
- Get all attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}/child/AttachmentsRevision
- Get an attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}/child/AttachmentsRevision/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_AttachmentsRevision_Id}
- Update a revision attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}/child/AttachmentsRevision/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_AttachmentsRevision_Id}
Shared Services/Communication Attachments/Communication Attachment Accessor/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}/enclosure/FileContents
Shared Services/Communication Attachments/Communication Attachment Accessor/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/child/CommLogMsgAttAccessor/{publicSectorLogMessageAttachments_CommLogMsgAttAccessor_Id}/enclosure/FileWebImage
Shared Services/Communication Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments/{DocumentKey}/enclosure/Preview
Shared Services/Communication Error Logs
The communciation error logs resource is used to view communication error logs.
- Get a communication error log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationErrorLogs/{publicSectorCommunicationErrorLogsUniqID}
- Get all communication error logs
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationErrorLogs
Shared Services/Communication Error Logs/Large Object (LOB) Attributes - Body
- Get a Body
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationErrorLogs/{publicSectorCommunicationErrorLogsUniqID}/enclosure/Body
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationEvents
- Get a communication event
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationEvents/{EventId}
- Get all communication events
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationEvents
- Update a communication event
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationEvents/{EventId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRequests
- Get a communication request
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRequests/{LogId}
- Get all communication requests
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRequests
Shared Services/Communication Requests/Large Object (LOB) Attributes - Log
- Get a Log
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRequests/{LogId}/enclosure/Log
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResendMessages
- Get a communication resend request
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResendMessages/{LogMessageId}
- Get all communication resend requests
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResendMessages
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources
- Delete a communication resource
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}
- Get a communication resource
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}
- Get all communication resources
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources
- Update a communication resource
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}
Shared Services/Communication Resources/Communication Related Resources
The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.
- Create a related communication resource
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}/child/CommResourceRelations
- Delete a related communication resource
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}/child/CommResourceRelations/{ResourceRelationId}
- Get a related communication resource
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}/child/CommResourceRelations/{ResourceRelationId}
- Get all related communication resources
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}/child/CommResourceRelations
- Update a related communication resource
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}/child/CommResourceRelations/{ResourceRelationId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates
- Delete a communication template
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates/{TemplateId}
- Get a communication template
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates/{TemplateId}
- Get all communication templates
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates
- Update a communication template
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates/{TemplateId}
Shared Services/Communication Templates/Large Object (LOB) Attributes - Body
- Delete a Body
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates/{TemplateId}/enclosure/Body
- Get a Body
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates/{TemplateId}/enclosure/Body
- Replace a Body
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates/{TemplateId}/enclosure/Body
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTextSenders
- Delete a communication text sender list
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTextSenders/{phoneNumber}
- Get a communication text sender list
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTextSenders/{phoneNumber}
- Get all communication text sender lists
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTextSenders
- Update a communication text sender list
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTextSenders/{phoneNumber}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations
- Delete a dashboard configuration
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations/{publicSectorAnalyticsConfigurationsUniqID}
- Get a dashboard configuration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations/{publicSectorAnalyticsConfigurationsUniqID}
- Get all dashboard configurations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations
- Update a dashboard configuration
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations/{publicSectorAnalyticsConfigurationsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes
- Delete a district type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes/{DistrictType}
- Get a district type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes/{DistrictType}
- Get all district types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes
- Update a district type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes/{DistrictType}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistricts
- Delete a district
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistricts/{DistrictId}
- Get a district
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistricts/{DistrictId}
- Get all districts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistricts
- Update a district
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDistricts/{DistrictId}
Shared Services/Dynamic Workflow References
The dynamic workflow reference resource is used to view a workflow reference. Dynamic Workflows are used in Code Enforcement.
- Create a dynamic workflow reference
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDynamicWorkflowReferences
- Get a dynamic workflow reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDynamicWorkflowReferences/{CrossReferenceKey}
- Get all dynamic workflow references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDynamicWorkflowReferences
- Update a dynamic workflow reference
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDynamicWorkflowReferences/{CrossReferenceKey}
Shared Services/Dynamic Workflow Status Inconsistencies
The dynamic workflow status inconsistency resource is used to view a workflow reference. It is also used to indicate if the workflow item is not matching Public Sector Compliance and Regulation (PSCR) and Oracle Integration Cloud (OIC). Dynamic Workflows are used in Code Enforcement.
- Get a dynamic workflow inconsistency status
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDynamicWorkflowInconsistencyStatus/{CrossReferenceKey}
- Get all dynamic workflow inconsistency statuses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDynamicWorkflowInconsistencyStatus
- Update a dynamic workflow inconsistency status
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorDynamicWorkflowInconsistencyStatus/{CrossReferenceKey}
Shared Services/Employees
The employees resource is used to list the attributes of the agency staff.
- Create a set of agency staff
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees
- Get all agency staff
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees
- Get an agency staff
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}
- Update an agency staff
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions
- Delete a job function
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}
- Get a job function
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}
- Get all job functions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions
- Update a job function
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}/child/PersonJobFuncAssignments
- Delete a job attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}
- Get a job attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}
- Get all job attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}/child/PersonJobFuncAssignments
- Update a job attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities
- Delete an entity
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}
- Get all entities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities
- Get an entity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}
- Update an entity
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}/child/EntityAttributeService
- Delete an entity attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}/child/EntityAttributeService/{EntityAttributeServiceUniqID}
- Get all entity attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}/child/EntityAttributeService
- Get an entity attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}/child/EntityAttributeService/{EntityAttributeServiceUniqID}
- Update an entity attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}/child/EntityAttributeService/{EntityAttributeServiceUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes
- Delete an entity attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes/{publicSectorOpaEntityAttributesUniqID}
- Get all entity attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes
- Get an entity attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes/{publicSectorOpaEntityAttributesUniqID}
- Update an entity attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes/{publicSectorOpaEntityAttributesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels
- Delete an entity model
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}
- Get all entity models
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels
- Get an entity model
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}
- Update an entity model
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService
- Delete an entity
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService/{EntityServiceUniqID}
- Get all entities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService
- Get an entity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService/{EntityServiceUniqID}
- Update an entity
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService/{EntityServiceUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumChildValues
- Delete an enumeration child value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumChildValues/{publicSectorOpaEnumChildValuesUniqID}
- Get all enumeration child values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumChildValues
- Get an enumeration child value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumChildValues/{publicSectorOpaEnumChildValuesUniqID}
- Update an enumeration child value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumChildValues/{publicSectorOpaEnumChildValuesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues
- Delete an enumeration value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}
- Get all enumeration values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues
- Get an enumeration value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}
- Update an enumeration value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}/child/EnumChildValueAccessor
- Delete an enumeration child value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}/child/EnumChildValueAccessor/{EnumChildValueAccessorUniqID}
- Get all enumeration child values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}/child/EnumChildValueAccessor
- Get an enumeration child value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}/child/EnumChildValueAccessor/{EnumChildValueAccessorUniqID}
- Update an enumeration child value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumValues/{publicSectorOpaEnumValuesUniqID}/child/EnumChildValueAccessor/{EnumChildValueAccessorUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations
- Delete an enumeration
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}
- Get all enumerations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations
- Get an enumeration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}
- Update an enumeration
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService
- Delete an enumeration value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService/{EnumValueServiceUniqID}
- Get all enumeration values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService
- Get an enumeration value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService/{EnumValueServiceUniqID}
- Update an enumeration value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService/{EnumValueServiceUniqID}
Shared Services/Event Transaction Line Errors
The event transaction line errors resource is used to view accounting transaction errors.
- Get all accounting transaction errors
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEventTransactionLineErrors
- Get an accounting transaction error
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEventTransactionLineErrors/{publicSectorEventTransactionLineErrorsUniqID}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEventTransactionLines
- Get an accounting transaction
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorEventTransactionLines/{EventLineId}
Shared Services/Faulted Opa Process Searches
The faulted process searches resource is used to retrieve information about faulted transactions or alerted tasks along with their associated application data.
- Get all information about all faulted processes or alerted tasks along with their associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedOpaProcessSearches
- Get information about a faulted process or alerted task along with its associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedOpaProcessSearches/{FaultedTransId}
Shared Services/Faulted Opa Process Searches/Large Object (LOB) Attributes - ErrorDetails
- Get an ErrorDetails
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedOpaProcessSearches/{FaultedTransId}/enclosure/ErrorDetails
Shared Services/Faulted Process Searches
The faulted process searches resource is used to retrieve information about faulted transactions or alerted tasks along with their associated application data.
- Get all information about all faulted processes or alerted tasks along with their associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcessSearches
- Get information about a faulted process or alerted task along with its associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcessSearches/{FaultedTransId}
Shared Services/Faulted Process Searches/Large Object (LOB) Attributes - ErrorDetails
- Get an ErrorDetails
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcessSearches/{FaultedTransId}/enclosure/ErrorDetails
Shared Services/Faulted Processes
The faulted process resource is used to view, create, update and delete the faulted transactions.
- Create a faulted processes
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcesses
- Delete a faulted process by FaultedTransId
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcesses/{FaultedTransId}
- Get a faulted process by FaultedTransId
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcesses/{FaultedTransId}
- Get all faulted processes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcesses
- Update a faulted process by FaultedTransId
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcesses/{FaultedTransId}
Shared Services/Faulted Processes/Large Object (LOB) Attributes - ErrorDetails
- Delete an ErrorDetails
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcesses/{FaultedTransId}/enclosure/ErrorDetails
- Get an ErrorDetails
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcesses/{FaultedTransId}/enclosure/ErrorDetails
- Replace an ErrorDetails
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcesses/{FaultedTransId}/enclosure/ErrorDetails
Shared Services/Features
The feature resource is used to get the list of features available for each offering.
- Get a feature
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeatures/{FeatureCode}
- Get all features
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFeatures
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFusionLedgers/{LedgerId}
- Get all Fusion ledgers
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorFusionLedgers
Shared Services/GIS Attribute Mappings
The GIS Attribute Mappings resource is used to view, create, delete or modify all attribute mappings for a given map service that can be selected for capture at application intake.
- Create a GIS attribute mapping
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISAttributeMappings
- Delete a GIS attribute mapping
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISAttributeMappings/{publicSectorGISAttributeMappingsUniqID}
- Get a GIS attribute mapping
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISAttributeMappings/{publicSectorGISAttributeMappingsUniqID}
- Get all GIS attribute mappings
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISAttributeMappings
- Update a GIS attribute mapping
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISAttributeMappings/{publicSectorGISAttributeMappingsUniqID}
Shared Services/GIS Map Services
The GIS Map Services resource is used to view, create, delete or modify all map services used to retrieve attribute mappings that can be selected for capture at application intake.
- Create a GIS map service
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISServices
- Delete a GIS map service
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISServices/{publicSectorGISServicesUniqID}
- Get a GIS map service
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISServices/{publicSectorGISServicesUniqID}
- Get all GIS map services
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISServices
- Update a GIS map service
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISServices/{publicSectorGISServicesUniqID}
Shared Services/GIS Map Services/GIS Attribute Mappings
The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.
- Create a GIS attribute mapping
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISServices/{publicSectorGISServicesUniqID}/child/GISAttrMappings
- Delete a GIS attribute mapping
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISServices/{publicSectorGISServicesUniqID}/child/GISAttrMappings/{GISAttrMappingsUniqID}
- Get a GIS attribute mapping
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISServices/{publicSectorGISServicesUniqID}/child/GISAttrMappings/{GISAttrMappingsUniqID}
- Get all GIS attribute mappings
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISServices/{publicSectorGISServicesUniqID}/child/GISAttrMappings
- Update a GIS attribute mapping
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISServices/{publicSectorGISServicesUniqID}/child/GISAttrMappings/{GISAttrMappingsUniqID}
Shared Services/GIS OAuth Setup
Use the OAuth setups resource to view, update, create, and delete settings for accessing secure web maps using OAuth.
- Create an OAuth setup
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISOAuthSetups
- Delete an OAuth setup
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISOAuthSetups/{publicSectorGISOAuthSetupsUniqID}
- Get all OAuth setups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISOAuthSetups
- Get an OAuth setup
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISOAuthSetups/{publicSectorGISOAuthSetupsUniqID}
- Update an OAuth setup
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorGISOAuthSetups/{publicSectorGISOAuthSetupsUniqID}
Shared Services/Identity Domain Applications
The identity domain applications resource is used to view and update identity domain information used to integrate with an IDCS identity provider.
- Get a domain's IDCS application details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIdcsApplicationDetails/{IntegrationId}
- Get all IDCS application details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIdcsApplicationDetails
- Update a domain's IDCS application details
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorIdcsApplicationDetails/{IntegrationId}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOutOfSyncInstances
- Get an inconsistent instance
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOutOfSyncInstances/{publicSectorOutOfSyncInstancesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstances
- Delete a data security instance
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstances/{publicSectorInstancesUniqID}
- Get a data security instance
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstances/{publicSectorInstancesUniqID}
- Get all data security instances
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstances
- Update a data security instance
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorInstances/{publicSectorInstancesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncConfigurations
- Delete a job function configuration
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncConfigurations/{publicSectorJobFuncConfigurationsUniqID}
- Get a job function configuration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncConfigurations/{publicSectorJobFuncConfigurationsUniqID}
- Get all job function configurations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncConfigurations
- Update a job function configuration
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncConfigurations/{publicSectorJobFuncConfigurationsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncSections
- Delete a job attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncSections/{JobFuncSecId}
- Get a job attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncSections/{JobFuncSecId}
- Get all job attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncSections
- Update a job attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncSections/{JobFuncSecId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFunctions
- Delete a job function
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFunctions/{JobFuncId}
- Get a job function
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFunctions/{JobFuncId}
- Get all job functions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFunctions
- Update a job function
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobFunctions/{JobFuncId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFuncSections
- Delete a job group attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFuncSections/{publicSectorJobGroupFuncSectionsUniqID}
- Get a job group attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFuncSections/{publicSectorJobGroupFuncSectionsUniqID}
- Get all job group attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFuncSections
- Update a job group attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFuncSections/{publicSectorJobGroupFuncSectionsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupDefinitions
- Delete a job group definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupDefinitions/{publicSectorJobGroupDefinitionsUniqID}
- Get a job group definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupDefinitions/{publicSectorJobGroupDefinitionsUniqID}
- Get all job group definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupDefinitions
- Update a job group definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupDefinitions/{publicSectorJobGroupDefinitionsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions
- Delete a job group function
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}
- Get a job group function
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}
- Get all job group functions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions
- Update a job group function
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}/child/JobGrpFuncSec
- Delete a job group attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}
- Get a job group attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}
- Get all job group attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}/child/JobGrpFuncSec
- Update a job group attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupFunctions/{publicSectorJobGroupFunctionsUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups
- Delete a job group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}
- Get a job group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}
- Get all job groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups
- Update a job group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc
- Delete a job group function
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}
- Get a job group function
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}
- Get all job group functions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc
- Update a job group function
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}/child/JobGrpFuncSec
- Delete a job group attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}
- Get a job group attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}
- Get all job group attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}/child/JobGrpFuncSec
- Update a job group attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobGroups/{publicSectorJobGroupsUniqID}/child/JobGrpFunc/{JobGrpFuncUniqID}/child/JobGrpFuncSec/{JobGrpFuncSecUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobTitles
- Delete a job title
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobTitles/{publicSectorJobTitlesUniqID}
- Get a job title
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobTitles/{publicSectorJobTitlesUniqID}
- Get all related job titles
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobTitles
- Update a job title
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJobTitles/{publicSectorJobTitlesUniqID}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalErrors/{publicSectorJournalErrorsUniqID}
- Get all journal header errors
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalErrors
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalHeaders/{JeHeaderId}
- Get all journal headers
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalHeaders
- Update a journal header
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalHeaders/{JeHeaderId}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalLineDetails/{publicSectorJournalLineDetailsUniqID}
- Get all journal lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalLineDetails
- Update a journal line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalLineDetails/{publicSectorJournalLineDetailsUniqID}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalLineErrors/{publicSectorJournalLineErrorsUniqID}
- Get all journal line errors
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalLineErrors
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalLines/{publicSectorJournalLinesUniqID}
- Get all journal lines
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalLines
- Update a journal line
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorJournalLines/{publicSectorJournalLinesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLegalEmployers
- Delete a legal employer
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorLegalEmployers/{publicSectorLegalEmployersUniqID}
- Get a legal employer
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLegalEmployers/{publicSectorLegalEmployersUniqID}
- Get all legal employers
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLegalEmployers
- Update a legal employer
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLegalEmployers/{publicSectorLegalEmployersUniqID}
Shared Services/Linked Records
The linked record resource is used to capture all primary and subapplication records, and display the application information to the user. Details include the application type, application ID, and the applicant's name or user who created the application.
- Get a record with details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLinkedRecords/{LnpRecordKey}
- Get all records with details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorLinkedRecords
Shared Services/List of Values/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAvailableMeetingSlots
- Get all available meeting start dates and time
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyMeetingSlots
- Get an available meeting start date and time
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyMeetingSlots/{StartTime}
- Get an available meeting start date and time
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorAvailableMeetingSlots/{publicSectorAvailableMeetingSlotsUniqID}
Shared Services/Map Profile References
Use the map profile references resource 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences
- Delete a map profile reference
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences/{publicSectorMapProfileReferencesUniqID}
- Get a map profile reference
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences/{publicSectorMapProfileReferencesUniqID}
- Get all map profile references
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences
- Update a map profile reference
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences/{publicSectorMapProfileReferencesUniqID}
Shared Services/Map Profile References/Map Service Attributes
Use the map service attributes resource to view, create, update, and delete map service layer attributes.
- Create a map service attribute configuration
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences/{publicSectorMapProfileReferencesUniqID}/child/MapServiceAttributes
- Delete a map service attribute configuration
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences/{publicSectorMapProfileReferencesUniqID}/child/MapServiceAttributes/{MapServiceAttributesUniqID}
- Get a map service attribute configuration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences/{publicSectorMapProfileReferencesUniqID}/child/MapServiceAttributes/{MapServiceAttributesUniqID}
- Get all map service attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences/{publicSectorMapProfileReferencesUniqID}/child/MapServiceAttributes
- Update a map service attribute configuration
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences/{publicSectorMapProfileReferencesUniqID}/child/MapServiceAttributes/{MapServiceAttributesUniqID}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRuntimeMapProfiles/{publicSectorRuntimeMapProfilesUniqID}
- Get all map profiles
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRuntimeMapProfiles
Shared Services/Map Runtime Profiles/Large Object (LOB) Attributes - MapPreview
- Delete a MapPreview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRuntimeMapProfiles/{publicSectorRuntimeMapProfilesUniqID}/enclosure/MapPreview
- Get a MapPreview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRuntimeMapProfiles/{publicSectorRuntimeMapProfilesUniqID}/enclosure/MapPreview
- Replace a MapPreview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRuntimeMapProfiles/{publicSectorRuntimeMapProfilesUniqID}/enclosure/MapPreview
Shared Services/Map Runtime Profiles/Map Service Attributes
Use the map service attributes resource to view, create, update, and delete map service layer attributes.
- Get a map service attribute configuration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRuntimeMapProfiles/{publicSectorRuntimeMapProfilesUniqID}/child/MapServiceAttributes/{MapServiceAttributesUniqID}
- Get all map service attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRuntimeMapProfiles/{publicSectorRuntimeMapProfilesUniqID}/child/MapServiceAttributes
Shared Services/Map Service Attributes
Use the map service attributes resource to view, create, update, and delete map service layer attributes.
- Create a map service attribute configuration
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapServiceAttributes
- Delete a map service attribute configuration
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapServiceAttributes/{publicSectorMapServiceAttributesUniqID}
- Get a map service attribute configuration
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapServiceAttributes/{publicSectorMapServiceAttributesUniqID}
- Get all map service attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapServiceAttributes
- Update a map service attribute configuration
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMapServiceAttributes/{publicSectorMapServiceAttributesUniqID}
Shared Services/Meeting Comments
The meeting comment resource is used to save the comments related to meetings.
- Create a set of meeting comments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingComments
- Delete a meeting comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingComments/{publicSectorMeetingCommentsUniqID}
- Get a meeting comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingComments/{publicSectorMeetingCommentsUniqID}
- Get all meeting comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingComments
- Update a meeting comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingComments/{publicSectorMeetingCommentsUniqID}
Shared Services/Meeting Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingComments/{publicSectorMeetingCommentsUniqID}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingComments/{publicSectorMeetingCommentsUniqID}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingComments/{publicSectorMeetingCommentsUniqID}/enclosure/CommentText
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingParticipants
- Delete a meeting participant
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingParticipants/{publicSectorMeetingParticipantsUniqID}
- Get a meeting participant
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingParticipants/{publicSectorMeetingParticipantsUniqID}
- Get all meeting participants
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingParticipants
- Update a meeting participant
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingParticipants/{publicSectorMeetingParticipantsUniqID}
Shared Services/Meeting Rosters
The public sector meeting rosters resource is used to view scheduled meetings.
- Create a set of meetings
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters
- Delete a meeting
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}
- Get a meeting
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}
- Get all meetings
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters
- Update a meeting
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}
Shared Services/Meeting Rosters/Large Object (LOB) Attributes - MeetingAgendaPlain
- Delete a MeetingAgendaPlain
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/enclosure/MeetingAgendaPlain
- Get a MeetingAgendaPlain
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/enclosure/MeetingAgendaPlain
- Replace a MeetingAgendaPlain
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/enclosure/MeetingAgendaPlain
Shared Services/Meeting Rosters/Large Object (LOB) Attributes - MeetingAgendaText
- Delete a MeetingAgendaText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/enclosure/MeetingAgendaText
- Get a MeetingAgendaText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/enclosure/MeetingAgendaText
- Replace a MeetingAgendaText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/enclosure/MeetingAgendaText
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipant
- Delete a meeting participant
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipant/{MeetingParticipantUniqID}
- Get a meeting participant
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipant/{MeetingParticipantUniqID}
- Get all participants
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipant
- Update a meeting participant
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipant/{MeetingParticipantUniqID}
Shared Services/Meeting Templates
The public sector meeting template resource is used to configure meetings for planning and zoning and business license applications.
- Create a set of meeting templates
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups
- Delete a meeting template
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups/{publicSectorMeetingSetupsUniqID}
- Get a meeting template
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups/{publicSectorMeetingSetupsUniqID}
- Get all meeting templates
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups
- Update a meeting template attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups/{publicSectorMeetingSetupsUniqID}
Shared Services/Meeting Templates/Large Object (LOB) Attributes - MeetingAgendaPlainText
- Delete a MeetingAgendaPlainText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups/{publicSectorMeetingSetupsUniqID}/enclosure/MeetingAgendaPlainText
- Get a MeetingAgendaPlainText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups/{publicSectorMeetingSetupsUniqID}/enclosure/MeetingAgendaPlainText
- Replace a MeetingAgendaPlainText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups/{publicSectorMeetingSetupsUniqID}/enclosure/MeetingAgendaPlainText
Shared Services/Meeting Templates/Large Object (LOB) Attributes - MeetingAgendaText
- Delete a MeetingAgendaText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups/{publicSectorMeetingSetupsUniqID}/enclosure/MeetingAgendaText
- Get a MeetingAgendaText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups/{publicSectorMeetingSetupsUniqID}/enclosure/MeetingAgendaText
- Replace a MeetingAgendaText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups/{publicSectorMeetingSetupsUniqID}/enclosure/MeetingAgendaText
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemAttributes
- Delete a menu item attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemAttributes/{publicSectorRegistryItemAttributesUniqID}
- Get a menu item attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemAttributes/{publicSectorRegistryItemAttributesUniqID}
- Get all menu item attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemAttributes
- Update a menu item attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemAttributes/{publicSectorRegistryItemAttributesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemConfigurations
- Delete a menu item customer configuration data record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemConfigurations/{publicSectorRegistryItemConfigurationsUniqID}
- Get a menu item customer configuration data record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemConfigurations/{publicSectorRegistryItemConfigurationsUniqID}
- Get all menu item customer configuration data records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemConfigurations
- Update a menu item customer configuration data record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemConfigurations/{publicSectorRegistryItemConfigurationsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions
- Delete a menu item
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}
- Get a menu item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}
- Get all menu items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions
- Update a menu item
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Attributes
- Delete a menu item attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Attributes/{AttributesUniqID}
- Get a menu item attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Attributes/{AttributesUniqID}
- Get all menu item attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Attributes
- Update a menu item attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Attributes/{AttributesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Configurations
- Delete a menu item customer configuration data record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Configurations/{ConfigurationsUniqID}
- Get a menu item customer configuration data record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Configurations/{ConfigurationsUniqID}
- Get all menu item customer configuration data records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Configurations
- Update a menu item customer configuration data record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Configurations/{ConfigurationsUniqID}
Shared Services/Menus
The menus resource is used to view, create, modify, or delete a navigation menu.
- Create a menu
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions
- Delete a menu
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}
- Get a menu
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}
- Get all menus
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions
- Update a menu
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityLinks
- Delete a metadata entity link
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityLinks/{publicSectorOpaMetaDataEntityLinksUniqID}
- Get a metadata entity link
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityLinks/{publicSectorOpaMetaDataEntityLinksUniqID}
- Get all metadata entity links
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityLinks
- Update a metadata entity link
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityLinks/{publicSectorOpaMetaDataEntityLinksUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships
- Delete a metadata entity relationship
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}
- Get a metadata entity relationship
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}
- Get all metadata entity relationships
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships
- Update a metadata entity relationship
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}/child/MetaDataEntityLinkAccessor
- Delete a metadata entity link
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}/child/MetaDataEntityLinkAccessor/{MetaDataEntityLinkAccessorUniqID}
- Get a metadata entity link
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}/child/MetaDataEntityLinkAccessor/{MetaDataEntityLinkAccessorUniqID}
- Get all metadata entity links
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}/child/MetaDataEntityLinkAccessor
- Update a metadata entity link
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}/child/MetaDataEntityLinkAccessor/{MetaDataEntityLinkAccessorUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEnumRelationships
- Delete a metadata enumeration relationship
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEnumRelationships/{publicSectorOpaMetaDataEnumRelationshipsUniqID}
- Get a metadata enumeration relationship
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEnumRelationships/{publicSectorOpaMetaDataEnumRelationshipsUniqID}
- Get all metadata enumeration relationships
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEnumRelationships
- Update a metadata enumeration relationship
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEnumRelationships/{publicSectorOpaMetaDataEnumRelationshipsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
- Delete a metadata model
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}
- Get a metadata model
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}
- Get all metadata models
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
- Get the metadata model to be used for policy modeling.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/action/getOPAMetaData
- Get the seed data to be loaded at the start of an interview.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/action/getOPALoadData
- Save the outcome data at the end of an interview.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/action/getOPASaveData
- Update a metadata model
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataEntityRelationAccessor
- Delete a metadata entity relationship
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataEntityRelationAccessor/{MetaDataEntityRelationAccessorUniqID}
- Get a metadata entity relationship
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataEntityRelationAccessor/{MetaDataEntityRelationAccessorUniqID}
- Get all metadata entity relationships
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataEntityRelationAccessor
- Update a metadata entity relationship
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataEntityRelationAccessor/{MetaDataEntityRelationAccessorUniqID}
Shared Services/Metadata Models/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 existing in the configuration schema.
- Create a set of metadata enumeration relationships
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataModelEnumRelation
- Delete a metadata enumeration relationship
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataModelEnumRelation/{MetaDataModelEnumRelationUniqID}
- Get a metadata enumeration relationship
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataModelEnumRelation/{MetaDataModelEnumRelationUniqID}
- Get all metadata enumeration relationships
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataModelEnumRelation
- Update a metadata enumeration relationship
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataModelEnumRelation/{MetaDataModelEnumRelationUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileCommunications
- Delete the content details
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileCommunications/{ContentId}
- Get all content
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileCommunications
- Get the content details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileCommunications/{ContentId}
- Update a particular piece of content
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileCommunications/{ContentId}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineControlFields/{publicSectorMobileOfflineControlFieldsUniqID}
- Get all mobile offline control fields
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineControlFields
- Update a mobile offline control field
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineControlFields/{publicSectorMobileOfflineControlFieldsUniqID}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineResources
- Get an offline-enabled resource
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineResources/{publicSectorMobileOfflineResourcesUniqID}
Shared Services/Mobile Offline Resources/Large Object (LOB) Attributes - ExtensionField
- Get an ExtensionField
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineResources/{publicSectorMobileOfflineResourcesUniqID}/enclosure/ExtensionField
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows
- Delete a mobile offline unit of work
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}
- Get a mobile offline unit of work
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}
- Get all mobile offline units of work
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows
- Update a mobile offline unit of work
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord
- Delete a mobile offline unit of work record
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}
- Get a mobile offline unit of work record
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}
- Get all mobile offline unit of work records
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord
- Update a mobile offline unit of work record
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}
Shared Services/Mobile Offline Work Units/Mobile Offline Unit of Work Records/Large Object (LOB) Attributes - CurrentErrorResponse
- Delete a CurrentErrorResponse
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}/enclosure/CurrentErrorResponse
- Get a CurrentErrorResponse
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}/enclosure/CurrentErrorResponse
- Replace a CurrentErrorResponse
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}/enclosure/CurrentErrorResponse
Shared Services/Mobile Offline Work Units/Mobile Offline Unit of Work Records/Large Object (LOB) Attributes - UowContent
- Delete an UowContent
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}/enclosure/UowContent
- Get an UowContent
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}/enclosure/UowContent
- Replace an UowContent
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/OfflineUowRecord/{OfflineUowRecordUniqID}/enclosure/UowContent
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileLoginStatus/{publicSectorMobileLoginStatusUniqID}
- Get all access to the mobile app on success
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorMobileLoginStatus
Shared Services/Notifications
The notifications resource is used to view communication details triggered using the notification channel.
- Get a notification
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNotifications/{publicSectorNotificationsUniqID}
- Get all notifications
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNotifications
- Update a notification
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNotifications/{publicSectorNotificationsUniqID}
Shared Services/Notifications/Large Object (LOB) Attributes - Body
- Get a Body
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNotifications/{publicSectorNotificationsUniqID}/enclosure/Body
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorObjectattrs
- Delete a data security object and its attributes
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorObjectattrs/{publicSectorObjectattrsUniqID}
- Get a data security object and its attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorObjectattrs/{publicSectorObjectattrsUniqID}
- Get all data security objects and its attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorObjectattrs
- Update a data security object and its attributes
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorObjectattrs/{publicSectorObjectattrsUniqID}
Shared Services/Objects
The objects resource is used to capture all data security objects.
- Create a data security object
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorObjects
- Delete a data security object
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorObjects/{publicSectorObjectsUniqID}
- Get a data security object
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorObjects/{publicSectorObjectsUniqID}
- Get all data security objects
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorObjects
- Unregister a data security object
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorObjects/action/unregisterobjects
- Update a data security object
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorObjects/{publicSectorObjectsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks
- Delete an offline task
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}
- Get all offline tasks
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks
- Get an offline task
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}
- Update an offline task
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}
Shared Services/PCS Offline Tasks/Large Object (LOB) Attributes - CallbackMethodName
- Delete a CallbackMethodName
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/CallbackMethodName
- Get a CallbackMethodName
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/CallbackMethodName
- Replace a CallbackMethodName
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/CallbackMethodName
Shared Services/PCS Offline Tasks/Large Object (LOB) Attributes - RequestHeaders
- Delete a RequestHeaders
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RequestHeaders
- Get a RequestHeaders
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RequestHeaders
- Replace a RequestHeaders
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RequestHeaders
Shared Services/PCS Offline Tasks/Large Object (LOB) Attributes - RequestPayload
- Delete a RequestPayload
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RequestPayload
- Get a RequestPayload
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RequestPayload
- Replace a RequestPayload
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RequestPayload
Shared Services/PCS Offline Tasks/Large Object (LOB) Attributes - RequestUrl
- Delete a RequestUrl
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RequestUrl
- Get a RequestUrl
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RequestUrl
- Replace a RequestUrl
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RequestUrl
Shared Services/PCS Offline Tasks/Large Object (LOB) Attributes - RestResponse
- Delete a RestResponse
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RestResponse
- Get a RestResponse
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RestResponse
- Replace a RestResponse
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks/{TaskId}/enclosure/RestResponse
Shared Services/Permit Plan Review Time Entry Fees
The permit plan review time entry fees resource is used to identify the mapping attributes for DMN to calculate the fees for plan review time recording entries.
- Get a set of mapping attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculatePlanReviewFees/{publicSectorCalculatePlanReviewFeesUniqID}
- Get all mapping attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorCalculatePlanReviewFees
Shared Services/Permit Required Document Communications
The permit required document communications resource is used to view permit information related to required documents.
- Get a permit required document communication item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitRequiredDocumentCommunications/{LnpRecordKey}
- Get all permit required document communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPermitRequiredDocumentCommunications
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonDetails/{publicSectorPersonDetailsUniqID}
- Get all persons
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonDetails
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonDetails/{publicSectorPersonDetailsUniqID}/child/PersonJobFuncAssignmentP/{PersonJobFuncAssignmentPUniqID}
- Get all job functions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonDetails/{publicSectorPersonDetailsUniqID}/child/PersonJobFuncAssignmentP
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctionSections
- Delete a job attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctionSections/{publicSectorPersonJobFunctionSectionsUniqID}
- Get a job attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctionSections/{publicSectorPersonJobFunctionSectionsUniqID}
- Get all job attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctionSections
- Update a job attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctionSections/{publicSectorPersonJobFunctionSectionsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions
- Delete a job function
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}
- Get a job function
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}
- Get all employees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions
- Update a job function
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}/child/PersonJobFuncAssignments
- Delete a job attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}
- Get a job attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}
- Get all job attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}/child/PersonJobFuncAssignments
- Update a job attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonJobFunctions/{publicSectorPersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonNotifications
- Get a notification
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonNotifications/{PersonId}
- Get all notifications
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonNotifications
- Update a notification
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonNotifications/{PersonId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles
- Delete a role assigned to the person
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles/{publicSectorPersonRolesUniqID}
- Get a role assigned to the person
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles/{publicSectorPersonRolesUniqID}
- Get all roles assigned to the person
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles
- Process person and associated roles.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles/action/perUserRoleAction
Shared Services/Persons
The persons resource is used to list all the persons in the agency.
- Get a person
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersons/{publicSectorPersonsUniqID}
- Get all persons
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersons
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersons/{publicSectorPersonsUniqID}/child/PersonJobFuncAssignmentP/{PersonJobFuncAssignmentPUniqID}
- Get all job functions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPersons/{publicSectorPersonsUniqID}/child/PersonJobFuncAssignmentP
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewAllComments/{CommentId}
- Get all plan review comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewAllComments
Shared Services/Plan Review All Comments/Large Object (LOB) Attributes - CommentPlain
- Get a CommentPlain
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewAllComments/{CommentId}/enclosure/CommentPlain
Shared Services/Plan Review All Comments/Large Object (LOB) Attributes - CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewAllComments/{CommentId}/enclosure/CommentText
Shared Services/Plan Review All Reviews
The plan review all reviews resource is used to view all plan reviews by department and reviewer.
- Get a plan review by department and reviewer
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewAllReviews/{PlanReviewUserKey}
- Get all plan reviews by departments and reviewers
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewAllReviews
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments
- Delete a permit plan review comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments/{publicSectorPlanReviewCommentsUniqID}
- Get a permit plan review comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments/{publicSectorPlanReviewCommentsUniqID}
- Get all permit plan review comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments
- Update a permit plan review comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments/{publicSectorPlanReviewCommentsUniqID}
Shared Services/Plan Review Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments/{publicSectorPlanReviewCommentsUniqID}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments/{publicSectorPlanReviewCommentsUniqID}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments/{publicSectorPlanReviewCommentsUniqID}/enclosure/CommentText
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewCycles/{PlanReviewKey}
- Get all cycle information for a permit plan review
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewCycles
Shared Services/Plan Review Documents
The plan review documents resource is used to view plan review documents.
- Get a plan review document
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDocuments/{DocumentFileKey}
- Get all plan review documents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDocuments
Shared Services/Plan Review Files
Use the plan review files resource to view, update, create, and delete plan review files.
- Create a plan review file
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles
- Delete a plan review file
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}
- Get a plan review file
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}
- Get all plan review files
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles
- Update a plan review file
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}
Shared Services/Plan Review Files/Plan Review File Users
Use the plan review file users resource to view, update, create, and delete plan review file reviewers.
- Create a plan review file reviewer
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser
- Delete a plan review file reviewer
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser/{DocumentUserKey}
- Get a plan review file reviewer
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser/{DocumentUserKey}
- Get all plan review file reviewers
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser
- Update a plan review file reviewer
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser/{DocumentUserKey}
Shared Services/Plan Review Open Reviews
The plan review open reviews resource is used to view all plan review cycles that are currently in progress.
- Get all open plan review cycles
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewOpenReviews
- Get an open plan review cycle
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewOpenReviews/{PlanReviewKey}
Shared Services/Plan Review Pending Reviews
The plan review pending reviews resource is used to view all plan review cycles that are currently in a pending state regarding plan review. These are plan review cycles that are in a rejected state or in an approved state but were sent back for further review.
- Get a pending plan review cycle
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewPendingReviews/{LnpRecordKey}
- Get all pending plan review cycles
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewPendingReviews
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewStatuses/{publicSectorPlanReviewStatusesUniqID}
- Get all plan review statuses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewStatuses
- Update a plan review status
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewStatuses/{publicSectorPlanReviewStatusesUniqID}
Shared Services/Plan Review Unassigned Reviewers
The plan review unassigned reviewers resource is used to view plan review cycles with unassigned reviewers for required departments.
- Get a plan review unassigned reviewer
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewUnassignedReviewers/{LnpRecordKey}
- Get all plan review unassigned reviewers
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewUnassignedReviewers
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewWorkFlowTasks/{publicSectorPlanReviewWorkFlowTasksUniqID}
- Get all plan review workflow task
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewWorkFlowTasks
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments
- Delete a plan reviewer's comments for a permit plan review
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments/{publicSectorPlanReviewerCommentsUniqID}
- Get a plan reviewer's comments for a permit plan review
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments/{publicSectorPlanReviewerCommentsUniqID}
- Get all plan reviewer's comments for a permit plan review
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments
- Update a plan reviewer's comments for a permit plan review
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments/{publicSectorPlanReviewerCommentsUniqID}
Shared Services/Plan Reviewer Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments/{publicSectorPlanReviewerCommentsUniqID}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments/{publicSectorPlanReviewerCommentsUniqID}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments/{publicSectorPlanReviewerCommentsUniqID}/enclosure/CommentText
Shared Services/Plan Reviewer Departments
The plan reviewer departments resource is used to view plan reviewer departments that are assigned to an agency user. These values are user-defined.
- Create a plan reviewer department
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments
- Delete a plan reviewer department
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments/{publicSectorPlanReviewerDepartmentsUniqID}
- Get a plan reviewer department
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments/{publicSectorPlanReviewerDepartmentsUniqID}
- Get all plan reviewer departments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments
- Update a plan reviewer department
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments/{publicSectorPlanReviewerDepartmentsUniqID}
Shared Services/Plan Reviewer Workload By Due Dates
The plan reviewer workload by due dates resource is used to provide reviewer count information.
- Get all plan reviewers count by due date information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerWorkloadByDates
- Get plan reviewer count by due date information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerWorkloadByDates/{publicSectorPlanReviewerWorkloadByDatesUniqID}
Shared Services/Plan Reviewer Workload By Reviewers
The plan reviewer workload by reviewers resource is used to provide reviewer count information.
- Get all plan reviewers count information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerWorkloadByReviewers
- Get plan reviewer count information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerWorkloadByReviewers/{ReviewerId}
Shared Services/Plan Reviewers
The plan reviewers resource is used to view, create, delete, or modify plan reviewers for a plan review.
- Copy plan reviewers.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers/action/copy
- Create a plan reviewer for a permit plan review
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers
- Delete a plan reviewer for a permit plan review
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers/{PlanReviewUserKey}
- Get a plan reviewer for a permit plan review
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers/{PlanReviewUserKey}
- Get all plan reviewers for a permit plan review
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers
- Update a plan reviewer for a permit plan review
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers/{PlanReviewUserKey}
Shared Services/Plan Reviews
The plan reviews resource is used to view, update, create, and delete a plan review cycle.
- Create a plan review cycle
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews
- Get a plan review cycle
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}
- Get all plan review cycles
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews
- Update a plan review cycle
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}
Shared Services/Plan Reviews/Markup Sessions
The markup sessions resource is used to view, update, create, and delete a markup session.
- Create a markup session
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions
- Delete a markup session
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions/{BluebeamSessionsUniqID}
- Get a markup session
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions/{BluebeamSessionsUniqID}
- Get all markup sessions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions
- Update a markup session
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions/{BluebeamSessionsUniqID}
Shared Services/Planning Required Document Communications
The planning required document communications resource is used to view planning information related to required documents.
- Get a planning required document communication item
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRequiredDocumentCommunications/{LnpRecordKey}
- Get all planning required document communication items
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPzRequiredDocumentCommunications
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPolicies
- Delete a data security policy
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPolicies/{publicSectorPoliciesUniqID}
- Get a data security policy
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPolicies/{publicSectorPoliciesUniqID}
- Get all data security policies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPolicies
- Update a data security policy
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPolicies/{publicSectorPoliciesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs
- Delete a Pre-application meeting setup attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs/{publicSectorPreappMeetingConfigsUniqID}
- Get a Pre-application meeting setup attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs/{publicSectorPreappMeetingConfigsUniqID}
- Get all Pre-application meeting setup attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs
- Update a Pre-application meeting setup attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs/{publicSectorPreappMeetingConfigsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPrivileges
- Delete a data security privilege
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPrivileges/{publicSectorPrivilegesUniqID}
- Get a data security privilege
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPrivileges/{publicSectorPrivilegesUniqID}
- Get all data security privileges
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPrivileges
- Update a data security privilege
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPrivileges/{publicSectorPrivilegesUniqID}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessAudits
- Get an audit for a process
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessAudits/{taskId}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessAudits/{taskId}/child/ProcessAuditHistory
- Get the audit history for a process
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessAudits/{taskId}/child/ProcessAuditHistory/{ProcessAuditHistoryUniqID}
Shared Services/Process References
The process references resource is used to view, create, update and delete cross reference keys for permitting and licensing to support both Generation 2 and 3 for Oracle Integration Cloud (OIC). This resource is used internally by Oracle development teams for workflow processing and Oracle Process Automation (OPA).
- Create process reference details for permitting and licensing
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessReferences
- Delete a process reference detail stored by permitting and licensing
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessReferences/{PscXrefKey}
- Get a process reference detail stored by permitting and licensing
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessReferences/{PscXrefKey}
- Get all the process reference details stored by permitting and licensing
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessReferences
- Update a process reference detail stored by permitting and licensing
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessReferences/{PscXrefKey}
Shared Services/Process Task Action Details
The process task action details resource is used to view, create, update and delete request/accept information action intiation reasons related to workflow for permitting and licensing. It adds it for permitting and licensing and displays it when task status information is requested. It is similar to publicSectorTaskActionDetails and enables coexistence with generation 2 and 3 of Oracle Integration Clouf (OIC) for workflow and Oracle Process Automation (OPA).
- Create request info/accept info reason details stored in permitting and licensing.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessTaskActionDetails
- Delete request info/accept info reason details stored in permitting and licensing.
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessTaskActionDetails/{WorklistTaskId}
- Get all request info/accept info reason details stored in permitting and licensing.
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessTaskActionDetails
- Get request info/accept info reason details stored in permitting and licensing.
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessTaskActionDetails/{WorklistTaskId}
- Update request info/accept info reason details stored in permitting and licensing.
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessTaskActionDetails/{WorklistTaskId}
Shared Services/Process Worker Runs
This process worker run resource is used to keep track of the last time when the ESS job was run and get, view, create, update and delete any faulted processes.
- Create worker job information by LoginUserId
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorkerRuns
- Delete information of worker job by LoginUserId
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorkerRuns/{LoginUserId}
- Get all worker job information by LoginUserId
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorkerRuns
- Get information of worker job by LoginUserId
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorkerRuns/{LoginUserId}
- Update information of worker job by LoginUserId
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorkerRuns/{LoginUserId}
Shared Services/Process Worklist Task Assignments
The worklist task assignment resource is used to view, create, update and delete information about workflow task assignments Generation 3 Oracle Integration Cloud cofiguration.
- Create a workflow task assignment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTaskAssignments
- Delete a workflow task assignment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTaskAssignments/{publicSectorProcessWorklistTaskAssignmentsUniqID}
- Get all information about workflow task assignments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTaskAssignments
- Get information about a workflow task assignment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTaskAssignments/{publicSectorProcessWorklistTaskAssignmentsUniqID}
- Update a workflow task assignment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTaskAssignments/{publicSectorProcessWorklistTaskAssignmentsUniqID}
Shared Services/Process Worklist Task Searches
The worklist task searches resource is used to retrieve information about workflow tasks and their associated application data, in Gen3.
- Get all information about workflow tasks and their associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTaskSearches
- Get information about a workflow task and its associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTaskSearches/{publicSectorProcessWorklistTaskSearchesUniqID}
Shared Services/Process Worklist Tasks
The process worklist tasks resource is used to view, create, and update information about workflow tasks and their associated application data, in a Generation 3 Oracle Integration Cloud configuration.
- Create a workflow task and its associated application data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTasks
- Delete a workflow task and its associated application data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTasks/{WorklistTaskId}
- Get all information about workflow tasks and their associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTasks
- Get information about a workflow task and its associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTasks/{WorklistTaskId}
- Update a workflow task and its associated application data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTasks/{WorklistTaskId}
Shared Services/Recent Activities
The recent activities resource is used to view, create, delete, or modify the stored recent activities of the user as they navigate throughout the application.
- Create a recent activity item for a user
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNavigationRecentActivities
- Delete a recent activity item for a user
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorNavigationRecentActivities/{publicSectorNavigationRecentActivitiesUniqID}
- Get a recent activity item for a user
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNavigationRecentActivities/{publicSectorNavigationRecentActivitiesUniqID}
- Get all the recent activity items for a user
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNavigationRecentActivities
- Update a recent activity item for a user
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNavigationRecentActivities/{publicSectorNavigationRecentActivitiesUniqID}
Shared Services/Recent Activities/Large Object (LOB) Attributes - UserData
- Delete an UserData
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorNavigationRecentActivities/{publicSectorNavigationRecentActivitiesUniqID}/enclosure/UserData
- Get an UserData
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNavigationRecentActivities/{publicSectorNavigationRecentActivitiesUniqID}/enclosure/UserData
- Replace an UserData
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorNavigationRecentActivities/{publicSectorNavigationRecentActivitiesUniqID}/enclosure/UserData
Shared Services/Recent Activity Configurations
The recent activity configurations resource is used to view, update, and store the count of registry items visited by users as they navigate in the application.
- Get the count of allrecent activity configurations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecentActivityConfigurations
- Get the count of recent activity configurations
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecentActivityConfigurations/{publicSectorRecentActivityConfigurationsUniqID}
- Update an existing recent activity configuration
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecentActivityConfigurations/{publicSectorRecentActivityConfigurationsUniqID}
Shared Services/Recent Activity Configurations/Large Object (LOB) Attributes - CustomConfig
- Delete a CustomConfig
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecentActivityConfigurations/{publicSectorRecentActivityConfigurationsUniqID}/enclosure/CustomConfig
- Get a CustomConfig
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecentActivityConfigurations/{publicSectorRecentActivityConfigurationsUniqID}/enclosure/CustomConfig
- Replace a CustomConfig
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecentActivityConfigurations/{publicSectorRecentActivityConfigurationsUniqID}/enclosure/CustomConfig
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders
- Delete a recommended list
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}
- Get a recommended list
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}
- Get all recommended lists
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders
- Update a recommended list
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}/child/OpaResultList
- Delete a permit list
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}/child/OpaResultList/{OpaResultListId}
- Get a permit list
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}/child/OpaResultList/{OpaResultListId}
- Get all permit lists
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}/child/OpaResultList
- Update a permit list
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}/child/OpaResultList/{OpaResultListId}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultTransferRequests/{OpaResultId}
- Get recommended lists
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultTransferRequests
- Update a recommended list
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultTransferRequests/{OpaResultId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordWorkflowComments
- Delete a record from workflow comments
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordWorkflowComments/{publicSectorRecordWorkflowCommentsUniqID}
- Get a record from workflow comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordWorkflowComments/{publicSectorRecordWorkflowCommentsUniqID}
- Get all records from workflow comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordWorkflowComments
- Patch a record from workflow comments
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRecordWorkflowComments/{publicSectorRecordWorkflowCommentsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedRecordTypes
- Delete a related record type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedRecordTypes/{publicSectorRelatedRecordTypesUniqID}
- Get a related record type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedRecordTypes/{publicSectorRelatedRecordTypesUniqID}
- Get all related record types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedRecordTypes
- Update a related record type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedRecordTypes/{publicSectorRelatedRecordTypesUniqID}
Shared Services/Related Transaction Options
The related transaction option resource is used to provide access for applicants and contact users to view and update related transactions in an agency.
- Create a set of related transaction agency options
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactionOptions
- Delete a related transaction agency option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactionOptions/{AgencyId}
- Get a related transaction agency option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactionOptions/{AgencyId}
- Get all related transaction options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactionOptions
- Update a related transaction agency option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactionOptions/{AgencyId}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactionQueries/{publicSectorRelatedTransactionQueriesUniqID}
- Get all related transactions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactionQueries
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions
- Delete a related transaction
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions/{RelatedKey}
- Get a related transaction
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions/{RelatedKey}
- Get all related transactions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions
- Update a related transaction
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions/{RelatedKey}
Shared Services/Required Documents
The required documents resource is used to view, create, delete, or modify required document records.
- Create a required document
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRequiredDocuments
- Get a required document
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRequiredDocuments/{RequiredDocumentKey}
- Get all required documents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRequiredDocuments
- Update a required document
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRequiredDocuments/{RequiredDocumentKey}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments
- Delete a review summary comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments/{publicSectorReviewSummaryCommentsUniqID}
- Get a review summary comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments/{publicSectorReviewSummaryCommentsUniqID}
- Get all review summary comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments
- Update a review summary comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments/{publicSectorReviewSummaryCommentsUniqID}
Shared Services/Review Summary Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments/{publicSectorReviewSummaryCommentsUniqID}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments/{publicSectorReviewSummaryCommentsUniqID}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments/{publicSectorReviewSummaryCommentsUniqID}/enclosure/CommentText
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions
- Delete a role definition
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions/{publicSectorRoleDefinitionsUniqID}
- Get a role definition
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions/{publicSectorRoleDefinitionsUniqID}
- Get all role definitions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions
- Gets a role name by the role ID.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions/action/getRoleNameByRoleId
- Gets a unique GUID by the role ID.
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions/action/getRoleGuidByRoleId
- Update a role definition
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions/{publicSectorRoleDefinitionsUniqID}
Shared Services/Search Configurations
The search component configurations resource is used to retrieve search attributes related information particular to a web component. This information can be retrieved only if the search service feature is enabled at an agency for component based search. This resource is no longer used as has been replaced by Search Component Configurations.
- Get a search component configuration for a web component
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchComponentConfigs/{CompElementId}
- Get search the component configuration for all web components
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchComponentConfigs
Shared Services/Search Configurations/Large Object (LOB) Attributes - SearchConfig
- Delete a SearchConfig
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchComponentConfigs/{CompElementId}/enclosure/SearchConfig
- Get a SearchConfig
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchComponentConfigs/{CompElementId}/enclosure/SearchConfig
- Replace a SearchConfig
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorSearchComponentConfigs/{CompElementId}/enclosure/SearchConfig
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorServiceTypes
- Delete a service type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorServiceTypes/{ServiceType}
- Get a service type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorServiceTypes/{ServiceType}
- Get all service types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorServiceTypes
- Update a service type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorServiceTypes/{ServiceType}
Shared Services/Task Action Details
The task action details resource is used to view, create, modify or delete the reason why request information or accept information was initiated for a transaction.
- Create a reason
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaskActionDetails
- Delete a reason
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaskActionDetails/{TaskId}
- Get a reason
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaskActionDetails/{TaskId}
- Get all reasons
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaskActionDetails
- Update a reason
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTaskActionDetails/{TaskId}
Shared Services/Template Attachments
The template attachments resource is used to view, create, delete, or modify attachments on communication event template
- Create all communication template attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments
- Delete a communication template attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}
- Get a communication template attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}
- Get all communication template attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments
- Update a communication template attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}
Shared Services/Template Attachments/Communication Template Attachments Accessors
The communication template attachment accessors resource is used for displaying communication attachment file-related information such as file name and file URL
- Create a communication attachment's file-related information
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor
- Delete a communication attachment's file-related information
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}
- Get a communication attachment's file-related information
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}
- Get all attachment file-related information for a communication
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor
- Update a communication attachment's file-related information
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}
Shared Services/Template Attachments/Communication Template Attachments Accessors/Attachment Revisions
The attachment revision resource is used to view attachment revisions.
- Create a set of revision attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}/child/AttachmentsRevision
- Delete a revision attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}/child/AttachmentsRevision/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_AttachmentsRevision_Id}
- Get all attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}/child/AttachmentsRevision
- Get an attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}/child/AttachmentsRevision/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_AttachmentsRevision_Id}
- Update a revision attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}/child/AttachmentsRevision/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_AttachmentsRevision_Id}
Shared Services/Template Attachments/Communication Template Attachments Accessors/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}/enclosure/FileContents
Shared Services/Template Attachments/Communication Template Attachments Accessors/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/child/CommTemplatesAttAccessor/{publicSectorTemplateAttachments_CommTemplatesAttAccessor_Id}/enclosure/FileWebImage
Shared Services/Template Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments/{DocumentKey}/enclosure/Preview
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignmentAttributes
- Delete a theme assignment plan attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignmentAttributes/{publicSectorRegistryThemeAssignmentAttributesUniqID}
- Get a theme assignment plan attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignmentAttributes/{publicSectorRegistryThemeAssignmentAttributesUniqID}
- Get all theme assignment plan attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignmentAttributes
- Update a theme assignment plan attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignmentAttributes/{publicSectorRegistryThemeAssignmentAttributesUniqID}
Shared Services/Theme Assignments
The theme assignments resource is used to view, create, modify, or delete a theme assignment plan.
- Create a theme assignment plan
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments
- Delete a theme assignment plan
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}
- Get a theme assignment plan
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}
- Get all theme assignment plans
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments
- Update a theme assignment plan
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/Attributes
- Delete a theme assignment plan attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
- Get a theme assignment plan attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
- Get all theme assignment plan attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/Attributes
- Update a theme assignment plan attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments
- Delete a user level theme assignment plan
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}
- Get a user level theme assignment plan
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}
- Get all user level theme assignment plans
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments
- Update a user level theme assignment plan
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}
Shared Services/Theme Assignments/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 theme assignment plan attribute
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}/child/Attributes
- Delete a theme assignment plan attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
- Get a theme assignment plan attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
- Get all theme assignment plan attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}/child/Attributes
- Update a theme assignment plan attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
Shared Services/Theme Attributes
The theme attributes resource is used to view, create, modify, or delete a branding theme attribute.
- Create a branding theme attribute
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitionAttributes
- Delete a branding theme attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitionAttributes/{publicSectorThemeDefinitionAttributesUniqID}
- Get a branding theme attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitionAttributes/{publicSectorThemeDefinitionAttributesUniqID}
- Get all branding theme attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitionAttributes
- Update a branding theme attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitionAttributes/{publicSectorThemeDefinitionAttributesUniqID}
Shared Services/Themes
The themes resource is used to view, create, modify, or delete a branding theme.
- Create a branding theme
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions
- Delete a branding theme
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}
- Get a branding theme
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}
- Get all branding themes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions
- Update a branding theme
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}/child/Attributes
- Delete a branding theme attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}/child/Attributes/{AttributesUniqID}
- Get a branding theme attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}/child/Attributes/{AttributesUniqID}
- Get all branding theme attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}/child/Attributes
- Update a branding theme attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions/{ThemeId}/child/Attributes/{AttributesUniqID}
Shared Services/Time Recording Comments
The time recording comments resource is used to update comments for a time recording entry. This resource is used to update comments when the time entry fee has been paid.
- Get a time recording entry
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingComments/{TeEntryKey}
- Get all time recording entries
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingComments
- Update a time recording entry
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingComments/{TeEntryKey}
Shared Services/Time Recording Entries
The time recording entries resource is used to create, update, delete, and return all time recording entries for a given classification and child transaction combination. For example, for a classification of Permits and child transaction of Inspection. The transaction association is optional. Therefore, time recording can also be created at only the classification level, without the need to be assigned to a specific child transaction.
- Create a time recording entry
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingEntries
- Delete a time recording entry
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingEntries/{TeEntryKey}
- Get a time recording entry
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingEntries/{TeEntryKey}
- Get all time recording entries
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingEntries
- Update a time recording entry
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingEntries/{TeEntryKey}
Shared Services/Time Recording Entry Details
The time recording entry details resource is used to retrieve all time recording entries for a given classification and child transaction combination. This information includes the person for which the entry was recorded, the date, and the hours and minutes spent.
- Get all time recording details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingDetailEntries
- Get time recording details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingDetailEntries/{TeEntryKey}
Shared Services/Time Recording Transactions
The time recording transactions resource is used to return all application records along with related reported time recording entries.
- Get a time recording transaction
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingTransactions/{publicSectorTimeRecordingTransactionsUniqID}
- Get all time recording transactions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingTransactions
Shared Services/Time Transaction Types
Use the time transaction types resource to view, create, update, and delete time recording transaction types.
- Create a time transaction type
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeTransactionTypes
- Delete a time transaction type
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeTransactionTypes/{TransactionTypeKey}
- Get a time transaction type
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeTransactionTypes/{TransactionTypeKey}
- Get all time transaction types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeTransactionTypes
- Update a time transaction type
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTimeTransactionTypes/{TransactionTypeKey}
Shared Services/Tokens
The tokens resource is used to view, add, delete and modify token entries for the Token Framework.
- Create a token
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTokens
- Delete a token
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorTokens/{ReqId}
- Get a token
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTokens/{ReqId}
- Get all tokens
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTokens
- Update a token
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTokens/{ReqId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTransactionAssignees
- Get a transaction assignee
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTransactionAssignees/{TransAssignKey}
- Get all transaction assignees
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTransactionAssignees
- Update a transaction assignee
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorTransactionAssignees/{TransAssignKey}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignmentAttributes
- Delete a user level theme assignment plan attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignmentAttributes/{publicSectorRegistryUserThemeAssignmentAttributesUniqID}
- Get a user level theme assignment plan attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignmentAttributes/{publicSectorRegistryUserThemeAssignmentAttributesUniqID}
- Get all user level theme assignment plan attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignmentAttributes
- Update a user level theme assignment plan attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignmentAttributes/{publicSectorRegistryUserThemeAssignmentAttributesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments
- Delete a user level theme assignment plan
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}
- Get a user level theme assignment plan
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}
- Get all user level theme assignment plans
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments
- Update a user level theme assignment plan
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}/child/Attributes
- Delete a user level theme assignment plan attribute
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
- Get a user level theme assignment plan attribute
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
- Get all user level theme assignment plan attributes
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}/child/Attributes
- Update a user level theme assignment plan attribute
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions
- Delete a web application
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions/{HostName}
- Get a web application
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions/{HostName}
- Get all web applications
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions
- Update a web application
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions/{HostName}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments
- Delete an attachment for a registered public user account
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}
- Get all attachments for a registered public user account
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments
- Get an attachment for a registered public user account
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}
- Update an attachment for a registered public user account
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}
Shared Services/Web Form Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/enclosure/Preview
Shared Services/Web Form Attachments/Web Form Attachment Accessors
The web form attachment accessors resource is used to display file-related information such as file name and file URL.
- Create a web form attachment accessor
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor
- Delete a web form attachment accessor
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}
- Get a web form attachment accessor
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}
- Get all web form attachment accessors
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor
- Update a web form attachment accessor
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}
Shared Services/Web Form Attachments/Web Form Attachment Accessors/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}/enclosure/FileContents
Shared Services/Web Form Attachments/Web Form Attachment Accessors/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}/enclosure/FileWebImage
Shared Services/Web Form Attachments/Web Form Attachment Accessors/Web Form Attachment Revisions
The web form attachment revisions resource is used to display the historical information for an attachment.
- Create a web form attachment revision
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}/child/AttachmentsRevision
- Delete a web form attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}/child/AttachmentsRevision/{publicSectorWebformAttachments_CommWebformAttachAccessor_AttachmentsRevision_Id}
- Get a web form attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}/child/AttachmentsRevision/{publicSectorWebformAttachments_CommWebformAttachAccessor_AttachmentsRevision_Id}
- Get all web form attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}/child/AttachmentsRevision
- Update a web form attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}/child/CommWebformAttachAccessor/{publicSectorWebformAttachments_CommWebformAttachAccessor_Id}/child/AttachmentsRevision/{publicSectorWebformAttachments_CommWebformAttachAccessor_AttachmentsRevision_Id}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}
- Get all web form responses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses
- Update a web form response
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}
Shared Services/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: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}/child/WebForms/{WebformId}
- Get all web form details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}/child/WebForms
- Update a web form
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}/child/WebForms/{WebformId}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities
- Delete a workflow activity
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}
- Get a workflow activity
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}
- Get all workflow activities
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities
- Update a workflow activity
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}
Shared Services/Workflow Activities/Large Object (LOB) Attributes - CustomData
- Delete a CustomData
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/CustomData
- Get a CustomData
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/CustomData
- Replace a CustomData
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/CustomData
Shared Services/Workflow Activities/Large Object (LOB) Attributes - RequestPayload
- Delete a RequestPayload
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/RequestPayload
- Get a RequestPayload
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/RequestPayload
- Replace a RequestPayload
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/RequestPayload
Shared Services/Workflow Activities/Large Object (LOB) Attributes - RequestUrl
- Delete a RequestUrl
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/RequestUrl
- Get a RequestUrl
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/RequestUrl
- Replace a RequestUrl
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/RequestUrl
Shared Services/Workflow Activities/Large Object (LOB) Attributes - RestResponse
- Delete a RestResponse
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/RestResponse
- Get a RestResponse
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/RestResponse
- Replace a RestResponse
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{publicSectorWorkflowActivitiesUniqID}/enclosure/RestResponse
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments
- Delete a workflow attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}
- Get a workflow attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}
- Get all workflow attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments
- Update a workflow attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}
Shared Services/Workflow Attachments/Attachments
The attachments resource is used to perform the file attachment functionality.
- Create a set of workflow attachments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor
- Delete an uploaded attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}
- Get all workflow attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor
- Get an uploaded attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}
- Update an uploaded attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}/child/AttachmentsRevision
- Delete a revision attachment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get a revision attachment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all revision attachments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}/child/AttachmentsRevision
- Update a revision attachment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Shared Services/Workflow Attachments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}/enclosure/FileContents
Shared Services/Workflow Attachments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}/enclosure/FileWebImage
Shared Services/Workflow Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/enclosure/Preview
Shared Services/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments
- Delete a workflow comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}
- Get a workflow comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}
- Get all workflow comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments
- Update a workflow comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}
Shared Services/Workflow Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}/enclosure/CommentText
Shared Services/Worklist Task Assignments
The worklist task assignment resource is used to view, create, update and delete information about workflow task assignments.
- Create a workflow task assignment
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskAssignments
- Delete a workflow task assignment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskAssignments/{publicSectorWorklistTaskAssignmentsUniqID}
- Get all information about workflow task assignments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskAssignments
- Get information about a workflow task assignment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskAssignments/{publicSectorWorklistTaskAssignmentsUniqID}
- Update a workflow task assignment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskAssignments/{publicSectorWorklistTaskAssignmentsUniqID}
Shared Services/Worklist Task Searches
The worklist task searches resource is used to retrieve information about workflow tasks and their associated application data.
- Get all information about workflow tasks and their associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskSearches
- Get information about a workflow task and its associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskSearches/{publicSectorWorklistTaskSearchesUniqID}
Shared Services/Worklist Task Workers
The worklist task workers resource is used to view, create, and update information about worklist task workers.
- Create a worklist task worker
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskWorkers
- Delete a worklist task worker
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskWorkers/{LoginUserId}
- Get all information about worklist task workers
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskWorkers
- Get information about a worklist task worker
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskWorkers/{LoginUserId}
- Update a worklist task worker
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskWorkers/{LoginUserId}
Shared Services/Worklist Tasks
The worklist tasks resource is used to view, create, and update information about workflow tasks and their associated application data.
- Create a workflow task and its associated application data
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTasks
- Delete a workflow task and its associated application data
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTasks/{TaskId}
- Get all information about workflow tasks and their associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTasks
- Get information about a workflow task and its associated application data
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTasks/{TaskId}
- Update a workflow task and its associated application data
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTasks/{TaskId}
Trade License Management/Contractor Attachments
The contractor attachments resource is used to view, create, delete or modify attachments to contractor license.
- Create a set of attachments for a contractor license
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments
- Delete an attachment for a contractor license
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}
- Get all attachments for a contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments
- Get an attachment for a contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}
- Update an attachment for a contractor license
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}
Trade License Management/Contractor Attachments/Attachments
The attachments resource is used to view, create, and update attachments.
- Create a set of contractor attachment accessor
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor
- Delete an contractor attachment accessor
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}
- Get all contractor attachments accessors
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor
- Get an contractor attachment accessor
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}
- Update an contractor attachment accessor
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}
Trade License Management/Contractor Attachments/Attachments/Attachment Revisions
The attachmentsRevision resource is used to view attachment revisions.
- Create a set of contractor attachment revisions
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}/child/AttachmentsRevision
- Delete an contractor attachment revision
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Get all contractor attachment revisions
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}/child/AttachmentsRevision
- Get an contractor attachment revision
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
- Update an contractor attachment revision
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Trade License Management/Contractor Attachments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}/enclosure/FileContents
Trade License Management/Contractor Attachments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/child/ContractorLicenseAttachmentsAccessor/{ContractorLicenseAttachmentsAccessorUniqID}/enclosure/FileWebImage
Trade License Management/Contractor Attachments/Large Object (LOB) Attributes - Preview
- Delete a Preview
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/enclosure/Preview
- Get a Preview
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/enclosure/Preview
- Replace a Preview
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorAttachments/{LicenseAttachmentKey}/enclosure/Preview
Trade License Management/Contractor Comments
The contractor comments resource is used to view, create, delete, or modify contractor license comments.
- Create a set of contractor license comments
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorComments
- Delete a contractor license comment
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorComments/{LicenseCommentKey}
- Get a contractor license comment
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorComments/{LicenseCommentKey}
- Get all contractor license comments
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorComments
- Update a contractor license comment
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorComments/{LicenseCommentKey}
Trade License Management/Contractor Comments/Large Object (LOB) Attributes - CommentText
- Delete a CommentText
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorComments/{LicenseCommentKey}/enclosure/CommentText
- Get a CommentText
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorComments/{LicenseCommentKey}/enclosure/CommentText
- Replace a CommentText
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorComments/{LicenseCommentKey}/enclosure/CommentText
Trade License Management/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorFacts
- Delete a contractor validation fact is not allowed
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorFacts/{publicSectorContractorFactsUniqID}
- Get a contractor validation fact
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorFacts/{publicSectorContractorFactsUniqID}
- Get all contractor validation facts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorFacts
- Update a contractor validation fact
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorFacts/{publicSectorContractorFactsUniqID}
Trade License Management/Contractor License Agents
The contractor 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseAgents
- Delete a license agent for a contractor license
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseAgents/{LicenseAgentKey}
- Get a license agent for a contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseAgents/{LicenseAgentKey}
- Get all license agents for a contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseAgents
- Update a license agent for a contractor license
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseAgents/{LicenseAgentKey}
Trade License Management/Contractor License Facts
The contractor 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseFacts
- Delete a license fact for a contractor license
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseFacts/{LicenseFactKey}
- Get a license fact for a contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseFacts/{LicenseFactKey}
- Get all license facts for a contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseFacts
- Update a license fact for a contractor license
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseFacts/{LicenseFactKey}
Trade License Management/Contractor License Insurances
The contractor 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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances
- Delete a license insurance for a contractor license
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances/{LicenseInsuranceKey}
- Get a license insurance for a contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances/{LicenseInsuranceKey}
- Get all license insurances for a contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances
- Update a license insurance for a contractor license
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances/{LicenseInsuranceKey}
Trade License Management/Contractor License Insurances/Large Object (LOB) Attributes - Exemptlongdesc
- Delete an Exemptlongdesc
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances/{LicenseInsuranceKey}/enclosure/Exemptlongdesc
- Get an Exemptlongdesc
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances/{LicenseInsuranceKey}/enclosure/Exemptlongdesc
- Replace an Exemptlongdesc
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances/{LicenseInsuranceKey}/enclosure/Exemptlongdesc
Trade License Management/Contractor Licenses
The contractor licenses resource is used to view, add, delete, and modify general information for a contractor license.
- Create a contractor license
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses
- Delete a contractor license
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}
- Get a contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}
- Get all contractor licenses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses
- Update a contractor license
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}
Trade License Management/Contractor Licenses/Contractor License Agents
The contractor 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 contractor license agent
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents
- Delete a contractor license agent
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents/{LicenseAgentKey}
- Get a contractor license agent
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents/{LicenseAgentKey}
- Get all contractor license agents
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents
- Update a contractor license agent
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents/{LicenseAgentKey}
Trade License Management/Contractor Licenses/Contractor License Facts
The contractor 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 contractor license detail
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts
- Delete a contractor license detail
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts/{LicenseFactKey}
- Get a contractor license detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts/{LicenseFactKey}
- Get all contractor license details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts
- Update a contractor license detail
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts/{LicenseFactKey}
Trade License Management/Contractor Licenses/Contractor License Insurances
The contractor license insurances resource is used to view, add, delete, and modify details pertaining to insurance and workers compensation for a contractor license.
- Create a license insurance information for a contractor license
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances
- Delete a license insurance information for a contractor license
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances/{LicenseInsuranceKey}
- Get all license insurance information for contractor licenses
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances
- Get license insurance information for a contractor license
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances/{LicenseInsuranceKey}
- Update a license insurance information for a contractor license
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances/{LicenseInsuranceKey}
Trade License Management/Contractor Licenses/Contractor License Insurances/Large Object (LOB) Attributes - Exemptlongdesc
- Delete an Exemptlongdesc
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances/{LicenseInsuranceKey}/enclosure/Exemptlongdesc
- Get an Exemptlongdesc
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances/{LicenseInsuranceKey}/enclosure/Exemptlongdesc
- Replace an Exemptlongdesc
- Method: putPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances/{LicenseInsuranceKey}/enclosure/Exemptlongdesc
Trade License Management/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionClassifications
- Delete a classification for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionClassifications/{publicSectorContractorOptionClassificationsUniqID}
- Get a classification for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionClassifications/{publicSectorContractorOptionClassificationsUniqID}
- Get all classifications for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionClassifications
- Update a classification for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionClassifications/{publicSectorContractorOptionClassificationsUniqID}
Trade License Management/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionFacts
- Get a fact for contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionFacts/{publicSectorContractorOptionFactsUniqID}
- Get all contractor validation option facts
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionFacts
- Update a fact for contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionFacts/{publicSectorContractorOptionFactsUniqID}
Trade License Management/Contractor Option Insurance Types
The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types.
- Create a set of insurance types for a contractor validation option
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionInsuranceTypes
- Delete an insurance type for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionInsuranceTypes/{publicSectorContractorOptionInsuranceTypesUniqID}
- Get all insurance types for contractor validation options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionInsuranceTypes
- Get an insurance type for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionInsuranceTypes/{publicSectorContractorOptionInsuranceTypesUniqID}
- Update an insurance type for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionInsuranceTypes/{publicSectorContractorOptionInsuranceTypesUniqID}
Trade License Management/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations
- Delete an integration for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations/{publicSectorContractorOptionIntegrationsUniqID}
- Get all integrations for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations
- Get an integration for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations/{publicSectorContractorOptionIntegrationsUniqID}
- Update an integration for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations/{publicSectorContractorOptionIntegrationsUniqID}
Trade License Management/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionLicenseTypes
- Delete a license type for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionLicenseTypes/{publicSectorContractorOptionLicenseTypesUniqID}
- Get a license type for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionLicenseTypes/{publicSectorContractorOptionLicenseTypesUniqID}
- Get all license types for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionLicenseTypes
- Update a license type for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionLicenseTypes/{publicSectorContractorOptionLicenseTypesUniqID}
Trade License Management/Contractor Option Ownership Types
The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types.
- Create a set of ownership type for a contractor validation option
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionOwnershipTypes
- Delete an ownership type for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionOwnershipTypes/{publicSectorContractorOptionOwnershipTypesUniqID}
- Get all ownership types for contractor validation options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionOwnershipTypes
- Get an ownership type for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionOwnershipTypes/{publicSectorContractorOptionOwnershipTypesUniqID}
- Update an ownership type for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionOwnershipTypes/{publicSectorContractorOptionOwnershipTypesUniqID}
Trade License Management/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionStatusMappings
- Delete a status mapping for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionStatusMappings/{publicSectorContractorOptionStatusMappingsUniqID}
- Get a status mapping for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionStatusMappings/{publicSectorContractorOptionStatusMappingsUniqID}
- Get all status mappings for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionStatusMappings
- Update a status mapping for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionStatusMappings/{publicSectorContractorOptionStatusMappingsUniqID}
Trade License Management/Contractor Options
The contractor options resource is used to view, add, delete, and modify contractor license options for validating licenses.
- Create a set of contractor validation options
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions
- Delete a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}
- Get a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}
- Get all contractor validation options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions
- Update a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}
Trade License Management/Contractor Options for Registered Users
The contractor options for registered users resource is used to view contractor license options for validating licenses for registsred users.
- Create a set of contractor validation options is not allowed
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions
- Delete a contractor validation option is not allowed
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}
- Get a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}
- Get all contractor validation options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions
- Update a contractor validation option is not allowed
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}
Trade License Management/Contractor Options for Registered Users/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 is not allowed
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionClassifications
- Delete a classification for a contractor validation option is not allowed
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}
- Get a classification for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}
- Get all classifications for contractor validation options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionClassifications
- Update a classification for a contractor validation option is not allowed
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}
Trade License Management/Contractor Options for Registered Users/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 details for a contractor validation option is not allowed
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionFacts
- Delete a detail for a contractor validation option is not allowed
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}
- Get a detail for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}
- Get all details for contractor validation options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionFacts
- Update a detail for a contractor validation option is not allowed
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}
Trade License Management/Contractor Options for Registered Users/Contractor Option Insurance Types
The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types.
- Create a set of insurance types for a contractor validation option
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionInsuranceTypes
- Delete an insurance type for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionInsuranceTypes/{ContractorOptionInsuranceTypesUniqID}
- Get all insurance types for contractor validation options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionInsuranceTypes
- Get an insurance type for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionInsuranceTypes/{ContractorOptionInsuranceTypesUniqID}
- Update an insurance type for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionInsuranceTypes/{ContractorOptionInsuranceTypesUniqID}
Trade License Management/Contractor Options for Registered Users/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionLicenseTypes
- Delete a license type of contractor validation option is not allowed is not allowed
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}
- Get a license type for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}
- Get all contractor validation option license types
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionLicenseTypes
- Update a license type of contractor validation option is not allowed is not allowed
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}
Trade License Management/Contractor Options for Registered Users/Contractor Option Ownership Types
The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types.
- Create a set of ownership types for a contractor validation option
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionOwnershipTypes
- Delete an ownership type for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionOwnershipTypes/{ContractorOptionOwnershipTypesUniqID}
- Get all ownership types for contractor validation options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionOwnershipTypes
- Get an ownership type for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionOwnershipTypes/{ContractorOptionOwnershipTypesUniqID}
- Update an ownership type for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionOwnershipTypes/{ContractorOptionOwnershipTypesUniqID}
Trade License Management/Contractor Options for Registered Users/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 is not allowed
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings
- Delete a status mapping for a contractor validation option is not allowed
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}
- Get a status mapping for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}
- Get all status mappings for contractor validation options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings
- Update a status mapping for a contractor validation option is not allowed
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}
Trade License Management/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionClassifications
- Delete a classification for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}
- Get a classification for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}
- Get all classifications for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionClassifications
- Update a classification for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionClassifications/{ContractorOptionClassificationsUniqID}
Trade License Management/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionFacts
- Delete a fact for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}
- Get a fact for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}
- Get all facts for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionFacts
- Update a fact for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionFacts/{ContractorOptionFactsUniqID}
Trade License Management/Contractor Options/Contractor Option Insurance Types
The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types.
- Create a set of insurance types for a contractor validation option
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionInsuranceTypes
- Delete an insurance type for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionInsuranceTypes/{ContractorOptionInsuranceTypesUniqID}
- Get all insurance types for contractor validation options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionInsuranceTypes
- Get an insurance type for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionInsuranceTypes/{ContractorOptionInsuranceTypesUniqID}
- Update an insurance type for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionInsuranceTypes/{ContractorOptionInsuranceTypesUniqID}
Trade License Management/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionIntegrations
- Delete an integration for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionIntegrations/{ContractorOptionIntegrationsUniqID}
- Get all integrations for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionIntegrations
- Get an integration for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionIntegrations/{ContractorOptionIntegrationsUniqID}
- Update an integration for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionIntegrations/{ContractorOptionIntegrationsUniqID}
Trade License Management/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 license types for a contractor validation option
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionLicenseTypes
- Delete a license type for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}
- Get a license type for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}
- Get all license types for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionLicenseTypes
- Update a license type for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionLicenseTypes/{ContractorOptionLicenseTypesUniqID}
Trade License Management/Contractor Options/Contractor Option Ownership Types
The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types.
- Create a set of ownership types for a contractor validation option
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionOwnershipTypes
- Delete an ownership type for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionOwnershipTypes/{ContractorOptionOwnershipTypesUniqID}
- Get all ownership types for contractor validation options
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionOwnershipTypes
- Get an ownership type for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionOwnershipTypes/{ContractorOptionOwnershipTypesUniqID}
- Update an ownership type for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionOwnershipTypes/{ContractorOptionOwnershipTypesUniqID}
Trade License Management/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: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionStatusMappings
- Delete a status mapping for a contractor validation option
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}
- Get a status mapping for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}
- Get all status mappings for a contractor validation option
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionStatusMappings
- Update a status mapping for a contractor validation option
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}
Trade License Management/Validation Group Detail Value Sets
The validation group detail value sets is used to view, add, delete and modify the job cost and insurances that need to be validated for license classifications and license types.
- Create a validation group detail value set
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetailValueSets
- Delete a validation group detail value set
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetailValueSets/{publicSectorValidationGroupDetailValueSetsUniqID}
- Get a validation group detail value set
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetailValueSets/{publicSectorValidationGroupDetailValueSetsUniqID}
- Get all validation group detail value sets
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetailValueSets
- Update a validation group detail value set
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetailValueSets/{publicSectorValidationGroupDetailValueSetsUniqID}
Trade License Management/Validation Group Detail Values
The validaton group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.
- Create a validation group detail value
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetailValues
- Delete a validation group detail value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetailValues/{publicSectorValidationGroupDetailValuesUniqID}
- Get a validation group detail value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetailValues/{publicSectorValidationGroupDetailValuesUniqID}
- Get all validation group detail values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetailValues
- Update a validation group detail value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetailValues/{publicSectorValidationGroupDetailValuesUniqID}
Trade License Management/Validation Group Details
The validation group details resource is used to view, add, delete, and modify the validation options.
- Create a validation group detail
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails
- Delete a validation group detail
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}
- Get a validation group detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}
- Get all validation group details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails
- Update a validation group detail
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}
Trade License Management/Validation Group Details/Validation Group Detail Value Sets
The validation group detail value sets is used to view, add, delete, and modify the job cost and insurances that must be validated for the license classifications and license types.
- Create a validation group detail value set
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets
- Delete a validation group detail value set
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets/{ValidationGroupDetailValueSetsUniqID}
- Get a validation group detail value set
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets/{ValidationGroupDetailValueSetsUniqID}
- Get all validation group detail value sets
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets
- Update a validation group detail value set
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets/{ValidationGroupDetailValueSetsUniqID}
Trade License Management/Validation Group Details/Validation Group Detail Values
The validation group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.
- Create a validation group detail value
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues
- Delete a validation group detail value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues/{ValidationGroupDetailValuesUniqID}
- Get a validation group detail value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues/{ValidationGroupDetailValuesUniqID}
- Get all validation group detail values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues
- Update a validation group detail value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues/{ValidationGroupDetailValuesUniqID}
Trade License Management/Validation Groups
The validation groups resource is used to view, add, delete, and modify the validation groups.
- Create a validation group
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups
- Delete a validation group
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}
- Get a validation group
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}
- Get all validation groups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups
- Update a validation group
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}
Trade License Management/Validation Groups/Validation Group Details
The validation group details resource is used to view, add, delete, and modify the validation options.
- Create a validation group detail
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails
- Delete a validation group detail
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}
- Get a validation group detail
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}
- Get all validation group details
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails
- Update a validation group detail
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}
Trade License Management/Validation Groups/Validation Group Details/Validation Group Detail Value Sets
Used to configure job cost and insurances that must be validated for license classifications and license types while submitting an application.
- Create a validation group details value set
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets
- Delete a validation group details value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets/{ValidationGroupDetailValueSetsUniqID}
- Get a validation group details value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets/{ValidationGroupDetailValueSetsUniqID}
- Get all validation group details value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets
- Update a validation group details value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets/{ValidationGroupDetailValueSetsUniqID}
Trade License Management/Validation Groups/Validation Group Details/Validation Group Detail Values
The validation group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.
- Create a validation group detail value
- Method: postPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues
- Delete a validation group detail value
- Method: deletePath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues/{ValidationGroupDetailValuesUniqID}
- Get a validation group detail value
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues/{ValidationGroupDetailValuesUniqID}
- Get all validation group detail values
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues
- Update a validation group detail value
- Method: patchPath:
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues/{ValidationGroupDetailValuesUniqID}