XenDirect API

Version 1.0.1

Resources:

ClientAssignment PUT GET /{organizationID}/clientAssignment

GET
Get Client Assignment Record(s)
required numeric cliID (default: 0)
optional numeric schID (default: 0)
optional numeric assID (default: 0)
optional string courseCode (default: "")
optional numeric branchID (default: 0)
optional string ven (default: "")
PUT
Update the Client Assignment
required numeric assID (default: 0)
optional string enrollmentStatus (default: "")
Possible: Applicant/Waiting List,Applicant/Inquiry,Applicant/Registered,Applicant/Incomplete Application,Applicant/Declined Application,Approved Visitor,Enrolled/Active,Enrolled/OnHold,Completed-Satisfactory,Completed-Unsatisfactory,Did Not Complete-Other,Did Not Complete-No Show,Did Not Complete-Incomplete,Did Not Complete-Dropped,Did Not Complete-Failed,Did Not Complete-Refunded,Did Not Complete-Transferred,Did Not Enroll,Did Not Enroll-Course Cancelled,Applicant/Waiting List,Applicant/Inquiry,Applicant/Registered,Applicant/Incomplete Application,Applicant/Declined Application,Approved Visitor,Enrolled/Active,Enrolled/OnHold,Completed-Satisfactory,Completed-Unsatisfactory,Did Not Complete-Other,Did Not Complete-No Show,Did Not Complete-Incomplete,Did Not Complete-Dropped,Did Not Complete-Failed,Did Not Complete-Refunded,Did Not Complete-Transferred,Did Not Enroll,Did Not Enroll-Course Cancelled,Aggregate/Company,Aggregate/Company,Did Not Complete-Substituted,Did Not Complete-Substituted
optional string CreditsEarned (default: "")
optional string Grade (default: "")
optional string assDateEnd (default: "")

Client PUT GET /{organizationID}/client

GET
optional numeric cliID (default: 0)
optional string UserName (default: "")
optional string ClientID (default: "")
optional string LName (default: "")
optional string FName (default: "")
PUT
Updates a Client record
required numeric cliID (default: 0)
optional string UserName (default: "")
Must be Unique
optional string AltID1 (default: "")
optional string AltID2 (default: "")
optional string LName (default: "")
optional string FName (default: "")
optional string mailAddress1 (default: "")
optional string mailAddress2 (default: "")
optional string mailCity (default: "")
Must send MailCity and MailZip to change either.
optional string mailZip (default: "")
Must send MailCity and MailZip to change either.
optional string email (default: "")

Resources are listed in matching order. From top to bottom, the first URI to match the request is used.