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

• AgencyAddress(optional): array (AgencyAddress)
  Title: (AgencyAddress)

  The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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 (AgencyLang)
  Title: (AgencyLang)

  The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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 (AgencyOptions)
  Title: (AgencyOptions)

  The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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 that 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

  The format for displaying date for the agency. Value is mandatory and the default value is m/dd/yy, for example, 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 during a create action.
• EnableFinGl(optional): string
  Title: Create Subledger Accounting

  Maximum Length: 1
• FinGLEnabled(optional): boolean
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The last date and time that 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
• LedgerName(optional): string
  Maximum Length: 30
• links(optional): array Items
  Title: Items

  Link Relations
• NumberFormat(optional): string
  Title: Number Format

  Maximum Length: 30

  The format for displaying number for the agency. Value is mandatory and the default value is #,##0.###, for example, -1,234.567.
• 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.
• TimeFormat(optional): string
  Title: Time Format

  Maximum Length: 30

  The format for displaying time for the agency. Value is mandatory and the default value is h:mm a, for example, 1:30 PM.
• Tzname(optional): string
  Title: Time Zone

  Maximum Length: 64

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

{
    "properties":{
        "AgencyAddress":{
            "items":{
                "$ref":"#/definitions/publicSectorAgencies-AgencyAddress-item"
            },
            "type":"array",
            "description":"The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
            "title":"(AgencyAddress)"
        },
        "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. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
            "title":"(AgencyLang)"
        },
        "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. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
            "title":"(AgencyOptions)"
        },
        "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 that 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":"The format for displaying date for the agency. Value is mandatory and the default value is m/dd/yy, for example, 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 during a create action.",
            "title":"Description"
        },
        "EnableFinGl":{
            "maxLength":1,
            "type":"string",
            "description":"",
            "title":"Create Subledger Accounting"
        },
        "FinGLEnabled":{
            "type":"boolean",
            "description":""
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that 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":"",
            "title":"Financials Cloud Ledger"
        },
        "LedgerName":{
            "maxLength":30,
            "type":"string",
            "description":""
        },
        "NumberFormat":{
            "maxLength":30,
            "type":"string",
            "description":"The format for displaying number for the agency. Value is mandatory and the default value is #,##0.###, for example, -1,234.567.",
            "title":"Number Format"
        },
        "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"
        },
        "TimeFormat":{
            "maxLength":30,
            "type":"string",
            "description":"The format for displaying time for the agency. Value is mandatory and the default value is h:mm a, for example, 1:30 PM.",
            "title":"Time Format"
        },
        "Tzname":{
            "maxLength":64,
            "type":"string",
            "description":"The time zone in which the agency is located. 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 : (AgencyAddress)

Type: array

Title: (AgencyAddress)

The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
    "title":"(AgencyAddress)"
}

Nested Schema : (AgencyLang)

Type: array

Title: (AgencyLang)

The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
    "title":"(AgencyLang)"
}

Nested Schema : (AgencyOptions)

Type: array

Title: (AgencyOptions)

The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
    "title":"(AgencyOptions)"
}

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
• Address2(optional): string
  Title: Address

  Maximum Length: 240
• Address3(optional): string
  Title: Address

  Maximum Length: 240
• Address4(optional): string
  Title: Address

  Maximum Length: 240
• AddressCode(optional): string
  Title: Address ID

  Maximum Length: 32
• AgencyAddressId(optional): integer(int64)
  Title: Address ID
• AgencyId(optional): integer(int32)
  Title: Agency ID
• CityName(optional): string
  Title: City

  Maximum Length: 60
• CountryCode(optional): string
  Title: Country

  Maximum Length: 3
• CountyCodeIncits(optional): string
  Title: County

  Maximum Length: 60
• CreatedBy(optional): string
  Maximum Length: 64
• CreationDate(optional): string(date-time)
• LastUpdateDate(optional): string(date-time)
• LastUpdatedBy(optional): string
  Maximum Length: 64
• links(optional): array Items
  Title: Items

  Link Relations
• PostalPlus4Code(optional): string
  Maximum Length: 10
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1
• Province(optional): string
  Maximum Length: 60
• State(optional): string
  Title: State

  Maximum Length: 60
• ValidFromDate(optional): string(date)
  Title: From Date
• ValidToDate(optional): string(date)
  Title: To Date
• ZipCode(optional): string
  Maximum Length: 60

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"",
            "title":"Address"
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"",
            "title":"Address"
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"",
            "title":"Address"
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"",
            "title":"Address"
        },
        "AddressCode":{
            "maxLength":32,
            "type":"string",
            "description":"",
            "title":"Address ID"
        },
        "AgencyAddressId":{
            "format":"int64",
            "type":"integer",
            "description":"",
            "title":"Address ID"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"",
            "title":"Agency ID"
        },
        "CityName":{
            "maxLength":60,
            "type":"string",
            "description":"",
            "title":"City"
        },
        "CountryCode":{
            "maxLength":3,
            "type":"string",
            "description":"",
            "title":"Country"
        },
        "CountyCodeIncits":{
            "maxLength":60,
            "type":"string",
            "description":"",
            "title":"County"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":""
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":""
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":""
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":""
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":""
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"",
            "title":"Primary"
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":""
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"",
            "title":"State"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"",
            "title":"To Date"
        },
        "ZipCode":{
            "maxLength":60,
            "type":"string",
            "description":""
        },
        "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
