Create an agency address
post
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress
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.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorAgencies-AgencyAddress-item
Type:
Show Source
object
-
Address1(optional):
string
Title:
Address
Maximum Length:240
The first address line of the agency address. -
Address2(optional):
string
Title:
Address
Maximum Length:240
The second address line of the agency address. -
Address3(optional):
string
Title:
Address
Maximum Length:240
The third address line of the agency address. -
Address4(optional):
string
Title:
Address
Maximum Length:240
The fourth address line of the agency address. -
AddressCode(optional):
string
Title:
Address ID
Maximum Length:32
The unique identifier of the address. Value is mandatory and is entered by the user when the address is created. -
AgencyAddressId(optional):
integer(int64)
Title:
Address ID
The unique identifier of the address. Value is mandatory and is system-generated when the address is created. ID is not displayed to the user. -
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1. -
CityName(optional):
string
Title:
City
Maximum Length:60
The name of the city as part of the agency address. -
CountryCode(optional):
string
Title:
Country
Maximum Length:3
The name of the country as part of the agency address. -
CountyCodeIncits(optional):
string
Title:
County
Maximum Length:60
The name of the county as part of the agency address. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the agency address. -
CreationDate(optional):
string(date-time)
The date and time that the agency addess was created.
-
LastUpdateDate(optional):
string(date-time)
The last date and time that the agency address was updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the agency address. -
links(optional):
array Items
Title:
Items
Link Relations -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal code plus four as part of the agency address. -
PrimaryFlag(optional):
string
Title:
Primary
Maximum Length:1
Indicates whether the address is the primary address of the agency. A value of Y means the address is primary. Default value is N. -
Province(optional):
string
Title:
Province
Maximum Length:60
The name of the province as part of the agency address. -
State(optional):
string
Title:
State
Maximum Length:60
The name of the state as part of the agency address. -
ValidFromDate(optional):
string(date)
Title:
From Date
The first day that the address may be used. -
ValidToDate(optional):
string(date)
Title:
To Date
The last day that the address may be used. -
ZipCode(optional):
string
Title:
Postal Code
Maximum Length:60
The postal code as part of the agency address.
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.
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-AgencyAddress-item
Type:
Show Source
object
-
Address1(optional):
string
Title:
Address
Maximum Length:240
The first address line of the agency address. -
Address2(optional):
string
Title:
Address
Maximum Length:240
The second address line of the agency address. -
Address3(optional):
string
Title:
Address
Maximum Length:240
The third address line of the agency address. -
Address4(optional):
string
Title:
Address
Maximum Length:240
The fourth address line of the agency address. -
AddressCode(optional):
string
Title:
Address ID
Maximum Length:32
The unique identifier of the address. Value is mandatory and is entered by the user when the address is created. -
AgencyAddressId(optional):
integer(int64)
Title:
Address ID
The unique identifier of the address. Value is mandatory and is system-generated when the address is created. ID is not displayed to the user. -
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1. -
CityName(optional):
string
Title:
City
Maximum Length:60
The name of the city as part of the agency address. -
CountryCode(optional):
string
Title:
Country
Maximum Length:3
The name of the country as part of the agency address. -
CountyCodeIncits(optional):
string
Title:
County
Maximum Length:60
The name of the county as part of the agency address. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the agency address. -
CreationDate(optional):
string(date-time)
The date and time that the agency addess was created.
-
LastUpdateDate(optional):
string(date-time)
The last date and time that the agency address was updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the agency address. -
links(optional):
array Items
Title:
Items
Link Relations -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal code plus four as part of the agency address. -
PrimaryFlag(optional):
string
Title:
Primary
Maximum Length:1
Indicates whether the address is the primary address of the agency. A value of Y means the address is primary. Default value is N. -
Province(optional):
string
Title:
Province
Maximum Length:60
The name of the province as part of the agency address. -
State(optional):
string
Title:
State
Maximum Length:60
The name of the state as part of the agency address. -
ValidFromDate(optional):
string(date)
Title:
From Date
The first day that the address may be used. -
ValidToDate(optional):
string(date)
Title:
To Date
The last day that the address may be used. -
ZipCode(optional):
string
Title:
Postal Code
Maximum Length:60
The postal code as part of the agency address.
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.