Member Classes

Create MemberClass

Creates a new MemberClass

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
memberClass_Key
required
integer <int32>

Unique identifier for each Class entry for this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

class_Code
required
string [ 1 .. 32 ] characters

List of 'classes' that can be associated with a Member. This can be configured within Enrollment Services > Enrollment Configuration > Classes.

effective_Date
string or null <date-time>

Date when the 'class' becomes/became effective.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

subscriber_ID
required
string [ 1 .. 9 ] characters

References Members.Subscriber_ID value on the parent record.

term_Date
string or null <date-time>

Date when the 'class' becomes/became terminated.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/members/{memberSeq}/classes
Request samples
{
  • "memberClass_Key": 0,
  • "class_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "member_Seq": "st",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberClass

Lists all MemberClass 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}/classes
Request samples 
Response samples 
No sample
Get MemberClass
Gets MemberClass


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberClassKey
required
integer <int32> 
MemberClass Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/classes/{memberClassKey}
Request samples 
Response samples 
No sample
Update MemberClass
Updates a specific MemberClass.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberClassKey
required
integer <int32> 
MemberClass Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
memberClass_Key
required
integer <int32> 
Unique identifier for each Class entry for this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
class_Code
required
string  [ 1 .. 32 ] characters 
List of 'classes' that can be associated with a Member. This can be configured within Enrollment Services > Enrollment Configuration > Classes.


 
effective_Date
string or null <date-time> 
Date when the 'class' becomes/became effective.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


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


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


 
term_Date
string or null <date-time> 
Date when the 'class' becomes/became terminated.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/classes/{memberClassKey}
Request samples 
{
  • "memberClass_Key": 0,
  • "class_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "member_Seq": "st",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberClass
Deletes an MemberClass


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberClassKey
required
integer <int32> 
MemberClass Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/classes/{memberClassKey}
Request samples 
Create or Update Batch MemberClass
Create or Update multiple MemberClass 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 
memberClass_Key
required
integer <int32> 
Unique identifier for each Class entry for this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
class_Code
required
string  [ 1 .. 32 ] characters 
List of 'classes' that can be associated with a Member. This can be configured within Enrollment Services > Enrollment Configuration > Classes.


 
effective_Date
string or null <date-time> 
Date when the 'class' becomes/became effective.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


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


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


 
term_Date
string or null <date-time> 
Date when the 'class' becomes/became terminated.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
207
Success


401
Unauthorized


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