Career Services

• StudentPlacement
  • postChange Placement Status
  • postCreate Student Placement
  • postDelete Student Placement
  • postEmployer Job Record Update Audit Put
  • postGet Student Placement
  • postSave Student Placement
  • postSave New Student Placement
  • postSave Placement Site Defined Fields
  • postSave Student Placement
  • postSave Student Placement Delete Audit
  • postSave Student Salary Info
  • postSet Placement Rollback
  • postStudent Audit Placement
  • postValidate Custom Business Rules
  • postVerify Placement Student

API docs by Redocly

Career Services (1.0)

Download OpenAPI specification:Download

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

All API calls related to Career Services.

StudentPlacement

Change Placement Status

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (careerservices-studentplacement-changeplacementstatus-request-payload)
plStudentID number <int32> placementStatusID number <int32> userID string

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/changePlacementStatus

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "plStudentID": 0,
  • "placementStatusID": 0,
  • "userID": "string"

  }

}

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

}

Create Student Placement

Authorizations:

apikey

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/create

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "employerId": 0,
    • "employerJobId": 0,
    • "endDate": "2019-08-24T14:15:22Z",
    • "endTime": "string",
    • "fieldOfStudy": "string",
    • "fullJobTitle": "string",
    • "hasBenefits": true,
    • "howPlacedId": 0,
    • "isConverted": true,
    • "isCurrent": true,
    • "isFromInterview": true,
    • "isPlacementFee": true,
    • "jobCategoryId": 0,
    • "jobDescription": "string",
    • "jobSchedule": "string",
    • "jobSourceId": 0,
    • "jobStatus": "string",
    • "jobTitleId": 0,
    • "jobTypeId": 0,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "note": "string",
    • "placementDate": "2019-08-24T14:15:22Z",
    • "placementRepId": 0,
    • "rowVersion": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "startTime": "string",
    • "studentCourseId": 0,
    • "studentPlacementSummaryId": 0,
    • "supervisor": "string",
    • "supervisorPhoneNumber": "string",
    • "terminationDate": "2019-08-24T14:15:22Z",
    • "terminationReason": "string",
    • "verifiedPlacementRepId": 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 Student Placement

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (careerservices-studentplacement-delete-request-payload)

id number <int32> Id createdDateTime string <date-time> Created Date Time employerId number <int32> Employer Id employerJobId number <int32> Employer Job Id endDate string <date-time> End Date endTime string End Time fieldOfStudy string Field Of Study fullJobTitle string Full Job Title hasBenefits boolean Has Benefits howPlacedId number <int32> How Placed Id isConverted boolean Is Converted isCurrent boolean Is Current isFromInterview boolean Is From Interview isPlacementFee boolean Is Placement Fee jobCategoryId number <int32> Job Category Id jobDescription string Job Description jobSchedule string Job Schedule jobSourceId number <int32> Job Source Id jobStatus string Job Status jobTitleId number <int32> Job Title Id jobTypeId number <int32> Job Type Id lastModifiedDateTime string <date-time> Last Modified Date Time lastModifiedUserId number <int32> Last Modified User Id note string Note placementDate string <date-time> Placement Date placementRepId number <int32> Placement Rep Id rowVersion string startDate string <date-time> Start Date startTime string Start Time studentCourseId number <int32> Student Course Id studentPlacementSummaryId number <int32> Student Placement Summary Id supervisor string Supervisor supervisorPhoneNumber string Supervisor Phone Number terminationDate string <date-time> Termination Date terminationReason string Termination Reason verifiedPlacementRepId number <int32> Verified Placement Rep Id originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/delete

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "employerId": 0,
  • "employerJobId": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "string",
  • "fieldOfStudy": "string",
  • "fullJobTitle": "string",
  • "hasBenefits": true,
  • "howPlacedId": 0,
  • "isConverted": true,
  • "isCurrent": true,
  • "isFromInterview": true,
  • "isPlacementFee": true,
  • "jobCategoryId": 0,
  • "jobDescription": "string",
  • "jobSchedule": "string",
  • "jobSourceId": 0,
  • "jobStatus": "string",
  • "jobTitleId": 0,
  • "jobTypeId": 0,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "note": "string",
  • "placementDate": "2019-08-24T14:15:22Z",
  • "placementRepId": 0,
  • "rowVersion": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startTime": "string",
  • "studentCourseId": 0,
  • "studentPlacementSummaryId": 0,
  • "supervisor": "string",
  • "supervisorPhoneNumber": "string",
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "terminationReason": "string",
  • "verifiedPlacementRepId": 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

}

