Colleges

Create College

Creates a new College

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
college_Key
required
integer <int32>
address
string or null <= 128 characters
address2
string or null <= 128 characters
city
string or null <= 32 characters
college_Type
string or null <= 16 characters
country_ID
string or null <= 8 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
fax
string or null <= 32 characters
fax_Country_Code
string or null <= 8 characters
name
string or null <= 128 characters
phone
string or null <= 32 characters
phone_Country_Code
string or null <= 8 characters
state
string or null <= 2 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
zip_Code
string or null <= 32 characters
Responses
200

Success

401

Unauthorized

post/colleges
Request samples
{
  • "college_Key": 0,
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "college_Type": "string",
  • "country_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "name": "string",
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "state": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List College

Lists all College

SecurityapiKeyAuth and bearerAuth
Request
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/colleges
Request samples 
Response samples 
No sample
Get College
Gets College


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
collegeKey
required
integer <int32> 
College Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/colleges/{collegeKey}
Request samples 
Response samples 
No sample
Update College
Updates a specific College.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
collegeKey
required
integer <int32> 
College Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
college_Key
required
integer <int32> 
 
address
string or null  <= 128 characters 
 
address2
string or null  <= 128 characters 
 
city
string or null  <= 32 characters 
 
college_Type
string or null  <= 16 characters 
 
country_ID
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
fax
string or null  <= 32 characters 
 
fax_Country_Code
string or null  <= 8 characters 
 
name
string or null  <= 128 characters 
 
phone
string or null  <= 32 characters 
 
phone_Country_Code
string or null  <= 8 characters 
 
state
string or null  <= 2 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
zip_Code
string or null  <= 32 characters 
 
Responses 
200
Success


401
Unauthorized


put/colleges/{collegeKey}
Request samples 
{
  • "college_Key": 0,
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "college_Type": "string",
  • "country_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "name": "string",
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "state": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete College
Deletes an College


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
collegeKey
required
integer <int32> 
College Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/colleges/{collegeKey}
Request samples 
Create or Update Batch College
Create or Update multiple College at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
college_Key
required
integer <int32> 
 
address
string or null  <= 128 characters 
 
address2
string or null  <= 128 characters 
 
city
string or null  <= 32 characters 
 
college_Type
string or null  <= 16 characters 
 
country_ID
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
fax
string or null  <= 32 characters 
 
fax_Country_Code
string or null  <= 8 characters 
 
name
string or null  <= 128 characters 
 
phone
string or null  <= 32 characters 
 
phone_Country_Code
string or null  <= 8 characters 
 
state
string or null  <= 2 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
zip_Code
string or null  <= 32 characters 
 
Responses 
207
Success


401
Unauthorized


put/colleges-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}