• CreatedBy(optional): string
  Maximum Length: 64
• CreationDate(optional): string(date-time)
• Description(optional): string
  Title: Primary

  Maximum Length: 30
• LanguageCd(optional): string
  Title: Language

  Maximum Length: 4
• LastUpdateDate(optional): string(date-time)
• LastUpdatedBy(optional): string
  Maximum Length: 64
• links(optional): array Items
  Title: Items

  Link Relations
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1
• ValidFromDate(optional): string(date)
  Title: From Date
• ValidToDate(optional): string(date)
  Title: To Date

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":""
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":""
        },
        "Description":{
            "maxLength":30,
            "type":"string",
            "description":"",
            "title":"Primary"
        },
        "LanguageCd":{
            "maxLength":4,
            "type":"string",
            "description":"",
            "title":"Language"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":""
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":""
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"",
            "title":"Primary"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"",
            "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
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64
• CreationDate(optional): string(date-time)
  Title: Creation Date
• DestURL(optional): string
  Maximum Length: 254
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64
• links(optional): array Items
  Title: Items

  Link Relations
• OfferingId(optional): string
  Title: Offering

  Maximum Length: 80
• OfferingName(optional): string
  Title: Offering

  Maximum Length: 150
• OptOffering(optional): string

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"",
            "title":"Creation Date"
        },
        "DestURL":{
            "maxLength":254,
            "type":"string",
            "description":""
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"",
            "title":"Last Updated By"
        },
        "OfferingId":{
            "maxLength":80,
            "type":"string",
            "description":"",
            "title":"Offering"
        },
        "OfferingName":{
            "maxLength":150,
            "type":"string",
            "description":"",
            "title":"Offering"
        },
        "OptOffering":{
            "type":"string",
            "description":""
        },
        "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

• AgencyAddress(optional): array (AgencyAddress)
  Title: (AgencyAddress)

  The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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 (AgencyLang)
  Title: (AgencyLang)

  The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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 (AgencyOptions)
  Title: (AgencyOptions)

  The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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 that 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

  The format for displaying date for the agency. Value is mandatory and the default value is m/dd/yy, for example, 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 during a create action.
• EnableFinGl(optional): string
  Title: Create Subledger Accounting

  Maximum Length: 1
• FinGLEnabled(optional): boolean
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The last date and time that 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
• LedgerName(optional): string
  Maximum Length: 30
• links(optional): array Items
  Title: Items

  Link Relations
• NumberFormat(optional): string
  Title: Number Format

  Maximum Length: 30

  The format for displaying number for the agency. Value is mandatory and the default value is #,##0.###, for example, -1,234.567.
• 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.
• TimeFormat(optional): string
  Title: Time Format

  Maximum Length: 30

  The format for displaying time for the agency. Value is mandatory and the default value is h:mm a, for example, 1:30 PM.
• Tzname(optional): string
  Title: Time Zone

  Maximum Length: 64

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

{
    "properties":{
        "AgencyAddress":{
            "items":{
                "$ref":"#/definitions/publicSectorAgencies-AgencyAddress-item"
            },
            "type":"array",
            "description":"The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
            "title":"(AgencyAddress)"
        },
        "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. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
            "title":"(AgencyLang)"
        },
        "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. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
            "title":"(AgencyOptions)"
        },
        "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 that 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":"The format for displaying date for the agency. Value is mandatory and the default value is m/dd/yy, for example, 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 during a create action.",
            "title":"Description"
        },
        "EnableFinGl":{
            "maxLength":1,
            "type":"string",
            "description":"",
            "title":"Create Subledger Accounting"
        },
        "FinGLEnabled":{
            "type":"boolean",
            "description":""
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that 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":"",
            "title":"Financials Cloud Ledger"
        },
        "LedgerName":{
            "maxLength":30,
            "type":"string",
            "description":""
        },
        "NumberFormat":{
            "maxLength":30,
            "type":"string",
            "description":"The format for displaying number for the agency. Value is mandatory and the default value is #,##0.###, for example, -1,234.567.",
            "title":"Number Format"
        },
        "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"
        },
        "TimeFormat":{
            "maxLength":30,
            "type":"string",
            "description":"The format for displaying time for the agency. Value is mandatory and the default value is h:mm a, for example, 1:30 PM.",
            "title":"Time Format"
        },
        "Tzname":{
            "maxLength":64,
            "type":"string",
            "description":"The time zone in which the agency is located. 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 : (AgencyAddress)

Type: array

Title: (AgencyAddress)

The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
    "title":"(AgencyAddress)"
}