Employer Job Record Update Audit Put

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (careerservices-studentplacement-employerjobrecordupdateauditput-request-payload)
plEmployerId number <int32> plEmployerJobId number <int32> numberOpenings number <int32> sTAT string comments string userID number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/employerJobRecordUpdateAuditPut

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "plEmployerId": 0,
  • "plEmployerJobId": 0,
  • "numberOpenings": 0,
  • "sTAT": "string",
  • "comments": "string",
  • "userID": 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 Student Placement

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (careerservices-studentplacement-get-request-payload)
id number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/get

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "employerId": 0,
    • "employerJobId": 0,
    • "endDate": "2019-08-24T14:15:22Z",
    • "endTime": "string",
    • "fieldOfStudy": "string",
    • "fullJobTitle": "string",
    • "hasBenefits": true,
    • "howPlacedId": 0,
    • "isConverted": true,
    • "isCurrent": true,
    • "isFromInterview": true,
    • "isPlacementFee": true,
    • "jobCategoryId": 0,
    • "jobDescription": "string",
    • "jobSchedule": "string",
    • "jobSourceId": 0,
    • "jobStatus": "string",
    • "jobTitleId": 0,
    • "jobTypeId": 0,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "note": "string",
    • "placementDate": "2019-08-24T14:15:22Z",
    • "placementRepId": 0,
    • "rowVersion": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "startTime": "string",
    • "studentCourseId": 0,
    • "studentPlacementSummaryId": 0,
    • "supervisor": "string",
    • "supervisorPhoneNumber": "string",
    • "terminationDate": "2019-08-24T14:15:22Z",
    • "terminationReason": "string",
    • "verifiedPlacementRepId": 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 Student Placement

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (careerservices-studentplacement-save-request-payload)

id number <int32> Id createdDateTime string <date-time> Created Date Time employerId number <int32> Employer Id employerJobId number <int32> Employer Job Id endDate string <date-time> End Date endTime string End Time fieldOfStudy string Field Of Study fullJobTitle string Full Job Title hasBenefits boolean Has Benefits howPlacedId number <int32> How Placed Id isConverted boolean Is Converted isCurrent boolean Is Current isFromInterview boolean Is From Interview isPlacementFee boolean Is Placement Fee jobCategoryId number <int32> Job Category Id jobDescription string Job Description jobSchedule string Job Schedule jobSourceId number <int32> Job Source Id jobStatus string Job Status jobTitleId number <int32> Job Title Id jobTypeId number <int32> Job Type Id lastModifiedDateTime string <date-time> Last Modified Date Time lastModifiedUserId number <int32> Last Modified User Id note string Note placementDate string <date-time> Placement Date placementRepId number <int32> Placement Rep Id rowVersion string startDate string <date-time> Start Date startTime string Start Time studentCourseId number <int32> Student Course Id studentPlacementSummaryId number <int32> Student Placement Summary Id supervisor string Supervisor supervisorPhoneNumber string Supervisor Phone Number terminationDate string <date-time> Termination Date terminationReason string Termination Reason verifiedPlacementRepId number <int32> Verified Placement Rep Id originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/save

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "employerId": 0,
  • "employerJobId": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "string",
  • "fieldOfStudy": "string",
  • "fullJobTitle": "string",
  • "hasBenefits": true,
  • "howPlacedId": 0,
  • "isConverted": true,
  • "isCurrent": true,
  • "isFromInterview": true,
  • "isPlacementFee": true,
  • "jobCategoryId": 0,
  • "jobDescription": "string",
  • "jobSchedule": "string",
  • "jobSourceId": 0,
  • "jobStatus": "string",
  • "jobTitleId": 0,
  • "jobTypeId": 0,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "note": "string",
  • "placementDate": "2019-08-24T14:15:22Z",
  • "placementRepId": 0,
  • "rowVersion": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startTime": "string",
  • "studentCourseId": 0,
  • "studentPlacementSummaryId": 0,
  • "supervisor": "string",
  • "supervisorPhoneNumber": "string",
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "terminationReason": "string",
  • "verifiedPlacementRepId": 0,
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "employerId": 0,
    • "employerJobId": 0,
    • "endDate": "2019-08-24T14:15:22Z",
    • "endTime": "string",
    • "fieldOfStudy": "string",
    • "fullJobTitle": "string",
    • "hasBenefits": true,
    • "howPlacedId": 0,
    • "isConverted": true,
    • "isCurrent": true,
    • "isFromInterview": true,
    • "isPlacementFee": true,
    • "jobCategoryId": 0,
    • "jobDescription": "string",
    • "jobSchedule": "string",
    • "jobSourceId": 0,
    • "jobStatus": "string",
    • "jobTitleId": 0,
    • "jobTypeId": 0,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "note": "string",
    • "placementDate": "2019-08-24T14:15:22Z",
    • "placementRepId": 0,
    • "rowVersion": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "startTime": "string",
    • "studentCourseId": 0,
    • "studentPlacementSummaryId": 0,
    • "supervisor": "string",
    • "supervisorPhoneNumber": "string",
    • "terminationDate": "2019-08-24T14:15:22Z",
    • "terminationReason": "string",
    • "verifiedPlacementRepId": 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 Student Placement

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (careerservices-studentplacement-savenew-request-payload)

id number <int32> Id createdDateTime string <date-time> Created Date Time employerId number <int32> Employer Id employerJobId number <int32> Employer Job Id endDate string <date-time> End Date endTime string End Time fieldOfStudy string Field Of Study fullJobTitle string Full Job Title hasBenefits boolean Has Benefits howPlacedId number <int32> How Placed Id isConverted boolean Is Converted isCurrent boolean Is Current isFromInterview boolean Is From Interview isPlacementFee boolean Is Placement Fee jobCategoryId number <int32> Job Category Id jobDescription string Job Description jobSchedule string Job Schedule jobSourceId number <int32> Job Source Id jobStatus string Job Status jobTitleId number <int32> Job Title Id jobTypeId number <int32> Job Type Id lastModifiedDateTime string <date-time> Last Modified Date Time lastModifiedUserId number <int32> Last Modified User Id note string Note placementDate string <date-time> Placement Date placementRepId number <int32> Placement Rep Id rowVersion string startDate string <date-time> Start Date startTime string Start Time studentCourseId number <int32> Student Course Id studentPlacementSummaryId number <int32> Student Placement Summary Id supervisor string Supervisor supervisorPhoneNumber string Supervisor Phone Number terminationDate string <date-time> Termination Date terminationReason string Termination Reason verifiedPlacementRepId number <int32> Verified Placement Rep Id originalState string secureState string extendedProperties Array of any entityState number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/saveNew

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "id": 0,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "employerId": 0,
  • "employerJobId": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "string",
  • "fieldOfStudy": "string",
  • "fullJobTitle": "string",
  • "hasBenefits": true,
  • "howPlacedId": 0,
  • "isConverted": true,
  • "isCurrent": true,
  • "isFromInterview": true,
  • "isPlacementFee": true,
  • "jobCategoryId": 0,
  • "jobDescription": "string",
  • "jobSchedule": "string",
  • "jobSourceId": 0,
  • "jobStatus": "string",
  • "jobTitleId": 0,
  • "jobTypeId": 0,
  • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "lastModifiedUserId": 0,
  • "note": "string",
  • "placementDate": "2019-08-24T14:15:22Z",
  • "placementRepId": 0,
  • "rowVersion": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startTime": "string",
  • "studentCourseId": 0,
  • "studentPlacementSummaryId": 0,
  • "supervisor": "string",
  • "supervisorPhoneNumber": "string",
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "terminationReason": "string",
  • "verifiedPlacementRepId": 0,
  • "originalState": "string",
  • "secureState": "string",
  • "extendedProperties": [

    • null

    ],
  • "entityState": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 0,
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "employerId": 0,
    • "employerJobId": 0,
    • "endDate": "2019-08-24T14:15:22Z",
    • "endTime": "string",
    • "fieldOfStudy": "string",
    • "fullJobTitle": "string",
    • "hasBenefits": true,
    • "howPlacedId": 0,
    • "isConverted": true,
    • "isCurrent": true,
    • "isFromInterview": true,
    • "isPlacementFee": true,
    • "jobCategoryId": 0,
    • "jobDescription": "string",
    • "jobSchedule": "string",
    • "jobSourceId": 0,
    • "jobStatus": "string",
    • "jobTitleId": 0,
    • "jobTypeId": 0,
    • "lastModifiedDateTime": "2019-08-24T14:15:22Z",
    • "lastModifiedUserId": 0,
    • "note": "string",
    • "placementDate": "2019-08-24T14:15:22Z",
    • "placementRepId": 0,
    • "rowVersion": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "startTime": "string",
    • "studentCourseId": 0,
    • "studentPlacementSummaryId": 0,
    • "supervisor": "string",
    • "supervisorPhoneNumber": "string",
    • "terminationDate": "2019-08-24T14:15:22Z",
    • "terminationReason": "string",
    • "verifiedPlacementRepId": 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 Placement Site Defined Fields

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (careerservices-studentplacement-saveplacementsitedefinedfields-request-payload)
studentId number <int32> strXml string

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/savePlacementSiteDefinedFields

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "studentId": 0,
  • "strXml": "string"

  }

}

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

}

