Get a deposit account record data
get
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountRecords/{DepositRecordKey}
Request
Path Parameters
-
DepositRecordKey(required): integer(int64)
The unique system-generated numeric identifier of a transaction assigned to the 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 : publicSectorDepositAccountRecords-item-response
Type:
Show Source
object
-
AllRecords: string
Title:
All Records
Maximum Length:1
The value that identifies whether the transaction association applies to all records. -
AllRecordsDesc: string
Read Only:
true
Maximum Length:80
Describes the value that identifies whether the transaction association applies to all records. -
AssignStatus: string
Title:
Assign Status
Maximum Length:1
The status of the transaction's assignment to the deposit account. -
AssignStatusDesc: string
Read Only:
true
Maximum Length:80
Describes the status of the transaction's assignment to the deposit account. -
Classification: string
Title:
Classification
Maximum Length:3
The reason code provided by the user for change of ownership. -
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. -
DepositRecordKey: integer
(int64)
Title:
Transaction Key
The unique system-generated numeric identifier of a transaction assigned to the deposit account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryAccount: string
Title:
Primary Account
Maximum Length:1
Indicates whether the deposit account is the primary account for the transaction. -
PrimaryAccountDesc: string
Read Only:
true
Maximum Length:80
Describes whether the deposit account is the primary account for the transaction. The default value is Y. -
RecordType: string
Read Only:
true
Maximum Length:100
The unique record type assigned to the deposit account. -
RecordTypeId: string
Title:
Transaction Type ID
Maximum Length:50
The unique record type identifier assigned to the deposit account. -
SourceRecordId: string
Title:
Transaction ID
Maximum Length:50
The user-friendly record identifier assigned to the deposit account. -
SourceRecordKey: integer
(int64)
Title:
Source Record Key
The key of the source record assigned to the deposit account.
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.