Admissions

• Applicant
  • postCreate Applicant
  • postDelete Applicant
  • postGet Applicant
  • postGet Applicant Status Change
  • postSave Applicant
  • postSave New Applicant
  • postSet Applicant Program Version Defaults
• College
  • postCreate College
  • postDelete College
  • postGet College
  • postSave College
  • postSave New College
• EntranceTestScore
  • postAdd Entrance Test Scores
  • postCreate Entrance Test Score
  • postCreate Entrance Test Score From Template
  • postDelete Entrance Test Score
  • postDelete Entrance Test Scores
  • postGet Entrance Test Score
  • postGet Available Test
  • postGet Selected Entrance Test
  • postSave Entrance Test Score
  • postSave Entrance Test Scores
  • postSave New Entrance Test Score
• ExtraCurricularActivity
  • postCreate Extra Curricular Activity
  • postDelete Extra Curricular Activity
  • postGet Extra Curricular Activity
  • postSave Extra Curricular Activity
  • postSave New Extra Curricular Activity
• HighSchool
  • postCreate High School
  • postDelete High School
  • postGet High School
  • postSave High School
  • postSave New High School
• PreviousEducation
  • postCreate Previous Education
  • postDelete Previous Education
  • postGet Previous Education
  • postSave Previous Education
  • postSave New Previous Education
• ProspectInquiry
  • postCreate Prospect Inquiry
  • postDelete Prospect Inquiry
  • postDelete Prospect
  • postGet Prospect Inquiry
  • postSave Prospect Inquiry
  • postSave New Prospect Inquiry
• StudentPreviousEducation
  • postCreate Student Previous Education
  • postDelete Student Previous Education
  • postGet Student Previous Education
  • postSave Student Previous Education
  • postSave New Student Previous Education

API docs by Redocly

Admissions (1.0)

Download OpenAPI specification:Download

Anthology, Inc.: support@anthology.com URL: https://www.anthology.com

All API calls related to Admissions.

Applicant

Create Applicant

Authorizations:

