Get a deposit account owner data
get
/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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 ID
Maximum Length:480
The unique alphanumeric identifier of the deposit account owner record. -
Address1: string
Title:
Address Line 1
Maximum Length:240
First address line of the owner address assigned to the deposit account. -
Address2: string
Title:
Address Line 2
Maximum Length:240
Second address line of the owner address assigned to the deposit account. -
Address3: string
Title:
Address Line 3
Maximum Length:240
Third address line of the owner address assigned to the deposit account. -
Address4: string
Title:
Address Line 4
Maximum Length:240
Fourth address line of the owner address assigned to the deposit account. -
City: string
Title:
City
Maximum Length:60
City of the owner address assigned to the deposit account. -
Comments: string
Title:
Comments
Maximum Length:480
Comments provided by user for change of ownership. -
Country: string
Title:
Country
Maximum Length:3
Country of the owner address assigned to the deposit account. -
County: string
Title:
County
Maximum Length:60
County 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:
30
The unique agency-defined alphanumeric identifier of the deposit account. -
DepositAccountPuid: string
Maximum Length:
480
The unique alphanumeric identifier of the deposit account record. -
DepositOwnershipKey: integer
(int64)
Title:
Ownership Key
The unique system-generated numeric identifier of an owner assigned to a deposit account. -
EmailAddress: string
Title:
Email Address
Maximum Length:320
Email identifier of the owner assigned to the deposit account. -
FirstName: string
Title:
First Name
Maximum Length:150
First name of the person assigned as owner to the deposit account. -
InactiveReasonCode: string
Title:
Inactive Reason Code
Maximum Length:30
Reason code provided by user for change of ownership. -
LastName: string
Title:
Last Name
Maximum Length:150
Last name of the person assigned as owner to the deposit account. -
LicenseHolderName: string
Title:
License Holder Name
Maximum Length:360
Name on the license provided to establish a deposit account. -
LicenseNumber: string
Title:
License Number
Maximum Length:30
The number of the license provided to establish a deposit account. -
LicenseType: string
Title:
License Type
Maximum Length:30
The type of the license provided to establish a deposit account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
Middle name of the person assigned as owner to the deposit account. -
MigratedDataFlag: string
Title:
Migrated Data
Read Only:true
Maximum Length:3
Default Value:N
Identifies whether the ownership record is migrated or not. -
OwnerName: string
Title:
Name
Maximum Length:360
Name of the person or business assigned as owner to the deposit account. -
PartyId: integer
(int64)
Title:
Owner Party ID
Identifier of the party assigned as owner to the deposit account. -
PartyType: string
Title:
Account Owner Type
Maximum Length:30
Identifies the type of the party assigned as owner to the deposit account. -
PhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:10
Phone area code of the owner assigned to the deposit account. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
Phone country code of the owner assigned to the deposit account. -
PhoneExtention: string
Title:
Phone Extension
Maximum Length:20
Phone extension code of the owner assigned to the deposit account. -
PhoneNumber: string
Title:
Phone Number
Maximum Length:40
Phone number of the owner assigned to the deposit account. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
Postal code of the owner address assigned to the deposit account. -
PostalPlus4Code: string
Title:
Postal Plus4 Code
Maximum Length:10
Extended postal code of the owner address assigned to the deposit account. -
PrimaryOwner: boolean
Title:
Primary Owner
Maximum Length:1
Identifies whether the owner is the primary owner or not. -
Province: string
Title:
Province
Maximum Length:60
Province of the owner address assigned to the deposit account. -
State: string
Title:
State
Maximum Length:60
State of the owner address assigned to the deposit account. -
ValidFromDate: string
(date-time)
Title:
Valid From
Identifies the start date of the ownership record. -
ValidToDate: string
(date-time)
Title:
Valid To
Identifies the end date of the ownership record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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.