(update an item of AgencyAddress)
patch
/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyAddress/{AgencyAddressUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
AgencyAddressUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and AgencyAddressId ---for the (AgencyAddress) resource and used to uniquely identify an instance of (AgencyAddress). The client should not generate the hash key value. Instead, the client should query on the (AgencyAddress) collection resource with a filter on the primary key values in order to navigate to a specific instance of (AgencyAddress).
For example: AgencyAddress?q=AgencyId=<value1>;AgencyAddressId=<value2> -
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
-
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.
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
-
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.