Example API Using REST and JSON
Virtual Recording Studio
Removing the limitations to music collaboration
This is an example of the VReST login API. It must be called in two parts: A session Request, and then the actual login.
VReSTInit: Initialize VRS Session API.
VReSTInit sets up the session, which can only be used once.
If you wish to Login to VRS again, you must call VReSTInit again to start a new session.
Type=JSon or XML
Output:
VReSTSess - The Generated Session Number
VReSTRtcd - The Return Code
VReSTRtxt - The Return Code Text Description
VReSTLogn: VRS User Login API.
VReSTLogn is called after the session is setup by VReSTInit.
VReSTLogn Logs in to the VRS collaboration engine.
Type=JSon or XML
Sess=[Session Number]
User=[VRS UserId]
Pass=[Session Password]
VReSTSess - The Generated Session Number
VReSTRtcd - The Return Code
VReSTRtxt - The Return Code Text Description
VReSTUser - UserId that logged in
VReSTPass - Unique Session Password
VReSTName - Logged In User Full Name
VReSTMail - Logged In User Email Address
VReSTProf: VRS User Profile API.
VReSTProf is called after VRS User Login by VReSTLogn.
VReSTProf Displays the VRS Users Profile data.
Type=JSon or XML
Sess=[Session Number]
User=[VRS UserId]
Pass=[VRS Password]
VReSTSess - The Generated Session Number
VReSTRtcd - The Return Code
VReSTRtxt - The Return Code Text Description
VReSTUser - UserId that logged in
VReSTPass - Unique Session Password
VReSTName - Logged in User Full Name
VReSTMail - Logged in User Email Address
VReSTUUrl - Logged In User URL
VReSTULvl - Logged In User Level
VReSTENty - Logged In User eMail Notifications
VReSTNews - Logged In User VRS News Setting
VReSTAval - Logged In User Availability Setting
VReSTHide - Logged In User Hidden Setting
VReSTUAbt - Logged In User About Me Text
VReSTAdtn - Logged In User Audition File URL
VReSTTags - Logged In User Tags (Search Tags)
VReSTPLst: VRS Project List API.
VReSTPLst is called after VRS User Login by VReSTLogn.
VReSTPLst Lists all of the User's Projects.
Type=JSon or XML
Sess=[Session Number]
User=[VRS UserId]
Pass=[VRS Password]
VReSTSess - The Generated Session Number
VReSTRtcd - The Return Code
VReSTRtxt - The Return Code Text Description
VReSTPNum - The Number Of User Projects
VReSTProj[n] - An Array of User Projects
VReSTProj[n].ProjAdmn - Project Admin
VReSTProj[n].ProjName - Project Name
VReSTProj[n].ProjTitl - Project Title
VReSTProj[0].ProjStat - My Project Status