Member Plan Years

Create MemberPlanYear

Creates a new MemberPlanYear

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
memberPlanYear_Key
required
integer <int32>

Unique identifier for each custom plany year for this member.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

plan_Year
required
string [ 1 .. 8 ] characters

Specifies the plan year associated with the selected Plan.

plan_Year_End
required
string <date-time>

Date when the plan year ends/ended.

plan_Year_Start
required
string <date-time>

Date when the plan year starts/started.

seq
required
integer <int32>

Sequence assigned to this Plan Year record within this configuration.

subscriber_ID
required
string [ 1 .. 9 ] characters

References Members.Subscriber_ID value on the parent record.

year
required
string [ 1 .. 4 ] characters

The calendar year associated with this Plan Year (used in instances where the plan year is not a calendar year).

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/members/{memberSeq}/plan-years
Request samples
{
  • "memberPlanYear_Key": 0,
  • "member_Seq": "st",
  • "plan_Year": "string",
  • "plan_Year_End": "2019-08-24T14:15:22Z",
  • "plan_Year_Start": "2019-08-24T14:15:22Z",
  • "seq": 0,
  • "subscriber_ID": "string",
  • "year": "stri"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberPlanYear

Lists all MemberPlanYear for the given subscriberID and memberSeq

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

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.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/members/{memberSeq}/plan-years
Request samples 
Response samples 
No sample
Get MemberPlanYear
Gets MemberPlanYear


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberPlanYearKey
required
integer <int32> 
MemberPlanYear Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/plan-years/{memberPlanYearKey}
Request samples 
Response samples 
No sample
Update MemberPlanYear
Updates a specific MemberPlanYear.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberPlanYearKey
required
integer <int32> 
MemberPlanYear Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
memberPlanYear_Key
required
integer <int32> 
Unique identifier for each custom plany year for this member.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq value on the parent record.


 
plan_Year
required
string  [ 1 .. 8 ] characters 
Specifies the plan year associated with the selected Plan.


 
plan_Year_End
required
string <date-time> 
Date when the plan year ends/ended.


 
plan_Year_Start
required
string <date-time> 
Date when the plan year starts/started.


 
seq
required
integer <int32> 
Sequence assigned to this Plan Year record within this configuration.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
year
required
string  [ 1 .. 4 ] characters 
The calendar year associated with this Plan Year (used in instances where the plan year is not a calendar year).


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/plan-years/{memberPlanYearKey}
Request samples 
{
  • "memberPlanYear_Key": 0,
  • "member_Seq": "st",
  • "plan_Year": "string",
  • "plan_Year_End": "2019-08-24T14:15:22Z",
  • "plan_Year_Start": "2019-08-24T14:15:22Z",
  • "seq": 0,
  • "subscriber_ID": "string",
  • "year": "stri"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberPlanYear
Deletes an MemberPlanYear


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberPlanYearKey
required
integer <int32> 
MemberPlanYear Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/plan-years/{memberPlanYearKey}
Request samples 
Create or Update Batch MemberPlanYear
Create or Update multiple MemberPlanYear 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
Subscriber ID


 
memberSeq
required
string
Member Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
memberPlanYear_Key
required
integer <int32> 
Unique identifier for each custom plany year for this member.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq value on the parent record.


 
plan_Year
required
string  [ 1 .. 8 ] characters 
Specifies the plan year associated with the selected Plan.


 
plan_Year_End
required
string <date-time> 
Date when the plan year ends/ended.


 
plan_Year_Start
required
string <date-time> 
Date when the plan year starts/started.


 
seq
required
integer <int32> 
Sequence assigned to this Plan Year record within this configuration.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
year
required
string  [ 1 .. 4 ] characters 
The calendar year associated with this Plan Year (used in instances where the plan year is not a calendar year).


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/plan-years-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}