Save Student Placement

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (careerservices-studentplacement-savestudentplacement-request-payload)

placementID number <int32> descrip string plStudentID number <int32> employerID number <int32> jobID number <int32> plRepID number <int32> userID number <int32> supervisor string comment string howPlacedId number <int32> salaryType string salary number <double> inFieldOfStudy string fromInterview boolean benefits boolean fee boolean jobSchedule string current boolean schedFrom string schedTo string endDate string <date-time> jobTypeID number <int32> datePlaced string <date-time> startDate string <date-time> plJobTitleID number <int32> placementStatusID number <int32> plJobSourceID number <int32> supervisorPhone string enrollSchID number <int32> exactJobTitle string plJobCategoryID number <int32> termDate string <date-time> termReason string converted boolean status string oldPlacementID number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/saveStudentPlacement

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "placementID": 0,
  • "descrip": "string",
  • "plStudentID": 0,
  • "employerID": 0,
  • "jobID": 0,
  • "plRepID": 0,
  • "userID": 0,
  • "supervisor": "string",
  • "comment": "string",
  • "howPlacedId": 0,
  • "salaryType": "string",
  • "salary": 0,
  • "inFieldOfStudy": "string",
  • "fromInterview": true,
  • "benefits": true,
  • "fee": true,
  • "jobSchedule": "string",
  • "current": true,
  • "schedFrom": "string",
  • "schedTo": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "jobTypeID": 0,
  • "datePlaced": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "plJobTitleID": 0,
  • "placementStatusID": 0,
  • "plJobSourceID": 0,
  • "supervisorPhone": "string",
  • "enrollSchID": 0,
  • "exactJobTitle": "string",
  • "plJobCategoryID": 0,
  • "termDate": "2019-08-24T14:15:22Z",
  • "termReason": "string",
  • "converted": true,
  • "status": "string",
  • "oldPlacementID": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 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 Student Placement Delete Audit

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (careerservices-studentplacement-savestudentplacementdeleteaudit-request-payload)
plStudentID number <int32> plEmployerID number <int32> syStudentID number <int32> aDEnrollID number <int32> plJobTitleID number <int32> userID number <int32> comments string plStudentPlacementID number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/saveStudentPlacementDeleteAudit

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "plStudentID": 0,
  • "plEmployerID": 0,
  • "syStudentID": 0,
  • "aDEnrollID": 0,
  • "plJobTitleID": 0,
  • "userID": 0,
  • "comments": "string",
  • "plStudentPlacementID": 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

}

