Jump to

• Request
• Response

Update an agency

patch

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

Request

Path Parameters

• AgencyId(required): integer(int32)
  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.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyAddress: array Agency Addresses
  Title: Agency Addresses

  The agency addresses resource is used to view, create, or modify an agency address. An address represents the location information of an agency. There can be multiple addresses for an agency, each with its own start and end date. One address is identified as primary.
• AgencyLang: array Agency Languages
  Title: Agency Languages

  The agency languages resource is used to view, create, or modify the languages the agency supports.
• AgencyName: string
  Title: Name

  Maximum Length: 100

  The name of the agency. Value is mandatory and is defined by the user during a create action.
• AgencyOptions: array Agency Options
  Title: Agency Options

  The agency options resource is used to view and enable or disable product offerings as well as any optional features for an agency.
• AssignmentOption: string
  Maximum Length: 1

  Default Value: A

  Indicates whether the agency defines its own reference data or shares a common set of data. The only accepted value is A (Agency) at this time. Value is mandatory and system-assigned.
• CountryCode: string
  Title: Country

  Maximum Length: 3

  The country in which the agency is located. Value is mandatory and is defined by the user during a create action. A list of accepted values is defined in PSC_COM_COUNTRY_B.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 3

  The base currency in which the agency operates. Value is mandatory and is defined by the user during a create action. A list of accepted values is defined in PSC_COM_CURRENCY_B.
• DateFormat: string
  Title: Date Format

  Maximum Length: 30

  Default Value: M/d/yy

  Date format for the agency. Value is mandatory and the default is 'M/d/yy' like 1/31/99.
• DefaultInspectionDateFilter: string
  Title: Default Inspection Date Filter

  Maximum Length: 30

  The date range used by default to filter inspections. The default value is Today.
• DefaultInspectionDateTypeFilter: string
  Title: Default Inspection Date Type Filter

  Maximum Length: 30

  The type of date used by default to filter inspections. The default value is Requested.
• DefaultPlanReviewDateFilter: string
  Title: Default Plan Review Date Filter

  Maximum Length: 30

  Default Value: ORA_TDY

  The date range used by default to filter plan reviews. The default value is Today.
• DefaultPlanReviewDateTypeFilter: string
  Title: Default Plan Review Date Type Filter

  Maximum Length: 30

  Default Value: ORA_CYC_DUE

  The type of date used by default to filter plan reviews. The default value is Cycle Due.
• DefaultSearchFilter: string
  Title: Default Search Filter

  Maximum Length: 30

  The search filter used by default.
• DefaultSearchType: string
  Title: Default Search Type

  Maximum Length: 30

  The type of search used by default.
• Description: string
  Title: Description

  Maximum Length: 300

  The long description of the agency. Value is mandatory and is defined by the user when the agency is created.
• EnableFinGl: string
  Title: Create Subledger Accounting

  Maximum Length: 1

  Default Value: N

  Indicates whether Financials Cloud Subledger Accounting is used to generate accounting for the agency.
• ErrorNotificationEmail: string
  Title: Error Notification Email

  Maximum Length: 256

  Email address to notify in the event of an error.
• ErrorNotificationEnabled: boolean
  Title: Notify on Error

  Maximum Length: 1

  Default Value: false

  Indicates whether the error notification is enabled or not.
• HidePropertyOwner: string
  Maximum Length: 1

  Indicates whether or not the Owners tab of the Parcel page should be displayed to public users. Option is selected (hide) by default.
• InspectionCountLimit: integer (int32)
  Title: Inspection Count Limit

  Default Value: 20

  The limit of the total count of assigned inspections across both permits and business licenses.
• LedgerId: integer
  Title: Financials Cloud Ledger

  The Fusion ledger ID that contains accounting entries for the agency. Value is used and mandatory only if the Create Subledger Accounting option is selected.
• MaxActionRetryCount: integer (int32)
  Title: Automated Retry Limit

  Number of attempts the system will automatically retry for an action.
• MaxCopiesAllowed: integer (int32)
  Title: Maximum Copies Allowed

  The maximum copies allowed for the copy application.
• NumberFormat: string
  Title: Number Format

  Maximum Length: 30

  Default Value: #,##0.###

  Number format for the agency. Value is mandatory and the default is '#,##0.###', like -1,234.567.
