1. REST API for Oracle Public Sector Compliance and Regulation Cloud
  2. Tasks
  3. Agencies

Get an agency

get

/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}

Request

Path Parameters
  • 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.
Query Parameters
  • 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>
  • 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).
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : publicSectorAgencies-item
Type: object
Show Source
  • Indicates whether accounting is enabled for the agency.
  • 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.
  • 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.
  • 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.
  • Title: Name
    Maximum Length: 100
    The name of the agency. Value is mandatory and is defined by the user during a create action.
  • 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.
  • 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.
  • 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.
  • Title: Created By
    Maximum Length: 64
    The user who created the agency.
  • Title: Creation Date
    The date and time the agency was created.
  • 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.
  • 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.
  • 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.
  • Title: Create Subledger Accounting
    Maximum Length: 1
    Indicates whether Financials Cloud Subledger Accounting is used to generate accounting for the agency.
  • Indicates whether accounting is to be created through Subledger Accounting for the agency.
  • 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.
  • Title: Last Updated Date
    The last date and time the agency was updated.
  • Title: Last Updated By
    Maximum Length: 64
    The user who last updated the agency.
  • 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.
  • Maximum Length: 30
    The name of the Fusion ledger.
  • Items
  • Title: Number Format
    Maximum Length: 30
    Number format for the agency. Value is mandatory and the default is '#,##0.###', like -1,234.567.
  • 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.
  • 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'.
  • Indicates whether accounting is to be created within Public Sector Compliance and Regulation for the agency.
  • 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.
  • 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: object
Show Source
Nested Schema : publicSectorAgencies-AgencyLang-item
Type: object
Show Source
Nested Schema : publicSectorAgencies-AgencyOptions-item
Type: object
Show Source
Back to Top