Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "InvitedBy":{
            "title":"Invitation Source",
            "maxLength":"20",
            "type":"string",
            "description":"Indicates whether a person was invited by an owner or agency staff.",
            "nullable":false
        },
        "InviteStatus":{
            "title":"Invite Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the deposit account user invite record.",
            "nullable":false
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the person invited to access the deposit account.",
            "nullable":false
        },
        "InviteKey":{
            "title":"Invite Key",
            "type":"integer",
            "description":"The unique system-generated numeric identifier of the deposit account user invite record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DepositAccountNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":false
        },
        "UserAccess":{
            "title":"User Access",
            "maxLength":"1000",
            "type":"string",
            "description":"The access being granted to the person invited to access the deposit account.",
            "nullable":false
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system-generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EmailAddress":{
            "title":"Email Address",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the person invited to access the deposit account.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorDepositAccountUserInvites-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "InvitedBy":{
            "title":"Invitation Source",
            "maxLength":"20",
            "type":"string",
            "description":"Indicates whether a person was invited by an owner or agency staff.",
            "nullable":false,
            "x-queryable":true
        },
        "InviteStatus":{
            "title":"Invite Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the deposit account user invite record.",
            "nullable":false,
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the person invited to access the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "InviteKey":{
            "title":"Invite Key",
            "type":"integer",
            "description":"The unique system-generated numeric identifier of the deposit account user invite record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "UserAccess":{
            "title":"User Access",
            "maxLength":"1000",
            "type":"string",
            "description":"The access being granted to the person invited to access the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "EmailAddress":{
            "title":"Email Address",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the person invited to access the deposit account.",
            "nullable":false,
            "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