Update a deposit account owner data
patch
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountOwner/{DepositOwnershipKey}
Request
Path Parameters
-
DepositAccountKey(required): integer(int64)
The unique system generated numeric identifier of the deposit account.
-
DepositOwnershipKey(required): integer(int64)
The unique system-generated numeric identifier of an owner assigned to a deposit account.
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
Root Schema : schema
Type:
Show Source
object-
Address1: string
Title:
Address Line 1Maximum Length:240First address line of the owner address assigned to the deposit account. -
Address2: string
Title:
Address Line 2Maximum Length:240Second address line of the owner address assigned to the deposit account. -
Address3: string
Title:
Address Line 3Maximum Length:240Third address line of the owner address assigned to the deposit account. -
Address4: string
Title:
Address Line 4Maximum Length:240Fourth address line of the owner address assigned to the deposit account. -
City: string
Title:
CityMaximum Length:60City of the owner address assigned to the deposit account. -
Comments: string
Title:
CommentsMaximum Length:480Comments provided by user for change of ownership. -
Country: string
Title:
CountryMaximum Length:3Country of the owner address assigned to the deposit account. -
County: string
Title:
CountyMaximum Length:60County of the owner address assigned to the deposit account. -
DepositAccountKey: integer
(int64)
The unique system generated numeric identifier of the deposit account.
-
EmailAddress: string
Title:
Email AddressMaximum Length:320Email identifier of the owner assigned to the deposit account. -
FirstName: string
Title:
First NameMaximum Length:150First name of the person assigned as owner to the deposit account. -
InactiveReasonCode: string
Title:
Inactive Reason CodeMaximum Length:30Reason code provided by user for change of ownership. -
LastName: string
Title:
Last NameMaximum Length:150Last name of the person assigned as owner to the deposit account. -
LicenseHolderName: string
Title:
License Holder NameMaximum Length:360Name on the license provided to establish a deposit account. -
LicenseNumber: string
Title:
License NumberMaximum Length:30The number of the license provided to establish a deposit account. -
LicenseType: string
Title:
License TypeMaximum Length:30The type of the license provided to establish a deposit account. -
MiddleName: string
Title:
Middle NameMaximum Length:60Middle name of the person assigned as owner to the deposit account. -
OwnerName: string
Title:
NameMaximum Length:360Name of the person or business assigned as owner to the deposit account. -
PartyId: integer
(int64)
Title:
Owner Party IDIdentifier of the party assigned as owner to the deposit account. -
PartyType: string
Title:
Account Owner TypeMaximum Length:30Identifies the type of the party assigned as owner to the deposit account. -
PhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:10Phone area code of the owner assigned to the deposit account. -
PhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10Phone country code of the owner assigned to the deposit account. -
PhoneExtention: string
Title:
Phone ExtensionMaximum Length:20Phone extension code of the owner assigned to the deposit account. -
PhoneNumber: string
Title:
Phone NumberMaximum Length:40Phone number of the owner assigned to the deposit account. -
PostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the owner address assigned to the deposit account. -
PostalPlus4Code: string
Title:
Postal Plus4 CodeMaximum Length:10Extended postal code of the owner address assigned to the deposit account. -
PrimaryOwner: boolean
Title:
Primary OwnerMaximum Length:1Identifies whether the owner is the primary owner or not. -
Province: string
Title:
ProvinceMaximum Length:60Province of the owner address assigned to the deposit account. -
State: string
Title:
StateMaximum Length:60State of the owner address assigned to the deposit account. -
ValidFromDate: string
(date-time)
Title:
Valid FromIdentifies the start date of the ownership record. -
ValidToDate: string
(date-time)
Title:
Valid ToIdentifies the end date of the ownership record.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorDepositAccounts-DepositAccountOwner-item-response
Type:
Show Source
object-
AccountOwnerPuid: string
Title:
Public Unique IDMaximum Length:480The unique alphanumeric identifier of the deposit account owner record. -
Address1: string
Title:
Address Line 1Maximum Length:240First address line of the owner address assigned to the deposit account. -
Address2: string
Title:
Address Line 2Maximum Length:240Second address line of the owner address assigned to the deposit account. -
Address3: string
Title:
Address Line 3Maximum Length:240Third address line of the owner address assigned to the deposit account. -
Address4: string
Title:
Address Line 4Maximum Length:240Fourth address line of the owner address assigned to the deposit account. -
City: string
Title:
CityMaximum Length:60City of the owner address assigned to the deposit account. -
Comments: string
Title:
CommentsMaximum Length:480Comments provided by user for change of ownership. -
Country: string
Title:
CountryMaximum Length:3Country of the owner address assigned to the deposit account. -
County: string
Title:
CountyMaximum Length:60County of the owner address assigned to the deposit account. -
DepositAccountKey: integer
(int64)
The unique system generated numeric identifier of the deposit account.
-
DepositAccountNumber: string
Maximum Length:
30The unique agency-defined alphanumeric identifier of the deposit account. -
DepositAccountPuid: string
Maximum Length:
480The unique alphanumeric identifier of the deposit account record. -
DepositOwnershipKey: integer
(int64)
Title:
Ownership KeyThe unique system-generated numeric identifier of an owner assigned to a deposit account. -
EmailAddress: string
Title:
Email AddressMaximum Length:320Email identifier of the owner assigned to the deposit account. -
FirstName: string
Title:
First NameMaximum Length:150First name of the person assigned as owner to the deposit account. -
InactiveReasonCode: string
Title:
Inactive Reason CodeMaximum Length:30Reason code provided by user for change of ownership. -
LastName: string
Title:
Last NameMaximum Length:150Last name of the person assigned as owner to the deposit account. -
LicenseHolderName: string
Title:
License Holder NameMaximum Length:360Name on the license provided to establish a deposit account. -
LicenseNumber: string
Title:
License NumberMaximum Length:30The number of the license provided to establish a deposit account. -
LicenseType: string
Title:
License TypeMaximum Length:30The type of the license provided to establish a deposit account. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MiddleName: string
Title:
Middle NameMaximum Length:60Middle name of the person assigned as owner to the deposit account. -
MigratedDataFlag: string
Title:
Migrated DataRead Only:trueMaximum Length:3Default Value:NIdentifies whether the ownership record is migrated or not. -
OwnerName: string
Title:
NameMaximum Length:360Name of the person or business assigned as owner to the deposit account. -
PartyId: integer
(int64)
Title:
Owner Party IDIdentifier of the party assigned as owner to the deposit account. -
PartyType: string
Title:
Account Owner TypeMaximum Length:30Identifies the type of the party assigned as owner to the deposit account. -
PhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:10Phone area code of the owner assigned to the deposit account. -
PhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10Phone country code of the owner assigned to the deposit account. -
PhoneExtention: string
Title:
Phone ExtensionMaximum Length:20Phone extension code of the owner assigned to the deposit account. -
PhoneNumber: string
Title:
Phone NumberMaximum Length:40Phone number of the owner assigned to the deposit account. -
PostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the owner address assigned to the deposit account. -
PostalPlus4Code: string
Title:
Postal Plus4 CodeMaximum Length:10Extended postal code of the owner address assigned to the deposit account. -
PrimaryOwner: boolean
Title:
Primary OwnerMaximum Length:1Identifies whether the owner is the primary owner or not. -
Province: string
Title:
ProvinceMaximum Length:60Province of the owner address assigned to the deposit account. -
State: string
Title:
StateMaximum Length:60State of the owner address assigned to the deposit account. -
ValidFromDate: string
(date-time)
Title:
Valid FromIdentifies the start date of the ownership record. -
ValidToDate: string
(date-time)
Title:
Valid ToIdentifies the end date of the ownership record.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.