v5 Contact > Contact

This interchange defines contacts (originally parent) and captures the relationship between the student and the guardian as well as indicators for the contact for residence, primary parental contact, and emergency contact.
The Contact resource represents a parent or guardian of a student, such as mother, father or caretaker.

Prerequisites

  • None

Scenarios

  1. Load Contact 1

  2. Load Contact 2

  3. Update the email address of the first contact created.

  4. Update the address of the second contact created.



Resource
Property NameIs CollectionData Type

Required / Optional

Scenario 1
POST

Scenario 2
POST

Scenario 3
PUT

Scenario 4
PUT

ContactscontactUniqueIdFALSEstringREQUIRED

 ["333333"  if possible

| system value]

["444444"  if possible

| system value]

["333333"  if possible

| system value]

["444444"  if possible

| system value]

ContactsfirstNameFALSEstringREQUIRED MichaelAlexis  MichaelAlexis 
ContactslastSurnameFALSEstringREQUIRED JonesJohnson  JonesJohnson 
ContactssexDescriptorFALSEstringCONDITIONALMaleFemaleMaleFemale
ContactsaddressesTRUEcontactAddress[]REQUIRED
contactAddressesaddressTypeDescriptorFALSEaddressTypeDescriptor

REQUIRED

Home

Home

Home

Home

contactAddressescityFALSEstring

REQUIRED

Grand BendGrand BendGrand BendGrand Bend
contactAddressespostalCodeFALSEstring

REQUIRED

78834788347883478834
contactAddressesstateAbbreviationDescriptorFALSEstateAbbreviationDescriptor

REQUIRED

TXTXTXTX
contactAddressesstreetNumberNameFALSEstring

REQUIRED

654 Mission Hills

456 Cedar Street

654 Mission Hills

456 Cedar Bend

contactAddressesapartmentRoomSuiteNumberFALSEstring

REQUIRED

100
100
contactAddressesnameOfCountyFALSEstring

CONDITIONAL

WILLISTONWILLISTONWILLISTONWILLISTON
contactAddressesdoNotPublishIndicatorFALSEbooleanREQUIREDTRUE
TRUE
ContactselectronicMailsTRUEcontactElectronicMail[]REQUIRED
contactElectronicMailselectronicMailAddressFALSEstring

REQUIRED

michaeljones@email.comalexisjohnson@email.commJones@email.comalexisjohnson@email.com
contactElectronicMailselectronicMailTypeDescriptorFALSEelectronicMailTypeDescriptor

CONDITIONAL

Home/PersonalHome/PersonalHome/PersonalHome/Personal
contactElectronicMailsprimaryEmailAddressIndicatorFALSEboolean

REQUIRED

 TRUE
 TRUE