Member Colleges

Create MemberCollege

Creates a new MemberCollege

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

Unique identifier for each college record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

college_Key
integer or null <int32>

Identifier associated with the Member's school. This can be configured within System Services > System Configuration > Colleges.

contact_Fax
string or null <= 32 characters

Fax number of the Contact associated with the Member's school.

contact_Name
string or null <= 128 characters

Name of the Contact associated with the Member's school.

contact_Phone
string or null <= 32 characters

Phone number of the Contact associated with the Member's school.

effective_Date
string or null <date-time>

Date when the Member's 'student' status becomes/became effective.

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.

hours
number or null <double>

Identifies how many hours the Member is currently enrolled in.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

semester
integer or null <int32>

Identifies the semester that the Member is currently enrolled in.

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 Member's 'student' status expires/expired.

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}/colleges
Request samples
{
  • "memberCollege_Key": 0,
  • "college_Key": 0,
  • "contact_Fax": "string",
  • "contact_Name": "string",
  • "contact_Phone": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hours": 0.1,
  • "member_Seq": "st",
  • "semester": 0,
  • "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 MemberCollege

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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberCollegeKey
required
integer <int32> 
MemberCollege Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/colleges/{memberCollegeKey}
Request samples 
Response samples 
No sample
Update MemberCollege
Updates a specific MemberCollege.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberCollegeKey
required
integer <int32> 
MemberCollege Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
memberCollege_Key
required
integer <int32> 
Unique identifier for each college record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
college_Key
integer or null <int32> 
Identifier associated with the Member's school. This can be configured within System Services > System Configuration > Colleges.


 
contact_Fax
string or null  <= 32 characters 
Fax number of the Contact associated with the Member's school.


 
contact_Name
string or null  <= 128 characters 
Name of the Contact associated with the Member's school.


 
contact_Phone
string or null  <= 32 characters 
Phone number of the Contact associated with the Member's school.


 
effective_Date
string or null <date-time> 
Date when the Member's 'student' status becomes/became effective.


 
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.


 
hours
number or null <double> 
Identifies how many hours the Member is currently enrolled in.


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


 
semester
integer or null <int32> 
Identifies the semester that the Member is currently enrolled in.


 
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 Member's 'student' status expires/expired.


 
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}/colleges/{memberCollegeKey}
Request samples 
{
  • "memberCollege_Key": 0,
  • "college_Key": 0,
  • "contact_Fax": "string",
  • "contact_Name": "string",
  • "contact_Phone": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hours": 0.1,
  • "member_Seq": "st",
  • "semester": 0,
  • "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 MemberCollege
Deletes an MemberCollege


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberCollegeKey
required
integer <int32> 
MemberCollege Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/colleges/{memberCollegeKey}
Request samples 
Create or Update Batch MemberCollege
Create or Update multiple MemberCollege 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 
memberCollege_Key
required
integer <int32> 
Unique identifier for each college record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
college_Key
integer or null <int32> 
Identifier associated with the Member's school. This can be configured within System Services > System Configuration > Colleges.


 
contact_Fax
string or null  <= 32 characters 
Fax number of the Contact associated with the Member's school.


 
contact_Name
string or null  <= 128 characters 
Name of the Contact associated with the Member's school.


 
contact_Phone
string or null  <= 32 characters 
Phone number of the Contact associated with the Member's school.


 
effective_Date
string or null <date-time> 
Date when the Member's 'student' status becomes/became effective.


 
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.


 
hours
number or null <double> 
Identifies how many hours the Member is currently enrolled in.


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


 
semester
integer or null <int32> 
Identifies the semester that the Member is currently enrolled in.


 
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 Member's 'student' status expires/expired.


 
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}/colleges-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}