Create a deposit account invited user
patch
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountAuthorizedUsers/{DepositApplicantKey}/child/DepositAccountAccess/{DepositPermissionKey}/child/DepositAccountUser/{publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id}
Request
Path Parameters
-
DepositApplicantKey(required): integer(int64)
The unique system-generated numeric identifier of the deposit account authorized user.
-
DepositPermissionKey(required): integer(int64)
The unique system-generated numeric identifier of the deposit account permission.
-
publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
AssignStatus: string
Title:
Status
Maximum Length:1
The status of the authorized user's assignment. -
DepositAccountAccess: array
Deposit Account User Access
Title:
Deposit Account User Access
The deposit account access resource is used to provide access to invited users for a deposit account. -
DepositAccountKey: integer
(int64)
The unique system-generated numeric identifier of the deposit account.
-
EmailAddress: string
Title:
Email Address
Maximum Length:320
The authorized user's email address. -
InvitedBy: string
Maximum Length:
30
Default Value:ORA_NONE
Indicates whether a person was invited by an owner or agency staff. -
OwnerFlag: string
Maximum Length:
1
Default Value:N
Indicates whether authorized user is owner of the deposit account. -
PartyId: integer
(int64)
Title:
Authorized User Party ID
The authorized user's party identifier. -
UserName: string
Title:
Name
Maximum Length:360
The name of the user eligible to access a deposit account record.
Nested Schema : Deposit Account User Access
Type:
array
Title:
Deposit Account User Access
The deposit account access resource is used to provide access to invited users for a deposit account.
Show Source
Nested Schema : publicSectorDepositAccountAuthorizedUsers-DepositAccountAccess-DepositAccountUser-DepositAccountAccess-item-patch-request
Type:
Show Source
object
-
AccessCode: string
Title:
Access Code
Maximum Length:30
Indicates an action the authorized user can perform for the deposit account. -
DepositAccountKey: integer
(int64)
The unique system-generated numeric identifier of the deposit account.
-
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether an action is enabled for the authorized user for the deposit account. -
PartyId: integer
(int64)
The party identifier of the authorized user.
-
UserName: string
Title:
Name
Maximum Length:360
The name of the user eligible to perform an action for a deposit account record.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorDepositAccountAuthorizedUsers-DepositAccountAccess-DepositAccountUser-item-response
Type:
Show Source
object
-
AssignStatus: string
Title:
Status
Maximum Length:1
The status of the authorized user's assignment. -
DepositAccountAccess: array
Deposit Account User Access
Title:
Deposit Account User Access
The deposit account access resource is used to provide access to invited users for a 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. -
DepositApplicantKey: integer
(int64)
The unique system-generated numeric identifier of the deposit account authorized user.
-
EmailAddress: string
Title:
Email Address
Maximum Length:320
The authorized user's email address. -
InvitedBy: string
Maximum Length:
30
Default Value:ORA_NONE
Indicates whether a person was invited by an owner or agency staff. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerFlag: string
Maximum Length:
1
Default Value:N
Indicates whether authorized user is owner of the deposit account. -
PartyId: integer
(int64)
Title:
Authorized User Party ID
The authorized user's party identifier. -
UserName: string
Title:
Name
Maximum Length:360
The name of the user eligible to access a deposit account record.
Nested Schema : Deposit Account User Access
Type:
array
Title:
Deposit Account User Access
The deposit account access resource is used to provide access to invited users for a deposit account.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorDepositAccountAuthorizedUsers-DepositAccountAccess-DepositAccountUser-DepositAccountAccess-item-response
Type:
Show Source
object
-
AccessCode: string
Title:
Access Code
Maximum Length:30
Indicates an action the authorized user can perform for 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. -
DepositApplicantKey: integer
(int64)
The unique system-generated numeric identifier of the deposit account authorized user.
-
DepositPermissionKey: integer
(int64)
The unique system-generated numeric identifier of the deposit account permission.
-
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether an action is enabled for the authorized user for the deposit account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
The party identifier of the authorized user.
-
UserName: string
Title:
Name
Maximum Length:360
The name of the user eligible to perform an action for a deposit account 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.
Links
- DepositAccountAccess
-
Parameters:
- DepositApplicantKey:
$request.path.DepositApplicantKey
- DepositPermissionKey:
$request.path.DepositPermissionKey
- publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id:
$request.path.publicSectorDepositAccountAuthorizedUsers_DepositAccountAccess_DepositAccountUser_Id
The deposit account access resource is used to provide access to invited users for a deposit account. - DepositApplicantKey: