Member Alternate Payee Plan

Create MemberAlternatePayeePlan

Creates a new MemberAlternatePayeePlan

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberId
required
string

Subscriber ID

memberSeq
required
string

Member Seq

altPayeeId
required
string

Alternate Payee ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters
member_Seq
required
string [ 1 .. 2 ] characters
alternate_Payee_ID
required
string [ 1 .. 32 ] characters
plan_ID
required
string [ 1 .. 20 ] characters
entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberId}/members/{memberSeq}/alternate-payees/{altPayeeId}/plans
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "alternate_Payee_ID": "string",
  • "plan_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberAlternatePayeePlan

Lists all MemberAlternatePayeePlan for the given subscriberId and memberSeq and altPayeeId

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberId
required
string

Subscriber ID

memberSeq
required
string

Member Seq

altPayeeId
required
string

Alternate Payee ID

query Parameters
sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberId}/members/{memberSeq}/alternate-payees/{altPayeeId}/plans
Request samples 
Response samples 
No sample
Get MemberAlternatePayeePlan
Gets MemberAlternatePayeePlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberId
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
altPayeeId
required
string
Alternate Payee ID


 
planId
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberId}/members/{memberSeq}/alternate-payees/{altPayeeId}/plans/{planId}
Request samples 
Response samples 
No sample
Update MemberAlternatePayeePlan
Updates a specific MemberAlternatePayeePlan.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberId
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
altPayeeId
required
string
Alternate Payee ID


 
planId
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
 
member_Seq
required
string  [ 1 .. 2 ] characters 
 
alternate_Payee_ID
required
string  [ 1 .. 32 ] characters 
 
plan_ID
required
string  [ 1 .. 20 ] characters 
 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberId}/members/{memberSeq}/alternate-payees/{altPayeeId}/plans/{planId}
Request samples 
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "alternate_Payee_ID": "string",
  • "plan_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberAlternatePayeePlan
Deletes an MemberAlternatePayeePlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberId
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
altPayeeId
required
string
Alternate Payee ID


 
planId
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberId}/members/{memberSeq}/alternate-payees/{altPayeeId}/plans/{planId}
Request samples 
Create or Update Batch MemberAlternatePayeePlan
Create or Update multiple MemberAlternatePayeePlan at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberId
required
string
 
memberSeq
required
string
 
altPayeeId
required
string
 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
 
member_Seq
required
string  [ 1 .. 2 ] characters 
 
alternate_Payee_ID
required
string  [ 1 .. 32 ] characters 
 
plan_ID
required
string  [ 1 .. 20 ] characters 
 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberId}/members/{memberSeq}/alternate-payees/{altPayeeId}/plans-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}