• OPAPolicyId: string
  Title: Oracle Policy Automation ID

  Maximum Length: 150

  The unique identifier of the Oracle Policy Automation policy used by the agency. Value is entered by the user when the agency is created.
• ParcelOwnerFormat: string
  Title: Parcel Owner Format

  Maximum Length: 3

  Default Value: 1

  Indicates the preferred format for displaying parcel owner name. Accepted values are 1 (Use one field) and 2 (Use two fields) . The default value is '1'.
• PlanReviewSaturdaySundayFlag: boolean
  Title: Exclude Saturday and Sunday

  Maximum Length: 1

  Indicates whether Saturday and Sunday will be included in the plan review due date time rule calculations. Default value is N.
• RuleIdEntity: string
  Title: Business Number Rule

  Maximum Length: 20

  Autonumber rule used for generating a unique business entity ID for a business.
• RuleIdLicenseId: string
  Title: License Number Rule

  Maximum Length: 20

  Autonumber rule used for generating a unique license ID for a business.
• RuleIdLocation: string
  Title: Location Number Rule

  Maximum Length: 20

  Autonumber rule used for generating a unique business location ID for a business.
• RuleIdPolicyId: string
  Title: Insurance Policy Number Rule

  Maximum Length: 20

  Autonumber rule used for generating a unique insurance policy ID for a business.
• TimeFormat: string
  Title: Time Format

  Maximum Length: 30

  Default Value: h:mm a

  Time format for the agency. Value is mandatory and the default is 'h:mm a' like 1:30 PM.
• Tzname: string
  Title: Time Zone

  Maximum Length: 64

  The time zone the agency is located in. Value is mandatory and is defined by the user during a create action.

{
    "type":"object",
    "properties":{
        "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.",
            "nullable":false,
            "default":"A"
        },
        "Description":{
            "title":"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.",
            "nullable":true
        },
        "RuleIdLocation":{
            "title":"Location Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"Autonumber rule used for generating a unique business location ID for a business.",
            "nullable":true
        },
        "MaxActionRetryCount":{
            "title":"Automated Retry Limit",
            "type":"integer",
            "description":"Number of attempts the system will automatically retry for an action.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"3"
            }
        },
        "DefaultSearchType":{
            "title":"Default Search Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of search used by default.",
            "nullable":false
        },
        "PlanReviewSaturdaySundayFlag":{
            "title":"Exclude Saturday and Sunday",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether Saturday and Sunday will be included in the plan review due date time rule calculations. Default value is N.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "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.",
            "nullable":false
        },
        "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.",
            "nullable":true
        },
        "DefaultPlanReviewDateTypeFilter":{
            "title":"Default Plan Review Date Type Filter",
            "maxLength":"30",
            "type":"string",
            "description":"The type of date used by default to filter plan reviews. The default value is Cycle Due.",
            "nullable":false,
            "default":"ORA_CYC_DUE"
        },
        "DefaultInspectionDateTypeFilter":{
            "title":"Default Inspection Date Type Filter",
            "maxLength":"30",
            "type":"string",
            "description":"The type of date used by default to filter inspections. The default value is Requested.",
            "nullable":false
        },
        "AgencyOptions":{
            "title":"Agency Options",
            "type":"array",
            "description":"The agency options resource is used to view and enable or disable product offerings as well as any optional features for an agency.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAgencies-AgencyOptions-item-patch-request"
            }
        },
        "InspectionCountLimit":{
            "title":"Inspection Count Limit",
            "type":"integer",
            "description":"The limit of the total count of assigned inspections across both permits and business licenses.",
            "format":"int32",
            "nullable":false,
            "default":"20",
            "x-hints":{
                "precision":"4"
            }
        },
        "DefaultPlanReviewDateFilter":{
            "title":"Default Plan Review Date Filter",
            "maxLength":"30",
            "type":"string",
            "description":"The date range used by default to filter plan reviews. The default value is Today.",
            "nullable":false,
            "default":"ORA_TDY"
        },
        "RuleIdEntity":{
            "title":"Business Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"Autonumber rule used for generating a unique business entity ID for a business.",
            "nullable":true
        },
        "OPAPolicyId":{
            "title":"Oracle Policy Automation ID",
            "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.",
            "nullable":true
        },
        "ParcelOwnerFormat":{
            "title":"Parcel Owner Format",
            "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'.",
            "nullable":true,
            "default":"1"
        },
        "ErrorNotificationEmail":{
            "title":"Error Notification Email",
            "maxLength":"256",
            "type":"string",
            "description":"Email address to notify in the event of an error.",
            "nullable":true
        },
        "CountryCode":{
            "title":"Country",
            "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.",
            "nullable":false
        },
        "AgencyLang":{
            "title":"Agency Languages",
            "type":"array",
            "description":"The agency languages resource is used to view, create, or modify the languages the agency supports.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAgencies-AgencyLang-item-patch-request"
            }
        },
        "RuleIdPolicyId":{
            "title":"Insurance Policy Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"Autonumber rule used for generating a unique insurance policy ID for a business.",
            "nullable":true
        },
        "RuleIdLicenseId":{
            "title":"License Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"Autonumber rule used for generating a unique license ID for a business.",
            "nullable":true
        },
        "AgencyName":{
            "title":"Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the agency. Value is mandatory and is defined by the user during a create action.",
            "nullable":true
        },
        "TimeFormat":{
            "title":"Time Format",
            "maxLength":"30",
            "type":"string",
            "description":"Time format for the agency. Value is mandatory and the default is 'h:mm a' like 1:30 PM.",
            "nullable":false,
            "default":"h:mm a"
        },
        "DefaultSearchFilter":{
            "title":"Default Search Filter",
            "maxLength":"30",
            "type":"string",
            "description":"The search filter used by default.",
            "nullable":false
        },
        "LedgerId":{
            "title":"Financials Cloud Ledger",
            "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.",
            "nullable":true
        },
        "Tzname":{
            "title":"Time Zone",
            "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.",
            "nullable":false
        },
        "ErrorNotificationEnabled":{
            "title":"Notify on Error",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the error notification is enabled or not.",
            "nullable":true,
            "default":false
        },
        "AgencyAddress":{
            "title":"Agency Addresses",
            "type":"array",
            "description":"The agency addresses resource is used to view, create, or modify an agency address. An address represents the location information of an agency. There can be multiple addresses for an agency, each with its own start and end date. One address is identified as primary.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAgencies-AgencyAddress-item-patch-request"
            }
        },
        "EnableFinGl":{
            "title":"Create Subledger Accounting",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether Financials Cloud Subledger Accounting is used to generate accounting for the agency.",
            "nullable":false,
            "default":"N"
        },
        "DateFormat":{
            "title":"Date Format",
            "maxLength":"30",
            "type":"string",
            "description":"Date format for the agency. Value is mandatory and the default is 'M/d/yy' like 1/31/99.",
            "nullable":false,
            "default":"M/d/yy"
        },
        "MaxCopiesAllowed":{
            "title":"Maximum Copies Allowed",
            "type":"integer",
            "description":"The maximum copies allowed for the copy application.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"3"
            }
        },
        "DefaultInspectionDateFilter":{
            "title":"Default Inspection Date Filter",
            "maxLength":"30",
            "type":"string",
            "description":"The date range used by default to filter inspections. The default value is Today.",
            "nullable":false
        },
        "NumberFormat":{
            "title":"Number Format",
            "maxLength":"30",
            "type":"string",
            "description":"Number format for the agency. Value is mandatory and the default is '#,##0.###', like -1,234.567.",
            "nullable":false,
            "default":"#,##0.###"
        }
    }
}

Nested Schema : Agency Addresses

Type: array

Title: Agency Addresses

The agency addresses resource is used to view, create, or modify an agency address. An address represents the location information of an agency. There can be multiple addresses for an agency, each with its own start and end date. One address is identified as primary.

Show Source

• Array of: object schema

{
    "title":"Agency Addresses",
    "type":"array",
    "description":"The agency addresses resource is used to view, create, or modify an agency address. An address represents the location information of an agency. There can be multiple addresses for an agency, each with its own start and end date. One address is identified as primary.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAgencies-AgencyAddress-item-patch-request"
    }
}

Nested Schema : Agency Languages

Type: array

Title: Agency Languages

The agency languages resource is used to view, create, or modify the languages the agency supports.

Show Source

• Array of: object publicSectorAgencies-AgencyLang-item-patch-request

{
    "title":"Agency Languages",
    "type":"array",
    "description":"The agency languages resource is used to view, create, or modify the languages the agency supports.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAgencies-AgencyLang-item-patch-request"
    }
}

Nested Schema : Agency Options

Type: array

Title: Agency Options

The agency options resource is used to view and enable or disable product offerings as well as any optional features for an agency.

Show Source

• Array of: object schema

{
    "title":"Agency Options",
    "type":"array",
    "description":"The agency options resource is used to view and enable or disable product offerings as well as any optional features for an agency.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAgencies-AgencyOptions-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Address1: string
  Title: Address

  Maximum Length: 240

  The first address line of the agency address.
• Address2: string
  Title: Address

  Maximum Length: 240

  The second address line of the agency address.
• Address3: string
  Title: Address

  Maximum Length: 240

  The third address line of the agency address.
• Address4: string
  Title: Address

  Maximum Length: 240

  The fourth address line of the agency address.
• AddressCode: string
  Title: Address ID

  Maximum Length: 32

  The unique identifier of the address. Value is mandatory and is entered by the user when the address is created.
• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.
• CityName: string
  Title: City

  Maximum Length: 60

  The name of the city as part of the agency address.
• CountryCode: string
  Title: Country

  Maximum Length: 3

  The name of the country as part of the agency address.
• CountyCodeIncits: string
  Title: County

  Maximum Length: 60

  The name of the county as part of the agency address.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 10

  The postal code plus four as part of the agency address.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether the address is the primary address of the agency. A value of Y means the address is primary. Default value is N.
• Province: string
  Title: Province

  Maximum Length: 60

  The name of the province as part of the agency address.
• State: string
  Title: State

  Maximum Length: 60

  The name of the state as part of the agency address.
• ValidFromDate: string (date)
  Title: From Date

  The first day that the address may be used.
• ValidToDate: string (date)
  Title: To Date

  The last day that the address may be used.
• ZipCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code as part of the agency address.

{
    "type":"object",
    "properties":{
        "ValidToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The last day that the address may be used.",
            "format":"date",
            "nullable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "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.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "ZipCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code as part of the agency address.",
            "nullable":true
        },
        "Address2":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line of the agency address.",
            "nullable":true
        },
        "Address3":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The third address line of the agency address.",
            "nullable":true
        },
        "AddressCode":{
            "title":"Address ID",
            "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.",
            "nullable":false
        },
        "Address1":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The first address line of the agency address.",
            "nullable":true
        },
        "CityName":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city as part of the agency address.",
            "nullable":true
        },
        "CountyCodeIncits":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the county as part of the agency address.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province as part of the agency address.",
            "nullable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"10",
            "type":"string",
            "description":"The postal code plus four as part of the agency address.",
            "nullable":true
        },
        "Address4":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line of the agency address.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the state as part of the agency address.",
            "nullable":true
        },
        "ValidFromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The first day that the address may be used.",
            "format":"date",
            "nullable":false
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The name of the country as part of the agency address.",
            "nullable":false
        }
    }
}

Nested Schema : publicSectorAgencies-AgencyLang-item-patch-request

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 30

  The description of the language.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates the language is the primary (base) language of the agency.
• ValidFromDate: string (date)
  Title: From Date

  The first day the language may be used.
• ValidToDate: string (date)
  Title: To Date

  The last day the language may be used.

{
    "type":"object",
    "properties":{
        "ValidFromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The first day the language may be used.",
            "format":"date",
            "nullable":true
        },
        "ValidToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The last day the language may be used.",
            "format":"date",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the language is the primary (base) language of the agency.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"30",
            "type":"string",
            "description":"The description of the language.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the offering is enabled for the agency. A value of Y means the offering is enabled. The default value is Y for yes.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the offering is enabled for the agency. A value of Y means the offering is enabled. The default value is Y for yes.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorAgencies-item-response

Type: object

Show Source

• AccountEnabled: boolean
  Read Only: true

  Indicates whether accounting is enabled for the agency.
• AgencyAddress: array Agency Addresses
  Title: Agency Addresses

  The agency addresses resource is used to view, create, or modify an agency address. An address represents the location information of an agency. There can be multiple addresses for an agency, each with its own start and end date. One address is identified as primary.
• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.
• AgencyLang: array Agency Languages
  Title: Agency Languages

  The agency languages resource is used to view, create, or modify the languages the agency supports.
• AgencyName: string
  Title: Name

  Maximum Length: 100

  The name of the agency. Value is mandatory and is defined by the user during a create action.
• AgencyOptions: array Agency Options
  Title: Agency Options

  The agency options resource is used to view and enable or disable product offerings as well as any optional features for an agency.
• AssignmentOption: string
  Maximum Length: 1

  Default Value: A

  Indicates whether the agency defines its own reference data or shares a common set of data. The only accepted value is A (Agency) at this time. Value is mandatory and system-assigned.
• CountryCode: string
  Title: Country

  Maximum Length: 3

  The country in which the agency is located. Value is mandatory and is defined by the user during a create action. A list of accepted values is defined in PSC_COM_COUNTRY_B.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the agency.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the agency was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 3

  The base currency in which the agency operates. Value is mandatory and is defined by the user during a create action. A list of accepted values is defined in PSC_COM_CURRENCY_B.
• DateFormat: string
  Title: Date Format

  Maximum Length: 30

  Default Value: M/d/yy

  Date format for the agency. Value is mandatory and the default is 'M/d/yy' like 1/31/99.
• DefaultInspectionDateFilter: string
  Title: Default Inspection Date Filter

  Maximum Length: 30

  The date range used by default to filter inspections. The default value is Today.
• DefaultInspectionDateTypeFilter: string
  Title: Default Inspection Date Type Filter

  Maximum Length: 30

  The type of date used by default to filter inspections. The default value is Requested.
• DefaultPlanReviewDateFilter: string
  Title: Default Plan Review Date Filter

  Maximum Length: 30

  Default Value: ORA_TDY

  The date range used by default to filter plan reviews. The default value is Today.
• DefaultPlanReviewDateTypeFilter: string
  Title: Default Plan Review Date Type Filter

  Maximum Length: 30

  Default Value: ORA_CYC_DUE

  The type of date used by default to filter plan reviews. The default value is Cycle Due.
• DefaultSearchFilter: string
  Title: Default Search Filter

  Maximum Length: 30

  The search filter used by default.
• DefaultSearchType: string
  Title: Default Search Type

  Maximum Length: 30

  The type of search used by default.
• Description: string
  Title: Description

  Maximum Length: 300

  The long description of the agency. Value is mandatory and is defined by the user when the agency is created.
• EnableFinGl: string
  Title: Create Subledger Accounting

  Maximum Length: 1

  Default Value: N

  Indicates whether Financials Cloud Subledger Accounting is used to generate accounting for the agency.
• ErrorNotificationEmail: string
  Title: Error Notification Email

  Maximum Length: 256

  Email address to notify in the event of an error.
• ErrorNotificationEnabled: boolean
  Title: Notify on Error

  Maximum Length: 1

  Default Value: false

  Indicates whether the error notification is enabled or not.
• FinGLEnabled: boolean
  Read Only: true

  Indicates whether accounting is to be created through Subledger Accounting for the agency.
• HidePropertyOwner: string
  Maximum Length: 1

  Indicates whether or not the Owners tab of the Parcel page should be displayed to public users. Option is selected (hide) by default.
• InspectionCountLimit: integer (int32)
  Title: Inspection Count Limit

  Default Value: 20

  The limit of the total count of assigned inspections across both permits and business licenses.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The last date and time when the agency was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the agency.
• LedgerId: integer
  Title: Financials Cloud Ledger

  The Fusion ledger ID that contains accounting entries for the agency. Value is used and mandatory only if the Create Subledger Accounting option is selected.
• LedgerName: string
  Read Only: true

  Maximum Length: 30

  The name of the Fusion ledger.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaxActionRetryCount: integer (int32)
  Title: Automated Retry Limit

  Number of attempts the system will automatically retry for an action.
• MaxCopiesAllowed: integer (int32)
  Title: Maximum Copies Allowed

  The maximum copies allowed for the copy application.
• NumberFormat: string
  Title: Number Format

  Maximum Length: 30

  Default Value: #,##0.###

  Number format for the agency. Value is mandatory and the default is '#,##0.###', like -1,234.567.
• OPAPolicyId: string
  Title: Oracle Policy Automation ID

  Maximum Length: 150

  The unique identifier of the Oracle Policy Automation policy used by the agency. Value is entered by the user when the agency is created.
• ParcelOwnerFormat: string
  Title: Parcel Owner Format

  Maximum Length: 3

  Default Value: 1

  Indicates the preferred format for displaying parcel owner name. Accepted values are 1 (Use one field) and 2 (Use two fields) . The default value is '1'.
• PlanReviewSaturdaySundayFlag: boolean
  Title: Exclude Saturday and Sunday

  Maximum Length: 1

  Indicates whether Saturday and Sunday will be included in the plan review due date time rule calculations. Default value is N.
• PscGLEnabled: boolean
  Read Only: true

  Indicates whether accounting is to be created within Oracle Permitting and Licensing for the agency.
• RuleIdEntity: string
  Title: Business Number Rule

  Maximum Length: 20

  Autonumber rule used for generating a unique business entity ID for a business.
• RuleIdLicenseId: string
  Title: License Number Rule

  Maximum Length: 20

  Autonumber rule used for generating a unique license ID for a business.
• RuleIdLocation: string
  Title: Location Number Rule

  Maximum Length: 20

  Autonumber rule used for generating a unique business location ID for a business.
• RuleIdPolicyId: string
  Title: Insurance Policy Number Rule

  Maximum Length: 20

  Autonumber rule used for generating a unique insurance policy ID for a business.
• TimeFormat: string
  Title: Time Format

  Maximum Length: 30

  Default Value: h:mm a

  Time format for the agency. Value is mandatory and the default is 'h:mm a' like 1:30 PM.
• Tzname: string
  Title: Time Zone

  Maximum Length: 64

  The time zone the agency is located in. Value is mandatory and is defined by the user during a create action.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the agency was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "Description":{
            "title":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleIdLocation":{
            "title":"Location Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"Autonumber rule used for generating a unique business location ID for a business.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "SequenceName":"PSC_COM_AGENCY_B_S1",
                "precision":"8"
            },
            "x-queryable":true
        },
        "MaxActionRetryCount":{
            "title":"Automated Retry Limit",
            "type":"integer",
            "description":"Number of attempts the system will automatically retry for an action.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "DefaultSearchType":{
            "title":"Default Search Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of search used by default.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanReviewSaturdaySundayFlag":{
            "title":"Exclude Saturday and Sunday",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether Saturday and Sunday will be included in the plan review due date time rule calculations. Default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultPlanReviewDateTypeFilter":{
            "title":"Default Plan Review Date Type Filter",
            "maxLength":"30",
            "type":"string",
            "description":"The type of date used by default to filter plan reviews. The default value is Cycle Due.",
            "nullable":false,
            "default":"ORA_CYC_DUE",
            "x-queryable":true
        },
        "DefaultInspectionDateTypeFilter":{
            "title":"Default Inspection Date Type Filter",
            "maxLength":"30",
            "type":"string",
            "description":"The type of date used by default to filter inspections. The default value is Requested.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyOptions":{
            "title":"Agency Options",
            "type":"array",
            "description":"The agency options resource is used to view and enable or disable product offerings as well as any optional features for an agency.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAgencies-AgencyOptions-item-response"
            }
        },
        "InspectionCountLimit":{
            "title":"Inspection Count Limit",
            "type":"integer",
            "description":"The limit of the total count of assigned inspections across both permits and business licenses.",
            "format":"int32",
            "nullable":false,
            "default":"20",
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "DefaultPlanReviewDateFilter":{
            "title":"Default Plan Review Date Filter",
            "maxLength":"30",
            "type":"string",
            "description":"The date range used by default to filter plan reviews. The default value is Today.",
            "nullable":false,
            "default":"ORA_TDY",
            "x-queryable":true
        },
        "AccountEnabled":{
            "type":"boolean",
            "description":"Indicates whether accounting is enabled for the agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleIdEntity":{
            "title":"Business Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"Autonumber rule used for generating a unique business entity ID for a business.",
            "nullable":true,
            "x-queryable":true
        },
        "OPAPolicyId":{
            "title":"Oracle Policy Automation ID",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelOwnerFormat":{
            "title":"Parcel Owner Format",
            "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'.",
            "nullable":true,
            "default":"1",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FinGLEnabled":{
            "type":"boolean",
            "description":"Indicates whether accounting is to be created through Subledger Accounting for the agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorNotificationEmail":{
            "title":"Error Notification Email",
            "maxLength":"256",
            "type":"string",
            "description":"Email address to notify in the event of an error.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyLang":{
            "title":"Agency Languages",
            "type":"array",
            "description":"The agency languages resource is used to view, create, or modify the languages the agency supports.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAgencies-AgencyLang-item-response"
            }
        },
        "LedgerName":{
            "maxLength":"30",
            "type":"string",
            "description":"The name of the Fusion ledger.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleIdPolicyId":{
            "title":"Insurance Policy Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"Autonumber rule used for generating a unique insurance policy ID for a business.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleIdLicenseId":{
            "title":"License Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"Autonumber rule used for generating a unique license ID for a business.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the agency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyName":{
            "title":"Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the agency. Value is mandatory and is defined by the user during a create action.",
            "nullable":true,
            "x-queryable":true
        },
        "TimeFormat":{
            "title":"Time Format",
            "maxLength":"30",
            "type":"string",
            "description":"Time format for the agency. Value is mandatory and the default is 'h:mm a' like 1:30 PM.",
            "nullable":false,
            "default":"h:mm a",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the agency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultSearchFilter":{
            "title":"Default Search Filter",
            "maxLength":"30",
            "type":"string",
            "description":"The search filter used by default.",
            "nullable":false,
            "x-queryable":true
        },
        "LedgerId":{
            "title":"Financials Cloud Ledger",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "Tzname":{
            "title":"Time Zone",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorNotificationEnabled":{
            "title":"Notify on Error",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the error notification is enabled or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AgencyAddress":{
            "title":"Agency Addresses",
            "type":"array",
            "description":"The agency addresses resource is used to view, create, or modify an agency address. An address represents the location information of an agency. There can be multiple addresses for an agency, each with its own start and end date. One address is identified as primary.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAgencies-AgencyAddress-item-response"
            }
        },
        "EnableFinGl":{
            "title":"Create Subledger Accounting",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether Financials Cloud Subledger Accounting is used to generate accounting for the agency.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "DateFormat":{
            "title":"Date Format",
            "maxLength":"30",
            "type":"string",
            "description":"Date format for the agency. Value is mandatory and the default is 'M/d/yy' like 1/31/99.",
            "nullable":false,
            "default":"M/d/yy",
            "x-queryable":true
        },
        "MaxCopiesAllowed":{
            "title":"Maximum Copies Allowed",
            "type":"integer",
            "description":"The maximum copies allowed for the copy application.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "DefaultInspectionDateFilter":{
            "title":"Default Inspection Date Filter",
            "maxLength":"30",
            "type":"string",
            "description":"The date range used by default to filter inspections. The default value is Today.",
            "nullable":false,
            "x-queryable":true
        },
        "PscGLEnabled":{
            "type":"boolean",
            "description":"Indicates whether accounting is to be created within Oracle Permitting and Licensing for the agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last date and time when the agency was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberFormat":{
            "title":"Number Format",
            "maxLength":"30",
            "type":"string",
            "description":"Number format for the agency. Value is mandatory and the default is '#,##0.###', like -1,234.567.",
            "nullable":false,
            "default":"#,##0.###",
            "x-queryable":true
        }
    }
}

Nested Schema : Agency Addresses

Type: array

Title: Agency Addresses

The agency addresses resource is used to view, create, or modify an agency address. An address represents the location information of an agency. There can be multiple addresses for an agency, each with its own start and end date. One address is identified as primary.

Show Source

• Array of: object publicSectorAgencies-AgencyAddress-item-response

{
    "title":"Agency Addresses",
    "type":"array",
    "description":"The agency addresses resource is used to view, create, or modify an agency address. An address represents the location information of an agency. There can be multiple addresses for an agency, each with its own start and end date. One address is identified as primary.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAgencies-AgencyAddress-item-response"
    }
}

Nested Schema : Agency Languages

Type: array

Title: Agency Languages

The agency languages resource is used to view, create, or modify the languages the agency supports.

Show Source

• Array of: object publicSectorAgencies-AgencyLang-item-response

{
    "title":"Agency Languages",
    "type":"array",
    "description":"The agency languages resource is used to view, create, or modify the languages the agency supports.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAgencies-AgencyLang-item-response"
    }
}

Nested Schema : Agency Options

Type: array

Title: Agency Options

The agency options resource is used to view and enable or disable product offerings as well as any optional features for an agency.

Show Source

• Array of: object publicSectorAgencies-AgencyOptions-item-response

{
    "title":"Agency Options",
    "type":"array",
    "description":"The agency options resource is used to view and enable or disable product offerings as well as any optional features for an agency.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAgencies-AgencyOptions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorAgencies-AgencyAddress-item-response

Type: object

Show Source

• Address1: string
  Title: Address

  Maximum Length: 240

  The first address line of the agency address.
• Address2: string
  Title: Address

  Maximum Length: 240

  The second address line of the agency address.
• Address3: string
  Title: Address

  Maximum Length: 240

  The third address line of the agency address.
• Address4: string
  Title: Address

  Maximum Length: 240

  The fourth address line of the agency address.
• AddressCode: string
  Title: Address ID

  Maximum Length: 32

  The unique identifier of the address. Value is mandatory and is entered by the user when the address is created.
• AgencyAddressId: integer
  Title: Address ID

  The unique identifier of the address. Value is mandatory and is system-generated when the address is created. ID is not displayed to the user.
• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.
• CityName: string
  Title: City

  Maximum Length: 60

  The name of the city as part of the agency address.
• CountryCode: string
  Title: Country

  Maximum Length: 3

  The name of the country as part of the agency address.
• CountyCodeIncits: string
  Title: County

  Maximum Length: 60

  The name of the county as part of the agency address.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the agency address.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the agency address was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last date and time when the agency address was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the agency address.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 10

  The postal code plus four as part of the agency address.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether the address is the primary address of the agency. A value of Y means the address is primary. Default value is N.
• Province: string
  Title: Province

  Maximum Length: 60

  The name of the province as part of the agency address.
• State: string
  Title: State

  Maximum Length: 60

  The name of the state as part of the agency address.
• ValidFromDate: string (date)
  Title: From Date

  The first day that the address may be used.
• ValidToDate: string (date)
  Title: To Date

  The last day that the address may be used.
• ZipCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code as part of the agency address.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the agency address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the agency address was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The last day that the address may be used.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the agency address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ZipCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The third address line of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCode":{
            "title":"Address ID",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The first address line of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "CityName":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "CountyCodeIncits":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the county as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"10",
            "type":"string",
            "description":"The postal code plus four as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the state as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyAddressId":{
            "title":"Address ID",
            "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.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ValidFromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The first day that the address may be used.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The name of the country as part of the agency address.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last date and time when the agency address was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : publicSectorAgencies-AgencyLang-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the agency language.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the agency language was created.
• Description: string
  Title: Description

  Maximum Length: 30

  The description of the language.
• LanguageCd: string
  Title: Language

  Maximum Length: 4

  The unique identifier of a language that is supported by the agency. Value is mandatory and is defined by the user during a create action.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last date and time when the agency language was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the agency language.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates the language is the primary (base) language of the agency.
• ValidFromDate: string (date)
  Title: From Date

  The first day the language may be used.
• ValidToDate: string (date)
  Title: To Date

  The last day the language may be used.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the agency language.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the agency language was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The last day the language may be used.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the agency language.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the language is the primary (base) language of the agency.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"30",
            "type":"string",
            "description":"The description of the language.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "LanguageCd":{
            "title":"Language",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "ValidFromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The first day the language may be used.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last date and time when the agency language was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorAgencies-AgencyOptions-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the agency option.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the agency option was created.
• DestURL: string
  Read Only: true

  Maximum Length: 254

  A transient value calculated at runtime that fetches the jet path of the offering options page if it exists.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the offering is enabled for the agency. A value of Y means the offering is enabled. The default value is Y for yes.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The last date and time when the agency option was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the agency option.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OfferingId: string
  Title: Offering

  Maximum Length: 80

  The unique identifier of the product offering.
• OfferingName: string
  Title: Offering

  Read Only: true

  Maximum Length: 150

  The name of the product offering.
• OptOffering: string
  Read Only: true

  A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the agency option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the agency option was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the agency option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OptOffering":{
            "type":"string",
            "description":"A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferingName":{
            "title":"Offering",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the product offering.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the offering is enabled for the agency. A value of Y means the offering is enabled. The default value is Y for yes.",
            "nullable":false,
            "x-queryable":true
        },
        "OfferingId":{
            "title":"Offering",
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of the product offering.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last date and time when the agency option was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

AgencyAddress

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress

Parameters:

• AgencyId: $request.path.AgencyId

The agency addresses resource is used to view, create, or modify an agency address. An address represents the location information of an agency. There can be multiple addresses for an agency, each with its own start and end date. One address is identified as primary.

AgencyLang

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang

Parameters:

• AgencyId: $request.path.AgencyId

The agency languages resource is used to view, create, or modify the languages the agency supports.

AgencyOptions

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyOptions

Parameters:

• AgencyId: $request.path.AgencyId

The agency options resource is used to view and enable or disable product offerings as well as any optional features for an agency.

Back to Top