Create a set of deposit account user invite records
post
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountUserInvites
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DepositAccountKey: integer
(int64)
The unique system-generated numeric identifier of the deposit account.
-
DepositAccountNumber: string
Title:
Account Number
Maximum Length:30
The unique agency-defined alphanumeric identifier of the deposit account. -
EmailAddress: string
Title:
Email Address
Maximum Length:320
The email address of the person invited to access the deposit account. -
InvitedBy: string
Title:
Invitation Source
Maximum Length:20
Indicates whether a person was invited by an owner or agency staff. -
InviteKey: integer
(int64)
Title:
Invite Key
The unique system-generated numeric identifier of the deposit account user invite record. -
InviteStatus: string
Title:
Invite Status
Maximum Length:30
The status of the deposit account user invite record. -
UserAccess: string
Title:
User Access
Maximum Length:1000
The access being granted to the person invited to access the deposit account. -
UserName: string
Title:
User Name
Maximum Length:360
The name of the person invited to access the deposit account.
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 : publicSectorDepositAccountUserInvites-item-response
Type:
Show Source
object
-
DepositAccountKey: integer
(int64)
The unique system-generated numeric identifier of the deposit account.
-
DepositAccountNumber: string
Title:
Account Number
Maximum Length:30
The unique agency-defined alphanumeric identifier of the deposit account. -
EmailAddress: string
Title:
Email Address
Maximum Length:320
The email address of the person invited to access the deposit account. -
InvitedBy: string
Title:
Invitation Source
Maximum Length:20
Indicates whether a person was invited by an owner or agency staff. -
InviteKey: integer
(int64)
Title:
Invite Key
The unique system-generated numeric identifier of the deposit account user invite record. -
InviteStatus: string
Title:
Invite Status
Maximum Length:30
The status of the deposit account user invite record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UserAccess: string
Title:
User Access
Maximum Length:1000
The access being granted to the person invited to access the deposit account. -
UserName: string
Title:
User Name
Maximum Length:360
The name of the person invited to access 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.