Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Prerequisites

  • None

Scenarios

  1. Load parent 1

  2. Load parent 2

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

  4. Update the address of the Second Parent created.



Resource
Property NameIs CollectionData Type

Required / Optional

Scenario 1
POST

Scenario 2
POST

Scenario 3
PUT

Scenario 4
PUT

ParentsparentUniqueIdFALSEstringREQUIRED

 ["333333"  if possible

| system value]

["444444"  if possible

| system value]

["333333"  if possible

| system value]

["444444"  if possible

| system value]

ParentsfirstNameFALSEstringREQUIRED MichaelAlexis  MichaelAlexis 
ParentslastSurnameFALSEstringREQUIRED JonesJohnson  JonesJohnson 
ParentsgenerationCodeSuffixFALSEstringOPTIONAL
ParentsloginIdFALSEstringOPTIONAL
ParentsmaidenNameFALSEstringOPTIONAL
ParentsmiddleNameFALSEstringOPTIONAL
ParentspersonalTitlePrefixFALSEstringOPTIONAL
ParentssexDescriptorFALSEstringCONDITIONALMaleFemaleMaleFemale
ParentsaddressesTRUEparentAddress[]REQUIRED
parentAddressesaddressTypeDescriptorFALSEstring

REQUIRED

Home

Home

Home

Home

parentAddressescityFALSEstring

REQUIRED

Grand BendGrand BendGrand BendGrand Bend
parentAddressespostalCodeFALSEstring

REQUIRED

78834788347883478834
parentAddressesstateAbbreviationDescriptorFALSEstring

REQUIRED

TXTXTXTX
parentAddressesstreetNumberNameFALSEstring

REQUIRED

654 Mission Hills

456 Cedar Street

654 Mission Hills

456 Cedar Bend

parentAddressesapartmentRoomSuiteNumberFALSEstring

REQUIRED

100
100
parentAddressesbuildingSiteNumberFALSEstring

OPTIONAL


parentAddressescountyFIPSCodeFALSEstring

OPTIONAL


parentAddresseslatitudeFALSEstring

OPTIONAL


parentAddresseslongitudeFALSEstring

OPTIONAL


parentAddressesnameOfCountyFALSEstring

CONDITIONAL

WILLISTONWILLISTONWILLISTONWILLISTON
parentAddressesdoNotPublishIndicatorFALSEbooleanREQUIREDTRUE
TRUE
parentAddressesperiods[]TRUEperiods[]OPTIONAL
parentAddressPeriodsbeginDateFALSEstringOPTIONAL
parentAddressPeriodsendDateFALSEstringOPTIONAL
ParentselectronicMailsTRUEparentElectronicMail[]REQUIRED
parentElectronicMailselectronicMailAddressFALSEstring

REQUIRED

michaeljones@email.comalexisjohnson@email.commJones@email.comalexisjohnson@email.com
parentElectronicMailselectronicMailTypeDescriptorFALSEstring

CONDITIONAL

Home/PersonalHome/PersonalHome/PersonalHome/Personal
parentElectronicMailsprimaryEmailAddressIndicatorFALSEboolean

REQUIRED

 TRUE
 TRUE
parentElectronicMailsdoNotPublishIndicatorFALSEbooleanOPTIONAL
ParentsinternationalAddressesTRUEparentInternationalAddress[]OPTIONAL
parentInternationalAddressesaddressLine1FALSEstring

OPTIONAL


parentInternationalAddressesaddressTypeDescriptorFALSEstring

OPTIONAL


parentInternationalAddressescountryDescriptorFALSEstring

OPTIONAL


parentInternationalAddressesaddressLine2FALSEstring

OPTIONAL


parentInternationalAddressesaddressLine3FALSEstring

OPTIONAL


parentInternationalAddressesaddressLine4FALSEstring

OPTIONAL


parentInternationalAddressesbeginDateFALSEdate

OPTIONAL


parentInternationalAddressesendDateFALSEdate

OPTIONAL


parentInternationalAddresseslatitudeFALSEstring

OPTIONAL


parentInternationalAddresseslongitudeFALSEstring

OPTIONAL


ParentsotherNamesTRUEparentOtherName[]

OPTIONAL


parentOtherNamesfirstNameFALSEstring

OPTIONAL


parentOtherNameslastSurnameFALSEstring

OPTIONAL


parentOtherNamesotherNameTypeDescriptorFALSEstring

OPTIONAL


parentOtherNamesgenerationCodeSuffixFALSEstringOPTIONAL
parentOtherNamesmiddleNameFALSEstringOPTIONAL
parentOtherNamespersonalTitlePrefixFALSEstringOPTIONAL
ParentspersonalidentificationDocumentsTRUEpersonalIdentificationDocument[]OPTIONAL
parentPersonalIdentificationDocumentsidentificationDocumentUseDescriptorFALSEstring

OPTIONAL


parentPersonalIdentificationDocumentspersonalInformationVerificationDescriptorFALSEstring

OPTIONAL


parentPersonalIdentificationDocumentsdocumentExpirationDateFALSEdateOPTIONAL
parentPersonalIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL
parentPersonalIdentificationDocumentsissuerCountryDescriptorFALSEstringOPTIONAL
parentPersonalIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL
parentPersonalIdentificationDocumentsissuerNameFALSEstringOPTIONAL
ParentstelephonesTRUEparentTelephone[]OPTIONAL
parentTelephonestelephoneNumberFALSEstring

OPTIONAL


parentTelephonestelephoneNumberTypeDescriptorFALSEstring

OPTIONAL


parentTelephonesorderOfPriorityFALSEintegerOPTIONAL
parentTelephonestextMessageCapabilityIndicatorFALSEbooleanOPTIONAL
parentTelephonesdoNotPublishIndicatorFALSEbooleanOPTIONAL
ParentslanguagesTRUELanguage[]OPTIONAL
parentLanguageslanguageDescriptorFALSEstringOPTIONAL
parentLanguagesusesTRUELanguageUse[]OPTIONAL
parentLanguageUseslanguageUseDescriptorFALSEstring

OPTIONAL