Get all agencies
get
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:- 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. Finder Variables:
- AgencyId; integer; The unique identifier of the agency.
- simpleSearchFinder: Finds an agency with the agency name. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorAgencies
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorAgencies-item
Type:
Show Source
object
-
AccountEnabled(optional):
boolean
Indicates whether accounting is enabled for the agency.
-
AgencyAddress(optional):
array Agency Addresses
Title:
Agency Addresses
The agencies resource is used to view, create or modify an agency. Agency has a unique identifier and stores the default country, currency, timezone along with name and description. Agencies are entities which own transaction data like permit applications. -
AgencyId(optional):
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(optional):
array Agency Languages
Title:
Agency Languages
The agencies resource is used to view, create or modify an agency. Agency has a unique identifier and stores the default country, currency, timezone along with name and description. Agencies are entities which own transaction data like permit applications. -
AgencyName(optional):
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(optional):
array Agency Options
Title:
Agency Options
The agencies resource is used to view, create or modify an agency. Agency has a unique identifier and stores the default country, currency, timezone along with name and description. Agencies are entities which own transaction data like permit applications. -
AssignmentOption(optional):
string
Maximum Length:
1
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(optional):
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(optional):
string
Title:
Created By
Maximum Length:64
The user who created the agency. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time the agency was created. -
CurrencyCode(optional):
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(optional):
string
Title:
Date Format
Maximum Length:30
Date format for the agency. Value is mandatory and the default is 'M/d/yy' like 1/31/99. -
Description(optional):
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(optional):
string
Title:
Create Subledger Accounting
Maximum Length:1
Indicates whether Financials Cloud Subledger Accounting is used to generate accounting for the agency. -
FinGLEnabled(optional):
boolean
Indicates whether accounting is to be created through Subledger Accounting for the agency.
-
HidePropertyOwner(optional):
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. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The last date and time the agency was updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the agency. -
LedgerId(optional):
integer(int64)
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(optional):
string
Maximum Length:
30
The name of the Fusion ledger. -
links(optional):
array Items
Title:
Items
Link Relations -
NumberFormat(optional):
string
Title:
Number Format
Maximum Length:30
Number format for the agency. Value is mandatory and the default is '#,##0.###', like -1,234.567. -
OPAPolicyId(optional):
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(optional):
string
Title:
Parcel Owner Format
Maximum Length:3
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'. -
PscGLEnabled(optional):
boolean
Indicates whether accounting is to be created within Public Sector Compliance and Regulation for the agency.
-
RuleIdEntity(optional):
string
Title:
Business Number Rule
Maximum Length:20
Autonumber rule used for generating a unique business entity ID for a business. -
RuleIdLicenseId(optional):
string
Title:
License Number Rule
Maximum Length:20
Autonumber rule used for generating a unique license ID for a business. -
RuleIdLocation(optional):
string
Title:
Location Number Rule
Maximum Length:20
Autonumber rule used for generating a unique business location ID for a business. -
RuleIdPolicyId(optional):
string
Title:
Insurance Policy Number Rule
Maximum Length:20
Autonumber rule used for generating a unique insurance policy ID for a business. -
TimeFormat(optional):
string
Title:
Time Format
Maximum Length:30
Time format for the agency. Value is mandatory and the default is 'h:mm a' like 1:30 PM. -
Tzname(optional):
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 agencies resource is used to view, create or modify an agency. Agency has a unique identifier and stores the default country, currency, timezone along with name and description. Agencies are entities which own transaction data like permit applications.
Show Source
Nested Schema : Agency Languages
Type:
array
Title:
Agency Languages
The agencies resource is used to view, create or modify an agency. Agency has a unique identifier and stores the default country, currency, timezone along with name and description. Agencies are entities which own transaction data like permit applications.
Show Source
Nested Schema : Agency Options
Type:
array
Title:
Agency Options
The agencies resource is used to view, create or modify an agency. Agency has a unique identifier and stores the default country, currency, timezone along with name and description. Agencies are entities which own transaction data like permit applications.
Show Source
Nested Schema : publicSectorAgencies-AgencyAddress-item
Type:
Show Source
object
-
Address1(optional):
string
Title:
Address
Maximum Length:240
The first address line of the agency address. -
Address2(optional):
string
Title:
Address
Maximum Length:240
The second address line of the agency address. -
Address3(optional):
string
Title:
Address
Maximum Length:240
The third address line of the agency address. -
Address4(optional):
string
Title:
Address
Maximum Length:240
The fourth address line of the agency address. -
AddressCode(optional):
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(optional):
integer(int64)
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(optional):
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(optional):
string
Title:
City
Maximum Length:60
The name of the city as part of the agency address. -
CountryCode(optional):
string
Title:
Country
Maximum Length:3
The name of the country as part of the agency address. -
CountyCodeIncits(optional):
string
Title:
County
Maximum Length:60
The name of the county as part of the agency address. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the agency address. -
CreationDate(optional):
string(date-time)
The date and time that the agency addess was created.
-
LastUpdateDate(optional):
string(date-time)
The last date and time that the agency address was updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the agency address. -
links(optional):
array Items
Title:
Items
Link Relations -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal code plus four as part of the agency address. -
PrimaryFlag(optional):
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(optional):
string
Title:
Province
Maximum Length:60
The name of the province as part of the agency address. -
State(optional):
string
Title:
State
Maximum Length:60
The name of the state as part of the agency address. -
ValidFromDate(optional):
string(date)
Title:
From Date
The first day that the address may be used. -
ValidToDate(optional):
string(date)
Title:
To Date
The last day that the address may be used. -
ZipCode(optional):
string
Title:
Postal Code
Maximum Length:60
The postal code as part of the agency address.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorAgencies-AgencyLang-item
Type:
Show Source
object
-
AgencyId(optional):
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(optional):
string
Maximum Length:
64
The user who created the agency language. -
CreationDate(optional):
string(date-time)
The date and time the agency language was created.
-
Description(optional):
string
Title:
Description
Maximum Length:30
The description of the language. -
LanguageCd(optional):
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(optional):
string(date-time)
The last date and time the agency language was updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the agency language. -
links(optional):
array Items
Title:
Items
Link Relations -
PrimaryFlag(optional):
string
Title:
Primary
Maximum Length:1
Indicates the language is the primary (base) language of the agency. -
ValidFromDate(optional):
string(date)
Title:
From Date
The first day the language may be used. -
ValidToDate(optional):
string(date)
Title:
To Date
The last day the language may be used.
Nested Schema : publicSectorAgencies-AgencyOptions-item
Type:
Show Source
object
-
AgencyId(optional):
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(optional):
string
Title:
Created By
Maximum Length:64
The user who created the agency option. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time the agency option was created. -
DestURL(optional):
string
Maximum Length:
254
A transient value calculated at runtime that fetches the jet path of the offering options page if it exists. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates whether the offering is enabled for the agency. A value of Y means the offering is enabled. Default value is Y. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The last date and time the agency option was updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the agency option. -
links(optional):
array Items
Title:
Items
Link Relations -
OfferingId(optional):
string
Title:
Offering
Maximum Length:80
The unique identifier of the product offering. -
OfferingName(optional):
string
Title:
Offering
Maximum Length:150
The name of the product offering. -
OptOffering(optional):
string
A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager.