Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: changed PersonalTitlePrefix to OPTIONAL and removed sample data

StaffAssociation defines staff information. It can be used to define employment, assignment, and teaching associations, as well as staff positions and staff leave events.

...

 

ResourcePropertyNameIsCollectionDATA_TYPE

REQUIRED/

OPTIONAL

POST 1POST 2PUT 1PUT 2
StaffsstaffUniqueIdFALSEstringREQUIRED

["207220"  if possible

| system value]

["207269"  if possible

| system value]

["207220"  if possible

| system value]

["207269"  if possible

| system value]

StaffsfirstNameFALSEstringREQUIREDJohnJaneJohnJane
StaffshispanicLatinoEthnicityFALSEbooleanREQUIREDtruetruetruefalse
StaffslastSurnameFALSEstringREQUIREDLoyoSmithLoyoSmith
StaffsbirthDateFALSEdatetimeREQUIRED
1959-04-30
1973-07-20
1959-04-30
1973-07-20
StaffscitizenshipStatusTypeFALSEintegerOPTIONAL    
StaffsgenerationCodeSuffixFALSEstringREQUIREDSr Sr 
StaffshighestCompletedLevelOfEducationDescriptorFALSEintegerREQUIRED

Master's

Doctorate

Master's

Doctorate

StaffshighlyQualifiedTeacherFALSEbooleanREQUIREDtruetruefalsetrue
StaffsloginIdFALSEstringOPTIONAL    
StaffsmaidenNameFALSEstringOPTIONAL    
StaffsmiddleNameFALSEstringREQUIRED Marcy Marcy
StaffsoldEthnicityTypeFALSEintegerOPTIONAL    
StaffspersonalTitlePrefixFALSEstringREQUIREDMrMrsMrMrsOPTIONAL



