Jump to

• Request
• Response

Get a deposit account owner data

get

/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOwners/{DepositOwnershipKey}

Request

Path Parameters

• 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 Top

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.

Body ()

Root Schema : publicSectorDepositAccountOwners-item-response

Type: object

Show Source

• 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

  The first address line of the owner address assigned to the deposit account.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second address line of the owner address assigned to the deposit account.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address line of the owner address assigned to the deposit account.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address line of the owner address assigned to the deposit account.
• City: string
  Title: City

  Maximum Length: 60

  The city of the owner address assigned to the deposit account.
• Comments: string
  Title: Comments

  Maximum Length: 480

  The comments provided by the user for change of ownership.
• Country: string
  Title: Country

  Maximum Length: 3

  The country of the owner address assigned to the deposit account.
• County: string
  Title: County

  Maximum Length: 60

  The 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

  The email identifier of the owner assigned to the deposit account.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the person assigned as the owner to the deposit account.
• InactiveReasonCode: string
  Title: Inactive Reason Code

  Maximum Length: 30

  The reason code provided by the user for change of ownership.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the person assigned as the owner to the deposit account.
• LicenseHolderName: string
  Title: License Holder Name

  Maximum Length: 360

  The 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

  The middle name of the person assigned as the 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

  The name of the person or business assigned as the owner to the deposit account.
• PartyId: integer (int64)
  Title: Owner Party ID

  The identifier of the party assigned as the owner to the deposit account.
• PartyType: string
  Title: Account Owner Type

  Maximum Length: 30

  Identifies the type of the party assigned as the owner to the deposit account.
• PhoneAreaCode: string
  Title: Phone Area Code

  Maximum Length: 10

  The telephone area code of the owner assigned to the deposit account.
• PhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  The telephone country code of the owner assigned to the deposit account.
• PhoneExtention: string
  Title: Phone Extension

  Maximum Length: 20

  The telephone extension code of the owner assigned to the deposit account.
• PhoneNumber: string
  Title: Phone Number

  Maximum Length: 40

  The telephone number of the owner assigned to the deposit account.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the owner address assigned to the deposit account.
• PostalPlus4Code: string
  Title: Postal Plus4 Code

  Maximum Length: 10

  The 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

  The province of the owner address assigned to the deposit account.
• State: string
  Title: State

  Maximum Length: 60

  The 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.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "title":"Migrated Data",
            "maxLength":3,
            "type":"string",
            "description":"Identifies whether the ownership record is migrated or not.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the person or business assigned as the owner to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "LicenseNumber":{
            "title":"License Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the license provided to establish a deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the owner address assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system-generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhoneExtention":{
            "title":"Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The telephone extension code of the owner assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseType":{
            "title":"License Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the license provided to establish a deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositAccountPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique alphanumeric identifier of the deposit account record.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":10,
            "type":"string",
            "description":"The telephone area code of the owner assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The telephone country code of the owner assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "InactiveReasonCode":{
            "title":"Inactive Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"The reason code provided by the user for change of ownership.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositOwnershipKey":{
            "title":"Ownership Key",
            "type":"integer",
            "description":"The unique system-generated numeric identifier of an owner assigned to a deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AccountOwnerPuid":{
            "title":"Public Unique ID",
            "maxLength":480,
            "type":"string",
            "description":"The unique alphanumeric identifier of the deposit account owner record.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartyType":{
            "title":"Account Owner Type",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the type of the party assigned as the owner to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "LicenseHolderName":{
            "title":"License Holder Name",
            "maxLength":360,
            "type":"string",
            "description":"The name on the license provided to establish a deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidToDate":{
            "title":"Valid To",
            "type":"string",
            "description":"Identifies the end date of the ownership record.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person assigned as the owner to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":480,
            "type":"string",
            "description":"The comments provided by the user for change of ownership.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address line of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address line of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first address line of the owner address assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the owner address assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the person assigned as the owner to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email Address",
            "maxLength":320,
            "type":"string",
            "description":"The email identifier of the owner assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryOwner":{
            "title":"Primary Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Identifies whether the owner is the primary owner or not.",
            "nullable":false,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus4 Code",
            "maxLength":10,
            "type":"string",
            "description":"The extended postal code of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Owner Party ID",
            "type":"integer",
            "description":"The identifier of the party assigned as the owner to the deposit account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the owner address assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "ValidFromDate":{
            "title":"Valid From",
            "type":"string",
            "description":"Identifies the start date of the ownership record.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "description":"The country of the owner address assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The telephone number of the owner assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person assigned as the owner to the deposit account.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top