API Documentation For LS

Method: POST

Description: Create a new family or update an existing one.

Parameters:

• teneo_family_code: Unique identifier for the family.
• last_name: Family last name.
• address_1: Address Line 1
• address_2: Address Line 2
• city: City.
• postal_code: Postal code
• province: Province
• status: Family status ('Active' or 'Inactive').
• primary_contact: Primary contact person

Example JSON payload:

{
    "teneo_family_code": "TFC000123",
    "last_name": "Anderson",
    "address_1": "123",
    "address_2": "Main St",
    "city": "Cityville",
    "postal_code": "12345",
    "province": "State",
    "status": "Active",
    "primary_contact": "Michael Anderson"
}
        

Returns:

• 201 Created: Family created successfully or updated if the family code already exists.

Example Response:

{
    "message": "Family created or updated successfully"
}
            

• 500 Internal Server Error: If an error occurs during the family creation/update process.

Example Response:

{
    "error": "Internal server error"
}
            

Method: POST

Description: Create a new student.

Parameters:

• teneo_student_number: Unique identifier for the student (optional for updates).
• email_address: Student's email address.
• first_name: Student's first name.
• middle_name: Student's middle name.
• last_name: Student's last name.
• preferred_name: Student's preferred name.
• date_of_birth: Student's date of birth.
• teneo_family_code: Teneo family code associated with the student.
• language_preference: Language preference (English or Afrikaans).
• nationality: Student's nationality.
• social_security_number: Social security number.
• address_1: Address Line 1
• address_2: Address Line 2
• city: Student's city of residence.
• postal_code: Student's postal code.
• province: Student's province of residence.
• learning_barriers: Student's learning barriers.
• reason_for_joining: Student's reason for joining.

Example JSON payload:

{
    "teneo_student_number": "2410001",  // Optional
    "email_address": "john.anderson@example.com",
    "first_name": "John",
    "middle_name": "Robert",
    "last_name": "Anderson",
    "preferred_name": "Johnny",
    "date_of_birth": "2005-05-10",
    "teneo_family_code": "TFC000123",
    "grade_level": "10",
    "language_preference": "English",
    "nationality": "American",
    "social_security_number": "123-45-6789",
    "address_1": "123",
    "address_2": "Main St",
    "city": "Cityville",
    "postal_code": "12345",
    "province": "State"
}
        

Returns:

• 201 Created: Student created successfully. Returns the newly generated teneo_student_number.

Example Response:

{
    "message": "Student created successfully",
    "teneo_student_number": "2410001"
}
            

• 500 Internal Server Error: If an error occurs during the student creation process.

Example Response:

{
    "error": "Internal server error"
}
            

Method: POST

Description: Create a new contact.

Parameters:

• ssn: Social security number of the contact.
• first_name: Contact's first name.
• last_name: Contact's last name.
• relationship_to_student: Relationship to the student (Parent, Guardian, Next of Kin).
• email_address: Contact's email address.
• alternative_email_address: Alternative email address.
• mobile_number: Contact's mobile number.
• telephone_number: Contact's telephone number.
• whatsapp_number: Contact's WhatsApp number.
• address_1: Address Line 1
• address_2: Address Line 2
• city: Contact's city of residence.
• postal_code: Contact's postal code.
• province: Contact's province of residence.
• preferred_language: Preferred language of the contact (English or Afrikaans).
• contact_type: Type of contact (Primary, Billing, Academic).
• teneo_family_code: Teneo family code associated with the contact.
• country: Country of contact.

Example JSON payload:

{
    "ssn": "123-45-6789",
    "first_name": "Alice",
    "last_name": "Johnson",
    "relationship_to_student": "Parent",
    "email_address": "alice@example.com",
    "alternative_email_address": "alice.alt@example.com",
    "mobile_number": "555-1234",
    "telephone_number": "555-5678",
    "whatsapp_number": "555-9012",
    "address_1": "123",
    "address_2": "Main St",
    "city": "Cityville",
    "postal_code": "12345",
    "province": "State",
    "preferred_language": "English",
    "contact_type": "Emergency",
    "teneo_family_code": "TFC000123",
    "country": "South African"
}
        

Returns:

• 201 Created: Contact created successfully.

Example Response:

{
    "message": "Contact created successfully"
}
            

• 500 Internal Server Error: If an error occurs during the contact creation process.

Example Response:

{
    "error": "Internal server error"
}
            

Method: POST

Description: Create a new application for a student.

Parameters:

• teneo_student_number: Teneo student number associated with the application.
• year: Year of the application.
• format: Format of the application.
• curriculum_alignment: Curriculum alignment of the application.
• teneo_family_code: Teneo family code associated with the application.
• subject_1 to subject_19: Optional subjects associated with the application.
• language_of_learning: Language of Learning.

Example JSON payload:

{
    "teneo_student_number": "TSN001",
    "year": 2024,
    "format": "Full-time",
    "curriculum_alignment": "National",
    "teneo_family_code": "TFC000123",
    "subject_1": "Physics",
    "subject_2": "Chemistry",
    "subject_3": "Mathematics",
    "language_of_learning": "English"
}
        

Returns:

• 201 Created: Application created successfully. Returns the newly generated application_id.
• 404 Not Found: If the associated student is not found.
• 500 Internal Server Error: If an error occurs during the application creation process.