Save Student Salary Info

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (careerservices-studentplacement-savestudentsalaryinfo-request-payload)
placementID number <int32> salary number <double> salaryTypeCode string active number <int32> includeReport number <int32> effectiveDate string <date-time> type string userID number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/saveStudentSalaryInfo

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "placementID": 0,
  • "salary": 0,
  • "salaryTypeCode": "string",
  • "active": 0,
  • "includeReport": 0,
  • "effectiveDate": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "userID": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "id": 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

}

Set Placement Rollback

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (careerservices-studentplacement-setplacementrollback-request-payload)
placementID number <int32> descrip string

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/setPlacementRollback

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "placementID": 0,
  • "descrip": "string"

  }

}

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

}

Student Audit Placement

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (careerservices-studentplacement-studentauditplacement-request-payload)
strXML string

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/studentAuditPlacement

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "strXML": "string"

  }

}

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

}

Validate Custom Business Rules

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (careerservices-studentplacement-validatecustombusinessrules-request-payload)

formName string syCampusID number <int32> syStudentID number <int32> studentPlID number <int32> plStudentSalaryID number <int32> placementID number <int32> descrip string plStudentID number <int32> employerID number <int32> jobID number <int32> plRepID number <int32> userID number <int32> supervisor string comment string howPlacedId number <int32> salaryType string salary number <double> inFieldOfStudy string fromInterview boolean benefits boolean fee boolean jobSchedule string current boolean schedFrom string schedTo string endDate string <date-time> jobTypeID number <int32> datePlaced string <date-time> startDate string <date-time> plJobTitleID number <int32> placementStatusID number <int32> plJobSourceID number <int32> supervisorPhone string enrollSchID number <int32> exactJobTitle string plJobCategoryID number <int32> termDate string <date-time> termReason string converted boolean status string oldPlacementID number <int32>

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/validateCustomBusinessRules

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "formName": "string",
  • "syCampusID": 0,
  • "syStudentID": 0,
  • "studentPlID": 0,
  • "plStudentSalaryID": 0,
  • "placementID": 0,
  • "descrip": "string",
  • "plStudentID": 0,
  • "employerID": 0,
  • "jobID": 0,
  • "plRepID": 0,
  • "userID": 0,
  • "supervisor": "string",
  • "comment": "string",
  • "howPlacedId": 0,
  • "salaryType": "string",
  • "salary": 0,
  • "inFieldOfStudy": "string",
  • "fromInterview": true,
  • "benefits": true,
  • "fee": true,
  • "jobSchedule": "string",
  • "current": true,
  • "schedFrom": "string",
  • "schedTo": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "jobTypeID": 0,
  • "datePlaced": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "plJobTitleID": 0,
  • "placementStatusID": 0,
  • "plJobSourceID": 0,
  • "supervisorPhone": "string",
  • "enrollSchID": 0,
  • "exactJobTitle": "string",
  • "plJobCategoryID": 0,
  • "termDate": "2019-08-24T14:15:22Z",
  • "termReason": "string",
  • "converted": true,
  • "status": "string",
  • "oldPlacementID": 0

  }

}

Response samples

• 200

Content type

application/json

{

• "payload": {

  • "data": {

    • "showMessage": "string",
    • "stopSaveProcess": "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

}

Verify Placement Student

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

	object (careerservices-studentplacement-verifyplacementstudent-request-payload)
placementID number <int32> descrip string

Responses

https://localhost/Cmc.Nexus.Web/api/commands/CareerServices/StudentPlacement/verifyPlacementStudent

Request samples

• Payload

Content type

application/json

{

• "payload": {

  • "placementID": 0,
  • "descrip": "string"

  }

}

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

}