StaffssexTypeFALSEintegerREQUIREDMaleFemaleMaleFemale
StaffsyearsOfPriorProfessionalExperienceFALSEintegerOPTIONAL    
StaffsyearsOfPriorTeachingExperienceFALSEintegerOPTIONAL    
StaffsaddressesTRUEstaffAddress[]OPTIONAL 
StaffAddresssaddressTypeFALSEintegerREQUIRED*    
StaffAddressscityFALSEstringREQUIRED*    
StaffAddressspostalCodeFALSEstringREQUIRED*    
StaffAddresssstateAbbreviationTypeFALSEintegerREQUIRED*    
StaffAddresssstreetNumberNameFALSEstringREQUIRED*    
StaffAddresssapartmentRoomSuiteNumberFALSEstringOPTIONAL    
StaffAddresssbeginDateFALSEdatetimeOPTIONAL    
StaffAddresssbuildingSiteNumberFALSEstringOPTIONAL    
StaffAddressscountyFIPSCodeFALSEstringOPTIONAL    
StaffAddresssendDateFALSEdatetimeOPTIONAL    
StaffAddressslatitudeFALSEstringOPTIONAL    
StaffAddressslongitudeFALSEstringOPTIONAL    
StaffAddresssnameOfCountyFALSEstringOPTIONAL    
StaffscredentialsTRUEstaffCredential[]OPTIONAL    
StaffCredentialscredentialFieldDescriptorFALSEintegerREQUIRED*    
StaffCredentialscredentialIssuanceDateFALSEdatetimeREQUIRED*    
StaffCredentialscredentialTypeFALSEintegerREQUIRED*    
StaffCredentialslevelDescriptorFALSEintegerREQUIRED*    
StaffCredentialsteachingCredentialDescriptorFALSEintegerREQUIRED*    
StaffCredentialscredentialExpirationDateFALSEdatetimeOPTIONAL    
StaffCredentialsstateOfIssueStateAbbreviationTypeFALSEintegerOPTIONAL    
StaffCredentialsteachingCredentialBasisTypeFALSEintegerOPTIONAL    
StaffselectronicMailsTRUEstaffElectronicMail[]REQUIRED 
StaffElectronicMailselectronicMailAddressFALSEstringREQUIRED*johnloyo@edficert.orgjanesmith@edficert.orgjohnloyo@edficert.orgjanesmith@edficert.org
StaffElectronicMailselectronicMailTypeFALSEintegerREQUIRED*
Work
Work
Work
Work
StaffElectronicMailsprimaryEmailAddressIndicatorFALSEbooleanOPTIONAL    
StaffsidentificationCodesTRUEstaffIdentificationCode[]OPTIONAL 
StaffIdentificationCodesidentificationCodeFALSEstringREQUIRED*
207220
207269
207220
207269
StaffIdentificationCodesstaffIdentificationSystemDescriptorFALSEintegerREQUIRED*StateStateStateState
StaffIdentificationCodesassigningOrganizationIdentificationCodeFALSEstringOPTIONAL    
StaffsidentificationDocumentsTRUEstaffIdentificationDocument[]OPTIONAL    
StaffIdentificationDocumentsidentificationDocumentUseTypeFALSEintegerREQUIRED*    
StaffIdentificationDocumentspersonalInformationVerificationTypeFALSEintegerREQUIRED*    
StaffIdentificationDocumentsdocumentExpirationDateFALSEdatetimeOPTIONAL    
StaffIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL    
StaffIdentificationDocumentsissuerCountryDescriptorFALSEintegerOPTIONAL    
StaffIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL    
StaffIdentificationDocumentsissuerNameFALSEstringOPTIONAL    
StaffsinternationalAddressesTRUEstaffInternationalAddress[]OPTIONAL 
StaffInternationalAddresssaddressLine1FALSEstringREQUIRED*    
StaffInternationalAddresssaddressTypeFALSEintegerREQUIRED*    
StaffInternationalAddressscountryDescriptorFALSEintegerREQUIRED*    
StaffInternationalAddresssaddressLine2FALSEstringOPTIONAL    
StaffInternationalAddresssaddressLine3FALSEstringOPTIONAL    
StaffInternationalAddresssaddressLine4FALSEstringOPTIONAL    
StaffInternationalAddresssbeginDateFALSEdatetimeOPTIONAL    
StaffInternationalAddresssendDateFALSEdatetimeOPTIONAL    
StaffInternationalAddressslatitudeFALSEstringOPTIONAL    
StaffInternationalAddressslongitudeFALSEstringOPTIONAL    
StaffslanguagesTRUEstaffLanguage[]OPTIONAL 
StaffLanguageslanguageDescriptorFALSEintegerREQUIRED*    
staffLanguagesusesTRUEstaffLanguageUse[]OPTIONAL 
StaffLanguageUseslanguageDescriptorFALSEintegerOPTIONAL    
StaffLanguageUseslanguageUseTypeFALSEintegerOPTIONAL    
StaffsotherNamesTRUEstaffOtherName[]OPTIONAL 
StaffOtherNamesfirstNameFALSEstringREQUIRED*    
StaffOtherNameslastSurnameFALSEstringREQUIRED*    
StaffOtherNamesotherNameTypeFALSEintegerREQUIRED*    
StaffOtherNamesgenerationCodeSuffixFALSEstringOPTIONAL    
StaffOtherNamesmiddleNameFALSEstringOPTIONAL    
StaffOtherNamespersonalTitlePrefixFALSEstringOPTIONAL    
StaffsracesTRUEstaffRace[]OPTIONAL 
StaffRacesraceTypeFALSEintegerREQUIRED*WhiteBlack - African AmericanWhiteBlack - African American
StaffstelephonesTRUEstaffTelephone[]OPTIONAL 
StaffTelephonestelephoneNumberFALSEstringREQUIRED*    
StaffTelephonestelephoneNumberTypeFALSEintegerREQUIRED*    
StaffTelephonesorderOfPriorityFALSEintegerOPTIONAL    
StaffTelephonestextMessageCapabilityIndicatorFALSEbooleanOPTIONAL    
StaffsvisasTRUEstaffVisa[]OPTIONAL 
StaffVisasvisaTypeFALSEintegerREQUIRED*