Get all agencies
get
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds an agency with the specified primary key criteria.
Finder Variables:- AgencyId; integer; The unique identifier of the agency.
- simpleSearchFinder: Finds an agency with the agency name.
Finder Variables:- value; string; The name of the agency.
- PrimaryKey: Finds an agency with the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AccountEnabled; boolean; Indicates whether accounting is enabled for the agency.
- AgencyId; integer; The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.
- AgencyName; string; The name of the agency. Value is mandatory and is defined by the user during a create action.
- AssignmentOption; string; Indicates whether the agency defines its own reference data or shares a common set of data. The only accepted value is A (Agency) at this time. Value is mandatory and system-assigned.
- CountryCode; string; The country in which the agency is located. Value is mandatory and is defined by the user during a create action. A list of accepted values is defined in PSC_COM_COUNTRY_B.
- CreatedBy; string; The user who created the agency.
- CreationDate; string; The date and time when the agency was created.
- CurrencyCode; string; The base currency in which the agency operates. Value is mandatory and is defined by the user during a create action. A list of accepted values is defined in PSC_COM_CURRENCY_B.
- DateFormat; string; Date format for the agency. Value is mandatory and the default is 'M/d/yy' like 1/31/99.
- DefaultInspectionDateFilter; string; The date range used by default to filter inspections. The default value is Today.
- DefaultInspectionDateTypeFilter; string; The type of date used by default to filter inspections. The default value is Requested.
- DefaultPlanReviewDateFilter; string; The date range used by default to filter plan reviews. The default value is Today.
- DefaultPlanReviewDateTypeFilter; string; The type of date used by default to filter plan reviews. The default value is Cycle Due.
- DefaultSearchFilter; string; The search filter used by default.
- DefaultSearchType; string; The type of search used by default.
- Description; string; The long description of the agency. Value is mandatory and is defined by the user when the agency is created.
- EnableFinGl; string; Indicates whether Financials Cloud Subledger Accounting is used to generate accounting for the agency.
- ErrorNotificationEmail; string; Email address to notify in the event of an error.
- ErrorNotificationEnabled; boolean; Indicates whether the error notification is enabled or not.
- FinGLEnabled; boolean; Indicates whether accounting is to be created through Subledger Accounting for the agency.
- HidePropertyOwner; string; Indicates whether or not the Owners tab of the Parcel page should be displayed to public users. Option is selected (hide) by default.
- InspectionCountLimit; integer; The limit of the total count of assigned inspections across both permits and business licenses.
- LastUpdateDate; string; The last date and time when the agency was updated.
- LastUpdatedBy; string; The user who last updated the agency.
- LedgerId; integer; The Fusion ledger ID that contains accounting entries for the agency. Value is used and mandatory only if the Create Subledger Accounting option is selected.
- LedgerName; string; The name of the Fusion ledger.
- MaxActionRetryCount; integer; Number of attempts the system will automatically retry for an action.
- MaxCopiesAllowed; integer; The maximum copies allowed for the copy application.
- NumberFormat; string; Number format for the agency. Value is mandatory and the default is '#,##0.###', like -1,234.567.
- OPAPolicyId; string; The unique identifier of the Oracle Policy Automation policy used by the agency. Value is entered by the user when the agency is created.
- ParcelOwnerFormat; string; Indicates the preferred format for displaying parcel owner name. Accepted values are 1 (Use one field) and 2 (Use two fields) . The default value is '1'.
- PlanReviewSaturdaySundayFlag; boolean; Indicates whether Saturday and Sunday will be included in the plan review due date time rule calculations. Default value is N.
- PscGLEnabled; boolean; Indicates whether accounting is to be created within Oracle Permitting and Licensing for the agency.
- RuleIdEntity; string; Autonumber rule used for generating a unique business entity ID for a business.
- RuleIdLicenseId; string; Autonumber rule used for generating a unique license ID for a business.
- RuleIdLocation; string; Autonumber rule used for generating a unique business location ID for a business.
- RuleIdPolicyId; string; Autonumber rule used for generating a unique insurance policy ID for a business.
- TimeFormat; string; Time format for the agency. Value is mandatory and the default is 'h:mm a' like 1:30 PM.
- Tzname; string; The time zone the agency is located in. Value is mandatory and is defined by the user during a create action.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorAgencies
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorAgencies-item-response
Type:
Show Source
object
-
AccountEnabled: boolean
Read Only:
true
Indicates whether accounting is enabled for the agency. -
AgencyAddress: array
Agency Addresses
Title:
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. -
AgencyId: integer
(int32)
Title:
Agency ID
The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1. -
AgencyLang: array
Agency Languages
Title:
Agency Languages
The agency languages resource is used to view, create, or modify the languages the agency supports. -
AgencyName: string
Title:
Name
Maximum Length:100
The name of the agency. Value is mandatory and is defined by the user during a create action. -
AgencyOptions: array
Agency Options
Title:
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. -
AssignmentOption: string
Maximum Length:
1
Default Value:A
Indicates whether the agency defines its own reference data or shares a common set of data. The only accepted value is A (Agency) at this time. Value is mandatory and system-assigned. -
CountryCode: string
Title:
Country
Maximum Length:3
The country in which the agency is located. Value is mandatory and is defined by the user during a create action. A list of accepted values is defined in PSC_COM_COUNTRY_B. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the agency. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the agency was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
The base currency in which the agency operates. Value is mandatory and is defined by the user during a create action. A list of accepted values is defined in PSC_COM_CURRENCY_B. -
DateFormat: string
Title:
Date Format
Maximum Length:30
Default Value:M/d/yy
Date format for the agency. Value is mandatory and the default is 'M/d/yy' like 1/31/99. -
DefaultInspectionDateFilter: string
Title:
Default Inspection Date Filter
Maximum Length:30
The date range used by default to filter inspections. The default value is Today. -
DefaultInspectionDateTypeFilter: string
Title:
Default Inspection Date Type Filter
Maximum Length:30
The type of date used by default to filter inspections. The default value is Requested. -
DefaultPlanReviewDateFilter: string
Title:
Default Plan Review Date Filter
Maximum Length:30
Default Value:ORA_TDY
The date range used by default to filter plan reviews. The default value is Today. -
DefaultPlanReviewDateTypeFilter: string
Title:
Default Plan Review Date Type Filter
Maximum Length:30
Default Value:ORA_CYC_DUE
The type of date used by default to filter plan reviews. The default value is Cycle Due. -
DefaultSearchFilter: string
Title:
Default Search Filter
Maximum Length:30
The search filter used by default. -
DefaultSearchType: string
Title:
Default Search Type
Maximum Length:30
The type of search used by default. -
Description: string
Title:
Description
Maximum Length:300
The long description of the agency. Value is mandatory and is defined by the user when the agency is created. -
EnableFinGl: string
Title:
Create Subledger Accounting
Maximum Length:1
Default Value:N
Indicates whether Financials Cloud Subledger Accounting is used to generate accounting for the agency. -
ErrorNotificationEmail: string
Title:
Error Notification Email
Maximum Length:256
Email address to notify in the event of an error. -
ErrorNotificationEnabled: boolean
Title:
Notify on Error
Maximum Length:1
Default Value:false
Indicates whether the error notification is enabled or not. -
FinGLEnabled: boolean
Read Only:
true
Indicates whether accounting is to be created through Subledger Accounting for the agency. -
HidePropertyOwner: string
Maximum Length:
1
Indicates whether or not the Owners tab of the Parcel page should be displayed to public users. Option is selected (hide) by default. -
InspectionCountLimit: integer
(int32)
Title:
Inspection Count Limit
Default Value:20
The limit of the total count of assigned inspections across both permits and business licenses. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The last date and time when the agency was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the agency. -
LedgerId: integer
Title:
Financials Cloud Ledger
The Fusion ledger ID that contains accounting entries for the agency. Value is used and mandatory only if the Create Subledger Accounting option is selected. -
LedgerName: string
Read Only:
true
Maximum Length:30
The name of the Fusion ledger. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaxActionRetryCount: integer
(int32)
Title:
Automated Retry Limit
Number of attempts the system will automatically retry for an action. -
MaxCopiesAllowed: integer
(int32)
Title:
Maximum Copies Allowed
The maximum copies allowed for the copy application. -
NumberFormat: string
Title:
Number Format
Maximum Length:30
Default Value:#,##0.###
Number format for the agency. Value is mandatory and the default is '#,##0.###', like -1,234.567. -
OPAPolicyId: string
Title:
Oracle Policy Automation ID
Maximum Length:150
The unique identifier of the Oracle Policy Automation policy used by the agency. Value is entered by the user when the agency is created. -
ParcelOwnerFormat: string
Title:
Parcel Owner Format
Maximum Length:3
Default Value:1
Indicates the preferred format for displaying parcel owner name. Accepted values are 1 (Use one field) and 2 (Use two fields) . The default value is '1'. -
PlanReviewSaturdaySundayFlag: boolean
Title:
Exclude Saturday and Sunday
Maximum Length:1
Indicates whether Saturday and Sunday will be included in the plan review due date time rule calculations. Default value is N. -
PscGLEnabled: boolean
Read Only:
true
Indicates whether accounting is to be created within Oracle Permitting and Licensing for the agency. -
RuleIdEntity: string
Title:
Business Number Rule
Maximum Length:20
Autonumber rule used for generating a unique business entity ID for a business. -
RuleIdLicenseId: string
Title:
License Number Rule
Maximum Length:20
Autonumber rule used for generating a unique license ID for a business. -
RuleIdLocation: string
Title:
Location Number Rule
Maximum Length:20
Autonumber rule used for generating a unique business location ID for a business. -
RuleIdPolicyId: string
Title:
Insurance Policy Number Rule
Maximum Length:20
Autonumber rule used for generating a unique insurance policy ID for a business. -
TimeFormat: string
Title:
Time Format
Maximum Length:30
Default Value:h:mm a
Time format for the agency. Value is mandatory and the default is 'h:mm a' like 1:30 PM. -
Tzname: string
Title:
Time Zone
Maximum Length:64
The time zone the agency is located in. Value is mandatory and is defined by the user during a create action.
Nested Schema : Agency Addresses
Type:
array
Title:
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.
Show Source
Nested Schema : Agency Languages
Type:
array
Title:
Agency Languages
The agency languages resource is used to view, create, or modify the languages the agency supports.
Show Source
Nested Schema : Agency Options
Type:
array
Title:
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.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorAgencies-AgencyAddress-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address
Maximum Length:240
The first address line of the agency address. -
Address2: string
Title:
Address
Maximum Length:240
The second address line of the agency address. -
Address3: string
Title:
Address
Maximum Length:240
The third address line of the agency address. -
Address4: string
Title:
Address
Maximum Length:240
The fourth address line of the agency address. -
AddressCode: string
Title:
Address ID
Maximum Length:32
The unique identifier of the address. Value is mandatory and is entered by the user when the address is created. -
AgencyAddressId: integer
Title:
Address ID
The unique identifier of the address. Value is mandatory and is system-generated when the address is created. ID is not displayed to the user. -
AgencyId: integer
(int32)
Title:
Agency ID
The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1. -
CityName: string
Title:
City
Maximum Length:60
The name of the city as part of the agency address. -
CountryCode: string
Title:
Country
Maximum Length:3
The name of the country as part of the agency address. -
CountyCodeIncits: string
Title:
County
Maximum Length:60
The name of the county as part of the agency address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the agency address. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the agency address was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The last date and time when the agency address was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the agency address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal code plus four as part of the agency address. -
PrimaryFlag: string
Title:
Primary
Maximum Length:1
Indicates whether the address is the primary address of the agency. A value of Y means the address is primary. Default value is N. -
Province: string
Title:
Province
Maximum Length:60
The name of the province as part of the agency address. -
State: string
Title:
State
Maximum Length:60
The name of the state as part of the agency address. -
ValidFromDate: string
(date)
Title:
From Date
The first day that the address may be used. -
ValidToDate: string
(date)
Title:
To Date
The last day that the address may be used. -
ZipCode: string
Title:
Postal Code
Maximum Length:60
The postal code as part of the agency address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorAgencies-AgencyLang-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the agency language. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the agency language was created. -
Description: string
Title:
Description
Maximum Length:30
The description of the language. -
LanguageCd: string
Title:
Language
Maximum Length:4
The unique identifier of a language that is supported by the agency. Value is mandatory and is defined by the user during a create action. -
LastUpdateDate: string
(date-time)
Read Only:
true
The last date and time when the agency language was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the agency language. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: string
Title:
Primary
Maximum Length:1
Indicates the language is the primary (base) language of the agency. -
ValidFromDate: string
(date)
Title:
From Date
The first day the language may be used. -
ValidToDate: string
(date)
Title:
To Date
The last day the language may be used.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorAgencies-AgencyOptions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the agency option. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the agency option was created. -
DestURL: string
Read Only:
true
Maximum Length:254
A transient value calculated at runtime that fetches the jet path of the offering options page if it exists. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the offering is enabled for the agency. A value of Y means the offering is enabled. The default value is Y for yes. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The last date and time when the agency option was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the agency option. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferingId: string
Title:
Offering
Maximum Length:80
The unique identifier of the product offering. -
OfferingName: string
Title:
Offering
Read Only:true
Maximum Length:150
The name of the product offering. -
OptOffering: string
Read Only:
true
A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source