Nested Schema : (AgencyLang)

Type: array

Title: (AgencyLang)

The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
    "title":"(AgencyLang)"
}

Nested Schema : (AgencyOptions)

Type: array

Title: (AgencyOptions)

The agencies resource is used to view, create or modify an agency. An agency has a unique identifier and stores the default country, currency, time zone, 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. An agency has a unique identifier and stores the default country, currency, time zone, along with name and description. Agencies are entities which own transaction data like permit applications.",
    "title":"(AgencyOptions)"
}

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
• Address2(optional): string
  Title: Address

  Maximum Length: 240
• Address3(optional): string
  Title: Address

  Maximum Length: 240
• Address4(optional): string
  Title: Address

  Maximum Length: 240
• AddressCode(optional): string
  Title: Address ID

  Maximum Length: 32
• AgencyAddressId(optional): integer(int64)
  Title: Address ID
• AgencyId(optional): integer(int32)
  Title: Agency ID
• CityName(optional): string
  Title: City

  Maximum Length: 60
• CountryCode(optional): string
  Title: Country

  Maximum Length: 3
• CountyCodeIncits(optional): string
  Title: County

  Maximum Length: 60
• CreatedBy(optional): string
  Maximum Length: 64
• CreationDate(optional): string(date-time)
• LastUpdateDate(optional): string(date-time)
• LastUpdatedBy(optional): string
  Maximum Length: 64
• links(optional): array Items
  Title: Items

  Link Relations
• PostalPlus4Code(optional): string
  Maximum Length: 10
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1
• Province(optional): string
  Maximum Length: 60
• State(optional): string
  Title: State

  Maximum Length: 60
• ValidFromDate(optional): string(date)
  Title: From Date
• ValidToDate(optional): string(date)
  Title: To Date
• ZipCode(optional): string
  Maximum Length: 60

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"",
            "title":"Address"
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"",
            "title":"Address"
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"",
            "title":"Address"
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"",
            "title":"Address"
        },
        "AddressCode":{
            "maxLength":32,
            "type":"string",
            "description":"",
            "title":"Address ID"
        },
        "AgencyAddressId":{
            "format":"int64",
            "type":"integer",
            "description":"",
            "title":"Address ID"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"",
            "title":"Agency ID"
        },
        "CityName":{
            "maxLength":60,
            "type":"string",
            "description":"",
            "title":"City"
        },
        "CountryCode":{
            "maxLength":3,
            "type":"string",
            "description":"",
            "title":"Country"
        },
        "CountyCodeIncits":{
            "maxLength":60,
            "type":"string",
            "description":"",
            "title":"County"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":""
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":""
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":""
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":""
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":""
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"",
            "title":"Primary"
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":""
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"",
            "title":"State"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"",
            "title":"To Date"
        },
        "ZipCode":{
            "maxLength":60,
            "type":"string",
            "description":""
        },
        "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
• CreatedBy(optional): string
  Maximum Length: 64
• CreationDate(optional): string(date-time)
• Description(optional): string
  Title: Primary

  Maximum Length: 30
• LanguageCd(optional): string
  Title: Language

  Maximum Length: 4
• LastUpdateDate(optional): string(date-time)
• LastUpdatedBy(optional): string
  Maximum Length: 64
• links(optional): array Items
  Title: Items

  Link Relations
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1
• ValidFromDate(optional): string(date)
  Title: From Date
• ValidToDate(optional): string(date)
  Title: To Date

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":""
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":""
        },
        "Description":{
            "maxLength":30,
            "type":"string",
            "description":"",
            "title":"Primary"
        },
        "LanguageCd":{
            "maxLength":4,
            "type":"string",
            "description":"",
            "title":"Language"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":""
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":""
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"",
            "title":"Primary"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"",
            "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
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64
• CreationDate(optional): string(date-time)
  Title: Creation Date
• DestURL(optional): string
  Maximum Length: 254
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64
• links(optional): array Items
  Title: Items

  Link Relations
• OfferingId(optional): string
  Title: Offering

  Maximum Length: 80
• OfferingName(optional): string
  Title: Offering

  Maximum Length: 150
• OptOffering(optional): string

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"",
            "title":"Creation Date"
        },
        "DestURL":{
            "maxLength":254,
            "type":"string",
            "description":""
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"",
            "title":"Last Updated By"
        },
        "OfferingId":{
            "maxLength":80,
            "type":"string",
            "description":"",
            "title":"Offering"
        },
        "OfferingName":{
            "maxLength":150,
            "type":"string",
            "description":"",
            "title":"Offering"
        },
        "OptOffering":{
            "type":"string",
            "description":""
        },
        "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