apikey

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/Applicant/create

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "accountReceivableBalance": 0,
    • "admissionsRegionId": 0,
    • "applicantProgress": 0,
    • "applicantTypeId": 0,
    • "applicationReceivedDate": "2019-08-24T14:15:22Z",
    • "assignedAdmissionsRepId": 0,
    • "billingMethodId": 0,
    • "campusId": 0,
    • "catalogYearId": 0,
    • "clockHoursRequired": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "creditHoursRequired": 0,
    • "enrollmentDate": "2019-08-24T14:15:22Z",
    • "enrollmentNumber": "string",
    • "enrollmentStatusId": 0,
    • "expectedCreditsHoursPerTerm": 0,
    • "expectedHoursPerWeekForExternship": 0,
    • "expectedStartDate": "2019-08-24T14:15:22Z",
    • "externshipBeginDate": "2019-08-24T14:15:22Z",
    • "faEntranceInterviewDate": "2019-08-24T14:15:22Z",
    • "gradeLevelId": 0,
    • "gradeScaleId": 0,
    • "graduationDate": "2019-08-24T14:15:22Z",
    • "ipedsState": "string",
    • "isApplicant": true,
    • "isTransfer": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "midpointDate": "2019-08-24T14:15:22Z",
    • "note": "string",
    • "originalAssignedAdmissionsRepId": 0,
    • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
    • "previousEducationId": 0,
    • "programId": 0,
    • "programVersionId": 0,
    • "programVersionName": "string",
    • "rowVersion": "string",
    • "schoolStatusChangeDate": "2019-08-24T14:15:22Z",
    • "schoolStatusChangeReasonId": 0,
    • "schoolStatusId": 0,
    • "shiftId": 0,
    • "startDateId": 0,
    • "startTermId": 0,
    • "statChangeType": 0,
    • "studentId": 0,
    • "transcriptIssued": "2019-08-24T14:15:22Z",
    • "transferCreditHours": 0,
    • "applicantAreasOfStudy": [

      • {

        • "id": 0,
        • "areaOfStudyId": 0,
        • "createdByUserId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isExcludedCrmIntegration": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "programVersionAreaOfStudyId": 0,
        • "rowVersion": "string",
        • "studentAreaOfStudyParentId": 0,
        • "applicantId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "overrideWithProgramVersionDates": 0,
    • "modifiedPropertiesForEdit": [

      • "string"

      ],
    • "isProgramVersionDifferent": 0,
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Delete Applicant

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-applicant-delete-request-payload)

id number <int32> accountReceivableBalance number <double> Account Receivable Balance admissionsRegionId number <int32> Zone applicantProgress number <int32> Represents the Applicant Progress associated with this Student Enrollment Periods applicantTypeId number <int32> Represents the Applicant Type associated with this Student Enrollment Periods applicationReceivedDate string <date-time> Represents the Date Application was Received associated with this Student Enrollment Periods assignedAdmissionsRepId number <int32> Admissions Representative billingMethodId number <int32> Billing Method campusId number <int32> Represents the Campus associated with this Student Enrollment Periods catalogYearId number <int32> Catalog clockHoursRequired number <double> Represents the number of Clock Hours Required associated with this Student Enrollment Periods createdDateTime string <date-time> Date Added creditHoursRequired number <double> Represents the number of Credit Hours Required associated with this Student Enrollment Periods enrollmentDate string <date-time> Represents the Enrollment Date associated with this Student Enrollment Periods enrollmentNumber string Represents the Enrollment Number associated with this Student Enrollment Periods enrollmentStatusId number <int32> Enrollment Status expectedCreditsHoursPerTerm number <double> Represents the number of Credit/Hours per term associated with this Student Enrollment Periods expectedHoursPerWeekForExternship number <double> Expected Hours Per Week For Externship expectedStartDate string <date-time> Represents the Expected Start Date associated with this Student Enrollment Periods externshipBeginDate string <date-time> Represents the Date Externship Begins associated with this Student Enrollment Periods faEntranceInterviewDate string <date-time> Financial Aid Entrance Date gradeLevelId number <int32> Grade Level gradeScaleId number <int32> Grade Scale graduationDate string <date-time> Represents the Graduation Date associated with this Student Enrollment Periods ipedsState string Represents the IPEDS State associated with this Student Enrollment Periods isApplicant boolean Is this the applicant? isTransfer boolean Is this an IPEDS Transfer? lastActivityDate string <date-time> Last Task Date lastModifiedDateTime string <date-time> Date Modified lastModifiedUserId number <int32> Modified By midpointDate string <date-time> Represents the Midpoint Date associated with this Student Enrollment Periods note string Note originalAssignedAdmissionsRepId number <int32> Original Admissions Representative originalExpectedStartDate string <date-time> Represents the Date/Time of Original Expected Start associated with this Student Enrollment Periods previousEducationId number <int32> Previous Education programId number <int32> Represents the Program ID associated with this Student Enrollment Periods programVersionId number <int32> Program Version programVersionName string Program Version Name rowVersion string schoolStatusChangeDate string <date-time> Represents the Date Status Changed associated with this Student Enrollment Periods schoolStatusChangeReasonId number <int32> Status Reason schoolStatusId number <int32> Student Status shiftId number <int32> Shift startDateId number <int32> Represents the Start Date associated with this Student Enrollment Periods startTermId number <int32> Represents the Start Term ID associated with this Student Enrollment Periods statChangeType number <int32> studentId number <int32> Student Id transcriptIssued string <date-time> Transcript Issued transferCreditHours number <double> Represents the number of Transfer Credits/Hours associated with this Student Enrollment Periods Array of objects (cmc-nexus-admissions-entities-applicantAreaOfStudyEntity) Areas of Study overrideWithProgramVersionDates number <int32> modifiedPropertiesForEdit Array of strings isProgramVersionDifferent number <int32> originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/Applicant/delete

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "accountReceivableBalance": 0,
  • "admissionsRegionId": 0,
  • "applicantProgress": 0,
  • "applicantTypeId": 0,
  • "applicationReceivedDate": "2019-08-24T14:15:22Z",
  • "assignedAdmissionsRepId": 0,
  • "billingMethodId": 0,
  • "campusId": 0,
  • "catalogYearId": 0,
  • "clockHoursRequired": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "creditHoursRequired": 0,
  • "enrollmentDate": "2019-08-24T14:15:22Z",
  • "enrollmentNumber": "string",
  • "enrollmentStatusId": 0,
  • "expectedCreditsHoursPerTerm": 0,
  • "expectedHoursPerWeekForExternship": 0,
  • "expectedStartDate": "2019-08-24T14:15:22Z",
  • "externshipBeginDate": "2019-08-24T14:15:22Z",
  • "faEntranceInterviewDate": "2019-08-24T14:15:22Z",
  • "gradeLevelId": 0,
  • "gradeScaleId": 0,
  • "graduationDate": "2019-08-24T14:15:22Z",
  • "ipedsState": "string",
  • "isApplicant": true,
  • "isTransfer": true,
  • "lastActivityDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "midpointDate": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "originalAssignedAdmissionsRepId": 0,
  • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
  • "previousEducationId": 0,
  • "programId": 0,
  • "programVersionId": 0,
  • "programVersionName": "string",
  • "rowVersion": "string",
  • "schoolStatusChangeDate": "2019-08-24T14:15:22Z",
  • "schoolStatusChangeReasonId": 0,
  • "schoolStatusId": 0,
  • "shiftId": 0,
  • "startDateId": 0,
  • "startTermId": 0,
  • "statChangeType": 0,
  • "studentId": 0,
  • "transcriptIssued": "2019-08-24T14:15:22Z",
  • "transferCreditHours": 0,
  • "applicantAreasOfStudy": [

    • {

      • "id": 0,
      • "areaOfStudyId": 0,
      • "createdByUserId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isExcludedCrmIntegration": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "programVersionAreaOfStudyId": 0,
      • "rowVersion": "string",
      • "studentAreaOfStudyParentId": 0,
      • "applicantId": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "overrideWithProgramVersionDates": 0,
  • "modifiedPropertiesForEdit": [

    • "string"

    ],
  • "isProgramVersionDifferent": 0,
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "deleted": true

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Get Applicant

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-applicant-get-request-payload)
id number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/Applicant/get

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "accountReceivableBalance": 0,
    • "admissionsRegionId": 0,
    • "applicantProgress": 0,
    • "applicantTypeId": 0,
    • "applicationReceivedDate": "2019-08-24T14:15:22Z",
    • "assignedAdmissionsRepId": 0,
    • "billingMethodId": 0,
    • "campusId": 0,
    • "catalogYearId": 0,
    • "clockHoursRequired": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "creditHoursRequired": 0,
    • "enrollmentDate": "2019-08-24T14:15:22Z",
    • "enrollmentNumber": "string",
    • "enrollmentStatusId": 0,
    • "expectedCreditsHoursPerTerm": 0,
    • "expectedHoursPerWeekForExternship": 0,
    • "expectedStartDate": "2019-08-24T14:15:22Z",
    • "externshipBeginDate": "2019-08-24T14:15:22Z",
    • "faEntranceInterviewDate": "2019-08-24T14:15:22Z",
    • "gradeLevelId": 0,
    • "gradeScaleId": 0,
    • "graduationDate": "2019-08-24T14:15:22Z",
    • "ipedsState": "string",
    • "isApplicant": true,
    • "isTransfer": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "midpointDate": "2019-08-24T14:15:22Z",
    • "note": "string",
    • "originalAssignedAdmissionsRepId": 0,
    • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
    • "previousEducationId": 0,
    • "programId": 0,
    • "programVersionId": 0,
    • "programVersionName": "string",
    • "rowVersion": "string",
    • "schoolStatusChangeDate": "2019-08-24T14:15:22Z",
    • "schoolStatusChangeReasonId": 0,
    • "schoolStatusId": 0,
    • "shiftId": 0,
    • "startDateId": 0,
    • "startTermId": 0,
    • "statChangeType": 0,
    • "studentId": 0,
    • "transcriptIssued": "2019-08-24T14:15:22Z",
    • "transferCreditHours": 0,
    • "applicantAreasOfStudy": [

      • {

        • "id": 0,
        • "areaOfStudyId": 0,
        • "createdByUserId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isExcludedCrmIntegration": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "programVersionAreaOfStudyId": 0,
        • "rowVersion": "string",
        • "studentAreaOfStudyParentId": 0,
        • "applicantId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "overrideWithProgramVersionDates": 0,
    • "modifiedPropertiesForEdit": [

      • "string"

      ],
    • "isProgramVersionDifferent": 0,
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Get Applicant Status Change

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-applicant-getapplicantstatuschange-request-payload)

campusId number <int32> schoolStatusId number <int32> studentGroupIdList Array of numbers <int32> [ items <int32 > ] leadSourceIdList Array of numbers <int32> [ items <int32 > ] leadCategoryIdList Array of numbers <int32> [ items <int32 > ] stateIdList Array of numbers <int32> [ items <int32 > ] programIdList Array of numbers <int32> [ items <int32 > ] programVersionIdList Array of numbers <int32> [ items <int32 > ] admissionRepIdList Array of numbers <int32> [ items <int32 > ] prospectDateFrom string <date-time> prospectDateTo string <date-time> expectedStartDateFrom string <date-time> expectedStartDateTo string <date-time> applicationReceivedDateFrom string <date-time> applicationReceivedDateTo string <date-time> userId number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/Applicant/getApplicantStatusChange

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "campusId": 0,
  • "schoolStatusId": 0,
  • "studentGroupIdList": [

    • 0

    ],
  • "leadSourceIdList": [

    • 0

    ],
  • "leadCategoryIdList": [

    • 0

    ],
  • "stateIdList": [

    • 0

    ],
  • "programIdList": [

    • 0

    ],
  • "programVersionIdList": [

    • 0

    ],
  • "admissionRepIdList": [

    • 0

    ],
  • "prospectDateFrom": "2019-08-24T14:15:22Z",
  • "prospectDateTo": "2019-08-24T14:15:22Z",
  • "expectedStartDateFrom": "2019-08-24T14:15:22Z",
  • "expectedStartDateTo": "2019-08-24T14:15:22Z",
  • "applicationReceivedDateFrom": "2019-08-24T14:15:22Z",
  • "applicationReceivedDateTo": "2019-08-24T14:15:22Z",
  • "userId": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "applicantStatusChangeList": [

      • {

        • "studentId": 0,
        • "lastName": "string",
        • "firstName": "string",
        • "fullName": "string",
        • "studentNumber": "string",
        • "enrollmentNumber": "string",
        • "applicantId": 0,
        • "campusCode": "string",
        • "campusName": "string",
        • "programName": "string",
        • "programVersionName": "string",
        • "leadSourceName": "string",
        • "leadCategoryName": "string",
        • "studentState": "string",
        • "admissionsRepFullName": "string",
        • "admissionsRepCode": "string",
        • "prospectDate": "2019-08-24T14:15:22Z",
        • "expectedStartDate": "2019-08-24T14:15:22Z",
        • "applicationReceivedDate": "2019-08-24T14:15:22Z",
        • "admissionsRepId": 0

        }

      ],
    • "validationMessages": {

      • "hasErrors": true,
      • "count": 0,
      • "item": {

        • "message": "string",
        • "messageType": 0

        }

      }

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save Applicant

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-applicant-save-request-payload)

id number <int32> accountReceivableBalance number <double> Account Receivable Balance admissionsRegionId number <int32> Zone applicantProgress number <int32> Represents the Applicant Progress associated with this Student Enrollment Periods applicantTypeId number <int32> Represents the Applicant Type associated with this Student Enrollment Periods applicationReceivedDate string <date-time> Represents the Date Application was Received associated with this Student Enrollment Periods assignedAdmissionsRepId number <int32> Admissions Representative billingMethodId number <int32> Billing Method campusId number <int32> Represents the Campus associated with this Student Enrollment Periods catalogYearId number <int32> Catalog clockHoursRequired number <double> Represents the number of Clock Hours Required associated with this Student Enrollment Periods createdDateTime string <date-time> Date Added creditHoursRequired number <double> Represents the number of Credit Hours Required associated with this Student Enrollment Periods enrollmentDate string <date-time> Represents the Enrollment Date associated with this Student Enrollment Periods enrollmentNumber string Represents the Enrollment Number associated with this Student Enrollment Periods enrollmentStatusId number <int32> Enrollment Status expectedCreditsHoursPerTerm number <double> Represents the number of Credit/Hours per term associated with this Student Enrollment Periods expectedHoursPerWeekForExternship number <double> Expected Hours Per Week For Externship expectedStartDate string <date-time> Represents the Expected Start Date associated with this Student Enrollment Periods externshipBeginDate string <date-time> Represents the Date Externship Begins associated with this Student Enrollment Periods faEntranceInterviewDate string <date-time> Financial Aid Entrance Date gradeLevelId number <int32> Grade Level gradeScaleId number <int32> Grade Scale graduationDate string <date-time> Represents the Graduation Date associated with this Student Enrollment Periods ipedsState string Represents the IPEDS State associated with this Student Enrollment Periods isApplicant boolean Is this the applicant? isTransfer boolean Is this an IPEDS Transfer? lastActivityDate string <date-time> Last Task Date lastModifiedDateTime string <date-time> Date Modified lastModifiedUserId number <int32> Modified By midpointDate string <date-time> Represents the Midpoint Date associated with this Student Enrollment Periods note string Note originalAssignedAdmissionsRepId number <int32> Original Admissions Representative originalExpectedStartDate string <date-time> Represents the Date/Time of Original Expected Start associated with this Student Enrollment Periods previousEducationId number <int32> Previous Education programId number <int32> Represents the Program ID associated with this Student Enrollment Periods programVersionId number <int32> Program Version programVersionName string Program Version Name rowVersion string schoolStatusChangeDate string <date-time> Represents the Date Status Changed associated with this Student Enrollment Periods schoolStatusChangeReasonId number <int32> Status Reason schoolStatusId number <int32> Student Status shiftId number <int32> Shift startDateId number <int32> Represents the Start Date associated with this Student Enrollment Periods startTermId number <int32> Represents the Start Term ID associated with this Student Enrollment Periods statChangeType number <int32> studentId number <int32> Student Id transcriptIssued string <date-time> Transcript Issued transferCreditHours number <double> Represents the number of Transfer Credits/Hours associated with this Student Enrollment Periods Array of objects (cmc-nexus-admissions-entities-applicantAreaOfStudyEntity) Areas of Study overrideWithProgramVersionDates number <int32> modifiedPropertiesForEdit Array of strings isProgramVersionDifferent number <int32> originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/Applicant/save

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "accountReceivableBalance": 0,
  • "admissionsRegionId": 0,
  • "applicantProgress": 0,
  • "applicantTypeId": 0,
  • "applicationReceivedDate": "2019-08-24T14:15:22Z",
  • "assignedAdmissionsRepId": 0,
  • "billingMethodId": 0,
  • "campusId": 0,
  • "catalogYearId": 0,
  • "clockHoursRequired": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "creditHoursRequired": 0,
  • "enrollmentDate": "2019-08-24T14:15:22Z",
  • "enrollmentNumber": "string",
  • "enrollmentStatusId": 0,
  • "expectedCreditsHoursPerTerm": 0,
  • "expectedHoursPerWeekForExternship": 0,
  • "expectedStartDate": "2019-08-24T14:15:22Z",
  • "externshipBeginDate": "2019-08-24T14:15:22Z",
  • "faEntranceInterviewDate": "2019-08-24T14:15:22Z",
  • "gradeLevelId": 0,
  • "gradeScaleId": 0,
  • "graduationDate": "2019-08-24T14:15:22Z",
  • "ipedsState": "string",
  • "isApplicant": true,
  • "isTransfer": true,
  • "lastActivityDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "midpointDate": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "originalAssignedAdmissionsRepId": 0,
  • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
  • "previousEducationId": 0,
  • "programId": 0,
  • "programVersionId": 0,
  • "programVersionName": "string",
  • "rowVersion": "string",
  • "schoolStatusChangeDate": "2019-08-24T14:15:22Z",
  • "schoolStatusChangeReasonId": 0,
  • "schoolStatusId": 0,
  • "shiftId": 0,
  • "startDateId": 0,
  • "startTermId": 0,
  • "statChangeType": 0,
  • "studentId": 0,
  • "transcriptIssued": "2019-08-24T14:15:22Z",
  • "transferCreditHours": 0,
  • "applicantAreasOfStudy": [

    • {

      • "id": 0,
      • "areaOfStudyId": 0,
      • "createdByUserId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isExcludedCrmIntegration": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "programVersionAreaOfStudyId": 0,
      • "rowVersion": "string",
      • "studentAreaOfStudyParentId": 0,
      • "applicantId": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "overrideWithProgramVersionDates": 0,
  • "modifiedPropertiesForEdit": [

    • "string"

    ],
  • "isProgramVersionDifferent": 0,
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "accountReceivableBalance": 0,
    • "admissionsRegionId": 0,
    • "applicantProgress": 0,
    • "applicantTypeId": 0,
    • "applicationReceivedDate": "2019-08-24T14:15:22Z",
    • "assignedAdmissionsRepId": 0,
    • "billingMethodId": 0,
    • "campusId": 0,
    • "catalogYearId": 0,
    • "clockHoursRequired": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "creditHoursRequired": 0,
    • "enrollmentDate": "2019-08-24T14:15:22Z",
    • "enrollmentNumber": "string",
    • "enrollmentStatusId": 0,
    • "expectedCreditsHoursPerTerm": 0,
    • "expectedHoursPerWeekForExternship": 0,
    • "expectedStartDate": "2019-08-24T14:15:22Z",
    • "externshipBeginDate": "2019-08-24T14:15:22Z",
    • "faEntranceInterviewDate": "2019-08-24T14:15:22Z",
    • "gradeLevelId": 0,
    • "gradeScaleId": 0,
    • "graduationDate": "2019-08-24T14:15:22Z",
    • "ipedsState": "string",
    • "isApplicant": true,
    • "isTransfer": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "midpointDate": "2019-08-24T14:15:22Z",
    • "note": "string",
    • "originalAssignedAdmissionsRepId": 0,
    • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
    • "previousEducationId": 0,
    • "programId": 0,
    • "programVersionId": 0,
    • "programVersionName": "string",
    • "rowVersion": "string",
    • "schoolStatusChangeDate": "2019-08-24T14:15:22Z",
    • "schoolStatusChangeReasonId": 0,
    • "schoolStatusId": 0,
    • "shiftId": 0,
    • "startDateId": 0,
    • "startTermId": 0,
    • "statChangeType": 0,
    • "studentId": 0,
    • "transcriptIssued": "2019-08-24T14:15:22Z",
    • "transferCreditHours": 0,
    • "applicantAreasOfStudy": [

      • {

        • "id": 0,
        • "areaOfStudyId": 0,
        • "createdByUserId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isExcludedCrmIntegration": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "programVersionAreaOfStudyId": 0,
        • "rowVersion": "string",
        • "studentAreaOfStudyParentId": 0,
        • "applicantId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "overrideWithProgramVersionDates": 0,
    • "modifiedPropertiesForEdit": [

      • "string"

      ],
    • "isProgramVersionDifferent": 0,
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save New Applicant

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-applicant-savenew-request-payload)

id number <int32> accountReceivableBalance number <double> Account Receivable Balance admissionsRegionId number <int32> Zone applicantProgress number <int32> Represents the Applicant Progress associated with this Student Enrollment Periods applicantTypeId number <int32> Represents the Applicant Type associated with this Student Enrollment Periods applicationReceivedDate string <date-time> Represents the Date Application was Received associated with this Student Enrollment Periods assignedAdmissionsRepId number <int32> Admissions Representative billingMethodId number <int32> Billing Method campusId number <int32> Represents the Campus associated with this Student Enrollment Periods catalogYearId number <int32> Catalog clockHoursRequired number <double> Represents the number of Clock Hours Required associated with this Student Enrollment Periods createdDateTime string <date-time> Date Added creditHoursRequired number <double> Represents the number of Credit Hours Required associated with this Student Enrollment Periods enrollmentDate string <date-time> Represents the Enrollment Date associated with this Student Enrollment Periods enrollmentNumber string Represents the Enrollment Number associated with this Student Enrollment Periods enrollmentStatusId number <int32> Enrollment Status expectedCreditsHoursPerTerm number <double> Represents the number of Credit/Hours per term associated with this Student Enrollment Periods expectedHoursPerWeekForExternship number <double> Expected Hours Per Week For Externship expectedStartDate string <date-time> Represents the Expected Start Date associated with this Student Enrollment Periods externshipBeginDate string <date-time> Represents the Date Externship Begins associated with this Student Enrollment Periods faEntranceInterviewDate string <date-time> Financial Aid Entrance Date gradeLevelId number <int32> Grade Level gradeScaleId number <int32> Grade Scale graduationDate string <date-time> Represents the Graduation Date associated with this Student Enrollment Periods ipedsState string Represents the IPEDS State associated with this Student Enrollment Periods isApplicant boolean Is this the applicant? isTransfer boolean Is this an IPEDS Transfer? lastActivityDate string <date-time> Last Task Date lastModifiedDateTime string <date-time> Date Modified lastModifiedUserId number <int32> Modified By midpointDate string <date-time> Represents the Midpoint Date associated with this Student Enrollment Periods note string Note originalAssignedAdmissionsRepId number <int32> Original Admissions Representative originalExpectedStartDate string <date-time> Represents the Date/Time of Original Expected Start associated with this Student Enrollment Periods previousEducationId number <int32> Previous Education programId number <int32> Represents the Program ID associated with this Student Enrollment Periods programVersionId number <int32> Program Version programVersionName string Program Version Name rowVersion string schoolStatusChangeDate string <date-time> Represents the Date Status Changed associated with this Student Enrollment Periods schoolStatusChangeReasonId number <int32> Status Reason schoolStatusId number <int32> Student Status shiftId number <int32> Shift startDateId number <int32> Represents the Start Date associated with this Student Enrollment Periods startTermId number <int32> Represents the Start Term ID associated with this Student Enrollment Periods statChangeType number <int32> studentId number <int32> Student Id transcriptIssued string <date-time> Transcript Issued transferCreditHours number <double> Represents the number of Transfer Credits/Hours associated with this Student Enrollment Periods Array of objects (cmc-nexus-admissions-entities-applicantAreaOfStudyEntity) Areas of Study overrideWithProgramVersionDates number <int32> modifiedPropertiesForEdit Array of strings isProgramVersionDifferent number <int32> originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/Applicant/saveNew

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "accountReceivableBalance": 0,
  • "admissionsRegionId": 0,
  • "applicantProgress": 0,
  • "applicantTypeId": 0,
  • "applicationReceivedDate": "2019-08-24T14:15:22Z",
  • "assignedAdmissionsRepId": 0,
  • "billingMethodId": 0,
  • "campusId": 0,
  • "catalogYearId": 0,
  • "clockHoursRequired": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "creditHoursRequired": 0,
  • "enrollmentDate": "2019-08-24T14:15:22Z",
  • "enrollmentNumber": "string",
  • "enrollmentStatusId": 0,
  • "expectedCreditsHoursPerTerm": 0,
  • "expectedHoursPerWeekForExternship": 0,
  • "expectedStartDate": "2019-08-24T14:15:22Z",
  • "externshipBeginDate": "2019-08-24T14:15:22Z",
  • "faEntranceInterviewDate": "2019-08-24T14:15:22Z",
  • "gradeLevelId": 0,
  • "gradeScaleId": 0,
  • "graduationDate": "2019-08-24T14:15:22Z",
  • "ipedsState": "string",
  • "isApplicant": true,
  • "isTransfer": true,
  • "lastActivityDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "midpointDate": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "originalAssignedAdmissionsRepId": 0,
  • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
  • "previousEducationId": 0,
  • "programId": 0,
  • "programVersionId": 0,
  • "programVersionName": "string",
  • "rowVersion": "string",
  • "schoolStatusChangeDate": "2019-08-24T14:15:22Z",
  • "schoolStatusChangeReasonId": 0,
  • "schoolStatusId": 0,
  • "shiftId": 0,
  • "startDateId": 0,
  • "startTermId": 0,
  • "statChangeType": 0,
  • "studentId": 0,
  • "transcriptIssued": "2019-08-24T14:15:22Z",
  • "transferCreditHours": 0,
  • "applicantAreasOfStudy": [

    • {

      • "id": 0,
      • "areaOfStudyId": 0,
      • "createdByUserId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isExcludedCrmIntegration": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "programVersionAreaOfStudyId": 0,
      • "rowVersion": "string",
      • "studentAreaOfStudyParentId": 0,
      • "applicantId": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "overrideWithProgramVersionDates": 0,
  • "modifiedPropertiesForEdit": [

    • "string"

    ],
  • "isProgramVersionDifferent": 0,
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "accountReceivableBalance": 0,
    • "admissionsRegionId": 0,
    • "applicantProgress": 0,
    • "applicantTypeId": 0,
    • "applicationReceivedDate": "2019-08-24T14:15:22Z",
    • "assignedAdmissionsRepId": 0,
    • "billingMethodId": 0,
    • "campusId": 0,
    • "catalogYearId": 0,
    • "clockHoursRequired": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "creditHoursRequired": 0,
    • "enrollmentDate": "2019-08-24T14:15:22Z",
    • "enrollmentNumber": "string",
    • "enrollmentStatusId": 0,
    • "expectedCreditsHoursPerTerm": 0,
    • "expectedHoursPerWeekForExternship": 0,
    • "expectedStartDate": "2019-08-24T14:15:22Z",
    • "externshipBeginDate": "2019-08-24T14:15:22Z",
    • "faEntranceInterviewDate": "2019-08-24T14:15:22Z",
    • "gradeLevelId": 0,
    • "gradeScaleId": 0,
    • "graduationDate": "2019-08-24T14:15:22Z",
    • "ipedsState": "string",
    • "isApplicant": true,
    • "isTransfer": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "midpointDate": "2019-08-24T14:15:22Z",
    • "note": "string",
    • "originalAssignedAdmissionsRepId": 0,
    • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
    • "previousEducationId": 0,
    • "programId": 0,
    • "programVersionId": 0,
    • "programVersionName": "string",
    • "rowVersion": "string",
    • "schoolStatusChangeDate": "2019-08-24T14:15:22Z",
    • "schoolStatusChangeReasonId": 0,
    • "schoolStatusId": 0,
    • "shiftId": 0,
    • "startDateId": 0,
    • "startTermId": 0,
    • "statChangeType": 0,
    • "studentId": 0,
    • "transcriptIssued": "2019-08-24T14:15:22Z",
    • "transferCreditHours": 0,
    • "applicantAreasOfStudy": [

      • {

        • "id": 0,
        • "areaOfStudyId": 0,
        • "createdByUserId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isExcludedCrmIntegration": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "programVersionAreaOfStudyId": 0,
        • "rowVersion": "string",
        • "studentAreaOfStudyParentId": 0,
        • "applicantId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "overrideWithProgramVersionDates": 0,
    • "modifiedPropertiesForEdit": [

      • "string"

      ],
    • "isProgramVersionDifferent": 0,
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Set Applicant Program Version Defaults

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-applicant-setapplicantprogramversiondefaults-request-payload)

object (cmc-nexus-admissions-entities-applicantEntity) id required number <int32> accountReceivableBalance number <double> Account Receivable Balance admissionsRegionId number <int32> Zone applicantProgress number <int32> Represents the Applicant Progress associated with this Student Enrollment Periods applicantTypeId number <int32> Represents the Applicant Type associated with this Student Enrollment Periods applicationReceivedDate string <date-time> Represents the Date Application was Received associated with this Student Enrollment Periods assignedAdmissionsRepId number <int32> Admissions Representative billingMethodId number <int32> Billing Method campusId required number <int32> Represents the Campus associated with this Student Enrollment Periods catalogYearId number <int32> Catalog clockHoursRequired number <double> Represents the number of Clock Hours Required associated with this Student Enrollment Periods createdDateTime required string <date-time> Date Added creditHoursRequired number <double> Represents the number of Credit Hours Required associated with this Student Enrollment Periods enrollmentDate string <date-time> Represents the Enrollment Date associated with this Student Enrollment Periods enrollmentNumber string Represents the Enrollment Number associated with this Student Enrollment Periods enrollmentStatusId number <int32> Enrollment Status expectedCreditsHoursPerTerm number <double> Represents the number of Credit/Hours per term associated with this Student Enrollment Periods expectedHoursPerWeekForExternship number <double> Expected Hours Per Week For Externship expectedStartDate string <date-time> Represents the Expected Start Date associated with this Student Enrollment Periods externshipBeginDate string <date-time> Represents the Date Externship Begins associated with this Student Enrollment Periods faEntranceInterviewDate string <date-time> Financial Aid Entrance Date gradeLevelId number <int32> Grade Level gradeScaleId number <int32> Grade Scale graduationDate string <date-time> Represents the Graduation Date associated with this Student Enrollment Periods ipedsState string Represents the IPEDS State associated with this Student Enrollment Periods isApplicant boolean Is this the applicant? isTransfer boolean Is this an IPEDS Transfer? lastActivityDate string <date-time> Last Task Date lastModifiedDateTime required string <date-time> Date Modified lastModifiedUserId required number <int32> Modified By midpointDate string <date-time> Represents the Midpoint Date associated with this Student Enrollment Periods note string Note originalAssignedAdmissionsRepId number <int32> Original Admissions Representative originalExpectedStartDate string <date-time> Represents the Date/Time of Original Expected Start associated with this Student Enrollment Periods previousEducationId number <int32> Previous Education programId number <int32> Represents the Program ID associated with this Student Enrollment Periods programVersionId number <int32> Program Version programVersionName string Program Version Name rowVersion string schoolStatusChangeDate string <date-time> Represents the Date Status Changed associated with this Student Enrollment Periods schoolStatusChangeReasonId number <int32> Status Reason schoolStatusId required number <int32> Student Status shiftId number <int32> Shift startDateId number <int32> Represents the Start Date associated with this Student Enrollment Periods startTermId number <int32> Represents the Start Term ID associated with this Student Enrollment Periods statChangeType number <int32> studentId required number <int32> Student Id transcriptIssued string <date-time> Transcript Issued transferCreditHours number <double> Represents the number of Transfer Credits/Hours associated with this Student Enrollment Periods Array of objects (cmc-nexus-admissions-entities-applicantAreaOfStudyEntity) Areas of Study overrideWithProgramVersionDates number <int32> modifiedPropertiesForEdit Array of strings isProgramVersionDifferent number <int32> originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/Applicant/setApplicantProgramVersionDefaults

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "applicant": {

    • "id": 0,
    • "accountReceivableBalance": 0,
    • "admissionsRegionId": 0,
    • "applicantProgress": 0,
    • "applicantTypeId": 0,
    • "applicationReceivedDate": "2019-08-24T14:15:22Z",
    • "assignedAdmissionsRepId": 0,
    • "billingMethodId": 0,
    • "campusId": 0,
    • "catalogYearId": 0,
    • "clockHoursRequired": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "creditHoursRequired": 0,
    • "enrollmentDate": "2019-08-24T14:15:22Z",
    • "enrollmentNumber": "string",
    • "enrollmentStatusId": 0,
    • "expectedCreditsHoursPerTerm": 0,
    • "expectedHoursPerWeekForExternship": 0,
    • "expectedStartDate": "2019-08-24T14:15:22Z",
    • "externshipBeginDate": "2019-08-24T14:15:22Z",
    • "faEntranceInterviewDate": "2019-08-24T14:15:22Z",
    • "gradeLevelId": 0,
    • "gradeScaleId": 0,
    • "graduationDate": "2019-08-24T14:15:22Z",
    • "ipedsState": "string",
    • "isApplicant": true,
    • "isTransfer": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "midpointDate": "2019-08-24T14:15:22Z",
    • "note": "string",
    • "originalAssignedAdmissionsRepId": 0,
    • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
    • "previousEducationId": 0,
    • "programId": 0,
    • "programVersionId": 0,
    • "programVersionName": "string",
    • "rowVersion": "string",
    • "schoolStatusChangeDate": "2019-08-24T14:15:22Z",
    • "schoolStatusChangeReasonId": 0,
    • "schoolStatusId": 0,
    • "shiftId": 0,
    • "startDateId": 0,
    • "startTermId": 0,
    • "statChangeType": 0,
    • "studentId": 0,
    • "transcriptIssued": "2019-08-24T14:15:22Z",
    • "transferCreditHours": 0,
    • "applicantAreasOfStudy": [

      • {

        • "id": 0,
        • "areaOfStudyId": 0,
        • "createdByUserId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isExcludedCrmIntegration": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "programVersionAreaOfStudyId": 0,
        • "rowVersion": "string",
        • "studentAreaOfStudyParentId": 0,
        • "applicantId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "overrideWithProgramVersionDates": 0,
    • "modifiedPropertiesForEdit": [

      • "string"

      ],
    • "isProgramVersionDifferent": 0,
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "entity": {

      • "applicant": {

        • "id": 0,
        • "accountReceivableBalance": 0,
        • "admissionsRegionId": 0,
        • "applicantProgress": 0,
        • "applicantTypeId": 0,
        • "applicationReceivedDate": "2019-08-24T14:15:22Z",
        • "assignedAdmissionsRepId": 0,
        • "billingMethodId": 0,
        • "campusId": 0,
        • "catalogYearId": 0,
        • "clockHoursRequired": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "creditHoursRequired": 0,
        • "enrollmentDate": "2019-08-24T14:15:22Z",
        • "enrollmentNumber": "string",
        • "enrollmentStatusId": 0,
        • "expectedCreditsHoursPerTerm": 0,
        • "expectedHoursPerWeekForExternship": 0,
        • "expectedStartDate": "2019-08-24T14:15:22Z",
        • "externshipBeginDate": "2019-08-24T14:15:22Z",
        • "faEntranceInterviewDate": "2019-08-24T14:15:22Z",
        • "gradeLevelId": 0,
        • "gradeScaleId": 0,
        • "graduationDate": "2019-08-24T14:15:22Z",
        • "ipedsState": "string",
        • "isApplicant": true,
        • "isTransfer": true,
        • "lastActivityDate": "2019-08-24T14:15:22Z",
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "midpointDate": "2019-08-24T14:15:22Z",
        • "note": "string",
        • "originalAssignedAdmissionsRepId": 0,
        • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
        • "previousEducationId": 0,
        • "programId": 0,
        • "programVersionId": 0,
        • "programVersionName": "string",
        • "rowVersion": "string",
        • "schoolStatusChangeDate": "2019-08-24T14:15:22Z",
        • "schoolStatusChangeReasonId": 0,
        • "schoolStatusId": 0,
        • "shiftId": 0,
        • "startDateId": 0,
        • "startTermId": 0,
        • "statChangeType": 0,
        • "studentId": 0,
        • "transcriptIssued": "2019-08-24T14:15:22Z",
        • "transferCreditHours": 0,
        • "applicantAreasOfStudy": [

          • {

            • "id": 0,
            • "areaOfStudyId": 0,
            • "createdByUserId": 0,
            • "createdDateTime": "2019-08-24T14:15:22Z",
            • "isExcludedCrmIntegration": true,
            • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
            • "lastModifiedUserId": 0,
            • "programVersionAreaOfStudyId": 0,
            • "rowVersion": "string",
            • "studentAreaOfStudyParentId": 0,
            • "applicantId": 0,
            • "originalState": "string",
            • "secureState": "string",
            • "extendedProperties": [

              • null

              ],
            • "entityState": 0

            }

          ],
        • "overrideWithProgramVersionDates": 0,
        • "modifiedPropertiesForEdit": [

          • "string"

          ],
        • "isProgramVersionDifferent": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        },
      • "validationMessages": {

        • "hasErrors": true,
        • "count": 0,
        • "item": {

          • "message": "string",
          • "messageType": 0

          }

        }

      },
    • "validationMessages": {

      • "hasErrors": true,
      • "count": 0,
      • "item": {

        • "message": "string",
        • "messageType": 0

        }

      }

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

College

Create College

Authorizations:

apikey

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/College/create

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "city": "string",
    • "code": "string",
    • "countryId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "edExpressCode": "string",
    • "faxNumber": "string",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "note": "string",
    • "organizationId": 0,
    • "phoneNumber": "string",
    • "postalCode": "string",
    • "rowVersion": "string",
    • "state": "string",
    • "streetAddress": "string",
    • "transcriptContact": "string",
    • "transcriptFee": 0,
    • "transcriptOfficeCity": "string",
    • "transcriptOfficeFax": "string",
    • "transcriptOfficePhone": "string",
    • "transcriptOfficePostalCode": "string",
    • "transcriptOfficeState": "string",
    • "transcriptOfficeStreetAddress": "string",
    • "transcriptOfficeSyCountryId": 0,
    • "isExcludedCrmIntegration": true,
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Delete College

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-college-delete-request-payload)

id number <int32> Id city string The name of the city. code string The alpha numeric code assigned to the item by your institution. countryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. edExpressCode string Ed Express Code faxNumber string The number where a facsimile (fax) can be received. isActive boolean Specifies whether or not the associated record is active. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. note string Area you can use to display or specify comments or additional information. organizationId number <int32> Organization Id phoneNumber string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). postalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. rowVersion string state string If within the United States, the name of the state. streetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated. transcriptContact string The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution. transcriptFee number <double> The fee charged by the institution to process a transcript request. transcriptOfficeCity string The name of the city. transcriptOfficeFax string The number where a facsimile (fax) can be received. transcriptOfficePhone string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. transcriptOfficePostalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. transcriptOfficeState string If within the United States, the name of the state. transcriptOfficeStreetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated. transcriptOfficeSyCountryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. isExcludedCrmIntegration boolean originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/College/delete

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "city": "string",
  • "code": "string",
  • "countryId": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "edExpressCode": "string",
  • "faxNumber": "string",
  • "isActive": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "note": "string",
  • "organizationId": 0,
  • "phoneNumber": "string",
  • "postalCode": "string",
  • "rowVersion": "string",
  • "state": "string",
  • "streetAddress": "string",
  • "transcriptContact": "string",
  • "transcriptFee": 0,
  • "transcriptOfficeCity": "string",
  • "transcriptOfficeFax": "string",
  • "transcriptOfficePhone": "string",
  • "transcriptOfficePostalCode": "string",
  • "transcriptOfficeState": "string",
  • "transcriptOfficeStreetAddress": "string",
  • "transcriptOfficeSyCountryId": 0,
  • "isExcludedCrmIntegration": true,
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "deleted": true

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Get College

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-college-get-request-payload)
id number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/College/get

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "city": "string",
    • "code": "string",
    • "countryId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "edExpressCode": "string",
    • "faxNumber": "string",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "note": "string",
    • "organizationId": 0,
    • "phoneNumber": "string",
    • "postalCode": "string",
    • "rowVersion": "string",
    • "state": "string",
    • "streetAddress": "string",
    • "transcriptContact": "string",
    • "transcriptFee": 0,
    • "transcriptOfficeCity": "string",
    • "transcriptOfficeFax": "string",
    • "transcriptOfficePhone": "string",
    • "transcriptOfficePostalCode": "string",
    • "transcriptOfficeState": "string",
    • "transcriptOfficeStreetAddress": "string",
    • "transcriptOfficeSyCountryId": 0,
    • "isExcludedCrmIntegration": true,
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save College

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-college-save-request-payload)

id number <int32> Id city string The name of the city. code string The alpha numeric code assigned to the item by your institution. countryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. edExpressCode string Ed Express Code faxNumber string The number where a facsimile (fax) can be received. isActive boolean Specifies whether or not the associated record is active. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. note string Area you can use to display or specify comments or additional information. organizationId number <int32> Organization Id phoneNumber string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). postalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. rowVersion string state string If within the United States, the name of the state. streetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated. transcriptContact string The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution. transcriptFee number <double> The fee charged by the institution to process a transcript request. transcriptOfficeCity string The name of the city. transcriptOfficeFax string The number where a facsimile (fax) can be received. transcriptOfficePhone string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. transcriptOfficePostalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. transcriptOfficeState string If within the United States, the name of the state. transcriptOfficeStreetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated. transcriptOfficeSyCountryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. isExcludedCrmIntegration boolean originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/College/save

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "city": "string",
  • "code": "string",
  • "countryId": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "edExpressCode": "string",
  • "faxNumber": "string",
  • "isActive": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "note": "string",
  • "organizationId": 0,
  • "phoneNumber": "string",
  • "postalCode": "string",
  • "rowVersion": "string",
  • "state": "string",
  • "streetAddress": "string",
  • "transcriptContact": "string",
  • "transcriptFee": 0,
  • "transcriptOfficeCity": "string",
  • "transcriptOfficeFax": "string",
  • "transcriptOfficePhone": "string",
  • "transcriptOfficePostalCode": "string",
  • "transcriptOfficeState": "string",
  • "transcriptOfficeStreetAddress": "string",
  • "transcriptOfficeSyCountryId": 0,
  • "isExcludedCrmIntegration": true,
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "city": "string",
    • "code": "string",
    • "countryId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "edExpressCode": "string",
    • "faxNumber": "string",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "note": "string",
    • "organizationId": 0,
    • "phoneNumber": "string",
    • "postalCode": "string",
    • "rowVersion": "string",
    • "state": "string",
    • "streetAddress": "string",
    • "transcriptContact": "string",
    • "transcriptFee": 0,
    • "transcriptOfficeCity": "string",
    • "transcriptOfficeFax": "string",
    • "transcriptOfficePhone": "string",
    • "transcriptOfficePostalCode": "string",
    • "transcriptOfficeState": "string",
    • "transcriptOfficeStreetAddress": "string",
    • "transcriptOfficeSyCountryId": 0,
    • "isExcludedCrmIntegration": true,
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save New College

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-college-savenew-request-payload)

id number <int32> Id city string The name of the city. code string The alpha numeric code assigned to the item by your institution. countryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. edExpressCode string Ed Express Code faxNumber string The number where a facsimile (fax) can be received. isActive boolean Specifies whether or not the associated record is active. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. note string Area you can use to display or specify comments or additional information. organizationId number <int32> Organization Id phoneNumber string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). postalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. rowVersion string state string If within the United States, the name of the state. streetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated. transcriptContact string The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution. transcriptFee number <double> The fee charged by the institution to process a transcript request. transcriptOfficeCity string The name of the city. transcriptOfficeFax string The number where a facsimile (fax) can be received. transcriptOfficePhone string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. transcriptOfficePostalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. transcriptOfficeState string If within the United States, the name of the state. transcriptOfficeStreetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated. transcriptOfficeSyCountryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. isExcludedCrmIntegration boolean originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/College/saveNew

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "city": "string",
  • "code": "string",
  • "countryId": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "edExpressCode": "string",
  • "faxNumber": "string",
  • "isActive": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "note": "string",
  • "organizationId": 0,
  • "phoneNumber": "string",
  • "postalCode": "string",
  • "rowVersion": "string",
  • "state": "string",
  • "streetAddress": "string",
  • "transcriptContact": "string",
  • "transcriptFee": 0,
  • "transcriptOfficeCity": "string",
  • "transcriptOfficeFax": "string",
  • "transcriptOfficePhone": "string",
  • "transcriptOfficePostalCode": "string",
  • "transcriptOfficeState": "string",
  • "transcriptOfficeStreetAddress": "string",
  • "transcriptOfficeSyCountryId": 0,
  • "isExcludedCrmIntegration": true,
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "city": "string",
    • "code": "string",
    • "countryId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "edExpressCode": "string",
    • "faxNumber": "string",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "note": "string",
    • "organizationId": 0,
    • "phoneNumber": "string",
    • "postalCode": "string",
    • "rowVersion": "string",
    • "state": "string",
    • "streetAddress": "string",
    • "transcriptContact": "string",
    • "transcriptFee": 0,
    • "transcriptOfficeCity": "string",
    • "transcriptOfficeFax": "string",
    • "transcriptOfficePhone": "string",
    • "transcriptOfficePostalCode": "string",
    • "transcriptOfficeState": "string",
    • "transcriptOfficeStreetAddress": "string",
    • "transcriptOfficeSyCountryId": 0,
    • "isExcludedCrmIntegration": true,
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

EntranceTestScore

Add Entrance Test Scores

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-entrancetestscore-addentrancetestscores-request-payload)

Array of objects (cmc-nexus-admissions-entities-entranceTestScoreEntity) Array subTests Array of objects (cmc-nexus-admissions-entities-entranceTestScoreEntity) id required number <int32> Id createdDateTime string <date-time> The date when the item or person was added or the status change was entered. equivalentSatScore number <int32> If there is an equivalent SAT score, the Web Client displays it in the field. Otherwise, the field is not displayed. examFeeAmount number <double> The fee charged by your institution to take the test. If the test is administered by an organization outside of your institution, the value is blank. examLocationId number <int32> If your institution administers the test, the location of the test at the campus for the student. The locations are specified by your institution. isExamFeePaidByStudent boolean If the test is administered by your institution, specifies whether or not the student has paid your institution the fee for the test. isRequired boolean Is Required lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. minimumScoreRequired string Minimum Score Required numberResult number <int32> Number Result parentEntranceTestScoreId number <int32> Parent Entrance Test Score Id remedialCourseId number <int32> Remedial Course Id rowVersion string scheduledExamDate string <date-time> The date that the student was scheduled to take the test. studentEnrollmentPeriodId number <int32> The code and name of the enrollment. studentId required number <int32> Student Id testDate string <date-time> The date that the test or exam was taken by the student. testId required number <int32> The name of the test taken. testLocation string Test Location testResultDate string <date-time> Test Result Date testScore string The results of the test taken by the student reported as a score. textResult string Text Result originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/EntranceTestScore/addEntranceTestScores

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "entranceTestScoreEntityList": [

    • {

      • "subTests": [

        • { }

        ],
      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "equivalentSatScore": 0,
      • "examFeeAmount": 0,
      • "examLocationId": 0,
      • "isExamFeePaidByStudent": true,
      • "isRequired": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "minimumScoreRequired": "string",
      • "numberResult": 0,
      • "parentEntranceTestScoreId": 0,
      • "remedialCourseId": 0,
      • "rowVersion": "string",
      • "scheduledExamDate": "2019-08-24T14:15:22Z",
      • "studentEnrollmentPeriodId": 0,
      • "studentId": 0,
      • "testDate": "2019-08-24T14:15:22Z",
      • "testId": 0,
      • "testLocation": "string",
      • "testResultDate": "2019-08-24T14:15:22Z",
      • "testScore": "string",
      • "textResult": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ]

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "entranceTestScoreEntityList": [

      • {

        • "subTests": [

          • { }

          ],
        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "equivalentSatScore": 0,
        • "examFeeAmount": 0,
        • "examLocationId": 0,
        • "isExamFeePaidByStudent": true,
        • "isRequired": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "minimumScoreRequired": "string",
        • "numberResult": 0,
        • "parentEntranceTestScoreId": 0,
        • "remedialCourseId": 0,
        • "rowVersion": "string",
        • "scheduledExamDate": "2019-08-24T14:15:22Z",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "testDate": "2019-08-24T14:15:22Z",
        • "testId": 0,
        • "testLocation": "string",
        • "testResultDate": "2019-08-24T14:15:22Z",
        • "testScore": "string",
        • "textResult": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "validationMessages": {

      • "hasErrors": true,
      • "count": 0,
      • "item": {

        • "message": "string",
        • "messageType": 0

        }

      }

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Create Entrance Test Score

Authorizations:

apikey

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/EntranceTestScore/create

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "subTests": [

      • {

        • "subTests": [

          • { }

          ],
        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "equivalentSatScore": 0,
        • "examFeeAmount": 0,
        • "examLocationId": 0,
        • "isExamFeePaidByStudent": true,
        • "isRequired": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "minimumScoreRequired": "string",
        • "numberResult": 0,
        • "parentEntranceTestScoreId": 0,
        • "remedialCourseId": 0,
        • "rowVersion": "string",
        • "scheduledExamDate": "2019-08-24T14:15:22Z",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "testDate": "2019-08-24T14:15:22Z",
        • "testId": 0,
        • "testLocation": "string",
        • "testResultDate": "2019-08-24T14:15:22Z",
        • "testScore": "string",
        • "textResult": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "equivalentSatScore": 0,
    • "examFeeAmount": 0,
    • "examLocationId": 0,
    • "isExamFeePaidByStudent": true,
    • "isRequired": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "minimumScoreRequired": "string",
    • "numberResult": 0,
    • "parentEntranceTestScoreId": 0,
    • "remedialCourseId": 0,
    • "rowVersion": "string",
    • "scheduledExamDate": "2019-08-24T14:15:22Z",
    • "studentEnrollmentPeriodId": 0,
    • "studentId": 0,
    • "testDate": "2019-08-24T14:15:22Z",
    • "testId": 0,
    • "testLocation": "string",
    • "testResultDate": "2019-08-24T14:15:22Z",
    • "testScore": "string",
    • "textResult": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Create Entrance Test Score From Template

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-entrancetestscore-createentrancetestscorefromtemplate-request-payload)
entranceTestId number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/EntranceTestScore/createEntranceTestScoreFromTemplate

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "entranceTestId": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "subTests": [

      • {

        • "subTests": [

          • { }

          ],
        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "equivalentSatScore": 0,
        • "examFeeAmount": 0,
        • "examLocationId": 0,
        • "isExamFeePaidByStudent": true,
        • "isRequired": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "minimumScoreRequired": "string",
        • "numberResult": 0,
        • "parentEntranceTestScoreId": 0,
        • "remedialCourseId": 0,
        • "rowVersion": "string",
        • "scheduledExamDate": "2019-08-24T14:15:22Z",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "testDate": "2019-08-24T14:15:22Z",
        • "testId": 0,
        • "testLocation": "string",
        • "testResultDate": "2019-08-24T14:15:22Z",
        • "testScore": "string",
        • "textResult": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "equivalentSatScore": 0,
    • "examFeeAmount": 0,
    • "examLocationId": 0,
    • "isExamFeePaidByStudent": true,
    • "isRequired": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "minimumScoreRequired": "string",
    • "numberResult": 0,
    • "parentEntranceTestScoreId": 0,
    • "remedialCourseId": 0,
    • "rowVersion": "string",
    • "scheduledExamDate": "2019-08-24T14:15:22Z",
    • "studentEnrollmentPeriodId": 0,
    • "studentId": 0,
    • "testDate": "2019-08-24T14:15:22Z",
    • "testId": 0,
    • "testLocation": "string",
    • "testResultDate": "2019-08-24T14:15:22Z",
    • "testScore": "string",
    • "textResult": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Delete Entrance Test Score

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-entrancetestscore-delete-request-payload)

Array of objects (cmc-nexus-admissions-entities-entranceTestScoreEntity) id number <int32> Id createdDateTime string <date-time> The date when the item or person was added or the status change was entered. equivalentSatScore number <int32> If there is an equivalent SAT score, the Web Client displays it in the field. Otherwise, the field is not displayed. examFeeAmount number <double> The fee charged by your institution to take the test. If the test is administered by an organization outside of your institution, the value is blank. examLocationId number <int32> If your institution administers the test, the location of the test at the campus for the student. The locations are specified by your institution. isExamFeePaidByStudent boolean If the test is administered by your institution, specifies whether or not the student has paid your institution the fee for the test. isRequired boolean Is Required lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. minimumScoreRequired string Minimum Score Required numberResult number <int32> Number Result parentEntranceTestScoreId number <int32> Parent Entrance Test Score Id remedialCourseId number <int32> Remedial Course Id rowVersion string scheduledExamDate string <date-time> The date that the student was scheduled to take the test. studentEnrollmentPeriodId number <int32> The code and name of the enrollment. studentId number <int32> Student Id testDate string <date-time> The date that the test or exam was taken by the student. testId number <int32> The name of the test taken. testLocation string Test Location testResultDate string <date-time> Test Result Date testScore string The results of the test taken by the student reported as a score. textResult string Text Result originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/EntranceTestScore/delete

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "subTests": [

    • {

      • "subTests": [

        • { }

        ],
      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "equivalentSatScore": 0,
      • "examFeeAmount": 0,
      • "examLocationId": 0,
      • "isExamFeePaidByStudent": true,
      • "isRequired": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "minimumScoreRequired": "string",
      • "numberResult": 0,
      • "parentEntranceTestScoreId": 0,
      • "remedialCourseId": 0,
      • "rowVersion": "string",
      • "scheduledExamDate": "2019-08-24T14:15:22Z",
      • "studentEnrollmentPeriodId": 0,
      • "studentId": 0,
      • "testDate": "2019-08-24T14:15:22Z",
      • "testId": 0,
      • "testLocation": "string",
      • "testResultDate": "2019-08-24T14:15:22Z",
      • "testScore": "string",
      • "textResult": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "id": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "equivalentSatScore": 0,
  • "examFeeAmount": 0,
  • "examLocationId": 0,
  • "isExamFeePaidByStudent": true,
  • "isRequired": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "minimumScoreRequired": "string",
  • "numberResult": 0,
  • "parentEntranceTestScoreId": 0,
  • "remedialCourseId": 0,
  • "rowVersion": "string",
  • "scheduledExamDate": "2019-08-24T14:15:22Z",
  • "studentEnrollmentPeriodId": 0,
  • "studentId": 0,
  • "testDate": "2019-08-24T14:15:22Z",
  • "testId": 0,
  • "testLocation": "string",
  • "testResultDate": "2019-08-24T14:15:22Z",
  • "testScore": "string",
  • "textResult": "string",
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "deleted": true

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Delete Entrance Test Scores

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-entrancetestscore-deleteentrancetestscores-request-payload)
amProspectTestIds Array of numbers <int32> [ items <int32 > ]

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/EntranceTestScore/deleteEntranceTestScores

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "amProspectTestIds": [

    • 0

    ]

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "validationMessages": {

      • "hasErrors": true,
      • "count": 0,
      • "item": {

        • "message": "string",
        • "messageType": 0

        }

      }

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Get Entrance Test Score

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-entrancetestscore-get-request-payload)
id number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/EntranceTestScore/get

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "subTests": [

      • {

        • "subTests": [

          • { }

          ],
        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "equivalentSatScore": 0,
        • "examFeeAmount": 0,
        • "examLocationId": 0,
        • "isExamFeePaidByStudent": true,
        • "isRequired": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "minimumScoreRequired": "string",
        • "numberResult": 0,
        • "parentEntranceTestScoreId": 0,
        • "remedialCourseId": 0,
        • "rowVersion": "string",
        • "scheduledExamDate": "2019-08-24T14:15:22Z",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "testDate": "2019-08-24T14:15:22Z",
        • "testId": 0,
        • "testLocation": "string",
        • "testResultDate": "2019-08-24T14:15:22Z",
        • "testScore": "string",
        • "textResult": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "equivalentSatScore": 0,
    • "examFeeAmount": 0,
    • "examLocationId": 0,
    • "isExamFeePaidByStudent": true,
    • "isRequired": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "minimumScoreRequired": "string",
    • "numberResult": 0,
    • "parentEntranceTestScoreId": 0,
    • "remedialCourseId": 0,
    • "rowVersion": "string",
    • "scheduledExamDate": "2019-08-24T14:15:22Z",
    • "studentEnrollmentPeriodId": 0,
    • "studentId": 0,
    • "testDate": "2019-08-24T14:15:22Z",
    • "testId": 0,
    • "testLocation": "string",
    • "testResultDate": "2019-08-24T14:15:22Z",
    • "testScore": "string",
    • "textResult": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Get Available Test

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-entrancetestscore-getavailabletest-request-payload)
campusId number <int32> enrollId number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/EntranceTestScore/getAvailableTest

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "campusId": 0,
  • "enrollId": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "testRecordList": [

      • {

        • "code": "string",
        • "descrip": "string",
        • "systemCode": true,
        • "testType": "string",
        • "amTestID": 0,
        • "parentAmTestID": 0,
        • "codeDescrip": "string",
        • "active": true

        }

      ],
    • "validationMessages": {

      • "hasErrors": true,
      • "count": 0,
      • "item": {

        • "message": "string",
        • "messageType": 0

        }

      }

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Get Selected Entrance Test

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-entrancetestscore-getselectedentrancetest-request-payload)
studentId number <int32> enrollId number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/EntranceTestScore/getSelectedEntranceTest

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "studentId": 0,
  • "enrollId": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "entranceTestScoreList": [

      • {

        • "subTests": [

          • { }

          ],
        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "equivalentSatScore": 0,
        • "examFeeAmount": 0,
        • "examLocationId": 0,
        • "isExamFeePaidByStudent": true,
        • "isRequired": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "minimumScoreRequired": "string",
        • "numberResult": 0,
        • "parentEntranceTestScoreId": 0,
        • "remedialCourseId": 0,
        • "rowVersion": "string",
        • "scheduledExamDate": "2019-08-24T14:15:22Z",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "testDate": "2019-08-24T14:15:22Z",
        • "testId": 0,
        • "testLocation": "string",
        • "testResultDate": "2019-08-24T14:15:22Z",
        • "testScore": "string",
        • "textResult": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "validationMessages": {

      • "hasErrors": true,
      • "count": 0,
      • "item": {

        • "message": "string",
        • "messageType": 0

        }

      }

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save Entrance Test Score

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-entrancetestscore-save-request-payload)

Array of objects (cmc-nexus-admissions-entities-entranceTestScoreEntity) id number <int32> Id createdDateTime string <date-time> The date when the item or person was added or the status change was entered. equivalentSatScore number <int32> If there is an equivalent SAT score, the Web Client displays it in the field. Otherwise, the field is not displayed. examFeeAmount number <double> The fee charged by your institution to take the test. If the test is administered by an organization outside of your institution, the value is blank. examLocationId number <int32> If your institution administers the test, the location of the test at the campus for the student. The locations are specified by your institution. isExamFeePaidByStudent boolean If the test is administered by your institution, specifies whether or not the student has paid your institution the fee for the test. isRequired boolean Is Required lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. minimumScoreRequired string Minimum Score Required numberResult number <int32> Number Result parentEntranceTestScoreId number <int32> Parent Entrance Test Score Id remedialCourseId number <int32> Remedial Course Id rowVersion string scheduledExamDate string <date-time> The date that the student was scheduled to take the test. studentEnrollmentPeriodId number <int32> The code and name of the enrollment. studentId number <int32> Student Id testDate string <date-time> The date that the test or exam was taken by the student. testId number <int32> The name of the test taken. testLocation string Test Location testResultDate string <date-time> Test Result Date testScore string The results of the test taken by the student reported as a score. textResult string Text Result originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/EntranceTestScore/save

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "subTests": [

    • {

      • "subTests": [

        • { }

        ],
      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "equivalentSatScore": 0,
      • "examFeeAmount": 0,
      • "examLocationId": 0,
      • "isExamFeePaidByStudent": true,
      • "isRequired": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "minimumScoreRequired": "string",
      • "numberResult": 0,
      • "parentEntranceTestScoreId": 0,
      • "remedialCourseId": 0,
      • "rowVersion": "string",
      • "scheduledExamDate": "2019-08-24T14:15:22Z",
      • "studentEnrollmentPeriodId": 0,
      • "studentId": 0,
      • "testDate": "2019-08-24T14:15:22Z",
      • "testId": 0,
      • "testLocation": "string",
      • "testResultDate": "2019-08-24T14:15:22Z",
      • "testScore": "string",
      • "textResult": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "id": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "equivalentSatScore": 0,
  • "examFeeAmount": 0,
  • "examLocationId": 0,
  • "isExamFeePaidByStudent": true,
  • "isRequired": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "minimumScoreRequired": "string",
  • "numberResult": 0,
  • "parentEntranceTestScoreId": 0,
  • "remedialCourseId": 0,
  • "rowVersion": "string",
  • "scheduledExamDate": "2019-08-24T14:15:22Z",
  • "studentEnrollmentPeriodId": 0,
  • "studentId": 0,
  • "testDate": "2019-08-24T14:15:22Z",
  • "testId": 0,
  • "testLocation": "string",
  • "testResultDate": "2019-08-24T14:15:22Z",
  • "testScore": "string",
  • "textResult": "string",
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "subTests": [

      • {

        • "subTests": [

          • { }

          ],
        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "equivalentSatScore": 0,
        • "examFeeAmount": 0,
        • "examLocationId": 0,
        • "isExamFeePaidByStudent": true,
        • "isRequired": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "minimumScoreRequired": "string",
        • "numberResult": 0,
        • "parentEntranceTestScoreId": 0,
        • "remedialCourseId": 0,
        • "rowVersion": "string",
        • "scheduledExamDate": "2019-08-24T14:15:22Z",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "testDate": "2019-08-24T14:15:22Z",
        • "testId": 0,
        • "testLocation": "string",
        • "testResultDate": "2019-08-24T14:15:22Z",
        • "testScore": "string",
        • "textResult": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "equivalentSatScore": 0,
    • "examFeeAmount": 0,
    • "examLocationId": 0,
    • "isExamFeePaidByStudent": true,
    • "isRequired": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "minimumScoreRequired": "string",
    • "numberResult": 0,
    • "parentEntranceTestScoreId": 0,
    • "remedialCourseId": 0,
    • "rowVersion": "string",
    • "scheduledExamDate": "2019-08-24T14:15:22Z",
    • "studentEnrollmentPeriodId": 0,
    • "studentId": 0,
    • "testDate": "2019-08-24T14:15:22Z",
    • "testId": 0,
    • "testLocation": "string",
    • "testResultDate": "2019-08-24T14:15:22Z",
    • "testScore": "string",
    • "textResult": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save Entrance Test Scores

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-entrancetestscore-saveentrancetestscores-request-payload)

Array of objects (cmc-nexus-admissions-entities-entranceTestScoreEntity) Array subTests Array of objects (cmc-nexus-admissions-entities-entranceTestScoreEntity) id required number <int32> Id createdDateTime string <date-time> The date when the item or person was added or the status change was entered. equivalentSatScore number <int32> If there is an equivalent SAT score, the Web Client displays it in the field. Otherwise, the field is not displayed. examFeeAmount number <double> The fee charged by your institution to take the test. If the test is administered by an organization outside of your institution, the value is blank. examLocationId number <int32> If your institution administers the test, the location of the test at the campus for the student. The locations are specified by your institution. isExamFeePaidByStudent boolean If the test is administered by your institution, specifies whether or not the student has paid your institution the fee for the test. isRequired boolean Is Required lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. minimumScoreRequired string Minimum Score Required numberResult number <int32> Number Result parentEntranceTestScoreId number <int32> Parent Entrance Test Score Id remedialCourseId number <int32> Remedial Course Id rowVersion string scheduledExamDate string <date-time> The date that the student was scheduled to take the test. studentEnrollmentPeriodId number <int32> The code and name of the enrollment. studentId required number <int32> Student Id testDate string <date-time> The date that the test or exam was taken by the student. testId required number <int32> The name of the test taken. testLocation string Test Location testResultDate string <date-time> Test Result Date testScore string The results of the test taken by the student reported as a score. textResult string Text Result originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/EntranceTestScore/saveEntranceTestScores

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "entranceTestScoreEntityList": [

    • {

      • "subTests": [

        • { }

        ],
      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "equivalentSatScore": 0,
      • "examFeeAmount": 0,
      • "examLocationId": 0,
      • "isExamFeePaidByStudent": true,
      • "isRequired": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "minimumScoreRequired": "string",
      • "numberResult": 0,
      • "parentEntranceTestScoreId": 0,
      • "remedialCourseId": 0,
      • "rowVersion": "string",
      • "scheduledExamDate": "2019-08-24T14:15:22Z",
      • "studentEnrollmentPeriodId": 0,
      • "studentId": 0,
      • "testDate": "2019-08-24T14:15:22Z",
      • "testId": 0,
      • "testLocation": "string",
      • "testResultDate": "2019-08-24T14:15:22Z",
      • "testScore": "string",
      • "textResult": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ]

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "entranceTestScoreEntityList": [

      • {

        • "subTests": [

          • { }

          ],
        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "equivalentSatScore": 0,
        • "examFeeAmount": 0,
        • "examLocationId": 0,
        • "isExamFeePaidByStudent": true,
        • "isRequired": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "minimumScoreRequired": "string",
        • "numberResult": 0,
        • "parentEntranceTestScoreId": 0,
        • "remedialCourseId": 0,
        • "rowVersion": "string",
        • "scheduledExamDate": "2019-08-24T14:15:22Z",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "testDate": "2019-08-24T14:15:22Z",
        • "testId": 0,
        • "testLocation": "string",
        • "testResultDate": "2019-08-24T14:15:22Z",
        • "testScore": "string",
        • "textResult": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "validationMessages": {

      • "hasErrors": true,
      • "count": 0,
      • "item": {

        • "message": "string",
        • "messageType": 0

        }

      }

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save New Entrance Test Score

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-entrancetestscore-savenew-request-payload)

Array of objects (cmc-nexus-admissions-entities-entranceTestScoreEntity) id number <int32> Id createdDateTime string <date-time> The date when the item or person was added or the status change was entered. equivalentSatScore number <int32> If there is an equivalent SAT score, the Web Client displays it in the field. Otherwise, the field is not displayed. examFeeAmount number <double> The fee charged by your institution to take the test. If the test is administered by an organization outside of your institution, the value is blank. examLocationId number <int32> If your institution administers the test, the location of the test at the campus for the student. The locations are specified by your institution. isExamFeePaidByStudent boolean If the test is administered by your institution, specifies whether or not the student has paid your institution the fee for the test. isRequired boolean Is Required lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. minimumScoreRequired string Minimum Score Required numberResult number <int32> Number Result parentEntranceTestScoreId number <int32> Parent Entrance Test Score Id remedialCourseId number <int32> Remedial Course Id rowVersion string scheduledExamDate string <date-time> The date that the student was scheduled to take the test. studentEnrollmentPeriodId number <int32> The code and name of the enrollment. studentId number <int32> Student Id testDate string <date-time> The date that the test or exam was taken by the student. testId number <int32> The name of the test taken. testLocation string Test Location testResultDate string <date-time> Test Result Date testScore string The results of the test taken by the student reported as a score. textResult string Text Result originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/EntranceTestScore/saveNew

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "subTests": [

    • {

      • "subTests": [

        • { }

        ],
      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "equivalentSatScore": 0,
      • "examFeeAmount": 0,
      • "examLocationId": 0,
      • "isExamFeePaidByStudent": true,
      • "isRequired": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "minimumScoreRequired": "string",
      • "numberResult": 0,
      • "parentEntranceTestScoreId": 0,
      • "remedialCourseId": 0,
      • "rowVersion": "string",
      • "scheduledExamDate": "2019-08-24T14:15:22Z",
      • "studentEnrollmentPeriodId": 0,
      • "studentId": 0,
      • "testDate": "2019-08-24T14:15:22Z",
      • "testId": 0,
      • "testLocation": "string",
      • "testResultDate": "2019-08-24T14:15:22Z",
      • "testScore": "string",
      • "textResult": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "id": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "equivalentSatScore": 0,
  • "examFeeAmount": 0,
  • "examLocationId": 0,
  • "isExamFeePaidByStudent": true,
  • "isRequired": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "minimumScoreRequired": "string",
  • "numberResult": 0,
  • "parentEntranceTestScoreId": 0,
  • "remedialCourseId": 0,
  • "rowVersion": "string",
  • "scheduledExamDate": "2019-08-24T14:15:22Z",
  • "studentEnrollmentPeriodId": 0,
  • "studentId": 0,
  • "testDate": "2019-08-24T14:15:22Z",
  • "testId": 0,
  • "testLocation": "string",
  • "testResultDate": "2019-08-24T14:15:22Z",
  • "testScore": "string",
  • "textResult": "string",
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "subTests": [

      • {

        • "subTests": [

          • { }

          ],
        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "equivalentSatScore": 0,
        • "examFeeAmount": 0,
        • "examLocationId": 0,
        • "isExamFeePaidByStudent": true,
        • "isRequired": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "minimumScoreRequired": "string",
        • "numberResult": 0,
        • "parentEntranceTestScoreId": 0,
        • "remedialCourseId": 0,
        • "rowVersion": "string",
        • "scheduledExamDate": "2019-08-24T14:15:22Z",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "testDate": "2019-08-24T14:15:22Z",
        • "testId": 0,
        • "testLocation": "string",
        • "testResultDate": "2019-08-24T14:15:22Z",
        • "testScore": "string",
        • "textResult": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "equivalentSatScore": 0,
    • "examFeeAmount": 0,
    • "examLocationId": 0,
    • "isExamFeePaidByStudent": true,
    • "isRequired": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "minimumScoreRequired": "string",
    • "numberResult": 0,
    • "parentEntranceTestScoreId": 0,
    • "remedialCourseId": 0,
    • "rowVersion": "string",
    • "scheduledExamDate": "2019-08-24T14:15:22Z",
    • "studentEnrollmentPeriodId": 0,
    • "studentId": 0,
    • "testDate": "2019-08-24T14:15:22Z",
    • "testId": 0,
    • "testLocation": "string",
    • "testResultDate": "2019-08-24T14:15:22Z",
    • "testScore": "string",
    • "textResult": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

ExtraCurricularActivity

Create Extra Curricular Activity

Authorizations:

apikey

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/ExtraCurricularActivity/create

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "code": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "rowVersion": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Delete Extra Curricular Activity

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-extracurricularactivity-delete-request-payload)

id number <int32> Id code string The alpha numeric code assigned to the item by your institution. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. isActive boolean Specifies whether or not the associated record is active. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. rowVersion string originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/ExtraCurricularActivity/delete

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "code": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "rowVersion": "string",
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "deleted": true

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Get Extra Curricular Activity

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-extracurricularactivity-get-request-payload)
id number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/ExtraCurricularActivity/get

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "code": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "rowVersion": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save Extra Curricular Activity

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-extracurricularactivity-save-request-payload)

id number <int32> Id code string The alpha numeric code assigned to the item by your institution. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. isActive boolean Specifies whether or not the associated record is active. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. rowVersion string originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/ExtraCurricularActivity/save

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "code": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "rowVersion": "string",
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "code": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "rowVersion": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save New Extra Curricular Activity

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-extracurricularactivity-savenew-request-payload)

id number <int32> Id code string The alpha numeric code assigned to the item by your institution. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. isActive boolean Specifies whether or not the associated record is active. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. rowVersion string originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/ExtraCurricularActivity/saveNew

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "code": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "rowVersion": "string",
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "code": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "rowVersion": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

HighSchool

Create High School

Authorizations:

apikey

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/HighSchool/create

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "academicYearEndMonth": 0,
    • "campusGroupId": 0,
    • "city": "string",
    • "code": "string",
    • "contactEmailAddress": "string",
    • "contactName": "string",
    • "contactTitle": "string",
    • "country": "string",
    • "countryId": 0,
    • "countyId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "emailAddress": "string",
    • "faxNumber": "string",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "organizationId": 0,
    • "otherContactName": "string",
    • "otherContactTitle": "string",
    • "otherEmailAddress": "string",
    • "phoneNumber": "string",
    • "postalCode": "string",
    • "rowVersion": "string",
    • "state": "string",
    • "streetAddress": "string",
    • "syOrganizationId": 0,
    • "transcriptContact": "string",
    • "transcriptFee": 0,
    • "transcriptOfficeCity": "string",
    • "transcriptOfficeFax": "string",
    • "transcriptOfficePhone": "string",
    • "transcriptOfficePostalCode": "string",
    • "transcriptOfficeState": "string",
    • "transcriptOfficeStreetAddress": "string",
    • "transcriptOfficeSyCountryId": 0,
    • "url": "string",
    • "organizationContactStaffId": 0,
    • "isExcludedCrmIntegration": true,
    • "note": "string",
    • "drivingDirections": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Delete High School

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-highschool-delete-request-payload)

id number <int32> Id academicYearEndMonth number <int32> The month in which the academic year for the institution ends. campusGroupId number <int32> The group you specified for the campus. Your institution configures the groups for campuses. city string The name of the city. code string The alpha numeric code assigned to the item by your institution. contactEmailAddress string The email address. contactName string Specifies the name of the item or person. contactTitle string The title of the contact. country string Country countryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. countyId number <int32> The county for the address. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. emailAddress string The email address. faxNumber string The number where a facsimile (fax) can be received. isActive boolean Specifies whether or not the associated record is active. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. organizationId number <int32> Organization Id otherContactName string Other Contact Name otherContactTitle string Other Contact Title otherEmailAddress string Other Email Address phoneNumber string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). postalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. rowVersion string state string If within the United States, the name of the state. streetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, syOrganizationId number <int32> Sy Organization Id transcriptContact string The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution. transcriptFee number <double> The fee charged by the institution to process a transcript request. transcriptOfficeCity string The name of the city. transcriptOfficeFax string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). transcriptOfficePhone string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). transcriptOfficePostalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. transcriptOfficeState string If within the United States, the name of the state. transcriptOfficeStreetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated. transcriptOfficeSyCountryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. url string The web address for the person or institution. organizationContactStaffId number <int32> isExcludedCrmIntegration boolean note string Area you can use to display or specify comments or additional information. drivingDirections string The directions a driver would follow to get to the institution. originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/HighSchool/delete

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "academicYearEndMonth": 0,
  • "campusGroupId": 0,
  • "city": "string",
  • "code": "string",
  • "contactEmailAddress": "string",
  • "contactName": "string",
  • "contactTitle": "string",
  • "country": "string",
  • "countryId": 0,
  • "countyId": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "emailAddress": "string",
  • "faxNumber": "string",
  • "isActive": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "organizationId": 0,
  • "otherContactName": "string",
  • "otherContactTitle": "string",
  • "otherEmailAddress": "string",
  • "phoneNumber": "string",
  • "postalCode": "string",
  • "rowVersion": "string",
  • "state": "string",
  • "streetAddress": "string",
  • "syOrganizationId": 0,
  • "transcriptContact": "string",
  • "transcriptFee": 0,
  • "transcriptOfficeCity": "string",
  • "transcriptOfficeFax": "string",
  • "transcriptOfficePhone": "string",
  • "transcriptOfficePostalCode": "string",
  • "transcriptOfficeState": "string",
  • "transcriptOfficeStreetAddress": "string",
  • "transcriptOfficeSyCountryId": 0,
  • "url": "string",
  • "organizationContactStaffId": 0,
  • "isExcludedCrmIntegration": true,
  • "note": "string",
  • "drivingDirections": "string",
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "deleted": true

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Get High School

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-highschool-get-request-payload)
id number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/HighSchool/get

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "academicYearEndMonth": 0,
    • "campusGroupId": 0,
    • "city": "string",
    • "code": "string",
    • "contactEmailAddress": "string",
    • "contactName": "string",
    • "contactTitle": "string",
    • "country": "string",
    • "countryId": 0,
    • "countyId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "emailAddress": "string",
    • "faxNumber": "string",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "organizationId": 0,
    • "otherContactName": "string",
    • "otherContactTitle": "string",
    • "otherEmailAddress": "string",
    • "phoneNumber": "string",
    • "postalCode": "string",
    • "rowVersion": "string",
    • "state": "string",
    • "streetAddress": "string",
    • "syOrganizationId": 0,
    • "transcriptContact": "string",
    • "transcriptFee": 0,
    • "transcriptOfficeCity": "string",
    • "transcriptOfficeFax": "string",
    • "transcriptOfficePhone": "string",
    • "transcriptOfficePostalCode": "string",
    • "transcriptOfficeState": "string",
    • "transcriptOfficeStreetAddress": "string",
    • "transcriptOfficeSyCountryId": 0,
    • "url": "string",
    • "organizationContactStaffId": 0,
    • "isExcludedCrmIntegration": true,
    • "note": "string",
    • "drivingDirections": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save High School

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-highschool-save-request-payload)

id number <int32> Id academicYearEndMonth number <int32> The month in which the academic year for the institution ends. campusGroupId number <int32> The group you specified for the campus. Your institution configures the groups for campuses. city string The name of the city. code string The alpha numeric code assigned to the item by your institution. contactEmailAddress string The email address. contactName string Specifies the name of the item or person. contactTitle string The title of the contact. country string Country countryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. countyId number <int32> The county for the address. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. emailAddress string The email address. faxNumber string The number where a facsimile (fax) can be received. isActive boolean Specifies whether or not the associated record is active. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. organizationId number <int32> Organization Id otherContactName string Other Contact Name otherContactTitle string Other Contact Title otherEmailAddress string Other Email Address phoneNumber string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). postalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. rowVersion string state string If within the United States, the name of the state. streetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, syOrganizationId number <int32> Sy Organization Id transcriptContact string The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution. transcriptFee number <double> The fee charged by the institution to process a transcript request. transcriptOfficeCity string The name of the city. transcriptOfficeFax string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). transcriptOfficePhone string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). transcriptOfficePostalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. transcriptOfficeState string If within the United States, the name of the state. transcriptOfficeStreetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated. transcriptOfficeSyCountryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. url string The web address for the person or institution. organizationContactStaffId number <int32> isExcludedCrmIntegration boolean note string Area you can use to display or specify comments or additional information. drivingDirections string The directions a driver would follow to get to the institution. originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/HighSchool/save

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "academicYearEndMonth": 0,
  • "campusGroupId": 0,
  • "city": "string",
  • "code": "string",
  • "contactEmailAddress": "string",
  • "contactName": "string",
  • "contactTitle": "string",
  • "country": "string",
  • "countryId": 0,
  • "countyId": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "emailAddress": "string",
  • "faxNumber": "string",
  • "isActive": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "organizationId": 0,
  • "otherContactName": "string",
  • "otherContactTitle": "string",
  • "otherEmailAddress": "string",
  • "phoneNumber": "string",
  • "postalCode": "string",
  • "rowVersion": "string",
  • "state": "string",
  • "streetAddress": "string",
  • "syOrganizationId": 0,
  • "transcriptContact": "string",
  • "transcriptFee": 0,
  • "transcriptOfficeCity": "string",
  • "transcriptOfficeFax": "string",
  • "transcriptOfficePhone": "string",
  • "transcriptOfficePostalCode": "string",
  • "transcriptOfficeState": "string",
  • "transcriptOfficeStreetAddress": "string",
  • "transcriptOfficeSyCountryId": 0,
  • "url": "string",
  • "organizationContactStaffId": 0,
  • "isExcludedCrmIntegration": true,
  • "note": "string",
  • "drivingDirections": "string",
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "academicYearEndMonth": 0,
    • "campusGroupId": 0,
    • "city": "string",
    • "code": "string",
    • "contactEmailAddress": "string",
    • "contactName": "string",
    • "contactTitle": "string",
    • "country": "string",
    • "countryId": 0,
    • "countyId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "emailAddress": "string",
    • "faxNumber": "string",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "organizationId": 0,
    • "otherContactName": "string",
    • "otherContactTitle": "string",
    • "otherEmailAddress": "string",
    • "phoneNumber": "string",
    • "postalCode": "string",
    • "rowVersion": "string",
    • "state": "string",
    • "streetAddress": "string",
    • "syOrganizationId": 0,
    • "transcriptContact": "string",
    • "transcriptFee": 0,
    • "transcriptOfficeCity": "string",
    • "transcriptOfficeFax": "string",
    • "transcriptOfficePhone": "string",
    • "transcriptOfficePostalCode": "string",
    • "transcriptOfficeState": "string",
    • "transcriptOfficeStreetAddress": "string",
    • "transcriptOfficeSyCountryId": 0,
    • "url": "string",
    • "organizationContactStaffId": 0,
    • "isExcludedCrmIntegration": true,
    • "note": "string",
    • "drivingDirections": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save New High School

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-highschool-savenew-request-payload)

id number <int32> Id academicYearEndMonth number <int32> The month in which the academic year for the institution ends. campusGroupId number <int32> The group you specified for the campus. Your institution configures the groups for campuses. city string The name of the city. code string The alpha numeric code assigned to the item by your institution. contactEmailAddress string The email address. contactName string Specifies the name of the item or person. contactTitle string The title of the contact. country string Country countryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. countyId number <int32> The county for the address. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. emailAddress string The email address. faxNumber string The number where a facsimile (fax) can be received. isActive boolean Specifies whether or not the associated record is active. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. organizationId number <int32> Organization Id otherContactName string Other Contact Name otherContactTitle string Other Contact Title otherEmailAddress string Other Email Address phoneNumber string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). postalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. rowVersion string state string If within the United States, the name of the state. streetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, syOrganizationId number <int32> Sy Organization Id transcriptContact string The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution. transcriptFee number <double> The fee charged by the institution to process a transcript request. transcriptOfficeCity string The name of the city. transcriptOfficeFax string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). transcriptOfficePhone string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). transcriptOfficePostalCode string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes. transcriptOfficeState string If within the United States, the name of the state. transcriptOfficeStreetAddress string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated. transcriptOfficeSyCountryId number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country. url string The web address for the person or institution. organizationContactStaffId number <int32> isExcludedCrmIntegration boolean note string Area you can use to display or specify comments or additional information. drivingDirections string The directions a driver would follow to get to the institution. originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/HighSchool/saveNew

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "academicYearEndMonth": 0,
  • "campusGroupId": 0,
  • "city": "string",
  • "code": "string",
  • "contactEmailAddress": "string",
  • "contactName": "string",
  • "contactTitle": "string",
  • "country": "string",
  • "countryId": 0,
  • "countyId": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "emailAddress": "string",
  • "faxNumber": "string",
  • "isActive": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "organizationId": 0,
  • "otherContactName": "string",
  • "otherContactTitle": "string",
  • "otherEmailAddress": "string",
  • "phoneNumber": "string",
  • "postalCode": "string",
  • "rowVersion": "string",
  • "state": "string",
  • "streetAddress": "string",
  • "syOrganizationId": 0,
  • "transcriptContact": "string",
  • "transcriptFee": 0,
  • "transcriptOfficeCity": "string",
  • "transcriptOfficeFax": "string",
  • "transcriptOfficePhone": "string",
  • "transcriptOfficePostalCode": "string",
  • "transcriptOfficeState": "string",
  • "transcriptOfficeStreetAddress": "string",
  • "transcriptOfficeSyCountryId": 0,
  • "url": "string",
  • "organizationContactStaffId": 0,
  • "isExcludedCrmIntegration": true,
  • "note": "string",
  • "drivingDirections": "string",
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "academicYearEndMonth": 0,
    • "campusGroupId": 0,
    • "city": "string",
    • "code": "string",
    • "contactEmailAddress": "string",
    • "contactName": "string",
    • "contactTitle": "string",
    • "country": "string",
    • "countryId": 0,
    • "countyId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "emailAddress": "string",
    • "faxNumber": "string",
    • "isActive": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "organizationId": 0,
    • "otherContactName": "string",
    • "otherContactTitle": "string",
    • "otherEmailAddress": "string",
    • "phoneNumber": "string",
    • "postalCode": "string",
    • "rowVersion": "string",
    • "state": "string",
    • "streetAddress": "string",
    • "syOrganizationId": 0,
    • "transcriptContact": "string",
    • "transcriptFee": 0,
    • "transcriptOfficeCity": "string",
    • "transcriptOfficeFax": "string",
    • "transcriptOfficePhone": "string",
    • "transcriptOfficePostalCode": "string",
    • "transcriptOfficeState": "string",
    • "transcriptOfficeStreetAddress": "string",
    • "transcriptOfficeSyCountryId": 0,
    • "url": "string",
    • "organizationContactStaffId": 0,
    • "isExcludedCrmIntegration": true,
    • "note": "string",
    • "drivingDirections": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

PreviousEducation

Create Previous Education

Authorizations:

apikey

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/PreviousEducation/create

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "isExcludedCrmIntegration": true,
    • "id": 0,
    • "campusGroupId": 0,
    • "code": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isActive": true,
    • "isSystemCode": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "rowVersion": "string",
    • "type": "string",
    • "campusGroup": {

      • "id": 0,
      • "approverStaffId": 0,
      • "code": "string",
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "financialCampusGroup": true,
      • "isActive": true,
      • "isSystemCode": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "name": "string",
      • "rowVersion": "string",
      • "saStmtComments": "string",
      • "saStmtLastCloseDate": "2019-08-24T14:15:22Z",
      • "type": "string",
      • "campusList": [

        • {

          • "id": 0,
          • "campusGroupId": 0,
          • "campusId": 0,
          • "createdDateTime": "2019-08-24T14:15:22Z",
          • "isCampusActive": true,
          • "isSystemCode": true,
          • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
          • "lastModifiedUserId": 0,
          • "rowVersion": "string",
          • "originalState": "string",
          • "secureState": "string",
          • "extendedProperties": [

            • null

            ],
          • "entityState": 0

          }

        ],
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Delete Previous Education

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-previouseducation-delete-request-payload)

isExcludedCrmIntegration boolean id number <int32> Id campusGroupId number <int32> Campus Group Id code string The alpha numeric code assigned to the item by your institution. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. isActive boolean Specifies whether or not the associated record is active. isSystemCode boolean Specifies whether or not the value is system-defined. Yes indicates that the item is defined by CampusNexus student. No indicates that your institution added the item. You cannot edit, delete, or deactivate items that are system-defined. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. rowVersion string type string Type object (cmc-nexus-common-entities-campusGroupEntity) originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/PreviousEducation/delete

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "isExcludedCrmIntegration": true,
  • "id": 0,
  • "campusGroupId": 0,
  • "code": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "isSystemCode": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "rowVersion": "string",
  • "type": "string",
  • "campusGroup": {

    • "id": 0,
    • "approverStaffId": 0,
    • "code": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "financialCampusGroup": true,
    • "isActive": true,
    • "isSystemCode": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "rowVersion": "string",
    • "saStmtComments": "string",
    • "saStmtLastCloseDate": "2019-08-24T14:15:22Z",
    • "type": "string",
    • "campusList": [

      • {

        • "id": 0,
        • "campusGroupId": 0,
        • "campusId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isCampusActive": true,
        • "isSystemCode": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "rowVersion": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    },
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "deleted": true

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Get Previous Education

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-previouseducation-get-request-payload)
id number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/PreviousEducation/get

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "isExcludedCrmIntegration": true,
    • "id": 0,
    • "campusGroupId": 0,
    • "code": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isActive": true,
    • "isSystemCode": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "rowVersion": "string",
    • "type": "string",
    • "campusGroup": {

      • "id": 0,
      • "approverStaffId": 0,
      • "code": "string",
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "financialCampusGroup": true,
      • "isActive": true,
      • "isSystemCode": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "name": "string",
      • "rowVersion": "string",
      • "saStmtComments": "string",
      • "saStmtLastCloseDate": "2019-08-24T14:15:22Z",
      • "type": "string",
      • "campusList": [

        • {

          • "id": 0,
          • "campusGroupId": 0,
          • "campusId": 0,
          • "createdDateTime": "2019-08-24T14:15:22Z",
          • "isCampusActive": true,
          • "isSystemCode": true,
          • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
          • "lastModifiedUserId": 0,
          • "rowVersion": "string",
          • "originalState": "string",
          • "secureState": "string",
          • "extendedProperties": [

            • null

            ],
          • "entityState": 0

          }

        ],
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save Previous Education

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-previouseducation-save-request-payload)

isExcludedCrmIntegration boolean id number <int32> Id campusGroupId number <int32> Campus Group Id code string The alpha numeric code assigned to the item by your institution. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. isActive boolean Specifies whether or not the associated record is active. isSystemCode boolean Specifies whether or not the value is system-defined. Yes indicates that the item is defined by CampusNexus student. No indicates that your institution added the item. You cannot edit, delete, or deactivate items that are system-defined. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. rowVersion string type string Type object (cmc-nexus-common-entities-campusGroupEntity) originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/PreviousEducation/save

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "isExcludedCrmIntegration": true,
  • "id": 0,
  • "campusGroupId": 0,
  • "code": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "isSystemCode": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "rowVersion": "string",
  • "type": "string",
  • "campusGroup": {

    • "id": 0,
    • "approverStaffId": 0,
    • "code": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "financialCampusGroup": true,
    • "isActive": true,
    • "isSystemCode": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "rowVersion": "string",
    • "saStmtComments": "string",
    • "saStmtLastCloseDate": "2019-08-24T14:15:22Z",
    • "type": "string",
    • "campusList": [

      • {

        • "id": 0,
        • "campusGroupId": 0,
        • "campusId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isCampusActive": true,
        • "isSystemCode": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "rowVersion": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    },
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "isExcludedCrmIntegration": true,
    • "id": 0,
    • "campusGroupId": 0,
    • "code": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isActive": true,
    • "isSystemCode": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "rowVersion": "string",
    • "type": "string",
    • "campusGroup": {

      • "id": 0,
      • "approverStaffId": 0,
      • "code": "string",
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "financialCampusGroup": true,
      • "isActive": true,
      • "isSystemCode": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "name": "string",
      • "rowVersion": "string",
      • "saStmtComments": "string",
      • "saStmtLastCloseDate": "2019-08-24T14:15:22Z",
      • "type": "string",
      • "campusList": [

        • {

          • "id": 0,
          • "campusGroupId": 0,
          • "campusId": 0,
          • "createdDateTime": "2019-08-24T14:15:22Z",
          • "isCampusActive": true,
          • "isSystemCode": true,
          • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
          • "lastModifiedUserId": 0,
          • "rowVersion": "string",
          • "originalState": "string",
          • "secureState": "string",
          • "extendedProperties": [

            • null

            ],
          • "entityState": 0

          }

        ],
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save New Previous Education

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-previouseducation-savenew-request-payload)

isExcludedCrmIntegration boolean id number <int32> Id campusGroupId number <int32> Campus Group Id code string The alpha numeric code assigned to the item by your institution. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. isActive boolean Specifies whether or not the associated record is active. isSystemCode boolean Specifies whether or not the value is system-defined. Yes indicates that the item is defined by CampusNexus student. No indicates that your institution added the item. You cannot edit, delete, or deactivate items that are system-defined. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. name string Specifies the name of the item or person. rowVersion string type string Type object (cmc-nexus-common-entities-campusGroupEntity) originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/PreviousEducation/saveNew

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "isExcludedCrmIntegration": true,
  • "id": 0,
  • "campusGroupId": 0,
  • "code": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "isSystemCode": true,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "name": "string",
  • "rowVersion": "string",
  • "type": "string",
  • "campusGroup": {

    • "id": 0,
    • "approverStaffId": 0,
    • "code": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "financialCampusGroup": true,
    • "isActive": true,
    • "isSystemCode": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "rowVersion": "string",
    • "saStmtComments": "string",
    • "saStmtLastCloseDate": "2019-08-24T14:15:22Z",
    • "type": "string",
    • "campusList": [

      • {

        • "id": 0,
        • "campusGroupId": 0,
        • "campusId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isCampusActive": true,
        • "isSystemCode": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "rowVersion": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    },
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "isExcludedCrmIntegration": true,
    • "id": 0,
    • "campusGroupId": 0,
    • "code": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isActive": true,
    • "isSystemCode": true,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "name": "string",
    • "rowVersion": "string",
    • "type": "string",
    • "campusGroup": {

      • "id": 0,
      • "approverStaffId": 0,
      • "code": "string",
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "financialCampusGroup": true,
      • "isActive": true,
      • "isSystemCode": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "name": "string",
      • "rowVersion": "string",
      • "saStmtComments": "string",
      • "saStmtLastCloseDate": "2019-08-24T14:15:22Z",
      • "type": "string",
      • "campusList": [

        • {

          • "id": 0,
          • "campusGroupId": 0,
          • "campusId": 0,
          • "createdDateTime": "2019-08-24T14:15:22Z",
          • "isCampusActive": true,
          • "isSystemCode": true,
          • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
          • "lastModifiedUserId": 0,
          • "rowVersion": "string",
          • "originalState": "string",
          • "secureState": "string",
          • "extendedProperties": [

            • null

            ],
          • "entityState": 0

          }

        ],
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

ProspectInquiry

Create Prospect Inquiry

Authorizations:

apikey

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/ProspectInquiry/create

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "newAssignedAdmissionsRepId": 0,
    • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
    • "id": 0,
    • "admissionsRepTypeId": 0,
    • "assignedAdmissionsRepId": 0,
    • "campusId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isCurrentInquiry": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "leadDate": "2019-08-24T14:15:22Z",
    • "leadSourceId": 0,
    • "leadTypeId": 0,
    • "originalAssignedAdmissionsRepId": 0,
    • "programGroupId": 0,
    • "programId": 0,
    • "regionId": 0,
    • "responseDate": "2019-08-24T14:15:22Z",
    • "responsePhoneNumber": "string",
    • "responseTime": "2019-08-24T14:15:22Z",
    • "rowVersion": "string",
    • "studentId": 0,
    • "student": {

      • "isExcludedCrmIntegration": true,
      • "addressTypeId": 0,
      • "studentInquiryRequired": true,
      • "extraCurricularsList": [

        • 0

        ],
      • "programsList": [

        • 0

        ],
      • "enrolledProgramIdList": [

        • 0

        ],
      • "ethnicitiesList": [

        • 0

        ],
      • "leadSourcesList": [

        • 0

        ],
      • "deleteVeteranDetails": true,
      • "vendors": [

        • {

          • "syOrganizationId": 0,
          • "leadSourceId": 0

          }

        ],
      • "studentAddressAssociation": 0,
      • "newAssignedAdmissionsRepId": 0,
      • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
      • "studentRelationshipAddress": {

        • "isPermanentAddress": true,
        • "isDefaultAddress": true,
        • "isExcludedCrmIntegration": true,
        • "id": 0,
        • "addressBeginDate": "2019-08-24T14:15:22Z",
        • "addressEndDate": "2019-08-24T14:15:22Z",
        • "addressTypeId": 0,
        • "admissionsRegionId": 0,
        • "city": "string",
        • "countryId": 0,
        • "countryName": "string",
        • "countyId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "emailAddress": "string",
        • "employerName": "string",
        • "firstName": "string",
        • "isSeasonalAddress": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "lastName": "string",
        • "mobileNumber": "string",
        • "note": "string",
        • "otherEmailAddress": "string",
        • "otherPhone": "string",
        • "phoneNumber": "string",
        • "plusReferenceNumber": 0,
        • "postalCode": "string",
        • "printedOnMasterPromNote": "string",
        • "printedOnPlusPromNote": "string",
        • "referenceConfirmed": "string",
        • "referenceConfirmedDate": "2019-08-24T14:15:22Z",
        • "referenceNumber": 0,
        • "relationToStudent": "string",
        • "rowVersion": "string",
        • "secondPhoneNumber": "string",
        • "sourceSystem": "string",
        • "ssn": "string",
        • "state": "string",
        • "streetAddress": "string",
        • "streetAddress2": "string",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "titleId": 0,
        • "workPhoneNumber": "string",
        • "yearsAtAddress": 0,
        • "yearsKnownStudent": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        },
      • "lastFourSsn": "string",
      • "customProperties": [

        • "string"

        ],
      • "multiValueCustomProperties": [

        • "string"

        ],
      • "originalCustomProperties": [

        • "string"

        ],
      • "originalMultiValueCustomProperties": [

        • "string"

        ],
      • "originalCustomPropertiesValues": "string",
      • "originalMultiValueCustomPropertiesValues": "string",
      • "genderPronounList": [

        • 0

        ],
      • "overridePrevEducAltPellValidation": true,
      • "id": 0,
      • "acgEligReasonCode": "string",
      • "agencyId": 0,
      • "alienNumber": "string",
      • "arAccountStatus": "string",
      • "arBalance": 0,
      • "arNextTransactionNumber": { },
      • "assignedAdmissionsRepId": 0,
      • "athleticIdentifier": "string",
      • "bestTimeToContact": "string",
      • "campusId": 0,
      • "citizenId": 0,
      • "city": "string",
      • "collegeId": 0,
      • "countryId": 0,
      • "countyId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "cumulativeGpa": 0,
      • "cumulativeGpaPoints": 0,
      • "currencyCodeId": 0,
      • "currentLda": "2019-08-24T14:15:22Z",
      • "dataBlockIndicator": true,
      • "dateOfBirth": "2019-08-24T14:15:22Z",
      • "dbiModifiedDate": "2019-08-24T14:15:22Z",
      • "defaultAddressCode": "string",
      • "defaultMasterStudentAddressId": 0,
      • "defaultStudentAddressId": 0,
      • "disabled": "string",
      • "driverLicenseNumber": "string",
      • "driverLicenseState": "string",
      • "emailAddress": "string",
      • "employabilityAboutInfo": "string",
      • "employerId": 0,
      • "employmentStatusId": 0,
      • "externalStudentIdentifier": "string",
      • "extraCurricularActivityId": 0,
      • "facebookUrl": "string",
      • "faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
      • "faRigorousHighSchoolProgramCodeId": 0,
      • "firstName": "string",
      • "genderId": 0,
      • "gpaCredits": 0,
      • "hispanicLatino": "string",
      • "hsAcademicGpa": 0,
      • "instagramUrl": "string",
      • "isActive": true,
      • "isAllowedBulkRegistrationByTrack": true,
      • "isBadAddress": true,
      • "isBadPhone": true,
      • "isDdVeteran": true,
      • "isEftDefaultForStipends": true,
      • "isInDistrict": true,
      • "isSscrError11Received": true,
      • "lastActivityDate": "2019-08-24T14:15:22Z",
      • "lastInterestDate": "2019-08-24T14:15:22Z",
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "lastName": "string",
      • "lastNameFirstFour": "string",
      • "lastStatementBeginDate": "2019-08-24T14:15:22Z",
      • "lastStatementCloseDate": "2019-08-24T14:15:22Z",
      • "lastStatementDate": "2019-08-24T14:15:22Z",
      • "leadDate": "2019-08-24T14:15:22Z",
      • "leadSourceId": 0,
      • "leadTypeId": 0,
      • "linkedInUrl": "string",
      • "maidenName": "string",
      • "maritalStatusId": 0,
      • "mi": "string",
      • "middleName": "string",
      • "mobilePhoneNumber": "string",
      • "nationalityId": 0,
      • "nickName": "string",
      • "niStudent": true,
      • "note": "string",
      • "originalAssignedAdmissionsRepId": 0,
      • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
      • "originalStartDate": "2019-08-24T14:15:22Z",
      • "otherEmailAddress": "string",
      • "otherPhoneNumber": "string",
      • "personId": 0,
      • "phoneNumber": "string",
      • "pin": 0,
      • "postalCode": "string",
      • "postalCodeFirstThree": "string",
      • "preferredContactType": "string",
      • "preferredName": "string",
      • "previousEducationGpa": 0,
      • "previousEducationId": 0,
      • "programGroupId": 0,
      • "programId": 0,
      • "rawFirstName": "string",
      • "rawLastName": "string",
      • "rawPhoneNumber": "string",
      • "rowVersion": "string",
      • "schoolStatusId": 0,
      • "shiftId": 0,
      • "smsServiceProviderId": 0,
      • "sourceSystem": "string",
      • "ssn": "string",
      • "startDate": "2019-08-24T14:15:22Z",
      • "state": "string",
      • "statementComment": "string",
      • "streetAddress": "string",
      • "streetAddress2": "string",
      • "studentFullName": "string",
      • "studentIdentifier": "string",
      • "studentNumber": "string",
      • "subscribeToSms": true,
      • "suffix": "string",
      • "suffixId": 0,
      • "titleId": 0,
      • "twitterUrl": "string",
      • "veteran": "string",
      • "workPhoneNumber": "string",
      • "workPhoneNumberExtension": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "programsOfInterest": [

      • {

        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimaryProgramOfInterest": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "programId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "syStudentInquiryId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "leadSources": [

      • {

        • "isExcludedCrmIntegration": true,
        • "id": 0,
        • "assignedAdmissionsRepId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimarySource": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "leadDate": "2019-08-24T14:15:22Z",
        • "leadSourceId": 0,
        • "prospectInquiryId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "vendors": [

          • {

            • "id": 0,
            • "createdDateTime": "2019-08-24T14:15:22Z",
            • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
            • "lastModifiedUserId": 0,
            • "prospectInquiryLeadSourceId": 0,
            • "rowVersion": "string",
            • "syOrganizationId": 0,
            • "originalState": "string",
            • "secureState": "string",
            • "extendedProperties": [

              • null

              ],
            • "entityState": 0

            }

          ],
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "comment": {

      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "note": "string",
      • "rowVersion": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Delete Prospect Inquiry

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-prospectinquiry-delete-request-payload)

newAssignedAdmissionsRepId number <int32> assignedAdmissionsRepReassignedDate string <date-time> id number <int32> Id admissionsRepTypeId number <int32> Admissions Rep Type Id assignedAdmissionsRepId number <int32> The Admissions Representative for the student. If a staff member is removed from an Admissions Representative group after having been assigned to a student, CampusNexus Student retains the name of the former representative on the student record. campusId number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. isCurrentInquiry boolean Specifies that the inquiry is the most current inquiry for the student. You can only have one current inquiry. To make an inquiry current, select the check box. CampusNexus Student automatically removes the check for the box last inquiry that was marked as current. The current inquiry is also displayed on the Student Profile. lastActivityDate string <date-time> The last date of a closed Task that is associated with the specific inquiry. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. leadDate string <date-time> The date that the prospective student contacted the institution. leadSourceId number <int32> The source of the prospect specified on the Student Profile or inquiry. The values are configured by your institution and they indicate how a student heard about your institution. If you are specifying the value, the program displays a dialog that you can use to select more than one prospect source, vendor, or sub vendors. leadTypeId number <int32> The type of prospect. The values are configured by your institution. originalAssignedAdmissionsRepId number <int32> The last and then first name of the admissions representative initially assigned to the student. programGroupId number <int32> The program group that the student is interested in. Program groups classify program versions that have some common characteristic and are configured by your institution. The interest determines that program related documents and required tests that are added to the student profile. programId number <int32> The programs that the student is interested in. If you are selecting the values, you can select more than one program. regionId number <int32> The admissions region. Region corresponds to Timezone in CampusNexus student. The field is only displayed if your institution has configured zone assignments. responseDate string <date-time> If your institution has configured one or more of the sources you selected for Prospect Source to capture advertising information, the date that the student responded to the advertising campaign. responsePhoneNumber string If your institution has configured one or more of the sources you selected for Prospect Source to capture advertising information, the phone number that the student used to respond to the advertising campaign. responseTime string <date-time> If your institution has configured one or more of the sources you selected for Prospect Source to capture advertising information, the time that the student responded to the advertising campaign. rowVersion string studentId number <int32> Student Id object (cmc-nexus-common-entities-studentEntity) Array of objects (cmc-nexus-admissions-entities-prospectInquiryProgramEntity) Array of objects (cmc-nexus-admissions-entities-prospectInquiryLeadSourceEntity) object (cmc-nexus-admissions-entities-prospectInquiryCommentEntity) originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/ProspectInquiry/delete

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "newAssignedAdmissionsRepId": 0,
  • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "admissionsRepTypeId": 0,
  • "assignedAdmissionsRepId": 0,
  • "campusId": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "isCurrentInquiry": true,
  • "lastActivityDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "leadDate": "2019-08-24T14:15:22Z",
  • "leadSourceId": 0,
  • "leadTypeId": 0,
  • "originalAssignedAdmissionsRepId": 0,
  • "programGroupId": 0,
  • "programId": 0,
  • "regionId": 0,
  • "responseDate": "2019-08-24T14:15:22Z",
  • "responsePhoneNumber": "string",
  • "responseTime": "2019-08-24T14:15:22Z",
  • "rowVersion": "string",
  • "studentId": 0,
  • "student": {

    • "isExcludedCrmIntegration": true,
    • "addressTypeId": 0,
    • "studentInquiryRequired": true,
    • "extraCurricularsList": [

      • 0

      ],
    • "programsList": [

      • 0

      ],
    • "enrolledProgramIdList": [

      • 0

      ],
    • "ethnicitiesList": [

      • 0

      ],
    • "leadSourcesList": [

      • 0

      ],
    • "deleteVeteranDetails": true,
    • "vendors": [

      • {

        • "syOrganizationId": 0,
        • "leadSourceId": 0

        }

      ],
    • "studentAddressAssociation": 0,
    • "newAssignedAdmissionsRepId": 0,
    • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
    • "studentRelationshipAddress": {

      • "isPermanentAddress": true,
      • "isDefaultAddress": true,
      • "isExcludedCrmIntegration": true,
      • "id": 0,
      • "addressBeginDate": "2019-08-24T14:15:22Z",
      • "addressEndDate": "2019-08-24T14:15:22Z",
      • "addressTypeId": 0,
      • "admissionsRegionId": 0,
      • "city": "string",
      • "countryId": 0,
      • "countryName": "string",
      • "countyId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "emailAddress": "string",
      • "employerName": "string",
      • "firstName": "string",
      • "isSeasonalAddress": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "lastName": "string",
      • "mobileNumber": "string",
      • "note": "string",
      • "otherEmailAddress": "string",
      • "otherPhone": "string",
      • "phoneNumber": "string",
      • "plusReferenceNumber": 0,
      • "postalCode": "string",
      • "printedOnMasterPromNote": "string",
      • "printedOnPlusPromNote": "string",
      • "referenceConfirmed": "string",
      • "referenceConfirmedDate": "2019-08-24T14:15:22Z",
      • "referenceNumber": 0,
      • "relationToStudent": "string",
      • "rowVersion": "string",
      • "secondPhoneNumber": "string",
      • "sourceSystem": "string",
      • "ssn": "string",
      • "state": "string",
      • "streetAddress": "string",
      • "streetAddress2": "string",
      • "studentEnrollmentPeriodId": 0,
      • "studentId": 0,
      • "titleId": 0,
      • "workPhoneNumber": "string",
      • "yearsAtAddress": 0,
      • "yearsKnownStudent": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "lastFourSsn": "string",
    • "customProperties": [

      • "string"

      ],
    • "multiValueCustomProperties": [

      • "string"

      ],
    • "originalCustomProperties": [

      • "string"

      ],
    • "originalMultiValueCustomProperties": [

      • "string"

      ],
    • "originalCustomPropertiesValues": "string",
    • "originalMultiValueCustomPropertiesValues": "string",
    • "genderPronounList": [

      • 0

      ],
    • "overridePrevEducAltPellValidation": true,
    • "id": 0,
    • "acgEligReasonCode": "string",
    • "agencyId": 0,
    • "alienNumber": "string",
    • "arAccountStatus": "string",
    • "arBalance": 0,
    • "arNextTransactionNumber": { },
    • "assignedAdmissionsRepId": 0,
    • "athleticIdentifier": "string",
    • "bestTimeToContact": "string",
    • "campusId": 0,
    • "citizenId": 0,
    • "city": "string",
    • "collegeId": 0,
    • "countryId": 0,
    • "countyId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "cumulativeGpa": 0,
    • "cumulativeGpaPoints": 0,
    • "currencyCodeId": 0,
    • "currentLda": "2019-08-24T14:15:22Z",
    • "dataBlockIndicator": true,
    • "dateOfBirth": "2019-08-24T14:15:22Z",
    • "dbiModifiedDate": "2019-08-24T14:15:22Z",
    • "defaultAddressCode": "string",
    • "defaultMasterStudentAddressId": 0,
    • "defaultStudentAddressId": 0,
    • "disabled": "string",
    • "driverLicenseNumber": "string",
    • "driverLicenseState": "string",
    • "emailAddress": "string",
    • "employabilityAboutInfo": "string",
    • "employerId": 0,
    • "employmentStatusId": 0,
    • "externalStudentIdentifier": "string",
    • "extraCurricularActivityId": 0,
    • "facebookUrl": "string",
    • "faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
    • "faRigorousHighSchoolProgramCodeId": 0,
    • "firstName": "string",
    • "genderId": 0,
    • "gpaCredits": 0,
    • "hispanicLatino": "string",
    • "hsAcademicGpa": 0,
    • "instagramUrl": "string",
    • "isActive": true,
    • "isAllowedBulkRegistrationByTrack": true,
    • "isBadAddress": true,
    • "isBadPhone": true,
    • "isDdVeteran": true,
    • "isEftDefaultForStipends": true,
    • "isInDistrict": true,
    • "isSscrError11Received": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastInterestDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "lastName": "string",
    • "lastNameFirstFour": "string",
    • "lastStatementBeginDate": "2019-08-24T14:15:22Z",
    • "lastStatementCloseDate": "2019-08-24T14:15:22Z",
    • "lastStatementDate": "2019-08-24T14:15:22Z",
    • "leadDate": "2019-08-24T14:15:22Z",
    • "leadSourceId": 0,
    • "leadTypeId": 0,
    • "linkedInUrl": "string",
    • "maidenName": "string",
    • "maritalStatusId": 0,
    • "mi": "string",
    • "middleName": "string",
    • "mobilePhoneNumber": "string",
    • "nationalityId": 0,
    • "nickName": "string",
    • "niStudent": true,
    • "note": "string",
    • "originalAssignedAdmissionsRepId": 0,
    • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
    • "originalStartDate": "2019-08-24T14:15:22Z",
    • "otherEmailAddress": "string",
    • "otherPhoneNumber": "string",
    • "personId": 0,
    • "phoneNumber": "string",
    • "pin": 0,
    • "postalCode": "string",
    • "postalCodeFirstThree": "string",
    • "preferredContactType": "string",
    • "preferredName": "string",
    • "previousEducationGpa": 0,
    • "previousEducationId": 0,
    • "programGroupId": 0,
    • "programId": 0,
    • "rawFirstName": "string",
    • "rawLastName": "string",
    • "rawPhoneNumber": "string",
    • "rowVersion": "string",
    • "schoolStatusId": 0,
    • "shiftId": 0,
    • "smsServiceProviderId": 0,
    • "sourceSystem": "string",
    • "ssn": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "state": "string",
    • "statementComment": "string",
    • "streetAddress": "string",
    • "streetAddress2": "string",
    • "studentFullName": "string",
    • "studentIdentifier": "string",
    • "studentNumber": "string",
    • "subscribeToSms": true,
    • "suffix": "string",
    • "suffixId": 0,
    • "titleId": 0,
    • "twitterUrl": "string",
    • "veteran": "string",
    • "workPhoneNumber": "string",
    • "workPhoneNumberExtension": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    },
  • "programsOfInterest": [

    • {

      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isPrimaryProgramOfInterest": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "programId": 0,
      • "rowVersion": "string",
      • "studentId": 0,
      • "syStudentInquiryId": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "leadSources": [

    • {

      • "isExcludedCrmIntegration": true,
      • "id": 0,
      • "assignedAdmissionsRepId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isPrimarySource": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "leadDate": "2019-08-24T14:15:22Z",
      • "leadSourceId": 0,
      • "prospectInquiryId": 0,
      • "rowVersion": "string",
      • "studentId": 0,
      • "vendors": [

        • {

          • "id": 0,
          • "createdDateTime": "2019-08-24T14:15:22Z",
          • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
          • "lastModifiedUserId": 0,
          • "prospectInquiryLeadSourceId": 0,
          • "rowVersion": "string",
          • "syOrganizationId": 0,
          • "originalState": "string",
          • "secureState": "string",
          • "extendedProperties": [

            • null

            ],
          • "entityState": 0

          }

        ],
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "comment": {

    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "note": "string",
    • "rowVersion": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    },
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "deleted": true

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Delete Prospect

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-prospectinquiry-deleteprospect-request-payload)
campusIdList Array of numbers <int32> [ items <int32 > ] studentSchoolStatusIdList Array of numbers <int32> [ items <int32 > ] highLeadDate string <date-time> isDeleteBlankLeadDate boolean isDeleteFutureLeadDate boolean mode string

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/ProspectInquiry/deleteProspect

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "campusIdList": [

    • 0

    ],
  • "studentSchoolStatusIdList": [

    • 0

    ],
  • "highLeadDate": "2019-08-24T14:15:22Z",
  • "isDeleteBlankLeadDate": true,
  • "isDeleteFutureLeadDate": true,
  • "mode": "string"

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "mode": "string",
    • "isStatusUpdated": true,
    • "studentDetailList": [

      • {

        • "fullName": "string",
        • "firstName": "string",
        • "lastName": "string",
        • "city": "string",
        • "state": "string",
        • "emailAddress": "string",
        • "campusName": "string",
        • "leadDate": "2019-08-24T14:15:22Z",
        • "leadSourceName": "string",
        • "leadTypeName": "string",
        • "schoolStatusName": "string",
        • "studentId": 0,
        • "studentNumber": "string"

        }

      ],
    • "validationMessages": {

      • "hasErrors": true,
      • "count": 0,
      • "item": {

        • "message": "string",
        • "messageType": 0

        }

      }

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Get Prospect Inquiry

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-prospectinquiry-get-request-payload)
id number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/ProspectInquiry/get

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "newAssignedAdmissionsRepId": 0,
    • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
    • "id": 0,
    • "admissionsRepTypeId": 0,
    • "assignedAdmissionsRepId": 0,
    • "campusId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isCurrentInquiry": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "leadDate": "2019-08-24T14:15:22Z",
    • "leadSourceId": 0,
    • "leadTypeId": 0,
    • "originalAssignedAdmissionsRepId": 0,
    • "programGroupId": 0,
    • "programId": 0,
    • "regionId": 0,
    • "responseDate": "2019-08-24T14:15:22Z",
    • "responsePhoneNumber": "string",
    • "responseTime": "2019-08-24T14:15:22Z",
    • "rowVersion": "string",
    • "studentId": 0,
    • "student": {

      • "isExcludedCrmIntegration": true,
      • "addressTypeId": 0,
      • "studentInquiryRequired": true,
      • "extraCurricularsList": [

        • 0

        ],
      • "programsList": [

        • 0

        ],
      • "enrolledProgramIdList": [

        • 0

        ],
      • "ethnicitiesList": [

        • 0

        ],
      • "leadSourcesList": [

        • 0

        ],
      • "deleteVeteranDetails": true,
      • "vendors": [

        • {

          • "syOrganizationId": 0,
          • "leadSourceId": 0

          }

        ],
      • "studentAddressAssociation": 0,
      • "newAssignedAdmissionsRepId": 0,
      • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
      • "studentRelationshipAddress": {

        • "isPermanentAddress": true,
        • "isDefaultAddress": true,
        • "isExcludedCrmIntegration": true,
        • "id": 0,
        • "addressBeginDate": "2019-08-24T14:15:22Z",
        • "addressEndDate": "2019-08-24T14:15:22Z",
        • "addressTypeId": 0,
        • "admissionsRegionId": 0,
        • "city": "string",
        • "countryId": 0,
        • "countryName": "string",
        • "countyId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "emailAddress": "string",
        • "employerName": "string",
        • "firstName": "string",
        • "isSeasonalAddress": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "lastName": "string",
        • "mobileNumber": "string",
        • "note": "string",
        • "otherEmailAddress": "string",
        • "otherPhone": "string",
        • "phoneNumber": "string",
        • "plusReferenceNumber": 0,
        • "postalCode": "string",
        • "printedOnMasterPromNote": "string",
        • "printedOnPlusPromNote": "string",
        • "referenceConfirmed": "string",
        • "referenceConfirmedDate": "2019-08-24T14:15:22Z",
        • "referenceNumber": 0,
        • "relationToStudent": "string",
        • "rowVersion": "string",
        • "secondPhoneNumber": "string",
        • "sourceSystem": "string",
        • "ssn": "string",
        • "state": "string",
        • "streetAddress": "string",
        • "streetAddress2": "string",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "titleId": 0,
        • "workPhoneNumber": "string",
        • "yearsAtAddress": 0,
        • "yearsKnownStudent": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        },
      • "lastFourSsn": "string",
      • "customProperties": [

        • "string"

        ],
      • "multiValueCustomProperties": [

        • "string"

        ],
      • "originalCustomProperties": [

        • "string"

        ],
      • "originalMultiValueCustomProperties": [

        • "string"

        ],
      • "originalCustomPropertiesValues": "string",
      • "originalMultiValueCustomPropertiesValues": "string",
      • "genderPronounList": [

        • 0

        ],
      • "overridePrevEducAltPellValidation": true,
      • "id": 0,
      • "acgEligReasonCode": "string",
      • "agencyId": 0,
      • "alienNumber": "string",
      • "arAccountStatus": "string",
      • "arBalance": 0,
      • "arNextTransactionNumber": { },
      • "assignedAdmissionsRepId": 0,
      • "athleticIdentifier": "string",
      • "bestTimeToContact": "string",
      • "campusId": 0,
      • "citizenId": 0,
      • "city": "string",
      • "collegeId": 0,
      • "countryId": 0,
      • "countyId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "cumulativeGpa": 0,
      • "cumulativeGpaPoints": 0,
      • "currencyCodeId": 0,
      • "currentLda": "2019-08-24T14:15:22Z",
      • "dataBlockIndicator": true,
      • "dateOfBirth": "2019-08-24T14:15:22Z",
      • "dbiModifiedDate": "2019-08-24T14:15:22Z",
      • "defaultAddressCode": "string",
      • "defaultMasterStudentAddressId": 0,
      • "defaultStudentAddressId": 0,
      • "disabled": "string",
      • "driverLicenseNumber": "string",
      • "driverLicenseState": "string",
      • "emailAddress": "string",
      • "employabilityAboutInfo": "string",
      • "employerId": 0,
      • "employmentStatusId": 0,
      • "externalStudentIdentifier": "string",
      • "extraCurricularActivityId": 0,
      • "facebookUrl": "string",
      • "faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
      • "faRigorousHighSchoolProgramCodeId": 0,
      • "firstName": "string",
      • "genderId": 0,
      • "gpaCredits": 0,
      • "hispanicLatino": "string",
      • "hsAcademicGpa": 0,
      • "instagramUrl": "string",
      • "isActive": true,
      • "isAllowedBulkRegistrationByTrack": true,
      • "isBadAddress": true,
      • "isBadPhone": true,
      • "isDdVeteran": true,
      • "isEftDefaultForStipends": true,
      • "isInDistrict": true,
      • "isSscrError11Received": true,
      • "lastActivityDate": "2019-08-24T14:15:22Z",
      • "lastInterestDate": "2019-08-24T14:15:22Z",
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "lastName": "string",
      • "lastNameFirstFour": "string",
      • "lastStatementBeginDate": "2019-08-24T14:15:22Z",
      • "lastStatementCloseDate": "2019-08-24T14:15:22Z",
      • "lastStatementDate": "2019-08-24T14:15:22Z",
      • "leadDate": "2019-08-24T14:15:22Z",
      • "leadSourceId": 0,
      • "leadTypeId": 0,
      • "linkedInUrl": "string",
      • "maidenName": "string",
      • "maritalStatusId": 0,
      • "mi": "string",
      • "middleName": "string",
      • "mobilePhoneNumber": "string",
      • "nationalityId": 0,
      • "nickName": "string",
      • "niStudent": true,
      • "note": "string",
      • "originalAssignedAdmissionsRepId": 0,
      • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
      • "originalStartDate": "2019-08-24T14:15:22Z",
      • "otherEmailAddress": "string",
      • "otherPhoneNumber": "string",
      • "personId": 0,
      • "phoneNumber": "string",
      • "pin": 0,
      • "postalCode": "string",
      • "postalCodeFirstThree": "string",
      • "preferredContactType": "string",
      • "preferredName": "string",
      • "previousEducationGpa": 0,
      • "previousEducationId": 0,
      • "programGroupId": 0,
      • "programId": 0,
      • "rawFirstName": "string",
      • "rawLastName": "string",
      • "rawPhoneNumber": "string",
      • "rowVersion": "string",
      • "schoolStatusId": 0,
      • "shiftId": 0,
      • "smsServiceProviderId": 0,
      • "sourceSystem": "string",
      • "ssn": "string",
      • "startDate": "2019-08-24T14:15:22Z",
      • "state": "string",
      • "statementComment": "string",
      • "streetAddress": "string",
      • "streetAddress2": "string",
      • "studentFullName": "string",
      • "studentIdentifier": "string",
      • "studentNumber": "string",
      • "subscribeToSms": true,
      • "suffix": "string",
      • "suffixId": 0,
      • "titleId": 0,
      • "twitterUrl": "string",
      • "veteran": "string",
      • "workPhoneNumber": "string",
      • "workPhoneNumberExtension": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "programsOfInterest": [

      • {

        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimaryProgramOfInterest": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "programId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "syStudentInquiryId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "leadSources": [

      • {

        • "isExcludedCrmIntegration": true,
        • "id": 0,
        • "assignedAdmissionsRepId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimarySource": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "leadDate": "2019-08-24T14:15:22Z",
        • "leadSourceId": 0,
        • "prospectInquiryId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "vendors": [

          • {

            • "id": 0,
            • "createdDateTime": "2019-08-24T14:15:22Z",
            • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
            • "lastModifiedUserId": 0,
            • "prospectInquiryLeadSourceId": 0,
            • "rowVersion": "string",
            • "syOrganizationId": 0,
            • "originalState": "string",
            • "secureState": "string",
            • "extendedProperties": [

              • null

              ],
            • "entityState": 0

            }

          ],
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "comment": {

      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "note": "string",
      • "rowVersion": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save Prospect Inquiry

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-prospectinquiry-save-request-payload)

newAssignedAdmissionsRepId number <int32> assignedAdmissionsRepReassignedDate string <date-time> id number <int32> Id admissionsRepTypeId number <int32> Admissions Rep Type Id assignedAdmissionsRepId number <int32> The Admissions Representative for the student. If a staff member is removed from an Admissions Representative group after having been assigned to a student, CampusNexus Student retains the name of the former representative on the student record. campusId number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. isCurrentInquiry boolean Specifies that the inquiry is the most current inquiry for the student. You can only have one current inquiry. To make an inquiry current, select the check box. CampusNexus Student automatically removes the check for the box last inquiry that was marked as current. The current inquiry is also displayed on the Student Profile. lastActivityDate string <date-time> The last date of a closed Task that is associated with the specific inquiry. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. leadDate string <date-time> The date that the prospective student contacted the institution. leadSourceId number <int32> The source of the prospect specified on the Student Profile or inquiry. The values are configured by your institution and they indicate how a student heard about your institution. If you are specifying the value, the program displays a dialog that you can use to select more than one prospect source, vendor, or sub vendors. leadTypeId number <int32> The type of prospect. The values are configured by your institution. originalAssignedAdmissionsRepId number <int32> The last and then first name of the admissions representative initially assigned to the student. programGroupId number <int32> The program group that the student is interested in. Program groups classify program versions that have some common characteristic and are configured by your institution. The interest determines that program related documents and required tests that are added to the student profile. programId number <int32> The programs that the student is interested in. If you are selecting the values, you can select more than one program. regionId number <int32> The admissions region. Region corresponds to Timezone in CampusNexus student. The field is only displayed if your institution has configured zone assignments. responseDate string <date-time> If your institution has configured one or more of the sources you selected for Prospect Source to capture advertising information, the date that the student responded to the advertising campaign. responsePhoneNumber string If your institution has configured one or more of the sources you selected for Prospect Source to capture advertising information, the phone number that the student used to respond to the advertising campaign. responseTime string <date-time> If your institution has configured one or more of the sources you selected for Prospect Source to capture advertising information, the time that the student responded to the advertising campaign. rowVersion string studentId number <int32> Student Id object (cmc-nexus-common-entities-studentEntity) Array of objects (cmc-nexus-admissions-entities-prospectInquiryProgramEntity) Array of objects (cmc-nexus-admissions-entities-prospectInquiryLeadSourceEntity) object (cmc-nexus-admissions-entities-prospectInquiryCommentEntity) originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/ProspectInquiry/save

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "newAssignedAdmissionsRepId": 0,
  • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "admissionsRepTypeId": 0,
  • "assignedAdmissionsRepId": 0,
  • "campusId": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "isCurrentInquiry": true,
  • "lastActivityDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "leadDate": "2019-08-24T14:15:22Z",
  • "leadSourceId": 0,
  • "leadTypeId": 0,
  • "originalAssignedAdmissionsRepId": 0,
  • "programGroupId": 0,
  • "programId": 0,
  • "regionId": 0,
  • "responseDate": "2019-08-24T14:15:22Z",
  • "responsePhoneNumber": "string",
  • "responseTime": "2019-08-24T14:15:22Z",
  • "rowVersion": "string",
  • "studentId": 0,
  • "student": {

    • "isExcludedCrmIntegration": true,
    • "addressTypeId": 0,
    • "studentInquiryRequired": true,
    • "extraCurricularsList": [

      • 0

      ],
    • "programsList": [

      • 0

      ],
    • "enrolledProgramIdList": [

      • 0

      ],
    • "ethnicitiesList": [

      • 0

      ],
    • "leadSourcesList": [

      • 0

      ],
    • "deleteVeteranDetails": true,
    • "vendors": [

      • {

        • "syOrganizationId": 0,
        • "leadSourceId": 0

        }

      ],
    • "studentAddressAssociation": 0,
    • "newAssignedAdmissionsRepId": 0,
    • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
    • "studentRelationshipAddress": {

      • "isPermanentAddress": true,
      • "isDefaultAddress": true,
      • "isExcludedCrmIntegration": true,
      • "id": 0,
      • "addressBeginDate": "2019-08-24T14:15:22Z",
      • "addressEndDate": "2019-08-24T14:15:22Z",
      • "addressTypeId": 0,
      • "admissionsRegionId": 0,
      • "city": "string",
      • "countryId": 0,
      • "countryName": "string",
      • "countyId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "emailAddress": "string",
      • "employerName": "string",
      • "firstName": "string",
      • "isSeasonalAddress": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "lastName": "string",
      • "mobileNumber": "string",
      • "note": "string",
      • "otherEmailAddress": "string",
      • "otherPhone": "string",
      • "phoneNumber": "string",
      • "plusReferenceNumber": 0,
      • "postalCode": "string",
      • "printedOnMasterPromNote": "string",
      • "printedOnPlusPromNote": "string",
      • "referenceConfirmed": "string",
      • "referenceConfirmedDate": "2019-08-24T14:15:22Z",
      • "referenceNumber": 0,
      • "relationToStudent": "string",
      • "rowVersion": "string",
      • "secondPhoneNumber": "string",
      • "sourceSystem": "string",
      • "ssn": "string",
      • "state": "string",
      • "streetAddress": "string",
      • "streetAddress2": "string",
      • "studentEnrollmentPeriodId": 0,
      • "studentId": 0,
      • "titleId": 0,
      • "workPhoneNumber": "string",
      • "yearsAtAddress": 0,
      • "yearsKnownStudent": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "lastFourSsn": "string",
    • "customProperties": [

      • "string"

      ],
    • "multiValueCustomProperties": [

      • "string"

      ],
    • "originalCustomProperties": [

      • "string"

      ],
    • "originalMultiValueCustomProperties": [

      • "string"

      ],
    • "originalCustomPropertiesValues": "string",
    • "originalMultiValueCustomPropertiesValues": "string",
    • "genderPronounList": [

      • 0

      ],
    • "overridePrevEducAltPellValidation": true,
    • "id": 0,
    • "acgEligReasonCode": "string",
    • "agencyId": 0,
    • "alienNumber": "string",
    • "arAccountStatus": "string",
    • "arBalance": 0,
    • "arNextTransactionNumber": { },
    • "assignedAdmissionsRepId": 0,
    • "athleticIdentifier": "string",
    • "bestTimeToContact": "string",
    • "campusId": 0,
    • "citizenId": 0,
    • "city": "string",
    • "collegeId": 0,
    • "countryId": 0,
    • "countyId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "cumulativeGpa": 0,
    • "cumulativeGpaPoints": 0,
    • "currencyCodeId": 0,
    • "currentLda": "2019-08-24T14:15:22Z",
    • "dataBlockIndicator": true,
    • "dateOfBirth": "2019-08-24T14:15:22Z",
    • "dbiModifiedDate": "2019-08-24T14:15:22Z",
    • "defaultAddressCode": "string",
    • "defaultMasterStudentAddressId": 0,
    • "defaultStudentAddressId": 0,
    • "disabled": "string",
    • "driverLicenseNumber": "string",
    • "driverLicenseState": "string",
    • "emailAddress": "string",
    • "employabilityAboutInfo": "string",
    • "employerId": 0,
    • "employmentStatusId": 0,
    • "externalStudentIdentifier": "string",
    • "extraCurricularActivityId": 0,
    • "facebookUrl": "string",
    • "faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
    • "faRigorousHighSchoolProgramCodeId": 0,
    • "firstName": "string",
    • "genderId": 0,
    • "gpaCredits": 0,
    • "hispanicLatino": "string",
    • "hsAcademicGpa": 0,
    • "instagramUrl": "string",
    • "isActive": true,
    • "isAllowedBulkRegistrationByTrack": true,
    • "isBadAddress": true,
    • "isBadPhone": true,
    • "isDdVeteran": true,
    • "isEftDefaultForStipends": true,
    • "isInDistrict": true,
    • "isSscrError11Received": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastInterestDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "lastName": "string",
    • "lastNameFirstFour": "string",
    • "lastStatementBeginDate": "2019-08-24T14:15:22Z",
    • "lastStatementCloseDate": "2019-08-24T14:15:22Z",
    • "lastStatementDate": "2019-08-24T14:15:22Z",
    • "leadDate": "2019-08-24T14:15:22Z",
    • "leadSourceId": 0,
    • "leadTypeId": 0,
    • "linkedInUrl": "string",
    • "maidenName": "string",
    • "maritalStatusId": 0,
    • "mi": "string",
    • "middleName": "string",
    • "mobilePhoneNumber": "string",
    • "nationalityId": 0,
    • "nickName": "string",
    • "niStudent": true,
    • "note": "string",
    • "originalAssignedAdmissionsRepId": 0,
    • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
    • "originalStartDate": "2019-08-24T14:15:22Z",
    • "otherEmailAddress": "string",
    • "otherPhoneNumber": "string",
    • "personId": 0,
    • "phoneNumber": "string",
    • "pin": 0,
    • "postalCode": "string",
    • "postalCodeFirstThree": "string",
    • "preferredContactType": "string",
    • "preferredName": "string",
    • "previousEducationGpa": 0,
    • "previousEducationId": 0,
    • "programGroupId": 0,
    • "programId": 0,
    • "rawFirstName": "string",
    • "rawLastName": "string",
    • "rawPhoneNumber": "string",
    • "rowVersion": "string",
    • "schoolStatusId": 0,
    • "shiftId": 0,
    • "smsServiceProviderId": 0,
    • "sourceSystem": "string",
    • "ssn": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "state": "string",
    • "statementComment": "string",
    • "streetAddress": "string",
    • "streetAddress2": "string",
    • "studentFullName": "string",
    • "studentIdentifier": "string",
    • "studentNumber": "string",
    • "subscribeToSms": true,
    • "suffix": "string",
    • "suffixId": 0,
    • "titleId": 0,
    • "twitterUrl": "string",
    • "veteran": "string",
    • "workPhoneNumber": "string",
    • "workPhoneNumberExtension": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    },
  • "programsOfInterest": [

    • {

      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isPrimaryProgramOfInterest": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "programId": 0,
      • "rowVersion": "string",
      • "studentId": 0,
      • "syStudentInquiryId": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "leadSources": [

    • {

      • "isExcludedCrmIntegration": true,
      • "id": 0,
      • "assignedAdmissionsRepId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isPrimarySource": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "leadDate": "2019-08-24T14:15:22Z",
      • "leadSourceId": 0,
      • "prospectInquiryId": 0,
      • "rowVersion": "string",
      • "studentId": 0,
      • "vendors": [

        • {

          • "id": 0,
          • "createdDateTime": "2019-08-24T14:15:22Z",
          • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
          • "lastModifiedUserId": 0,
          • "prospectInquiryLeadSourceId": 0,
          • "rowVersion": "string",
          • "syOrganizationId": 0,
          • "originalState": "string",
          • "secureState": "string",
          • "extendedProperties": [

            • null

            ],
          • "entityState": 0

          }

        ],
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "comment": {

    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "note": "string",
    • "rowVersion": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    },
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "newAssignedAdmissionsRepId": 0,
    • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
    • "id": 0,
    • "admissionsRepTypeId": 0,
    • "assignedAdmissionsRepId": 0,
    • "campusId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isCurrentInquiry": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "leadDate": "2019-08-24T14:15:22Z",
    • "leadSourceId": 0,
    • "leadTypeId": 0,
    • "originalAssignedAdmissionsRepId": 0,
    • "programGroupId": 0,
    • "programId": 0,
    • "regionId": 0,
    • "responseDate": "2019-08-24T14:15:22Z",
    • "responsePhoneNumber": "string",
    • "responseTime": "2019-08-24T14:15:22Z",
    • "rowVersion": "string",
    • "studentId": 0,
    • "student": {

      • "isExcludedCrmIntegration": true,
      • "addressTypeId": 0,
      • "studentInquiryRequired": true,
      • "extraCurricularsList": [

        • 0

        ],
      • "programsList": [

        • 0

        ],
      • "enrolledProgramIdList": [

        • 0

        ],
      • "ethnicitiesList": [

        • 0

        ],
      • "leadSourcesList": [

        • 0

        ],
      • "deleteVeteranDetails": true,
      • "vendors": [

        • {

          • "syOrganizationId": 0,
          • "leadSourceId": 0

          }

        ],
      • "studentAddressAssociation": 0,
      • "newAssignedAdmissionsRepId": 0,
      • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
      • "studentRelationshipAddress": {

        • "isPermanentAddress": true,
        • "isDefaultAddress": true,
        • "isExcludedCrmIntegration": true,
        • "id": 0,
        • "addressBeginDate": "2019-08-24T14:15:22Z",
        • "addressEndDate": "2019-08-24T14:15:22Z",
        • "addressTypeId": 0,
        • "admissionsRegionId": 0,
        • "city": "string",
        • "countryId": 0,
        • "countryName": "string",
        • "countyId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "emailAddress": "string",
        • "employerName": "string",
        • "firstName": "string",
        • "isSeasonalAddress": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "lastName": "string",
        • "mobileNumber": "string",
        • "note": "string",
        • "otherEmailAddress": "string",
        • "otherPhone": "string",
        • "phoneNumber": "string",
        • "plusReferenceNumber": 0,
        • "postalCode": "string",
        • "printedOnMasterPromNote": "string",
        • "printedOnPlusPromNote": "string",
        • "referenceConfirmed": "string",
        • "referenceConfirmedDate": "2019-08-24T14:15:22Z",
        • "referenceNumber": 0,
        • "relationToStudent": "string",
        • "rowVersion": "string",
        • "secondPhoneNumber": "string",
        • "sourceSystem": "string",
        • "ssn": "string",
        • "state": "string",
        • "streetAddress": "string",
        • "streetAddress2": "string",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "titleId": 0,
        • "workPhoneNumber": "string",
        • "yearsAtAddress": 0,
        • "yearsKnownStudent": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        },
      • "lastFourSsn": "string",
      • "customProperties": [

        • "string"

        ],
      • "multiValueCustomProperties": [

        • "string"

        ],
      • "originalCustomProperties": [

        • "string"

        ],
      • "originalMultiValueCustomProperties": [

        • "string"

        ],
      • "originalCustomPropertiesValues": "string",
      • "originalMultiValueCustomPropertiesValues": "string",
      • "genderPronounList": [

        • 0

        ],
      • "overridePrevEducAltPellValidation": true,
      • "id": 0,
      • "acgEligReasonCode": "string",
      • "agencyId": 0,
      • "alienNumber": "string",
      • "arAccountStatus": "string",
      • "arBalance": 0,
      • "arNextTransactionNumber": { },
      • "assignedAdmissionsRepId": 0,
      • "athleticIdentifier": "string",
      • "bestTimeToContact": "string",
      • "campusId": 0,
      • "citizenId": 0,
      • "city": "string",
      • "collegeId": 0,
      • "countryId": 0,
      • "countyId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "cumulativeGpa": 0,
      • "cumulativeGpaPoints": 0,
      • "currencyCodeId": 0,
      • "currentLda": "2019-08-24T14:15:22Z",
      • "dataBlockIndicator": true,
      • "dateOfBirth": "2019-08-24T14:15:22Z",
      • "dbiModifiedDate": "2019-08-24T14:15:22Z",
      • "defaultAddressCode": "string",
      • "defaultMasterStudentAddressId": 0,
      • "defaultStudentAddressId": 0,
      • "disabled": "string",
      • "driverLicenseNumber": "string",
      • "driverLicenseState": "string",
      • "emailAddress": "string",
      • "employabilityAboutInfo": "string",
      • "employerId": 0,
      • "employmentStatusId": 0,
      • "externalStudentIdentifier": "string",
      • "extraCurricularActivityId": 0,
      • "facebookUrl": "string",
      • "faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
      • "faRigorousHighSchoolProgramCodeId": 0,
      • "firstName": "string",
      • "genderId": 0,
      • "gpaCredits": 0,
      • "hispanicLatino": "string",
      • "hsAcademicGpa": 0,
      • "instagramUrl": "string",
      • "isActive": true,
      • "isAllowedBulkRegistrationByTrack": true,
      • "isBadAddress": true,
      • "isBadPhone": true,
      • "isDdVeteran": true,
      • "isEftDefaultForStipends": true,
      • "isInDistrict": true,
      • "isSscrError11Received": true,
      • "lastActivityDate": "2019-08-24T14:15:22Z",
      • "lastInterestDate": "2019-08-24T14:15:22Z",
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "lastName": "string",
      • "lastNameFirstFour": "string",
      • "lastStatementBeginDate": "2019-08-24T14:15:22Z",
      • "lastStatementCloseDate": "2019-08-24T14:15:22Z",
      • "lastStatementDate": "2019-08-24T14:15:22Z",
      • "leadDate": "2019-08-24T14:15:22Z",
      • "leadSourceId": 0,
      • "leadTypeId": 0,
      • "linkedInUrl": "string",
      • "maidenName": "string",
      • "maritalStatusId": 0,
      • "mi": "string",
      • "middleName": "string",
      • "mobilePhoneNumber": "string",
      • "nationalityId": 0,
      • "nickName": "string",
      • "niStudent": true,
      • "note": "string",
      • "originalAssignedAdmissionsRepId": 0,
      • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
      • "originalStartDate": "2019-08-24T14:15:22Z",
      • "otherEmailAddress": "string",
      • "otherPhoneNumber": "string",
      • "personId": 0,
      • "phoneNumber": "string",
      • "pin": 0,
      • "postalCode": "string",
      • "postalCodeFirstThree": "string",
      • "preferredContactType": "string",
      • "preferredName": "string",
      • "previousEducationGpa": 0,
      • "previousEducationId": 0,
      • "programGroupId": 0,
      • "programId": 0,
      • "rawFirstName": "string",
      • "rawLastName": "string",
      • "rawPhoneNumber": "string",
      • "rowVersion": "string",
      • "schoolStatusId": 0,
      • "shiftId": 0,
      • "smsServiceProviderId": 0,
      • "sourceSystem": "string",
      • "ssn": "string",
      • "startDate": "2019-08-24T14:15:22Z",
      • "state": "string",
      • "statementComment": "string",
      • "streetAddress": "string",
      • "streetAddress2": "string",
      • "studentFullName": "string",
      • "studentIdentifier": "string",
      • "studentNumber": "string",
      • "subscribeToSms": true,
      • "suffix": "string",
      • "suffixId": 0,
      • "titleId": 0,
      • "twitterUrl": "string",
      • "veteran": "string",
      • "workPhoneNumber": "string",
      • "workPhoneNumberExtension": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "programsOfInterest": [

      • {

        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimaryProgramOfInterest": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "programId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "syStudentInquiryId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "leadSources": [

      • {

        • "isExcludedCrmIntegration": true,
        • "id": 0,
        • "assignedAdmissionsRepId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimarySource": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "leadDate": "2019-08-24T14:15:22Z",
        • "leadSourceId": 0,
        • "prospectInquiryId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "vendors": [

          • {

            • "id": 0,
            • "createdDateTime": "2019-08-24T14:15:22Z",
            • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
            • "lastModifiedUserId": 0,
            • "prospectInquiryLeadSourceId": 0,
            • "rowVersion": "string",
            • "syOrganizationId": 0,
            • "originalState": "string",
            • "secureState": "string",
            • "extendedProperties": [

              • null

              ],
            • "entityState": 0

            }

          ],
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "comment": {

      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "note": "string",
      • "rowVersion": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save New Prospect Inquiry

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-prospectinquiry-savenew-request-payload)

newAssignedAdmissionsRepId number <int32> assignedAdmissionsRepReassignedDate string <date-time> id number <int32> Id admissionsRepTypeId number <int32> Admissions Rep Type Id assignedAdmissionsRepId number <int32> The Admissions Representative for the student. If a staff member is removed from an Admissions Representative group after having been assigned to a student, CampusNexus Student retains the name of the former representative on the student record. campusId number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. isCurrentInquiry boolean Specifies that the inquiry is the most current inquiry for the student. You can only have one current inquiry. To make an inquiry current, select the check box. CampusNexus Student automatically removes the check for the box last inquiry that was marked as current. The current inquiry is also displayed on the Student Profile. lastActivityDate string <date-time> The last date of a closed Task that is associated with the specific inquiry. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. leadDate string <date-time> The date that the prospective student contacted the institution. leadSourceId number <int32> The source of the prospect specified on the Student Profile or inquiry. The values are configured by your institution and they indicate how a student heard about your institution. If you are specifying the value, the program displays a dialog that you can use to select more than one prospect source, vendor, or sub vendors. leadTypeId number <int32> The type of prospect. The values are configured by your institution. originalAssignedAdmissionsRepId number <int32> The last and then first name of the admissions representative initially assigned to the student. programGroupId number <int32> The program group that the student is interested in. Program groups classify program versions that have some common characteristic and are configured by your institution. The interest determines that program related documents and required tests that are added to the student profile. programId number <int32> The programs that the student is interested in. If you are selecting the values, you can select more than one program. regionId number <int32> The admissions region. Region corresponds to Timezone in CampusNexus student. The field is only displayed if your institution has configured zone assignments. responseDate string <date-time> If your institution has configured one or more of the sources you selected for Prospect Source to capture advertising information, the date that the student responded to the advertising campaign. responsePhoneNumber string If your institution has configured one or more of the sources you selected for Prospect Source to capture advertising information, the phone number that the student used to respond to the advertising campaign. responseTime string <date-time> If your institution has configured one or more of the sources you selected for Prospect Source to capture advertising information, the time that the student responded to the advertising campaign. rowVersion string studentId number <int32> Student Id object (cmc-nexus-common-entities-studentEntity) Array of objects (cmc-nexus-admissions-entities-prospectInquiryProgramEntity) Array of objects (cmc-nexus-admissions-entities-prospectInquiryLeadSourceEntity) object (cmc-nexus-admissions-entities-prospectInquiryCommentEntity) originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/ProspectInquiry/saveNew

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "newAssignedAdmissionsRepId": 0,
  • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "admissionsRepTypeId": 0,
  • "assignedAdmissionsRepId": 0,
  • "campusId": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "isCurrentInquiry": true,
  • "lastActivityDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "leadDate": "2019-08-24T14:15:22Z",
  • "leadSourceId": 0,
  • "leadTypeId": 0,
  • "originalAssignedAdmissionsRepId": 0,
  • "programGroupId": 0,
  • "programId": 0,
  • "regionId": 0,
  • "responseDate": "2019-08-24T14:15:22Z",
  • "responsePhoneNumber": "string",
  • "responseTime": "2019-08-24T14:15:22Z",
  • "rowVersion": "string",
  • "studentId": 0,
  • "student": {

    • "isExcludedCrmIntegration": true,
    • "addressTypeId": 0,
    • "studentInquiryRequired": true,
    • "extraCurricularsList": [

      • 0

      ],
    • "programsList": [

      • 0

      ],
    • "enrolledProgramIdList": [

      • 0

      ],
    • "ethnicitiesList": [

      • 0

      ],
    • "leadSourcesList": [

      • 0

      ],
    • "deleteVeteranDetails": true,
    • "vendors": [

      • {

        • "syOrganizationId": 0,
        • "leadSourceId": 0

        }

      ],
    • "studentAddressAssociation": 0,
    • "newAssignedAdmissionsRepId": 0,
    • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
    • "studentRelationshipAddress": {

      • "isPermanentAddress": true,
      • "isDefaultAddress": true,
      • "isExcludedCrmIntegration": true,
      • "id": 0,
      • "addressBeginDate": "2019-08-24T14:15:22Z",
      • "addressEndDate": "2019-08-24T14:15:22Z",
      • "addressTypeId": 0,
      • "admissionsRegionId": 0,
      • "city": "string",
      • "countryId": 0,
      • "countryName": "string",
      • "countyId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "emailAddress": "string",
      • "employerName": "string",
      • "firstName": "string",
      • "isSeasonalAddress": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "lastName": "string",
      • "mobileNumber": "string",
      • "note": "string",
      • "otherEmailAddress": "string",
      • "otherPhone": "string",
      • "phoneNumber": "string",
      • "plusReferenceNumber": 0,
      • "postalCode": "string",
      • "printedOnMasterPromNote": "string",
      • "printedOnPlusPromNote": "string",
      • "referenceConfirmed": "string",
      • "referenceConfirmedDate": "2019-08-24T14:15:22Z",
      • "referenceNumber": 0,
      • "relationToStudent": "string",
      • "rowVersion": "string",
      • "secondPhoneNumber": "string",
      • "sourceSystem": "string",
      • "ssn": "string",
      • "state": "string",
      • "streetAddress": "string",
      • "streetAddress2": "string",
      • "studentEnrollmentPeriodId": 0,
      • "studentId": 0,
      • "titleId": 0,
      • "workPhoneNumber": "string",
      • "yearsAtAddress": 0,
      • "yearsKnownStudent": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "lastFourSsn": "string",
    • "customProperties": [

      • "string"

      ],
    • "multiValueCustomProperties": [

      • "string"

      ],
    • "originalCustomProperties": [

      • "string"

      ],
    • "originalMultiValueCustomProperties": [

      • "string"

      ],
    • "originalCustomPropertiesValues": "string",
    • "originalMultiValueCustomPropertiesValues": "string",
    • "genderPronounList": [

      • 0

      ],
    • "overridePrevEducAltPellValidation": true,
    • "id": 0,
    • "acgEligReasonCode": "string",
    • "agencyId": 0,
    • "alienNumber": "string",
    • "arAccountStatus": "string",
    • "arBalance": 0,
    • "arNextTransactionNumber": { },
    • "assignedAdmissionsRepId": 0,
    • "athleticIdentifier": "string",
    • "bestTimeToContact": "string",
    • "campusId": 0,
    • "citizenId": 0,
    • "city": "string",
    • "collegeId": 0,
    • "countryId": 0,
    • "countyId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "cumulativeGpa": 0,
    • "cumulativeGpaPoints": 0,
    • "currencyCodeId": 0,
    • "currentLda": "2019-08-24T14:15:22Z",
    • "dataBlockIndicator": true,
    • "dateOfBirth": "2019-08-24T14:15:22Z",
    • "dbiModifiedDate": "2019-08-24T14:15:22Z",
    • "defaultAddressCode": "string",
    • "defaultMasterStudentAddressId": 0,
    • "defaultStudentAddressId": 0,
    • "disabled": "string",
    • "driverLicenseNumber": "string",
    • "driverLicenseState": "string",
    • "emailAddress": "string",
    • "employabilityAboutInfo": "string",
    • "employerId": 0,
    • "employmentStatusId": 0,
    • "externalStudentIdentifier": "string",
    • "extraCurricularActivityId": 0,
    • "facebookUrl": "string",
    • "faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
    • "faRigorousHighSchoolProgramCodeId": 0,
    • "firstName": "string",
    • "genderId": 0,
    • "gpaCredits": 0,
    • "hispanicLatino": "string",
    • "hsAcademicGpa": 0,
    • "instagramUrl": "string",
    • "isActive": true,
    • "isAllowedBulkRegistrationByTrack": true,
    • "isBadAddress": true,
    • "isBadPhone": true,
    • "isDdVeteran": true,
    • "isEftDefaultForStipends": true,
    • "isInDistrict": true,
    • "isSscrError11Received": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastInterestDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "lastName": "string",
    • "lastNameFirstFour": "string",
    • "lastStatementBeginDate": "2019-08-24T14:15:22Z",
    • "lastStatementCloseDate": "2019-08-24T14:15:22Z",
    • "lastStatementDate": "2019-08-24T14:15:22Z",
    • "leadDate": "2019-08-24T14:15:22Z",
    • "leadSourceId": 0,
    • "leadTypeId": 0,
    • "linkedInUrl": "string",
    • "maidenName": "string",
    • "maritalStatusId": 0,
    • "mi": "string",
    • "middleName": "string",
    • "mobilePhoneNumber": "string",
    • "nationalityId": 0,
    • "nickName": "string",
    • "niStudent": true,
    • "note": "string",
    • "originalAssignedAdmissionsRepId": 0,
    • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
    • "originalStartDate": "2019-08-24T14:15:22Z",
    • "otherEmailAddress": "string",
    • "otherPhoneNumber": "string",
    • "personId": 0,
    • "phoneNumber": "string",
    • "pin": 0,
    • "postalCode": "string",
    • "postalCodeFirstThree": "string",
    • "preferredContactType": "string",
    • "preferredName": "string",
    • "previousEducationGpa": 0,
    • "previousEducationId": 0,
    • "programGroupId": 0,
    • "programId": 0,
    • "rawFirstName": "string",
    • "rawLastName": "string",
    • "rawPhoneNumber": "string",
    • "rowVersion": "string",
    • "schoolStatusId": 0,
    • "shiftId": 0,
    • "smsServiceProviderId": 0,
    • "sourceSystem": "string",
    • "ssn": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "state": "string",
    • "statementComment": "string",
    • "streetAddress": "string",
    • "streetAddress2": "string",
    • "studentFullName": "string",
    • "studentIdentifier": "string",
    • "studentNumber": "string",
    • "subscribeToSms": true,
    • "suffix": "string",
    • "suffixId": 0,
    • "titleId": 0,
    • "twitterUrl": "string",
    • "veteran": "string",
    • "workPhoneNumber": "string",
    • "workPhoneNumberExtension": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    },
  • "programsOfInterest": [

    • {

      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isPrimaryProgramOfInterest": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "programId": 0,
      • "rowVersion": "string",
      • "studentId": 0,
      • "syStudentInquiryId": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "leadSources": [

    • {

      • "isExcludedCrmIntegration": true,
      • "id": 0,
      • "assignedAdmissionsRepId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isPrimarySource": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "leadDate": "2019-08-24T14:15:22Z",
      • "leadSourceId": 0,
      • "prospectInquiryId": 0,
      • "rowVersion": "string",
      • "studentId": 0,
      • "vendors": [

        • {

          • "id": 0,
          • "createdDateTime": "2019-08-24T14:15:22Z",
          • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
          • "lastModifiedUserId": 0,
          • "prospectInquiryLeadSourceId": 0,
          • "rowVersion": "string",
          • "syOrganizationId": 0,
          • "originalState": "string",
          • "secureState": "string",
          • "extendedProperties": [

            • null

            ],
          • "entityState": 0

          }

        ],
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "comment": {

    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "note": "string",
    • "rowVersion": "string",
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    },
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "newAssignedAdmissionsRepId": 0,
    • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
    • "id": 0,
    • "admissionsRepTypeId": 0,
    • "assignedAdmissionsRepId": 0,
    • "campusId": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "isCurrentInquiry": true,
    • "lastActivityDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "leadDate": "2019-08-24T14:15:22Z",
    • "leadSourceId": 0,
    • "leadTypeId": 0,
    • "originalAssignedAdmissionsRepId": 0,
    • "programGroupId": 0,
    • "programId": 0,
    • "regionId": 0,
    • "responseDate": "2019-08-24T14:15:22Z",
    • "responsePhoneNumber": "string",
    • "responseTime": "2019-08-24T14:15:22Z",
    • "rowVersion": "string",
    • "studentId": 0,
    • "student": {

      • "isExcludedCrmIntegration": true,
      • "addressTypeId": 0,
      • "studentInquiryRequired": true,
      • "extraCurricularsList": [

        • 0

        ],
      • "programsList": [

        • 0

        ],
      • "enrolledProgramIdList": [

        • 0

        ],
      • "ethnicitiesList": [

        • 0

        ],
      • "leadSourcesList": [

        • 0

        ],
      • "deleteVeteranDetails": true,
      • "vendors": [

        • {

          • "syOrganizationId": 0,
          • "leadSourceId": 0

          }

        ],
      • "studentAddressAssociation": 0,
      • "newAssignedAdmissionsRepId": 0,
      • "assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
      • "studentRelationshipAddress": {

        • "isPermanentAddress": true,
        • "isDefaultAddress": true,
        • "isExcludedCrmIntegration": true,
        • "id": 0,
        • "addressBeginDate": "2019-08-24T14:15:22Z",
        • "addressEndDate": "2019-08-24T14:15:22Z",
        • "addressTypeId": 0,
        • "admissionsRegionId": 0,
        • "city": "string",
        • "countryId": 0,
        • "countryName": "string",
        • "countyId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "emailAddress": "string",
        • "employerName": "string",
        • "firstName": "string",
        • "isSeasonalAddress": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "lastName": "string",
        • "mobileNumber": "string",
        • "note": "string",
        • "otherEmailAddress": "string",
        • "otherPhone": "string",
        • "phoneNumber": "string",
        • "plusReferenceNumber": 0,
        • "postalCode": "string",
        • "printedOnMasterPromNote": "string",
        • "printedOnPlusPromNote": "string",
        • "referenceConfirmed": "string",
        • "referenceConfirmedDate": "2019-08-24T14:15:22Z",
        • "referenceNumber": 0,
        • "relationToStudent": "string",
        • "rowVersion": "string",
        • "secondPhoneNumber": "string",
        • "sourceSystem": "string",
        • "ssn": "string",
        • "state": "string",
        • "streetAddress": "string",
        • "streetAddress2": "string",
        • "studentEnrollmentPeriodId": 0,
        • "studentId": 0,
        • "titleId": 0,
        • "workPhoneNumber": "string",
        • "yearsAtAddress": 0,
        • "yearsKnownStudent": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        },
      • "lastFourSsn": "string",
      • "customProperties": [

        • "string"

        ],
      • "multiValueCustomProperties": [

        • "string"

        ],
      • "originalCustomProperties": [

        • "string"

        ],
      • "originalMultiValueCustomProperties": [

        • "string"

        ],
      • "originalCustomPropertiesValues": "string",
      • "originalMultiValueCustomPropertiesValues": "string",
      • "genderPronounList": [

        • 0

        ],
      • "overridePrevEducAltPellValidation": true,
      • "id": 0,
      • "acgEligReasonCode": "string",
      • "agencyId": 0,
      • "alienNumber": "string",
      • "arAccountStatus": "string",
      • "arBalance": 0,
      • "arNextTransactionNumber": { },
      • "assignedAdmissionsRepId": 0,
      • "athleticIdentifier": "string",
      • "bestTimeToContact": "string",
      • "campusId": 0,
      • "citizenId": 0,
      • "city": "string",
      • "collegeId": 0,
      • "countryId": 0,
      • "countyId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "cumulativeGpa": 0,
      • "cumulativeGpaPoints": 0,
      • "currencyCodeId": 0,
      • "currentLda": "2019-08-24T14:15:22Z",
      • "dataBlockIndicator": true,
      • "dateOfBirth": "2019-08-24T14:15:22Z",
      • "dbiModifiedDate": "2019-08-24T14:15:22Z",
      • "defaultAddressCode": "string",
      • "defaultMasterStudentAddressId": 0,
      • "defaultStudentAddressId": 0,
      • "disabled": "string",
      • "driverLicenseNumber": "string",
      • "driverLicenseState": "string",
      • "emailAddress": "string",
      • "employabilityAboutInfo": "string",
      • "employerId": 0,
      • "employmentStatusId": 0,
      • "externalStudentIdentifier": "string",
      • "extraCurricularActivityId": 0,
      • "facebookUrl": "string",
      • "faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
      • "faRigorousHighSchoolProgramCodeId": 0,
      • "firstName": "string",
      • "genderId": 0,
      • "gpaCredits": 0,
      • "hispanicLatino": "string",
      • "hsAcademicGpa": 0,
      • "instagramUrl": "string",
      • "isActive": true,
      • "isAllowedBulkRegistrationByTrack": true,
      • "isBadAddress": true,
      • "isBadPhone": true,
      • "isDdVeteran": true,
      • "isEftDefaultForStipends": true,
      • "isInDistrict": true,
      • "isSscrError11Received": true,
      • "lastActivityDate": "2019-08-24T14:15:22Z",
      • "lastInterestDate": "2019-08-24T14:15:22Z",
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "lastName": "string",
      • "lastNameFirstFour": "string",
      • "lastStatementBeginDate": "2019-08-24T14:15:22Z",
      • "lastStatementCloseDate": "2019-08-24T14:15:22Z",
      • "lastStatementDate": "2019-08-24T14:15:22Z",
      • "leadDate": "2019-08-24T14:15:22Z",
      • "leadSourceId": 0,
      • "leadTypeId": 0,
      • "linkedInUrl": "string",
      • "maidenName": "string",
      • "maritalStatusId": 0,
      • "mi": "string",
      • "middleName": "string",
      • "mobilePhoneNumber": "string",
      • "nationalityId": 0,
      • "nickName": "string",
      • "niStudent": true,
      • "note": "string",
      • "originalAssignedAdmissionsRepId": 0,
      • "originalExpectedStartDate": "2019-08-24T14:15:22Z",
      • "originalStartDate": "2019-08-24T14:15:22Z",
      • "otherEmailAddress": "string",
      • "otherPhoneNumber": "string",
      • "personId": 0,
      • "phoneNumber": "string",
      • "pin": 0,
      • "postalCode": "string",
      • "postalCodeFirstThree": "string",
      • "preferredContactType": "string",
      • "preferredName": "string",
      • "previousEducationGpa": 0,
      • "previousEducationId": 0,
      • "programGroupId": 0,
      • "programId": 0,
      • "rawFirstName": "string",
      • "rawLastName": "string",
      • "rawPhoneNumber": "string",
      • "rowVersion": "string",
      • "schoolStatusId": 0,
      • "shiftId": 0,
      • "smsServiceProviderId": 0,
      • "sourceSystem": "string",
      • "ssn": "string",
      • "startDate": "2019-08-24T14:15:22Z",
      • "state": "string",
      • "statementComment": "string",
      • "streetAddress": "string",
      • "streetAddress2": "string",
      • "studentFullName": "string",
      • "studentIdentifier": "string",
      • "studentNumber": "string",
      • "subscribeToSms": true,
      • "suffix": "string",
      • "suffixId": 0,
      • "titleId": 0,
      • "twitterUrl": "string",
      • "veteran": "string",
      • "workPhoneNumber": "string",
      • "workPhoneNumberExtension": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "programsOfInterest": [

      • {

        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimaryProgramOfInterest": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "programId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "syStudentInquiryId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "leadSources": [

      • {

        • "isExcludedCrmIntegration": true,
        • "id": 0,
        • "assignedAdmissionsRepId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimarySource": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "leadDate": "2019-08-24T14:15:22Z",
        • "leadSourceId": 0,
        • "prospectInquiryId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "vendors": [

          • {

            • "id": 0,
            • "createdDateTime": "2019-08-24T14:15:22Z",
            • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
            • "lastModifiedUserId": 0,
            • "prospectInquiryLeadSourceId": 0,
            • "rowVersion": "string",
            • "syOrganizationId": 0,
            • "originalState": "string",
            • "secureState": "string",
            • "extendedProperties": [

              • null

              ],
            • "entityState": 0

            }

          ],
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "comment": {

      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "note": "string",
      • "rowVersion": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

StudentPreviousEducation

Create Student Previous Education

Authorizations:

apikey

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/StudentPreviousEducation/create

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "highSchoolContacts": [

      • {

        • "id": 0,
        • "city": "string",
        • "company": "string",
        • "countryId": 0,
        • "countyId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "emailAddress": "string",
        • "extension": "string",
        • "faxNumber": "string",
        • "firstName": "string",
        • "identifierDetails": "string",
        • "isActive": true,
        • "isPrimaryContact": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "lastName": "string",
        • "note": "string",
        • "organizationContactTypeId": 0,
        • "otherExtension": "string",
        • "otherPhoneNumber": "string",
        • "personId": 0,
        • "phoneNumber": "string",
        • "postalCode": "string",
        • "rowVersion": "string",
        • "state": "string",
        • "streetAddress": "string",
        • "syOrganizationId": 0,
        • "title": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "studentHighSchoolContacts": [

      • {

        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimaryContact": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "syOrganizationContactId": 0,
        • "syOrganizationId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "isPellMsgDisplayed": true,
    • "isExcludedCrmIntegration": true,
    • "id": 0,
    • "atbAdmin": "string",
    • "atbCode": "string",
    • "atbDate": "2019-08-24T14:15:22Z",
    • "atbState": "string",
    • "atbTest": "string",
    • "clockHoursAttempted": 0,
    • "collegeId": 0,
    • "coursesTaken": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "creditHoursAttempted": 0,
    • "degreeId": 0,
    • "enrollmentDate": "2019-08-24T14:15:22Z",
    • "financialAidTranscriptRequestDate": "2019-08-24T14:15:22Z",
    • "gedAwardedDate": "2019-08-24T14:15:22Z",
    • "gpa": 0,
    • "gradeLevelId": 0,
    • "gradePoints": 0,
    • "graduationDate": "2019-08-24T14:15:22Z",
    • "graduationSession": "string",
    • "highSchoolId": 0,
    • "hsGradYear": "string",
    • "isGraduated": true,
    • "lastAttendedDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "major": "string",
    • "note": "string",
    • "otherCollege": "string",
    • "previousEducationId": 0,
    • "qualityPoints": 0,
    • "rowVersion": "string",
    • "schoolSize": 0,
    • "status": "string",
    • "studentId": 0,
    • "studentRank": 0,
    • "transcriptId": 0,
    • "transcriptRequestDate": "2019-08-24T14:15:22Z",
    • "transcriptType": { },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Delete Student Previous Education

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-studentpreviouseducation-delete-request-payload)

Array of objects (cmc-nexus-admissions-entities-syOrganizationContactEntity) Array of objects (cmc-nexus-admissions-entities-studentHighSchoolContactEntity) isPellMsgDisplayed boolean isExcludedCrmIntegration boolean id number <int32> Id atbAdmin string Whether the test was taken at a testing center or administered using another method. atbCode string The Ability to Benefit code required by Common Origination and Disbursement (COD). ATB codes 03 and 05 are no longer valid and are not available to select. They are displayed if they were specified prior to the changes in valid codes. If you have students with ATB codes of 03 or 05, you must change the code for their record to pass COD validation. atbDate string <date-time> The date the Ability to Benefit test was completed. atbState string Atb State atbTest string The name of the ability to benefit (ATB) test that was taken. clockHoursAttempted number <double> The total number of hours that the student attempted on the transcript from the previous institution. collegeId number <int32> The name of the institution. If you are specifying the value, it displays a dialog so that you can search for the institution. The list contains all of the colleges or high schools configured by your organization. coursesTaken number <int32> The total number of courses for the student on the transcript from the previous institution. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. creditHoursAttempted number <double> The total credits the student attempted on the transcript from the previous institution. degreeId number <int32> The academic degree available at the institution or taken by the student. If you are selecting a degree, the list displays the degrees configured by your institution. enrollmentDate string <date-time> The date that the student enrolled at the institution. financialAidTranscriptRequestDate string <date-time> Financial Aid Transcript Request Date gedAwardedDate string <date-time> The date that the General Educational Development (GED) was awarded to the student. gpa number <double> The grade point average (GPA) for the student. gradeLevelId number <int32> The grade level for the student. Grade levels are configured by your institution and do not have to correspond to the option on the FAFSA or Stafford Loan forms. For a student to qualify for a Graduate PLUS loan, the grade level must be configured with the Department of Education ID 7 (Graduate/Professional or beyond). gradePoints number <double> For an unweighted grade point average, the sum of the total quality points on the transcript for the student at the previous institution. graduationDate string <date-time> The date that student graduated from the program. graduationSession string The session in which the student graduated (such as spring or fall). highSchoolId number <int32> The name of the institution. If you are specifying the value, it displays a dialog so that you can search for the institution. The list contains all of the colleges or high schools configured by your organization. hsGradYear string The year that the student graduated. isGraduated boolean Specifies that the student graduated from the institution. If you are adding or editing a college, it is automatically selected when you specify a value for Graduation Date. lastAttendedDate string <date-time> The date the student last attended the institution. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. major string The major for the student. note string Area you can use to display or specify comments or additional information. otherCollege string If the student specified another college they attended when they filled out their application using the Portal, displays the name of the college. previousEducationId number <int32> The previous education level of the student. qualityPoints number <double> For a weighted grade point average, the sum of the total quality points on the transcript for the student at the previous institution. rowVersion string schoolSize number <int32> Total number of students in the graduating class for the student. status string The associated School Status on the student's enrollment. studentId number <int32> Student Id studentRank number <int32> The graduating rank of the student as the rank of the number of students. transcriptId number <int32> Transcript Id transcriptRequestDate string <date-time> Transcript Request Date transcriptType object The type of transcript for the student. The values are Unofficial, Partial, and Official/Final. originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/StudentPreviousEducation/delete

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "highSchoolContacts": [

    • {

      • "id": 0,
      • "city": "string",
      • "company": "string",
      • "countryId": 0,
      • "countyId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "emailAddress": "string",
      • "extension": "string",
      • "faxNumber": "string",
      • "firstName": "string",
      • "identifierDetails": "string",
      • "isActive": true,
      • "isPrimaryContact": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "lastName": "string",
      • "note": "string",
      • "organizationContactTypeId": 0,
      • "otherExtension": "string",
      • "otherPhoneNumber": "string",
      • "personId": 0,
      • "phoneNumber": "string",
      • "postalCode": "string",
      • "rowVersion": "string",
      • "state": "string",
      • "streetAddress": "string",
      • "syOrganizationId": 0,
      • "title": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "studentHighSchoolContacts": [

    • {

      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isPrimaryContact": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "rowVersion": "string",
      • "studentId": 0,
      • "syOrganizationContactId": 0,
      • "syOrganizationId": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "isPellMsgDisplayed": true,
  • "isExcludedCrmIntegration": true,
  • "id": 0,
  • "atbAdmin": "string",
  • "atbCode": "string",
  • "atbDate": "2019-08-24T14:15:22Z",
  • "atbState": "string",
  • "atbTest": "string",
  • "clockHoursAttempted": 0,
  • "collegeId": 0,
  • "coursesTaken": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "creditHoursAttempted": 0,
  • "degreeId": 0,
  • "enrollmentDate": "2019-08-24T14:15:22Z",
  • "financialAidTranscriptRequestDate": "2019-08-24T14:15:22Z",
  • "gedAwardedDate": "2019-08-24T14:15:22Z",
  • "gpa": 0,
  • "gradeLevelId": 0,
  • "gradePoints": 0,
  • "graduationDate": "2019-08-24T14:15:22Z",
  • "graduationSession": "string",
  • "highSchoolId": 0,
  • "hsGradYear": "string",
  • "isGraduated": true,
  • "lastAttendedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "major": "string",
  • "note": "string",
  • "otherCollege": "string",
  • "previousEducationId": 0,
  • "qualityPoints": 0,
  • "rowVersion": "string",
  • "schoolSize": 0,
  • "status": "string",
  • "studentId": 0,
  • "studentRank": 0,
  • "transcriptId": 0,
  • "transcriptRequestDate": "2019-08-24T14:15:22Z",
  • "transcriptType": { },
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "deleted": true

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Get Student Previous Education

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (admissions-studentpreviouseducation-get-request-payload)
id number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/StudentPreviousEducation/get

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "highSchoolContacts": [

      • {

        • "id": 0,
        • "city": "string",
        • "company": "string",
        • "countryId": 0,
        • "countyId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "emailAddress": "string",
        • "extension": "string",
        • "faxNumber": "string",
        • "firstName": "string",
        • "identifierDetails": "string",
        • "isActive": true,
        • "isPrimaryContact": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "lastName": "string",
        • "note": "string",
        • "organizationContactTypeId": 0,
        • "otherExtension": "string",
        • "otherPhoneNumber": "string",
        • "personId": 0,
        • "phoneNumber": "string",
        • "postalCode": "string",
        • "rowVersion": "string",
        • "state": "string",
        • "streetAddress": "string",
        • "syOrganizationId": 0,
        • "title": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "studentHighSchoolContacts": [

      • {

        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimaryContact": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "syOrganizationContactId": 0,
        • "syOrganizationId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "isPellMsgDisplayed": true,
    • "isExcludedCrmIntegration": true,
    • "id": 0,
    • "atbAdmin": "string",
    • "atbCode": "string",
    • "atbDate": "2019-08-24T14:15:22Z",
    • "atbState": "string",
    • "atbTest": "string",
    • "clockHoursAttempted": 0,
    • "collegeId": 0,
    • "coursesTaken": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "creditHoursAttempted": 0,
    • "degreeId": 0,
    • "enrollmentDate": "2019-08-24T14:15:22Z",
    • "financialAidTranscriptRequestDate": "2019-08-24T14:15:22Z",
    • "gedAwardedDate": "2019-08-24T14:15:22Z",
    • "gpa": 0,
    • "gradeLevelId": 0,
    • "gradePoints": 0,
    • "graduationDate": "2019-08-24T14:15:22Z",
    • "graduationSession": "string",
    • "highSchoolId": 0,
    • "hsGradYear": "string",
    • "isGraduated": true,
    • "lastAttendedDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "major": "string",
    • "note": "string",
    • "otherCollege": "string",
    • "previousEducationId": 0,
    • "qualityPoints": 0,
    • "rowVersion": "string",
    • "schoolSize": 0,
    • "status": "string",
    • "studentId": 0,
    • "studentRank": 0,
    • "transcriptId": 0,
    • "transcriptRequestDate": "2019-08-24T14:15:22Z",
    • "transcriptType": { },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save Student Previous Education

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-studentpreviouseducation-save-request-payload)

Array of objects (cmc-nexus-admissions-entities-syOrganizationContactEntity) Array of objects (cmc-nexus-admissions-entities-studentHighSchoolContactEntity) isPellMsgDisplayed boolean isExcludedCrmIntegration boolean id number <int32> Id atbAdmin string Whether the test was taken at a testing center or administered using another method. atbCode string The Ability to Benefit code required by Common Origination and Disbursement (COD). ATB codes 03 and 05 are no longer valid and are not available to select. They are displayed if they were specified prior to the changes in valid codes. If you have students with ATB codes of 03 or 05, you must change the code for their record to pass COD validation. atbDate string <date-time> The date the Ability to Benefit test was completed. atbState string Atb State atbTest string The name of the ability to benefit (ATB) test that was taken. clockHoursAttempted number <double> The total number of hours that the student attempted on the transcript from the previous institution. collegeId number <int32> The name of the institution. If you are specifying the value, it displays a dialog so that you can search for the institution. The list contains all of the colleges or high schools configured by your organization. coursesTaken number <int32> The total number of courses for the student on the transcript from the previous institution. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. creditHoursAttempted number <double> The total credits the student attempted on the transcript from the previous institution. degreeId number <int32> The academic degree available at the institution or taken by the student. If you are selecting a degree, the list displays the degrees configured by your institution. enrollmentDate string <date-time> The date that the student enrolled at the institution. financialAidTranscriptRequestDate string <date-time> Financial Aid Transcript Request Date gedAwardedDate string <date-time> The date that the General Educational Development (GED) was awarded to the student. gpa number <double> The grade point average (GPA) for the student. gradeLevelId number <int32> The grade level for the student. Grade levels are configured by your institution and do not have to correspond to the option on the FAFSA or Stafford Loan forms. For a student to qualify for a Graduate PLUS loan, the grade level must be configured with the Department of Education ID 7 (Graduate/Professional or beyond). gradePoints number <double> For an unweighted grade point average, the sum of the total quality points on the transcript for the student at the previous institution. graduationDate string <date-time> The date that student graduated from the program. graduationSession string The session in which the student graduated (such as spring or fall). highSchoolId number <int32> The name of the institution. If you are specifying the value, it displays a dialog so that you can search for the institution. The list contains all of the colleges or high schools configured by your organization. hsGradYear string The year that the student graduated. isGraduated boolean Specifies that the student graduated from the institution. If you are adding or editing a college, it is automatically selected when you specify a value for Graduation Date. lastAttendedDate string <date-time> The date the student last attended the institution. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. major string The major for the student. note string Area you can use to display or specify comments or additional information. otherCollege string If the student specified another college they attended when they filled out their application using the Portal, displays the name of the college. previousEducationId number <int32> The previous education level of the student. qualityPoints number <double> For a weighted grade point average, the sum of the total quality points on the transcript for the student at the previous institution. rowVersion string schoolSize number <int32> Total number of students in the graduating class for the student. status string The associated School Status on the student's enrollment. studentId number <int32> Student Id studentRank number <int32> The graduating rank of the student as the rank of the number of students. transcriptId number <int32> Transcript Id transcriptRequestDate string <date-time> Transcript Request Date transcriptType object The type of transcript for the student. The values are Unofficial, Partial, and Official/Final. originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/StudentPreviousEducation/save

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "highSchoolContacts": [

    • {

      • "id": 0,
      • "city": "string",
      • "company": "string",
      • "countryId": 0,
      • "countyId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "emailAddress": "string",
      • "extension": "string",
      • "faxNumber": "string",
      • "firstName": "string",
      • "identifierDetails": "string",
      • "isActive": true,
      • "isPrimaryContact": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "lastName": "string",
      • "note": "string",
      • "organizationContactTypeId": 0,
      • "otherExtension": "string",
      • "otherPhoneNumber": "string",
      • "personId": 0,
      • "phoneNumber": "string",
      • "postalCode": "string",
      • "rowVersion": "string",
      • "state": "string",
      • "streetAddress": "string",
      • "syOrganizationId": 0,
      • "title": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "studentHighSchoolContacts": [

    • {

      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isPrimaryContact": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "rowVersion": "string",
      • "studentId": 0,
      • "syOrganizationContactId": 0,
      • "syOrganizationId": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "isPellMsgDisplayed": true,
  • "isExcludedCrmIntegration": true,
  • "id": 0,
  • "atbAdmin": "string",
  • "atbCode": "string",
  • "atbDate": "2019-08-24T14:15:22Z",
  • "atbState": "string",
  • "atbTest": "string",
  • "clockHoursAttempted": 0,
  • "collegeId": 0,
  • "coursesTaken": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "creditHoursAttempted": 0,
  • "degreeId": 0,
  • "enrollmentDate": "2019-08-24T14:15:22Z",
  • "financialAidTranscriptRequestDate": "2019-08-24T14:15:22Z",
  • "gedAwardedDate": "2019-08-24T14:15:22Z",
  • "gpa": 0,
  • "gradeLevelId": 0,
  • "gradePoints": 0,
  • "graduationDate": "2019-08-24T14:15:22Z",
  • "graduationSession": "string",
  • "highSchoolId": 0,
  • "hsGradYear": "string",
  • "isGraduated": true,
  • "lastAttendedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "major": "string",
  • "note": "string",
  • "otherCollege": "string",
  • "previousEducationId": 0,
  • "qualityPoints": 0,
  • "rowVersion": "string",
  • "schoolSize": 0,
  • "status": "string",
  • "studentId": 0,
  • "studentRank": 0,
  • "transcriptId": 0,
  • "transcriptRequestDate": "2019-08-24T14:15:22Z",
  • "transcriptType": { },
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "highSchoolContacts": [

      • {

        • "id": 0,
        • "city": "string",
        • "company": "string",
        • "countryId": 0,
        • "countyId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "emailAddress": "string",
        • "extension": "string",
        • "faxNumber": "string",
        • "firstName": "string",
        • "identifierDetails": "string",
        • "isActive": true,
        • "isPrimaryContact": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "lastName": "string",
        • "note": "string",
        • "organizationContactTypeId": 0,
        • "otherExtension": "string",
        • "otherPhoneNumber": "string",
        • "personId": 0,
        • "phoneNumber": "string",
        • "postalCode": "string",
        • "rowVersion": "string",
        • "state": "string",
        • "streetAddress": "string",
        • "syOrganizationId": 0,
        • "title": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "studentHighSchoolContacts": [

      • {

        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimaryContact": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "syOrganizationContactId": 0,
        • "syOrganizationId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "isPellMsgDisplayed": true,
    • "isExcludedCrmIntegration": true,
    • "id": 0,
    • "atbAdmin": "string",
    • "atbCode": "string",
    • "atbDate": "2019-08-24T14:15:22Z",
    • "atbState": "string",
    • "atbTest": "string",
    • "clockHoursAttempted": 0,
    • "collegeId": 0,
    • "coursesTaken": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "creditHoursAttempted": 0,
    • "degreeId": 0,
    • "enrollmentDate": "2019-08-24T14:15:22Z",
    • "financialAidTranscriptRequestDate": "2019-08-24T14:15:22Z",
    • "gedAwardedDate": "2019-08-24T14:15:22Z",
    • "gpa": 0,
    • "gradeLevelId": 0,
    • "gradePoints": 0,
    • "graduationDate": "2019-08-24T14:15:22Z",
    • "graduationSession": "string",
    • "highSchoolId": 0,
    • "hsGradYear": "string",
    • "isGraduated": true,
    • "lastAttendedDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "major": "string",
    • "note": "string",
    • "otherCollege": "string",
    • "previousEducationId": 0,
    • "qualityPoints": 0,
    • "rowVersion": "string",
    • "schoolSize": 0,
    • "status": "string",
    • "studentId": 0,
    • "studentRank": 0,
    • "transcriptId": 0,
    • "transcriptRequestDate": "2019-08-24T14:15:22Z",
    • "transcriptType": { },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}

Save New Student Previous Education

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (admissions-studentpreviouseducation-savenew-request-payload)

Array of objects (cmc-nexus-admissions-entities-syOrganizationContactEntity) Array of objects (cmc-nexus-admissions-entities-studentHighSchoolContactEntity) isPellMsgDisplayed boolean isExcludedCrmIntegration boolean id number <int32> Id atbAdmin string Whether the test was taken at a testing center or administered using another method. atbCode string The Ability to Benefit code required by Common Origination and Disbursement (COD). ATB codes 03 and 05 are no longer valid and are not available to select. They are displayed if they were specified prior to the changes in valid codes. If you have students with ATB codes of 03 or 05, you must change the code for their record to pass COD validation. atbDate string <date-time> The date the Ability to Benefit test was completed. atbState string Atb State atbTest string The name of the ability to benefit (ATB) test that was taken. clockHoursAttempted number <double> The total number of hours that the student attempted on the transcript from the previous institution. collegeId number <int32> The name of the institution. If you are specifying the value, it displays a dialog so that you can search for the institution. The list contains all of the colleges or high schools configured by your organization. coursesTaken number <int32> The total number of courses for the student on the transcript from the previous institution. createdDateTime string <date-time> The date when the item or person was added or the status change was entered. creditHoursAttempted number <double> The total credits the student attempted on the transcript from the previous institution. degreeId number <int32> The academic degree available at the institution or taken by the student. If you are selecting a degree, the list displays the degrees configured by your institution. enrollmentDate string <date-time> The date that the student enrolled at the institution. financialAidTranscriptRequestDate string <date-time> Financial Aid Transcript Request Date gedAwardedDate string <date-time> The date that the General Educational Development (GED) was awarded to the student. gpa number <double> The grade point average (GPA) for the student. gradeLevelId number <int32> The grade level for the student. Grade levels are configured by your institution and do not have to correspond to the option on the FAFSA or Stafford Loan forms. For a student to qualify for a Graduate PLUS loan, the grade level must be configured with the Department of Education ID 7 (Graduate/Professional or beyond). gradePoints number <double> For an unweighted grade point average, the sum of the total quality points on the transcript for the student at the previous institution. graduationDate string <date-time> The date that student graduated from the program. graduationSession string The session in which the student graduated (such as spring or fall). highSchoolId number <int32> The name of the institution. If you are specifying the value, it displays a dialog so that you can search for the institution. The list contains all of the colleges or high schools configured by your organization. hsGradYear string The year that the student graduated. isGraduated boolean Specifies that the student graduated from the institution. If you are adding or editing a college, it is automatically selected when you specify a value for Graduation Date. lastAttendedDate string <date-time> The date the student last attended the institution. lastModifiedDateTime string <date-time> The date that the item was updated or changed. lastModifiedUserId number <int32> The last and then first name of the person that changed the item. major string The major for the student. note string Area you can use to display or specify comments or additional information. otherCollege string If the student specified another college they attended when they filled out their application using the Portal, displays the name of the college. previousEducationId number <int32> The previous education level of the student. qualityPoints number <double> For a weighted grade point average, the sum of the total quality points on the transcript for the student at the previous institution. rowVersion string schoolSize number <int32> Total number of students in the graduating class for the student. status string The associated School Status on the student's enrollment. studentId number <int32> Student Id studentRank number <int32> The graduating rank of the student as the rank of the number of students. transcriptId number <int32> Transcript Id transcriptRequestDate string <date-time> Transcript Request Date transcriptType object The type of transcript for the student. The values are Unofficial, Partial, and Official/Final. originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/Admissions/StudentPreviousEducation/saveNew

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "highSchoolContacts": [

    • {

      • "id": 0,
      • "city": "string",
      • "company": "string",
      • "countryId": 0,
      • "countyId": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "emailAddress": "string",
      • "extension": "string",
      • "faxNumber": "string",
      • "firstName": "string",
      • "identifierDetails": "string",
      • "isActive": true,
      • "isPrimaryContact": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "lastName": "string",
      • "note": "string",
      • "organizationContactTypeId": 0,
      • "otherExtension": "string",
      • "otherPhoneNumber": "string",
      • "personId": 0,
      • "phoneNumber": "string",
      • "postalCode": "string",
      • "rowVersion": "string",
      • "state": "string",
      • "streetAddress": "string",
      • "syOrganizationId": 0,
      • "title": "string",
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "studentHighSchoolContacts": [

    • {

      • "id": 0,
      • "createdDateTime": "2019-08-24T14:15:22Z",
      • "isPrimaryContact": true,
      • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
      • "lastModifiedUserId": 0,
      • "rowVersion": "string",
      • "studentId": 0,
      • "syOrganizationContactId": 0,
      • "syOrganizationId": 0,
      • "originalState": "string",
      • "secureState": "string",
      • "extendedProperties": [

        • null

        ],
      • "entityState": 0

      }

    ],
  • "isPellMsgDisplayed": true,
  • "isExcludedCrmIntegration": true,
  • "id": 0,
  • "atbAdmin": "string",
  • "atbCode": "string",
  • "atbDate": "2019-08-24T14:15:22Z",
  • "atbState": "string",
  • "atbTest": "string",
  • "clockHoursAttempted": 0,
  • "collegeId": 0,
  • "coursesTaken": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "creditHoursAttempted": 0,
  • "degreeId": 0,
  • "enrollmentDate": "2019-08-24T14:15:22Z",
  • "financialAidTranscriptRequestDate": "2019-08-24T14:15:22Z",
  • "gedAwardedDate": "2019-08-24T14:15:22Z",
  • "gpa": 0,
  • "gradeLevelId": 0,
  • "gradePoints": 0,
  • "graduationDate": "2019-08-24T14:15:22Z",
  • "graduationSession": "string",
  • "highSchoolId": 0,
  • "hsGradYear": "string",
  • "isGraduated": true,
  • "lastAttendedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "major": "string",
  • "note": "string",
  • "otherCollege": "string",
  • "previousEducationId": 0,
  • "qualityPoints": 0,
  • "rowVersion": "string",
  • "schoolSize": 0,
  • "status": "string",
  • "studentId": 0,
  • "studentRank": 0,
  • "transcriptId": 0,
  • "transcriptRequestDate": "2019-08-24T14:15:22Z",
  • "transcriptType": { },
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "highSchoolContacts": [

      • {

        • "id": 0,
        • "city": "string",
        • "company": "string",
        • "countryId": 0,
        • "countyId": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "emailAddress": "string",
        • "extension": "string",
        • "faxNumber": "string",
        • "firstName": "string",
        • "identifierDetails": "string",
        • "isActive": true,
        • "isPrimaryContact": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "lastName": "string",
        • "note": "string",
        • "organizationContactTypeId": 0,
        • "otherExtension": "string",
        • "otherPhoneNumber": "string",
        • "personId": 0,
        • "phoneNumber": "string",
        • "postalCode": "string",
        • "rowVersion": "string",
        • "state": "string",
        • "streetAddress": "string",
        • "syOrganizationId": 0,
        • "title": "string",
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "studentHighSchoolContacts": [

      • {

        • "id": 0,
        • "createdDateTime": "2019-08-24T14:15:22Z",
        • "isPrimaryContact": true,
        • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
        • "lastModifiedUserId": 0,
        • "rowVersion": "string",
        • "studentId": 0,
        • "syOrganizationContactId": 0,
        • "syOrganizationId": 0,
        • "originalState": "string",
        • "secureState": "string",
        • "extendedProperties": [

          • null

          ],
        • "entityState": 0

        }

      ],
    • "isPellMsgDisplayed": true,
    • "isExcludedCrmIntegration": true,
    • "id": 0,
    • "atbAdmin": "string",
    • "atbCode": "string",
    • "atbDate": "2019-08-24T14:15:22Z",
    • "atbState": "string",
    • "atbTest": "string",
    • "clockHoursAttempted": 0,
    • "collegeId": 0,
    • "coursesTaken": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "creditHoursAttempted": 0,
    • "degreeId": 0,
    • "enrollmentDate": "2019-08-24T14:15:22Z",
    • "financialAidTranscriptRequestDate": "2019-08-24T14:15:22Z",
    • "gedAwardedDate": "2019-08-24T14:15:22Z",
    • "gpa": 0,
    • "gradeLevelId": 0,
    • "gradePoints": 0,
    • "graduationDate": "2019-08-24T14:15:22Z",
    • "graduationSession": "string",
    • "highSchoolId": 0,
    • "hsGradYear": "string",
    • "isGraduated": true,
    • "lastAttendedDate": "2019-08-24T14:15:22Z",
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "major": "string",
    • "note": "string",
    • "otherCollege": "string",
    • "previousEducationId": 0,
    • "qualityPoints": 0,
    • "rowVersion": "string",
    • "schoolSize": 0,
    • "status": "string",
    • "studentId": 0,
    • "studentRank": 0,
    • "transcriptId": 0,
    • "transcriptRequestDate": "2019-08-24T14:15:22Z",
    • "transcriptType": { },
    • "originalState": "string",
    • "secureState": "string",
    • "extendedProperties": [

      • null

      ],
    • "entityState": 0

    }

  },
• "notifications": [

  • null

  ],
• "hasError": false,
• "hasFault": false,
• "hasWarning": false,
• "hasValidationError": false,
• "hasValidationWarning": false,
• "hasValidationInformation": false,
• "hasSecurityError": false

}