Tips for using the Create and SaveNew API operations
Published: March 26, 2024
Last Update: March 26, 2024
A large subset of the available APIs in Anthology Student have a scope of inserting and updating single instances of an entity. Every entity in the Student data model inherits from a base entity service. The available operations in the base entity service are Get, Create, SaveNew, Save and Delete. There are some entities in the model that have additional APIs implemented for inserting and updating data. These will be reflected with additional endpoints that are documented in Swagger. The focus of this document will outline best practices for how to insert a new instance into an entity utilizing the Create and SaveNew endpoints.
Swagger documentation
The use case that will be used as an example in this document will be to insert a new record into the Student entity. The list of available API endpoints that can be used for the Student entity are shown below. Using the Create and SaveNew endpoints will be covered in this document.
Create Operation
The first step will be to execute this operation for the entity you are adding a new record for. There is no request payload to provide. The sole purpose of this operation is to return an instance of the entity. Additionally, if there is a constructor method implemented for this entity, then some of the properties will be assigned default values. Since the request payload for ALL SaveNew endpoints is the entity itself, the use of this endpoint provides a simple way to obtain an instantiated instance of the entity object that you will use as the request when calling the SaveNew endpoint for the entity. Additionally, any default values specified in the constructor method for the entity will be assigned to the applicable properties of the entity. Even if no constructor method is implemented, you will still benefit from using this to instantiate an empty instance of the entity you are adding a record for. Below is the response received when executing the Create endpoint. Copy/Paste the section of the response below that is inside the “data” element. This will be your starting payload for the SaveNew endpoint.
{
"payload": {
"data": {
"isExcludedCrmIntegration": false,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [],
"programsList": [],
"enrolledProgramIdList": [],
"ethnicitiesList": [],
"leadSourcesList": [],
"deleteVeteranDetails": false,
"vendors": [],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "0001/01/01 00:00:00",
"studentRelationshipAddress": null,
"lastFourSsn": null,
"customProperties": {},
"multiValueCustomProperties": {},
"originalCustomPropertiesValues": null,
"originalMultiValueCustomPropertiesValues": null,
"genderPronounList": [],
"overridePrevEducAltPellValidation": false,
"id": -1,
"acgEligReasonCode": null,
"agencyId": 0,
"alienNumber": "",
"arAccountStatus": "X",
"arBalance": 0,
"arNextTransactionNumber": 0,
"assignedAdmissionsRepId": 0,
"athleticIdentifier": null,
"bestTimeToContact": "Anytime",
"campusId": 0,
"citizenId": 0,
"city": "",
"collegeId": null,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2024/03/13 14:17:21",
"cumulativeGpa": null,
"cumulativeGpaPoints": null,
"currencyCodeId": null,
"currentLda": null,
"dataBlockIndicator": false,
"dateOfBirth": null,
"dbiModifiedDate": null,
"defaultAddressCode": null,
"defaultMasterStudentAddressId": null,
"defaultStudentAddressId": null,
"disabled": "X",
"driverLicenseNumber": "",
"driverLicenseState": "",
"emailAddress": "",
"employabilityAboutInfo": null,
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": null,
"extraCurricularActivityId": 0,
"facebookUrl": null,
"faGradPlusCounselingDate": null,
"faRigorousHighSchoolProgramCodeId": null,
"firstName": null,
"genderId": 0,
"gpaCredits": null,
"hispanicLatino": null,
"hsAcademicGpa": null,
"instagramUrl": null,
"isActive": true,
"isAllowedBulkRegistrationByTrack": null,
"isBadAddress": false,
"isBadPhone": false,
"isClearinghouseDataBlockIndicator": false,
"isDdVeteran": false,
"isEftDefaultForStipends": false,
"isInDistrict": false,
"isSscrError11Received": false,
"lastActivityDate": null,
"lastInterestDate": null,
"lastModifiedDateTime": "2024/03/13 14:17:21",
"lastModifiedUserId": 3050,
"lastName": null,
"lastNameFirstFour": null,
"lastStatementBeginDate": null,
"lastStatementCloseDate": null,
"lastStatementDate": null,
"leadDate": null,
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": null,
"maidenName": "",
"maritalStatusId": 0,
"mi": "",
"middleName": "",
"mobilePhoneNumber": "",
"nationalityId": 0,
"nickName": "",
"niStudent": false,
"note": "",
"originalAssignedAdmissionsRepId": null,
"originalExpectedStartDate": null,
"originalStartDate": null,
"otherEmailAddress": "",
"otherLanguageFirstName": null,
"otherLanguageLastName": null,
"otherLanguageMiddleName": null,
"otherLanguageStudentFullName": null,
"otherPhoneNumber": null,
"personId": null,
"phoneNumber": "",
"pin": null,
"postalCode": "",
"postalCodeFirstThree": null,
"preferredContactType": "Ph",
"preferredName": null,
"previousEducationGpa": null,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": null,
"rawLastName": null,
"rawPhoneNumber": null,
"rowVersion": null,
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": null,
"sourceSystem": "C",
"ssn": "",
"startDate": null,
"state": "",
"statementComment": "",
"streetAddress": "",
"streetAddress2": null,
"studentFullName": null,
"studentIdentifier": null,
"studentNumber": null,
"subscribeToSms": false,
"suffix": null,
"suffixId": null,
"titleId": 0,
"twitterUrl": null,
"veteran": "X",
"workPhoneNumber": "",
"workPhoneNumberExtension": "",
"originalState": "H4sIAAAAAAAEAL1Yy27bMBD8lcD3Wk5zMxwDqmIERf1C5aa90uTKXoQijSVpR/n6UnJQoIcURYHpSZAIzg60u7NDzkoR1W2aL9Q9KZto04Qo7A7KdbvuRDcvrXXhfnSM8TQtiqCP1KowblmLD76JY+3b4uNkclfcToqahJXlVxXZu2IADqMrwpR/YVwul/Hlbuzl0G+8LX6slvUA+4FdiMppGs1n79AZFuZLFeLKG26YzLdA8tnMiv77bNhyw1PH9n4UJdGomA9L72L9XZAHFWnHLQHCQLhXQpkxkvaOoyUI9zXr57WCkF4pNuRA4HUUolgaIxQCIqccOwjtXCQA3K3PvWwrbxDglU8udpDy2x69o3Vq9yQA9O9env9rhMVLJBeyHCMUkpTp3yB5eCRnQMq+HuZTHlSgElop4Vz7fWelAInwIHwmWbLOuSVUB/8WBFavpeUsyTD0AzmNyXLWY34lB8FetIotbpSUIfDBkSlNy6EXh/CVThgTlSWi9kk0RiS24g+i2kfxCcP/LQAEuz5yE0Gs6cw+hYVJetA6SJRSSq37QXwVOpQ3acnFyrf9A9JpJ+s70KC5gvfMgbNg7THqz0HtLSEYP1EkUQhH8olC7A88O195F5VGVMxVzuou5NJEmAdGcA6Iv529pagqibBOVmU1iHxGeapNPGYzix2LKzbGEurs6fdsCev9h2ORgM5FQg2JkHnrrH4FcR0ShjL6R+jiz5dZ85/9wSrH7RIAAA==",
"secureState": "H4sIAAAAAAAEAD3MQQrCMBAAwK9I7mZTeysqeFbpoSJel5C0C01Ssisxvl6s4ANm9qecsfb+7Ood56frPUumOGKst7q4zSvMkQ9qElk6ALaTC8g6kM2JkxdtU4CdMS00BgaXCWd6o1CKsMasfkNH/6OUokurUx6/sIHH9TKs7ZYiC0brFBw/juQnSpcAAAA=",
"extendedProperties": [],
"entityState": 0
}
},
"notifications": [],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}
SaveNew Operation
This is the operation that is used to insert an instance of the entity. Using the object returned from the call to the Create endpoint, update the applicable properties with the desired values. Below is an example of a payload for inserting a new instance into the Student entity. Properties where values were assigned are highlighted.
{
"payload": {
"isExcludedCrmIntegration": false,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [],
"programsList": [],
"enrolledProgramIdList": [],
"ethnicitiesList": [],
"leadSourcesList": [],
"deleteVeteranDetails": false,
"vendors": [],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "0001/01/01 00:00:00",
"studentRelationshipAddress": null,
"lastFourSsn": null,
"customProperties": {},
"multiValueCustomProperties": {},
"originalCustomPropertiesValues": null,
"originalMultiValueCustomPropertiesValues": null,
"genderPronounList": [],
"overridePrevEducAltPellValidation": false,
"id": -1,
"acgEligReasonCode": null,
"agencyId": 0,
"alienNumber": "",
"arAccountStatus": "X",
"arBalance": 0,
"arNextTransactionNumber": 0,
=="assignedAdmissionsRepId": 53,==
"athleticIdentifier": null,
"bestTimeToContact": "Anytime",
=="campusId": 5,==
"citizenId": 0,
=="city": "Englewood",==
"collegeId": null,
=="countryId": 1,==
"countyId": 0,
"createdDateTime": "2024/03/13 22:47:27",
"cumulativeGpa": null,
"cumulativeGpaPoints": null,
"currencyCodeId": null,
"currentLda": null,
"dataBlockIndicator": false,
"dateOfBirth": null,
"dbiModifiedDate": null,
"defaultAddressCode": null,
"defaultMasterStudentAddressId": null,
"defaultStudentAddressId": null,
"disabled": "X",
"driverLicenseNumber": "",
"driverLicenseState": "",
=="emailAddress": "jparker8765@gmail.com",==
"employabilityAboutInfo": null,
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": null,
"extraCurricularActivityId": 0,
"facebookUrl": null,
"faGradPlusCounselingDate": null,
"faRigorousHighSchoolProgramCodeId": null,
=="firstName": "Joseph",==
"genderId": 0,
"gpaCredits": null,
"hispanicLatino": null,
"hsAcademicGpa": null,
"instagramUrl": null,
"isActive": true,
"isAllowedBulkRegistrationByTrack": null,
"isBadAddress": false,
"isBadPhone": false,
"isClearinghouseDataBlockIndicator": false,
"isDdVeteran": false,
"isEftDefaultForStipends": false,
"isInDistrict": false,
"isSscrError11Received": false,
"lastActivityDate": null,
"lastInterestDate": null,
"lastModifiedDateTime": "2024/03/13 22:47:27",
"lastModifiedUserId": 3050,
=="lastName": "Parker",==
"lastNameFirstFour": null,
"lastStatementBeginDate": null,
"lastStatementCloseDate": null,
"lastStatementDate": null,
=="leadDate": "2024/03/12 00:00:00",==
=="leadSourceId": 689,==
"leadTypeId": 0,
"linkedInUrl": null,
"maidenName": "",
"maritalStatusId": 0,
"mi": "",
"middleName": "",
"mobilePhoneNumber": "",
"nationalityId": 0,
"nickName": "",
"niStudent": false,
"note": "",
"originalAssignedAdmissionsRepId": null,
"originalExpectedStartDate": null,
"originalStartDate": null,
"otherEmailAddress": "",
"otherLanguageFirstName": null,
"otherLanguageLastName": null,
"otherLanguageMiddleName": null,
"otherLanguageStudentFullName": null,
"otherPhoneNumber": null,
"personId": null,
"phoneNumber": "",
"pin": null,
=="postalCode": "80113",==
"postalCodeFirstThree": null,
"preferredContactType": "Ph",
"preferredName": null,
"previousEducationGpa": null,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": null,
"rawLastName": null,
"rawPhoneNumber": null,
"rowVersion": null,
=="schoolStatusId": 1,==
"shiftId": 0,
"smsServiceProviderId": null,
"sourceSystem": "C",
"ssn": "",
"startDate": null,
"state": "CO",
"statementComment": "",
=="streetAddress": "1234 Maple St.",==
"streetAddress2": null,
"studentFullName": null,
"studentIdentifier": null,
"studentNumber": null,
"subscribeToSms": false,
"suffix": null,
"suffixId": null,
"titleId": 0,
"twitterUrl": null,
"veteran": "X",
"workPhoneNumber": "",
"workPhoneNumberExtension": "",
"originalState": "H4sIAAAAAAAEAL1Yy27bMBD8lcD3Wk5zMxwDqmIERf1C5aa90uTKXoQijSVpR/n6UnJQoIcURYHpSZAIzg60u7NDzkoR1W2aL9Q9KZto04Qo7A7KdbvuRDcvrXXhfnSM8TQtiqCP1KowblmLD76JY+3b4uNkclfcToqahJXlVxXZu2IADqMrwpR/YVwul/Hlbuzl0G+8LX6slvUA+4FdiMppGs1n79AZFuZLFeLKG26YzLdA8tnMiv77bNhyw1PH9n4UJdGomA9L72L9XZAHFWnHLQHCQLhXQpkxkvaOoyUI9zXr57WCkF4pNuRA4HUUolgaIxQCIqccOwjtXCQA3K3PvWwrbxDglU8udpDy2x69o3Vq9yQA9O9env9rhMVLJBeyHCMUkpTp3yB5eCRnQMq+HuZTHlSgElop4Vz7fWelAInwIHwmWbLOuSVUB/8WBFavpeUsyTD0AzmNyXLWY34lB8FetIotbpSUIfDBkSlNy6EXh/CVThgTlSWi9kk0RiS24g+i2kfxCcP/LQAEuz5yE0Gs6cw+hYVJetA6SJRSSq37QXwVOpQ3acnFyrf9A9JpJ+s70KC5gvfMgbNg7THqz0HtLSEYP1EkUQhH8olC7A88O195F5VGVMxVzuou5NJEmAdGcA6Iv529pagqibBOVmU1iHxGeapNPGYzix2LKzbGEurs6fdsCev9h2ORgM5FQg2JkHnrrH4FcR0ShjL6R+jiz5dZ85/9wSrH7RIAAA==",
"secureState": "H4sIAAAAAAAEAD3MQQrCMBAAwK9I7mZTeysqeFbpoSJel5C0C01Ssisxvl6s4ANm9qecsfb+7Ood56frPUumOGKst7q4zSvMkQ9qElk6ALaTC8g6kM2JkxdtU4CdMS00BgaXCWd6o1CKsMasfkNH/6OUokurUx6/sIHH9TKs7ZYiC0brFBw/juQnSpcAAAA=",
"extendedProperties": [],
"entityState": 0
}
}
The response received when executing the SaveNew operation for the Student entity using the payload above is shown below.
{
"payload": {
"data": {
"isExcludedCrmIntegration": false,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [],
"programsList": [],
"enrolledProgramIdList": [],
"ethnicitiesList": [],
"leadSourcesList": [
689
],
"deleteVeteranDetails": false,
"vendors": [],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "0001/01/01 00:00:00",
"studentRelationshipAddress": null,
"lastFourSsn": "",
"customProperties": {},
"multiValueCustomProperties": {},
"originalCustomPropertiesValues": null,
"originalMultiValueCustomPropertiesValues": null,
"genderPronounList": [],
"overridePrevEducAltPellValidation": false,
"id": 50908,
"acgEligReasonCode": null,
"agencyId": 0,
"alienNumber": "",
"arAccountStatus": "X",
"arBalance": 0,
"arNextTransactionNumber": 0,
"assignedAdmissionsRepId": 53,
"athleticIdentifier": null,
"bestTimeToContact": "Anytime",
"campusId": 5,
"citizenId": 0,
"city": "Englewood",
"collegeId": null,
"countryId": 1,
"countyId": 0,
"createdDateTime": "2024/03/13 23:02:40",
"cumulativeGpa": null,
"cumulativeGpaPoints": null,
"currencyCodeId": null,
"currentLda": null,
"dataBlockIndicator": false,
"dateOfBirth": null,
"dbiModifiedDate": null,
"defaultAddressCode": null,
"defaultMasterStudentAddressId": null,
"defaultStudentAddressId": null,
"disabled": "X",
"driverLicenseNumber": "",
"driverLicenseState": "",
"emailAddress": "jparker8765@gmail.com",
"employabilityAboutInfo": null,
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": null,
"extraCurricularActivityId": 0,
"facebookUrl": null,
"faGradPlusCounselingDate": null,
"faRigorousHighSchoolProgramCodeId": null,
"firstName": "Joseph",
"genderId": 0,
"gpaCredits": null,
"hispanicLatino": null,
"hsAcademicGpa": null,
"instagramUrl": null,
"isActive": true,
"isAllowedBulkRegistrationByTrack": null,
"isBadAddress": false,
"isBadPhone": false,
"isClearinghouseDataBlockIndicator": false,
"isDdVeteran": false,
"isEftDefaultForStipends": false,
"isInDistrict": false,
"isSscrError11Received": false,
"lastActivityDate": null,
"lastInterestDate": null,
"lastModifiedDateTime": "2024/03/13 23:02:40",
"lastModifiedUserId": 3050,
"lastName": "Parker",
"lastNameFirstFour": null,
"lastStatementBeginDate": null,
"lastStatementCloseDate": null,
"lastStatementDate": null,
"leadDate": "2024/03/12 00:00:00",
"leadSourceId": 689,
"leadTypeId": 0,
"linkedInUrl": null,
"maidenName": "",
"maritalStatusId": 0,
"mi": "",
"middleName": "",
"mobilePhoneNumber": "",
"nationalityId": 0,
"nickName": "",
"niStudent": false,
"note": "",
"originalAssignedAdmissionsRepId": null,
"originalExpectedStartDate": null,
"originalStartDate": null,
"otherEmailAddress": "",
"otherLanguageFirstName": null,
"otherLanguageLastName": null,
"otherLanguageMiddleName": null,
"otherLanguageStudentFullName": null,
"otherPhoneNumber": null,
"personId": null,
"phoneNumber": "",
"pin": null,
"postalCode": "80113",
"postalCodeFirstThree": null,
"preferredContactType": "Ph",
"preferredName": null,
"previousEducationGpa": null,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": null,
"rawLastName": null,
"rawPhoneNumber": null,
"rowVersion": "AAAAAAMbrUk=",
"schoolStatusId": 1,
"shiftId": 0,
"smsServiceProviderId": null,
"sourceSystem": "C",
"ssn": "",
"startDate": null,
"state": "CO",
"statementComment": "",
"streetAddress": "1234 Maple St.",
"streetAddress2": null,
"studentFullName": null,
"studentIdentifier": null,
"studentNumber": "1149",
"subscribeToSms": false,
"suffix": null,
"suffixId": null,
"titleId": 0,
"twitterUrl": null,
"veteran": "X",
"workPhoneNumber": "",
"workPhoneNumberExtension": "",
"originalState": "H4sIAAAAAAAEANVbbVMiORD+K5bflQFcz6WUOkB0uVOkAPf2a0iaoY9MQnUyIvvrLzOi56njnU6ic5ZlqTDpJ+lO99MvHHeI2OZq/jtsvjOZwtXcWEIVM7WZblawc5tIZU52F9auWrWa4QtImNlPkJM2em73uU5qjShq1upRbQKETOJPZlGrWr6w2b1boYUPa6zX6/11c19TnD1Yr/24vJjky+6hMpYpDrvt4wI4+QvtgenfcpkKED1KBspCTLnI41r26nH+4A62rHvgZJe1ZlpLYOoeCft3JLvtOZMGjmv5Uu183UI4xTgvmLFnOqWJKYJ299BbkNXejWYgCkCgsm86my/R1+io7Nl0eNyXGI+BGa16WsATcArlya6lFErsuBOD4htv+45K71kiqGGazIAqYA8d6nCuU2UnltnUeEPU/lH6nKjLZOYICjAJ4Jgw+cHKoyHc2ikxZRjPvM3rilxo+mjrMgZjBaIjEnS/amXGsPJ36Zul8dmFBIt8IEBZnOOzs/Nx5btg7BQTmOqeVtYpyp9Zd9TGupXLHkOPJavU+NNLaTxo8Seo6nhJB2jjT2t9FUtYay1Kw9JSQgzPzsmH1fYyN0z+IlW9/GYdoApFzh4BsyBO3Y9pfgdfjgvbl9+ErRE1Dvai5l69OW00W1GjdRDtf21GjaPDo73ooBWVx54mqXT89AbOVyyE8Txef6Sdbp7Gcj9SiDI2lVG1MHcgF2AvRIgzcobDulLz5UAJ5Mzqorj9ablCZtpX8y6SXYTY/wwvtciCbn6HQkiAOUul7QhBYEwgQr8VcunyKqCJTTMmsZUYxCa38j5CEho2k1DkcD+DhZ+Scyl0gRyUgcpkLf9AlWUuRcHgI0H1E4Zyax7+NPjnitES6OiXwy+/xpmErNhSVqv9ZCX1hs1QOprVmenUDtRcB7DoO0FA1SERd4gSuM94K4Ts1vkzxeTW0QTNkJwsYlmwRe5oA3VcLnuDVeJ6Z4yDC8PLa5IBtn/GzomJkUxNxnENSPeGQCHxjI0x1qRT8w3jhTsfxy1GpGNiSTAWdYZk7JAVUuR3uKHftIHVoqxWz0GJKjkDx5VdUiEwCFn+hmbFFPILR8tVCOf6zXQ4E5AgD5NTDLJKfGaoYS7hwORup8hI30PCM0RlbcLBklKvQXRTuRxDjO49eWOhu5kS48sgJ9Fl4nXm8GkpSY5ttNDKp548Ies5wdm/F867QvWzu4E5Fd/BBXlWuSbVwPTndpvonGmXVeHKueoKGuNAnWYXEgtrup+IbWI49Yk01etj4OBcW1Gg+9Rm5D3ZC0R4MhFZO9Y5MxtQxONKxv+uGvh4A9fGIyNqRl+8gPNLHkd5CusLV85us456IMvK6wlZgth1wV8FNOEHQT2p8/gVXFAoGcBeqij6uYONaRS18u/SBuRgTpzd8OdZ13vv2+HRVx+osr+qkxVdoFqCGKgwtP+SoQDl1cGUAUNos5JLtUpBl1iFs0EhJFRFUXqGEvI8pDJV6GGeFjJZqcLZEPmyIjob4raUWTUWPNSVaBhcETqCweR/m9nx4XvvJfZvV8AtCOf3KBQpuJcVVIZdAAXpu5TEdMFUnLIYiiqx3jZ/L6iAtHuXUxgUvEva+o6zVMqQ4opDig8RIyCjn49VeVm6UrFwhE9rWl72qI1jZy/MEZRIRo+ier30GOPfwPIbPl0QhLDQEcEciEBs5xizVzym5aX7OQ/4At1Qt/4N6tT0RcpzshWm0fFMTHXo3LZVeE469TfG6wtVdQCN2TpkqHXLBwywbvWwUWis199dIHrlwzHMwOFB19E12rxtHDr/upzR9fKkrA7veuOeU/HSQ7CTBc5tdQx9kpgJ0A1ycHfwBl/qpvuwmLsy2WRjLCT+Ak6v9O4r8RmqkBmN32G2du+q9JE/FKl1khTn8h97/o5tWe+TdvVG82Dnkq0k7EzsfvlzewSyEcRSQudHHzGItpXhOY9p1+sHpQvzk3RmOOEMptp53arVsCbpfI63ITSSLxwkqkzRygr1OaZrtBYoTJvj9UGPd5h06VHuPzQtq1U0eIIoG4BVr7BUz9Bqr3/ovf0XA0njYRU/AAA=",
"secureState": "H4sIAAAAAAAEAD3MQQrCMBAAwK9I7mZTeysqeFbpoSJel5C0C01Ssisxvl6s4ANm9qecsfb+7Ood56frPUumOGKst7q4zSvMkQ9qElk6ALaTC8g6kM2JkxdtU4CdMS00BgaXCWd6o1CKsMasfkNH/6OUokurUx6/sIHH9TKs7ZYiC0brFBw/juQnSpcAAAA=",
"extendedProperties": [],
"entityState": 3
}
},
"notifications": [],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}
Additional notes:
Implementation of SaveNew operation
Not every entity has the SaveNew operation implemented. As a general rule you can use to determine if the SaveNew operation is implemented is to look at the other operations for that entity in the Swagger documentation. If there is another operation listed that has a summary description related to adding new records then the SaveNew operation should not be utilized. If you have any doubts, please send an email to Developers@anthology.com requesting clarification on which endpoint to use for inserting a new record into an entity.
EntityState property
EntityState is a property that exists on the base entity class that every entity inherits from. This is an enum property with the following valid values:
0= Record is being added
1= Record is being deleted
2= Record is being modified
3= Record is unchanged
The value provided in this property may or may not impact the execution logic of the API you are calling. The use of this property in the API execution logic is not consistent across all of the Delete, Save and SaveNew operations. It is recommended that this property be populated correctly to align with the action that is occurring to ensure expected behavior in the API if there is dependent execution logic on this property.
Id property
The primary key for every entity in the Student data model is called Id. In most cases, this property will be populated with -1 in the response returned from the Create operation. If not, it is recommended that you set the value for this property to -1 prior to calling the SaveNew operation.
Contributors on this article:
