Introduction

This article describes enhancements to the Aeries API for the Contacts endpoint.  These enhancements are technically available to any vendor with appropriate permissions, though great caution must be exercised when adding, updating, or deleting information using the Aeries API. Vendors must also be mindful of any state reporting requirements pertaining to this data.


Main API Documentation

Please refer to the Aeries API Full Documentation for more information about the Aeries API.  Version 4 (V4) of the Aeries API has not yet been fully released. Once a complete set of V4 endpoints is ready for publication, the main API documentation will be updated. In the interim, this separate documentation is being provided to appropriate vendors as V4 endpoints are added and updated.


Error Messages

Errors may occur for several reasons.  A violation of business rules or key constraints in a POST or PUT request will result in an error.  For example, attempting to create a new contact for a non-existent Student ID will generate an error.


Contact Information

Revision:

  • Updated to V4, added new fields.  

Security Area:

  • "Contact"

URL(s):

  • /api/v4/schools/{School}/contacts/{StudentID}
    • StudentID (optional) -  (numeric).

Notes:

  • If StudentID is not passed, all Contact records in the school will be returned.


Example Contact Information Results:


{

        "MiscCode": "",

        "MailTagCode": "A",

        "AddressTypeCode": "4",

        "AdditionalCommunicationTypeCode1": "",

        "AdditionalCommunicationTypeCode2": "",

        "AdditionalCommunicationTypeCode3": "",

        "AdditionalCommunicationTypeCode4": "",

        "AdditionalCommunicationDetail1": "",

        "AdditionalCommunicationDetail2": "",

        "AdditionalCommunicationDetail3": "",

        "AdditionalCommunicationDetail4": "",

        "AddressVerificationDate": null,

        "RecordAddedDate": "2019-11-13T00:00:00",

        "MilitaryUserFieldCode1": "",

        "MilitaryUserFieldCode2": "",

        "MilitaryUserFieldCode3": "",

        "MilitaryUserFieldCode4": "",

        "MilitaryUserFieldCode5": "",

        "PrimaryContact1Field": "WorkPhone",

        "PrimaryContact2Field": "",

        "PrimaryContact1Description": "Father Work - Adam A",

        "PrimaryContact2Description": "",

        "EducationalRightsHolder": "",

        "AttendanceNotification": "",

        "PermanentID": 99400001,

        "SchoolCode": 994,

        "SequenceNumber": 1,

        "MailingName": "Adam Abbott",

        "NamePrefix": "",

        "FirstName": "Adam",

        "LastName": "Abbott",

        "MiddleName": "",

        "NameSuffix": "",

        "Address": "5647 Elm St",

        "AddressCity": "Eagle rock",

        "AddressState": "CA",

        "AddressZipCode": "99998",

        "AddressZipExt": "",

        "RelationshipToStudentCode": "11",

        "LivesWithStudentIndicator": "",

        "RedFlag": false,

        "HomePhone": "",

        "WorkPhone": "7775557537",

        "WorkPhoneExt": "",

        "CellPhone": "",

        "Pager": "",

        "EmailAddress": "parent@aeries.com",

        "AccessToPortal": "",

        "ContactOrder": 1,

        "CorrespondanceLanguageCode": "",

        "EmployerName": "",

        "EmployerLocation": "",

        "MilitaryBranchCode": "AR",

        "MilitaryRankCode": "SGT",

        "MilitarySupervisorName": "John Brown",

        "MilitarySupervisorPhone": "9995551234",

        "MilitaryStatusCode": "X",

        "NotificationPreferenceCode": "1",

        "Comments": ""


Field Documentation:

CON Table Definition in Aeries
NameAeriesTable.ColumnDescriptionData TypeMax Length
PIDCON.PIDint
NMCON.NMNamenvarchar50
ADCON.ADAddressvarchar50
CYCON.CYCityvarchar24
STCON.STStatevarchar2
ZCCON.ZCZipvarchar5
TLCON.TLTelephonevarchar10
MECON.MEMemonvarchar
CDCON.CDCodevarchar2
MTCON.MTMailvarchar1
WPCON.WPWork Phonevarchar10
WXCON.WXWork Extvarchar5
CPCON.CPCell Phonevarchar10
PACON.PAPagervarchar10
EMCON.EMEmailvarchar255
SQCON.SQSequencesmallint
ORCON.ORContact Ordersmallint
PFCON.PFPrefixnvarchar5
FNCON.FNFirst Namenvarchar20
MNCON.MNMiddle Name
nvarchar20
LNCON.LNLast Namenvarchar50
SFCON.SFSuffixnvarchar10
RLCON.RLRelationvarchar2
ATCON.ATAddress Typevarchar1
AD2CON.AD2Address 2varchar55
ZXCON.ZXZip Extensionvarchar4
CT1CON.CT1Comm Type1varchar2
CN1CON.CN1Comm Num1varchar255
CT2CON.CT2Comm Type2varchar2
CN2CON.CN2Comm Num2varchar255
CT3CON.CT3Comm Type3varchar2
CN3CON.CN3Comm Num3varchar255
CT4CON.CT4Comm Type4varchar2
CN4CON.CN4Comm Num4varchar255
VDTCON.VDTVerified Datedatetime
RFCON.RFRed Flagbit
EDCON.EDEnter datedatetime
CLCON.CLCorr Languagevarchar2
ENMCON.ENMEmployer Namenvarchar255
ELCCON.ELCEmp Locnvarchar255
APCON.APAccess to Portalvarchar1
MBRCON.MBRMilitary Branchvarchar6
MDTCON.MDTMilitary Datedatetime
MRACON.MRAMilitary Rankvarchar6
MSNCON.MSNSupervisor namevarchar50
MSPCON.MSPSupervisor Phonevarchar10
MTGCON.MTGMilitary Status Tagvarchar1
MU1CON.MU1Military User1varchar3
MU2CON.MU2Military User2varchar3
MU3CON.MU3Military User3varchar3
MU4CON.MU4Military User4varchar3
MU5CON.MU5Military User5varchar3
LWCON.LWLiveWithvarchar1
C1FCON.C1FCon1Fldvarchar3
C1DCON.C1DCon1Descvarchar20
C2FCON.C2FCon2Fldvarchar3
C2DCON.C2DCon2Descvarchar20
NPCON.NPNotification Preferencevarchar1
ERHCON.ERHRightsHoldervarchar1
ANCON.ANAttendance Notificationvarchar1
DELCON.DELDELbit
DTSCON.DTSDateTimeStampdatetime
PCCON.PCPrimary Contactvarchar1
LKCON.LKAdministrative Lockvarchar1