Create an agency
post
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorAgencies-item
Type:
Show Source
object
-
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.
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
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
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
Nested Schema : publicSectorAgencies-AgencyAddress-item
Type:
Show Source
object
-
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
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorAgencies-AgencyLang-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
-
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
Nested Schema : publicSectorAgencies-AgencyOptions-item
Type:
Show Source
object
-
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
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorAgencies-item
Type:
Show Source
object
-
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.
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
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
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
Nested Schema : publicSectorAgencies-AgencyAddress-item
Type:
Show Source
object
-
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
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorAgencies-AgencyLang-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
-
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
Nested Schema : publicSectorAgencies-AgencyOptions-item
Type:
Show Source
object
-
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