Contents x
    TIES Adapter Actions
    • 04 Aug 2022
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    TIES Adapter Actions

    • Updated on 04 Aug 2022
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Article Summary

    TIES Adapter Actions

    defineTIESConnection

    Define a connection to a TIES Server.

    Property

    Value

    Description

    url*

    text, expression, variable

    the Base URL of the TIES REST service, not including page number

    apiKey*

    text, expression, variable

    API key for authentication to the TIES REST service

    secretKey*

    password, string, expression, variable

    Secret key for authentication to the TIES REST service

    districtNumber*

    text, expression, variable

    The District Number for use with the TIES REST service

    options

    expression, variable

    A record or JavaScript object with a field for each additional option. Currently defined fields are connectTimeout and socketTime which require a numeric value from 1 to 2147483647 (0x7FFFFFFF) that represents the number of milliseconds for the timeout, and 0 representing no timeout.

    returnVariable

    expression, variable

    name of the variable to be assigned to the return value

    Global.tiesURL = "https://api.tiescloud.net"
Global.tiesApiKey = "feeddeadbeef"
Global.tiesSecretKey = <Password>
Global.tiesDistrictNumber = 4200000000
session = defineTIESConnection(Globale.tiesURL, Global.tiesApiKey,
Global.tiesSecretKey, Global.tiesDistrictNumber)

    getTIESFamilies

    Get All TIES Family Records.

    Property

    Value

    Description

    connection*

    expression, variable

    the TIES connection definition

    filter

    text, expression, variable

    Any additional parameters to pass to the TIES REST service

    returnVariable

    expression, variable

    name of the variable to be assigned to the return value

    filter = createRecord()
setRecordFieldValue(filter, "StudentIds", student.StudentId)
families = getTIESFamilies(session, filter)

    getTIESFamily

    Get a given TIES Family Record.

    Property

    Value

    Description

    connection*

    expression, variable

    the TIES connection definition

    id*

    text, expression, variable

    The ID of the family

    returnVariable

    expression, variable

    name of the variable to be assigned to the return value

    family = getTIESFamily(session, "1234")

    getTIESStaffMember

    Gets a given TIES Staff Member Record.

    Property

    Value

    Description

    connection*

    expression, variable

    the TIES connection definition

    id*

    text, expression, variable

    The ID of the Staff Member

    returnVariable

    expression, variable

    name of the variable to be assigned to the return value

    staffMember = getTIESStaffMember(session, "1234")

    getTIESStaffMembers

    Get All TIES Staff Member Records.

    Property

    Value

    Description

    connection*

    expression, variable

    the TIES connection definition

    filter

    text, expression, variable

    Any additional parameters to pass to the TIES REST service

    returnVariable

    expression, variable

    name of the variable to be assigned to the return value

    teachers = getTIESStaffMembers(session)

    getTIESStudent

    Gets a given TIES Student Record.

    Property

    Value

    Description

    connection*

    expression, variable

    the TIES connection definition

    id*

    text, expression, variable

    The ID of the student

    returnVariable

    expression, variable

    name of the variable to be assigned to the return value

    student = getTIESStudent(session, "4567")

    getTIESStudents

    Get All TIES Student Records.

    Property

    Value

    Description

    connection*

    expression, variable

    the TIES connection definition

    filter

    text, expression, variable

    Any additional parameters to pass to the TIES REST service

    returnVariable

    expression, variable

    name of the variable to be assigned to the return value

    filter = createRecord()
setRecordFieldValue(filter, "SchoolYear", "2015")
setRecordFieldValue(filter, "Grade", "12")
students = getTIESStudents(session, filter)

    openTIESFamilyIterator

    Open TIES Family Iterator.

    Property

    Value

    Description

    connection*

    expression, variable

    the TIES connection definition

    filter

    text, expression, variable

    Any additional parameters to pass to the TIES REST service

    returnVariable

    expression, variable

    name of the variable to be assigned to the return value

    filter = createRecord()
setRecordFieldValue(filter, "StudentIds", student.StudentId)
it = openTIESFamilyIterator(session, filter)

    openTIESStaffMemberIterator

    Open TIES Staff Member Iterator.

    Property

    Value

    Description

    connection*

    expression, variable

    the TIES connection definition

    filter

    text, expression, variable

    Any additional parameters to pass to the TIES REST service

    returnVariable

    expression, variable

    name of the variable to be assigned to the return value

    it = openTIESStaffMemberIterator(session)

    openTIESStudentIterator

    Open TIES Student Iterator.

    Property

    Value

    Description

    connection*

    expression, variable

    the TIES connection definition

    filter

    text, expression, variable

    Any additional parameters to pass to the TIES REST service

    returnVariable

    expression, variable

    name of the variable to be assigned to the return value

    filter = createRecord()
setRecordFieldValue(filter, "SchoolYear", "2015")
setRecordFieldValue(filter, "Grade", "12")
it = openTIESStudentIterator(session, filter)

    Supported TIES Fields

    Was this article helpful?
    What's Next