Resource | Property Name | Is Collection | Data Type | Required / Optional | Scenario 1 | Scenario 2 POST | Scenario 3 PUT | Scenario 4 |
---|---|---|---|---|---|---|---|---|
Staffs | staffUniqueId | FALSE | string | REQUIRED | ["207220" if possible | system value] | ["207269" if possible | system value] | ["207220" if possible | system value] | ["207269" if possible | system value] |
Staffs | firstName | FALSE | string | REQUIRED | John | Jane | John | Jane |
Staffs | hispanicLatinoEthnicity | FALSE | boolean | REQUIRED | true | true | true | false |
Staffs | lastSurname | FALSE | string | REQUIRED | Loyo | Smith | Loyo | Smith |
Staffs | birthDate | FALSE | date | CONDITIONAL | 1959-04-30 | 1973-07-20 | 1959-04-30 | 1973-07-20 |
Staffs | citizenshipStatusDescriptor | FALSE | integer | OPTIONAL | ||||
Staffs | generationCodeSuffix | FALSE | string | REQUIRED | Sr | Sr | ||
Staffs | highestCompletedLevelOfEducationDescriptor | FALSE | integer | REQUIRED | Master's | Doctorate | Master's | Doctorate |
Staffs | highlyQualifiedTeacher | FALSE | boolean | REQUIRED | true | true | false | true |
Staffs | loginId | FALSE | string | OPTIONAL | ||||
Staffs | maidenName | FALSE | string | OPTIONAL | ||||
Staffs | middleName | FALSE | string | REQUIRED | Marcy | Marcy | ||
Staffs | oldEthnicityDescriptor | FALSE | integer | OPTIONAL | ||||
Staffs | personalTitlePrefix | FALSE | string | OPTIONAL | ||||
Staffs | sexDescriptor | FALSE | integer | REQUIRED | Male | Female | Male | Female |
Staffs | yearsOfPriorProfessionalExperience | FALSE | integer | OPTIONAL | ||||
Staffs | yearsOfPriorTeachingExperience | FALSE | integer | OPTIONAL | ||||
Staffs | addresses | TRUE | staffAddress[] | OPTIONAL | ||||
staffAddresses | addressTypeDescriptor | FALSE | integer | OPTIONAL | ||||
staffAddresses | city | FALSE | string | OPTIONAL | ||||
staffAddresses | postalCode | FALSE | string | OPTIONAL | ||||
staffAddresses | stateAbbreviationDescriptor | FALSE | integer | OPTIONAL | ||||
staffAddresses | streetNumberName | FALSE | string | OPTIONAL | ||||
staffAddresses | apartmentRoomSuiteNumber | FALSE | string | OPTIONAL | ||||
staffAddresses | buildingSiteNumber | FALSE | string | OPTIONAL | ||||
staffAddresses | countyFIPSCode | FALSE | string | OPTIONAL | ||||
staffAddresses | latitude | FALSE | string | OPTIONAL | ||||
staffAddresses | longitude | FALSE | string | OPTIONAL | ||||
staffAddresses | nameOfCounty | FALSE | string | OPTIONAL | ||||
staffAddresses | doNotPublishIndicator | FALSE | boolean | OPTIONAL | ||||
staffAddresses | periods | TRUE | Periods[] | OPTIONAL | ||||
staffAddressPeriods | beginDate | FALSE | string | OPTIONAL | ||||
staffAddressPeriods | endDate | FALSE | string | OPTIONAL | ||||
Staffs | credentials | TRUE | credential[] | OPTIONAL | ||||
staffCredentals | credentialReference | FALSE | credentialReference | OPTIONAL | ||||
credentialReference | credentialIdenitfier | FALSE | string | OPTIONAL | ||||
credentialReference | stateOfIssueStateAbbreviationDescriptor | FALSE | integer | OPTIONAL | ||||
Staffs | electronicMails | TRUE | staffElectronicMail[] | REQUIRED | ||||
staffElectronicMails | electronicMailAddress | FALSE | string | REQUIRED | johnloyo@edficert.org | janesmith@edficert.org | johnloyo@edficert.org | janesmith@edficert.org |
staffElectronicMails | electronicMailTypeDescriptor | FALSE | integer | CONDITIONAL | Work | Work | Work | Work |
staffElectronicMails | primaryEmailAddressIndicator | FALSE | boolean | OPTIONAL | ||||
staffElectronicMails | doNotPublishIndicator | FALSE | boolean | OPTIONAL | ||||
Staffs | identificationCodes | TRUE | staffIdentificationCode[] | OPTIONAL | ||||
staffIdentificationCodes | identificationCode | FALSE | string | OPTIONAL | ||||
staffIdentificationCodes | staffIdentificationSystemDescriptor | FALSE | integer | OPTIONAL | ||||
staffIdentificationCodes | assigningOrganizationIdentificationCode | FALSE | string | OPTIONAL | ||||
Staffs | identificationDocuments | TRUE | staffIdentificationDocument[] | OPTIONAL | ||||
stafflIdentificationDocuments | identificationDocumentUseDescriptor | FALSE | integer | OPTIONAL | ||||
stafflIdentificationDocuments | personalInformationVerificationDescriptor | FALSE | integer | OPTIONAL | ||||
stafflIdentificationDocuments | documentExpirationDate | FALSE | date | OPTIONAL | ||||
stafflIdentificationDocuments | documentTitle | FALSE | string | OPTIONAL | ||||
stafflIdentificationDocuments | issuerCountryDescriptor | FALSE | integer | OPTIONAL | ||||
stafflIdentificationDocuments | issuerDocumentIdentificationCode | FALSE | string | OPTIONAL | ||||
stafflIdentificationDocuments | issuerName | FALSE | string | OPTIONAL | ||||
Staffs | internationalAddresses | TRUE | staffInternationalAddress[] | OPTIONAL | ||||
staffInternationalAddresses | addressLine1 | FALSE | string | OPTIONAL | ||||
staffInternationalAddresses | addressTypeDescriptor | FALSE | integer | OPTIONAL | ||||
staffInternationalAddresses | countryDescriptor | FALSE | integer | OPTIONAL | ||||
staffInternationalAddresses | addressLine2 | FALSE | string | OPTIONAL | ||||
staffInternationalAddresses | addressLine3 | FALSE | string | OPTIONAL | ||||
staffInternationalAddresses | addressLine4 | FALSE | string | OPTIONAL | ||||
staffInternationalAddresses | beginDate | FALSE | date | OPTIONAL | ||||
staffInternationalAddresses | endDate | FALSE | date | OPTIONAL | ||||
staffInternationalAddresses | latitude | FALSE | string | OPTIONAL | ||||
staffInternationalAddresses | longitude | FALSE | string | OPTIONAL | ||||
Staffs | languages | TRUE | staffLanguage[] | OPTIONAL | ||||
staffLanguages | languageDescriptor | FALSE | integer | OPTIONAL | ||||
staffLanguages | uses | TRUE | staffLanguageUse[] | OPTIONAL | ||||
staffLanguageUses | languageUseDescriptor | FALSE | integer | OPTIONAL | ||||
Staffs | otherNames | TRUE | staffOtherName[] | OPTIONAL | ||||
staffOtherNames | firstName | FALSE | string | OPTIONAL | ||||
staffOtherNames | lastSurname | FALSE | string | OPTIONAL | ||||
staffOtherNames | otherNameTypeDescriptor | FALSE | integer | OPTIONAL | ||||
staffOtherNames | generationCodeSuffix | FALSE | string | OPTIONAL | ||||
staffOtherNames | middleName | FALSE | string | OPTIONAL | ||||
staffOtherNames | personalTitlePrefix | FALSE | string | OPTIONAL | ||||
Staffs | personalIdentificationDocuments | TRUE | staffpersonalIdentificationDocument[] | OPTIONAL | ||||
staffPersonalIdentificationDocuments | identificationDocumentUseDescriptor | FALSE | integer | OPTIONAL | ||||
staffPersonalIdentificationDocuments | personalInformationVerificationDescriptor | FALSE | integer | OPTIONAL | ||||
staffPersonalIdentificationDocuments | documentExpirationDate | FALSE | date | OPTIONAL | ||||
staffPersonalIdentificationDocuments | documentTitle | FALSE | string | OPTIONAL | ||||
staffPersonalIdentificationDocuments | issuerCountryDescriptor | FALSE | integer | OPTIONAL | ||||
staffPersonalIdentificationDocuments | issuerDocumentIdentificationCode | FALSE | string | OPTIONAL | ||||
staffPersonalIdentificationDocuments | issuerName | FALSE | string | OPTIONAL | ||||
Staffs | races | TRUE | staffRace[] | OPTIONAL | ||||
staffRaces | raceDescriptor | FALSE | integer | OPTIONAL | ||||
Staffs | telephones | TRUE | staffTelephone[] | OPTIONAL | ||||
staffTelephones | telephoneNumber | FALSE | string | OPTIONAL | ||||
staffTelephones | telephoneNumberTypeDescriptor | FALSE | integer | OPTIONAL | ||||
staffTelephones | orderOfPriority | FALSE | integer | OPTIONAL | ||||
staffTelephones | textMessageCapabilityIndicator | FALSE | boolean | OPTIONAL | ||||
Staffs | visas | TRUE | staffVisa[] | OPTIONAL | ||||
staffVisas | visaDescriptor | FALSE | integer | OPTIONAL | ||||
Staffs | tribalAffiliations | TRUE | tribalAffiliations[] | OPTIONAL | ||||
staffTribalAffiliations | tribalAffiliationDescriptor | FALSE | tribalAffiliationDescriptor | OPTIONAL | ||||
Staffs | recognitions | TRUE | Recognitions[] | OPTIONAL | ||||
staffRecognitions | achievementTitle | FALSE | string | OPTIONAL | ||||
staffRecognitions | achievementCategoryDescriptor | FALSE | achievementCategoryDescriptor | OPTIONAL | ||||
staffRecognitions | achievementCategorySystem | FALSE | string | OPTIONAL | ||||
staffRecognitions | issuerName | FALSE | string | OPTIONAL | ||||
staffRecognitions | issuerOriginURL | FALSE | string | OPTIONAL | ||||
staffRecognitions | criteria | FALSE | string | OPTIONAL | ||||
staffRecognitions | criteriaURL | FALSE | string | OPTIONAL | ||||
staffRecognitions | evidenceStatement | FALSE | string | OPTIONAL | ||||
staffRecognitions | imageURL | FALSE | string | OPTIONAL | ||||
staffRecognitions | recognitionTypeDescriptor | FALSE | recognitionTypeDescriptor | OPTIONAL | ||||
staffRecognitions | recognitionDescription | FALSE | string | OPTIONAL | ||||
staffRecognitions | recognitionAwardDate | FALSE | date | OPTIONAL | ||||
staffRecognitions | recognitionAwardExpiresDate | FALSE | date | OPTIONAL |
General
Content
Integrations