Jump to

• Request
• Response

Update an agency

patch

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

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• 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.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorAgencies-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AccountEnabled":{
            "type":"boolean",
            "description":"Indicates whether accounting is enabled for the agency."
        },
        "AgencyAddress":{
            "items":{
                "$ref":"#/definitions/publicSectorAgencies-AgencyAddress-item"
            },
            "type":"array",
            "description":"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 Addresses"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"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.",
            "title":"Agency ID"
        },
        "AgencyLang":{
            "items":{
                "$ref":"#/definitions/publicSectorAgencies-AgencyLang-item"
            },
            "type":"array",
            "description":"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 Languages"
        },
        "AgencyName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the agency. Value is mandatory and is defined by the user during a create action.",
            "title":"Name"
        },
        "AgencyOptions":{
            "items":{
                "$ref":"#/definitions/publicSectorAgencies-AgencyOptions-item"
            },
            "type":"array",
            "description":"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 Options"
        },
        "AssignmentOption":{
            "maxLength":1,
            "type":"string",
            "description":"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":{
            "maxLength":3,
            "type":"string",
            "description":"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":"Country"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the agency was created.",
            "title":"Creation Date"
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"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":"Currency"
        },
        "DateFormat":{
            "maxLength":30,
            "type":"string",
            "description":"Date format for the agency. Value is mandatory and the default is 'M/d/yy' like 1/31/99.",
            "title":"Date Format"
        },
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"The long description of the agency. Value is mandatory and is defined by the user when the agency is created.",
            "title":"Description"
        },
        "EnableFinGl":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether Financials Cloud Subledger Accounting is used to generate accounting for the agency.",
            "title":"Create Subledger Accounting"
        },
        "FinGLEnabled":{
            "type":"boolean",
            "description":"Indicates whether accounting is to be created through Subledger Accounting for the agency."
        },
        "HidePropertyOwner":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether or not the Owners tab of the Parcel page should be displayed to public users.  Option is selected (hide) by default."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time the agency was updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency.",
            "title":"Last Updated By"
        },
        "LedgerId":{
            "format":"int64",
            "type":"integer",
            "description":"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.",
            "title":"Financials Cloud Ledger"
        },
        "LedgerName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the Fusion ledger."
        },
        "NumberFormat":{
            "maxLength":30,
            "type":"string",
            "description":"Number format for the agency. Value is mandatory and the default is '#,##0.###', like -1,234.567.",
            "title":"Number Format"
        },
        "OPAPolicyId":{
            "maxLength":150,
            "type":"string",
            "description":"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":"Oracle Policy Automation ID"
        },
        "ParcelOwnerFormat":{
            "maxLength":3,
            "type":"string",
            "description":"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'.",
            "title":"Parcel Owner Format"
        },
        "PscGLEnabled":{
            "type":"boolean",
            "description":"Indicates whether accounting is to be created within Public Sector Compliance and Regulation for the agency."
        },
        "RuleIdEntity":{
            "maxLength":20,
            "type":"string",
            "description":"Autonumber rule used for generating a unique business entity ID for a business.",
            "title":"Business Number Rule"
        },
        "RuleIdLicenseId":{
            "maxLength":20,
            "type":"string",
            "description":"Autonumber rule used for generating a unique license ID for a business.",
            "title":"License Number Rule"
        },
        "RuleIdLocation":{
            "maxLength":20,
            "type":"string",
            "description":"Autonumber rule used for generating a unique business location ID for a business.",
            "title":"Location Number Rule"
        },
        "RuleIdPolicyId":{
            "maxLength":20,
            "type":"string",
            "description":"Autonumber rule used for generating a unique insurance policy ID for a business.",
            "title":"Insurance Policy Number Rule"
        },
        "TimeFormat":{
            "maxLength":30,
            "type":"string",
            "description":"Time format for the agency. Value is mandatory and the default is 'h:mm a' like 1:30 PM.",
            "title":"Time Format"
        },
        "Tzname":{
            "maxLength":64,
            "type":"string",
            "description":"The time zone the agency is located in. Value is mandatory and is defined by the user during a create action.",
            "title":"Time Zone"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

• Array of: object publicSectorAgencies-AgencyAddress-item

{
    "items":{
        "$ref":"#/definitions/publicSectorAgencies-AgencyAddress-item"
    },
    "type":"array",
    "description":"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 Addresses"
}

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

• Array of: object publicSectorAgencies-AgencyLang-item

{
    "items":{
        "$ref":"#/definitions/publicSectorAgencies-AgencyLang-item"
    },
    "type":"array",
    "description":"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 Languages"
}

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

• Array of: object publicSectorAgencies-AgencyOptions-item

{
    "items":{
        "$ref":"#/definitions/publicSectorAgencies-AgencyOptions-item"
    },
    "type":"array",
    "description":"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 Options"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorAgencies-AgencyAddress-item

Type: object

Show Source

• 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.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first address line of the agency address.",
            "title":"Address"
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second address line of the agency address.",
            "title":"Address"
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third address line of the agency address.",
            "title":"Address"
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line of the agency address.",
            "title":"Address"
        },
        "AddressCode":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the address. Value is mandatory and is entered by the user when the address is created.",
            "title":"Address ID"
        },
        "AgencyAddressId":{
            "format":"int64",
            "type":"integer",
            "description":"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.",
            "title":"Address ID"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"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.",
            "title":"Agency ID"
        },
        "CityName":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the city as part of the agency address.",
            "title":"City"
        },
        "CountryCode":{
            "maxLength":3,
            "type":"string",
            "description":"The name of the country as part of the agency address.",
            "title":"Country"
        },
        "CountyCodeIncits":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the county as part of the agency address.",
            "title":"County"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency address."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the agency addess was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the agency address was updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency address."
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The postal code plus four as part of the agency address.",
            "title":"Postal Plus 4 Code"
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the address is the primary address of the agency. A value of Y means the address is primary. Default value is N.",
            "title":"Primary"
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the province as part of the agency address.",
            "title":"Province"
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the state as part of the agency address.",
            "title":"State"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"The first day that the address may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"The last day that the address may be used.",
            "title":"To Date"
        },
        "ZipCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code as part of the agency address.",
            "title":"Postal Code"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorAgencies-AgencyLang-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"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.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency language."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the agency language was created."
        },
        "Description":{
            "maxLength":30,
            "type":"string",
            "description":"The description of the language.",
            "title":"Description"
        },
        "LanguageCd":{
            "maxLength":4,
            "type":"string",
            "description":"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.",
            "title":"Language"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time the agency language was updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency language."
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the language is the primary (base) language of the agency.",
            "title":"Primary"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"The first day the language may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"The last day the language may be used.",
            "title":"To Date"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorAgencies-AgencyOptions-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"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.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency option.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the agency option was created.",
            "title":"Creation Date"
        },
        "DestURL":{
            "maxLength":254,
            "type":"string",
            "description":"A transient value calculated at runtime that fetches the jet path of the offering options page if it exists."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the offering is enabled for the agency.  A value of Y means the offering is enabled.  Default value is Y.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time the agency option was updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency option.",
            "title":"Last Updated By"
        },
        "OfferingId":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the product offering.",
            "title":"Offering"
        },
        "OfferingName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the product offering.",
            "title":"Offering"
        },
        "OptOffering":{
            "type":"string",
            "description":"A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorAgencies-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AccountEnabled":{
            "type":"boolean",
            "description":"Indicates whether accounting is enabled for the agency."
        },
        "AgencyAddress":{
            "items":{
                "$ref":"#/definitions/publicSectorAgencies-AgencyAddress-item"
            },
            "type":"array",
            "description":"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 Addresses"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"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.",
            "title":"Agency ID"
        },
        "AgencyLang":{
            "items":{
                "$ref":"#/definitions/publicSectorAgencies-AgencyLang-item"
            },
            "type":"array",
            "description":"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 Languages"
        },
        "AgencyName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the agency. Value is mandatory and is defined by the user during a create action.",
            "title":"Name"
        },
        "AgencyOptions":{
            "items":{
                "$ref":"#/definitions/publicSectorAgencies-AgencyOptions-item"
            },
            "type":"array",
            "description":"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 Options"
        },
        "AssignmentOption":{
            "maxLength":1,
            "type":"string",
            "description":"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":{
            "maxLength":3,
            "type":"string",
            "description":"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":"Country"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the agency was created.",
            "title":"Creation Date"
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"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":"Currency"
        },
        "DateFormat":{
            "maxLength":30,
            "type":"string",
            "description":"Date format for the agency. Value is mandatory and the default is 'M/d/yy' like 1/31/99.",
            "title":"Date Format"
        },
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"The long description of the agency. Value is mandatory and is defined by the user when the agency is created.",
            "title":"Description"
        },
        "EnableFinGl":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether Financials Cloud Subledger Accounting is used to generate accounting for the agency.",
            "title":"Create Subledger Accounting"
        },
        "FinGLEnabled":{
            "type":"boolean",
            "description":"Indicates whether accounting is to be created through Subledger Accounting for the agency."
        },
        "HidePropertyOwner":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether or not the Owners tab of the Parcel page should be displayed to public users.  Option is selected (hide) by default."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time the agency was updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency.",
            "title":"Last Updated By"
        },
        "LedgerId":{
            "format":"int64",
            "type":"integer",
            "description":"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.",
            "title":"Financials Cloud Ledger"
        },
        "LedgerName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the Fusion ledger."
        },
        "NumberFormat":{
            "maxLength":30,
            "type":"string",
            "description":"Number format for the agency. Value is mandatory and the default is '#,##0.###', like -1,234.567.",
            "title":"Number Format"
        },
        "OPAPolicyId":{
            "maxLength":150,
            "type":"string",
            "description":"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":"Oracle Policy Automation ID"
        },
        "ParcelOwnerFormat":{
            "maxLength":3,
            "type":"string",
            "description":"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'.",
            "title":"Parcel Owner Format"
        },
        "PscGLEnabled":{
            "type":"boolean",
            "description":"Indicates whether accounting is to be created within Public Sector Compliance and Regulation for the agency."
        },
        "RuleIdEntity":{
            "maxLength":20,
            "type":"string",
            "description":"Autonumber rule used for generating a unique business entity ID for a business.",
            "title":"Business Number Rule"
        },
        "RuleIdLicenseId":{
            "maxLength":20,
            "type":"string",
            "description":"Autonumber rule used for generating a unique license ID for a business.",
            "title":"License Number Rule"
        },
        "RuleIdLocation":{
            "maxLength":20,
            "type":"string",
            "description":"Autonumber rule used for generating a unique business location ID for a business.",
            "title":"Location Number Rule"
        },
        "RuleIdPolicyId":{
            "maxLength":20,
            "type":"string",
            "description":"Autonumber rule used for generating a unique insurance policy ID for a business.",
            "title":"Insurance Policy Number Rule"
        },
        "TimeFormat":{
            "maxLength":30,
            "type":"string",
            "description":"Time format for the agency. Value is mandatory and the default is 'h:mm a' like 1:30 PM.",
            "title":"Time Format"
        },
        "Tzname":{
            "maxLength":64,
            "type":"string",
            "description":"The time zone the agency is located in. Value is mandatory and is defined by the user during a create action.",
            "title":"Time Zone"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

• Array of: object publicSectorAgencies-AgencyAddress-item

{
    "items":{
        "$ref":"#/definitions/publicSectorAgencies-AgencyAddress-item"
    },
    "type":"array",
    "description":"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 Addresses"
}

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

• Array of: object publicSectorAgencies-AgencyLang-item

{
    "items":{
        "$ref":"#/definitions/publicSectorAgencies-AgencyLang-item"
    },
    "type":"array",
    "description":"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 Languages"
}

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

• Array of: object publicSectorAgencies-AgencyOptions-item

{
    "items":{
        "$ref":"#/definitions/publicSectorAgencies-AgencyOptions-item"
    },
    "type":"array",
    "description":"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 Options"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorAgencies-AgencyAddress-item

Type: object

Show Source

• 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.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first address line of the agency address.",
            "title":"Address"
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second address line of the agency address.",
            "title":"Address"
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third address line of the agency address.",
            "title":"Address"
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line of the agency address.",
            "title":"Address"
        },
        "AddressCode":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the address. Value is mandatory and is entered by the user when the address is created.",
            "title":"Address ID"
        },
        "AgencyAddressId":{
            "format":"int64",
            "type":"integer",
            "description":"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.",
            "title":"Address ID"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"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.",
            "title":"Agency ID"
        },
        "CityName":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the city as part of the agency address.",
            "title":"City"
        },
        "CountryCode":{
            "maxLength":3,
            "type":"string",
            "description":"The name of the country as part of the agency address.",
            "title":"Country"
        },
        "CountyCodeIncits":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the county as part of the agency address.",
            "title":"County"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency address."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the agency addess was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the agency address was updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency address."
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The postal code plus four as part of the agency address.",
            "title":"Postal Plus 4 Code"
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the address is the primary address of the agency. A value of Y means the address is primary. Default value is N.",
            "title":"Primary"
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the province as part of the agency address.",
            "title":"Province"
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the state as part of the agency address.",
            "title":"State"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"The first day that the address may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"The last day that the address may be used.",
            "title":"To Date"
        },
        "ZipCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code as part of the agency address.",
            "title":"Postal Code"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorAgencies-AgencyLang-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"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.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency language."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the agency language was created."
        },
        "Description":{
            "maxLength":30,
            "type":"string",
            "description":"The description of the language.",
            "title":"Description"
        },
        "LanguageCd":{
            "maxLength":4,
            "type":"string",
            "description":"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.",
            "title":"Language"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time the agency language was updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency language."
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the language is the primary (base) language of the agency.",
            "title":"Primary"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"The first day the language may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"The last day the language may be used.",
            "title":"To Date"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorAgencies-AgencyOptions-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"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.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency option.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the agency option was created.",
            "title":"Creation Date"
        },
        "DestURL":{
            "maxLength":254,
            "type":"string",
            "description":"A transient value calculated at runtime that fetches the jet path of the offering options page if it exists."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the offering is enabled for the agency.  A value of Y means the offering is enabled.  Default value is Y.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time the agency option was updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency option.",
            "title":"Last Updated By"
        },
        "OfferingId":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the product offering.",
            "title":"Offering"
        },
        "OfferingName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the product offering.",
            "title":"Offering"
        },
        "OptOffering":{
            "type":"string",
            "description":"A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top