Skip to main content

Common

API docs by Redocly

Common (1.0)

Download OpenAPI specification:Download

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

All API calls related to Common.

Agency

Create Agency

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

payload
any (common-agency-create-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": null
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Agency

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-agency-delete-request-payload)
isExcludedCrmIntegration
boolean
id
number <int32>

Id

agencyTypeId
number <int32>

Agency Type Id

campusGroupId
number <int32>

Campus Group Id

code
string

Code

createdDateTime
string <date-time>

Created Date Time

fundSourceId
number <int32>

Fund Source Id

isActive
boolean

Is Active

isSystemCode
boolean

Is System Code

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

mainAgencyBranchId
number <int32>

Main Agency Branch Id

name
string

Name

rowVersion
string
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Agency

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-agency-get-request-payload)
agencyId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Agency

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-agency-save-request-payload)
object (cmc-nexus-common-entities-agencyEntity)
Array of objects (cmc-nexus-common-services-agencyTest)
Array of objects (cmc-nexus-common-services-agencyDocument)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Agency

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-agency-savenew-request-payload)
object (cmc-nexus-common-entities-agencyEntity)
Array of objects (cmc-nexus-common-services-agencyTest)
Array of objects (cmc-nexus-common-services-agencyDocument)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Cache

Clear

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-cache-clear-request-payload)
region
string
cacheKey
string
clearMetadataCache
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Remove

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-cache-remove-request-payload)
cacheKey
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

CampusGroup

Create Campus Group

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Campus Group

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusgroup-delete-request-payload)
id
number <int32>

Id

approverStaffId
number <int32>

Approver Staff Id

code
string

Code

createdDateTime
string <date-time>

Created Date Time

financialCampusGroup
boolean

Financial Campus Group

isActive
boolean

Is Active

isSystemCode
boolean

Is System Code

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

name
string

Name

rowVersion
string
saStmtComments
string

Sa Stmt Comments

saStmtLastCloseDate
string <date-time>

Sa Stmt Last Close Date

type
string

Type

Array of objects (cmc-nexus-common-entities-campusListEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Campus Group

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusgroup-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Campus Group

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusgroup-save-request-payload)
id
number <int32>

Id

approverStaffId
number <int32>

Approver Staff Id

code
string

Code

createdDateTime
string <date-time>

Created Date Time

financialCampusGroup
boolean

Financial Campus Group

isActive
boolean

Is Active

isSystemCode
boolean

Is System Code

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

name
string

Name

rowVersion
string
saStmtComments
string

Sa Stmt Comments

saStmtLastCloseDate
string <date-time>

Sa Stmt Last Close Date

type
string

Type

Array of objects (cmc-nexus-common-entities-campusListEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Campus Group

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusgroup-savenew-request-payload)
id
number <int32>

Id

approverStaffId
number <int32>

Approver Staff Id

code
string

Code

createdDateTime
string <date-time>

Created Date Time

financialCampusGroup
boolean

Financial Campus Group

isActive
boolean

Is Active

isSystemCode
boolean

Is System Code

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

name
string

Name

rowVersion
string
saStmtComments
string

Sa Stmt Comments

saStmtLastCloseDate
string <date-time>

Sa Stmt Last Close Date

type
string

Type

Array of objects (cmc-nexus-common-entities-campusListEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

CampusNexusStudentSetting

Create Campus Nexus Student Setting

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Campus Nexus Student Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusnexusstudentsetting-delete-request-payload)
settingId
number <int32>
id
number <int32>
settingName
string

Setting Name

createdDateTime
string <date-time>

Created Date Time

displayControlType
string

Display Control Type

displayOrder
number <int32>

Display Order

isDisplayedInWeb
boolean

Is Displayed In Web

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

longDisplayText
string

Long Display Text

maxLength
object

Max Length

rowVersion
string
settingValue
string

Setting Value

shortDisplayText
string

Short Display Text

validValues
string

Valid Values

webModule
string

Web Module

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusnexusstudentsetting-get-request-payload)
chars
object
length
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Sfaaa Settings

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusnexusstudentsetting-getsfaaasettings-request-payload)
campusId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Campus Nexus Student Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusnexusstudentsetting-save-request-payload)
settingId
number <int32>
id
number <int32>
settingName
string

Setting Name

createdDateTime
string <date-time>

Created Date Time

displayControlType
string

Display Control Type

displayOrder
number <int32>

Display Order

isDisplayedInWeb
boolean

Is Displayed In Web

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

longDisplayText
string

Long Display Text

maxLength
object

Max Length

rowVersion
string
settingValue
string

Setting Value

shortDisplayText
string

Short Display Text

validValues
string

Valid Values

webModule
string

Web Module

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Campus Nexus Student Settings

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusnexusstudentsetting-savecampusnexusstudentsettings-request-payload)
Array of objects (cmc-nexus-common-entities-campusNexusStudentSettingEntity)
isEnrollmentAdvisorRequiredSave
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Career Services Settings

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusnexusstudentsetting-savecareerservicessettings-request-payload)
newStudentPlacementSummaryRecordPlacementStatusId
number <int32>
placedPlacementStatusId
number <int32>
newInSchoolPlacementStatusId
number <int32>
inSchoolPlacedPlacementStatusId
number <int32>
employerCodeOption
number <int32>
employerCodeFormat
string
duplicateEmployerCheck
number <int32>
contactTypeAccessLimit
string
inFieldOfStudyValue
number <int32>
campusIdList
Array of numbers <int32> [ items <int32 > ]
Array of objects (cmc-nexus-common-services-staffEmployerAccessDetail)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Enrollment Required Fields

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusnexusstudentsetting-saveenrollmentrequiredfields-request-payload)
Array of objects (cmc-nexus-common-entities-staffGroupEntity)
Array of objects (cmc-nexus-common-entities-featureRequiredFieldEntity)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Lda Attendance Settings

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusnexusstudentsetting-saveldaattendancesettings-request-payload)
Array of objects (cmc-nexus-common-entities-staffGroupEntity)
Array of objects (cmc-nexus-common-entities-campusNexusStudentSettingEntity)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Campus Nexus Student Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusnexusstudentsetting-savenew-request-payload)
settingId
number <int32>
id
number <int32>
settingName
string

Setting Name

createdDateTime
string <date-time>

Created Date Time

displayControlType
string

Display Control Type

displayOrder
number <int32>

Display Order

isDisplayedInWeb
boolean

Is Displayed In Web

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

longDisplayText
string

Long Display Text

maxLength
object

Max Length

rowVersion
string
settingValue
string

Setting Value

shortDisplayText
string

Short Display Text

validValues
string

Valid Values

webModule
string

Web Module

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Custom String Resources

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusnexusstudentsetting-updatecustomstringresources-request-payload)
cultureKey
string
poFileContents
string <byte>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Fws Intergration

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-campusnexusstudentsetting-updatefwsintergration-request-payload)
isFwsIntergrationEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

DynamicForm

common-dynamicform-getdynamicform

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

PersonPicture

Create Person Picture

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Person Picture

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-personpicture-delete-request-payload)
id
number <int32>

Id

createdDateTime
string <date-time>

Created Date Time

isStudent
boolean

Is Student

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

pictureImage
string <byte>

Picture Image

rowVersion
string
staffId
number <int32>

Staff Id

studentId
number <int32>

Student Id

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Person Picture

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-personpicture-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Person Picture

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-personpicture-save-request-payload)
id
number <int32>

Id

createdDateTime
string <date-time>

Created Date Time

isStudent
boolean

Is Student

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

pictureImage
string <byte>

Picture Image

rowVersion
string
staffId
number <int32>

Staff Id

studentId
number <int32>

Student Id

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Person Picture

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-personpicture-savenew-request-payload)
id
number <int32>

Id

createdDateTime
string <date-time>

Created Date Time

isStudent
boolean

Is Student

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

pictureImage
string <byte>

Picture Image

rowVersion
string
staffId
number <int32>

Staff Id

studentId
number <int32>

Student Id

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Upload Staff Picture

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-personpicture-uploadstaffpicture-request-payload)
studentPictureId
number <int32>
staffPictureId
number <int32>
studentId
number <int32>
staffId
number <int32>
image
string <byte>
imageExtension
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Upload Student Picture

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-personpicture-uploadstudentpicture-request-payload)
studentPictureId
number <int32>
staffPictureId
number <int32>
studentId
number <int32>
staffId
number <int32>
image
string <byte>
imageExtension
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

SchoolStatus

Create School Status

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete School Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-schoolstatus-delete-request-payload)
isExcludedCrmIntegration
boolean
id
number <int32>

Id

campusGroupId
number <int32>

Campus Group Id

code
string

Code

createdDateTime
string <date-time>

Created Date Time

isActive
boolean

Is Active

isSystemCode
boolean

Is System Code

isTitleIvWithdrawal
boolean

Is Title Iv Withdrawal

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

name
string

Name

nsldsStatus
string

Nslds Status

rowVersion
string
statusDescription
string

Status Description

systemSchoolStatusId
number <int32>

System School Status Id

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get School Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-schoolstatus-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save School Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-schoolstatus-save-request-payload)
isExcludedCrmIntegration
boolean
id
number <int32>

Id

campusGroupId
number <int32>

Campus Group Id

code
string

Code

createdDateTime
string <date-time>

Created Date Time

isActive
boolean

Is Active

isSystemCode
boolean

Is System Code

isTitleIvWithdrawal
boolean

Is Title Iv Withdrawal

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

name
string

Name

nsldsStatus
string

Nslds Status

rowVersion
string
statusDescription
string

Status Description

systemSchoolStatusId
number <int32>

System School Status Id

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New School Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-schoolstatus-savenew-request-payload)
isExcludedCrmIntegration
boolean
id
number <int32>

Id

campusGroupId
number <int32>

Campus Group Id

code
string

Code

createdDateTime
string <date-time>

Created Date Time

isActive
boolean

Is Active

isSystemCode
boolean

Is System Code

isTitleIvWithdrawal
boolean

Is Title Iv Withdrawal

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

name
string

Name

nsldsStatus
string

Nslds Status

rowVersion
string
statusDescription
string

Status Description

systemSchoolStatusId
number <int32>

System School Status Id

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

SecurityContext

Get All

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-securitycontext-getall-request-payload)
ignored
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

SsrsReport

Export Report Data

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-ssrsreport-exportreportdata-request-payload)
reportPath
string
Array of objects (cmc-nexus-common-services-ssrsReportParameter)
downloadFileName
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Report Parameters

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-ssrsreport-getreportparameters-request-payload)
reportPath
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Reports

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

payload
any (common-ssrsreport-getreports-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": null
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Render Report

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-ssrsreport-renderreport-request-payload)
reportPath
string
Array of objects (cmc-nexus-common-services-ssrsReportParameter)
exportFormat
string
downloadFileName
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save As Student Group

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-ssrsreport-saveasstudentgroup-request-payload)
reportPath
string
Array of objects (cmc-nexus-common-services-ssrsReportParameter)
studentGroupId
number <int32>
studentGroupName
string
replaceAllStudents
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Validate Report Configuration

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

payload
any (common-ssrsreport-validatereportconfiguration-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": null
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Staff

Authenticate User Login

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-staff-authenticateuserlogin-request-payload)
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create Staff

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Staff

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-staff-delete-request-payload)
isExcludedCrmIntegration
boolean
isAllowedToViewSsnUi
boolean
staffGroupTemplateSettingId
number <int32>
Array of objects (cmc-nexus-common-entities-instructorAttributeMappingExtended)
staffType
number <int32>
id
number <int32>

Id

admissionsRepTypeId
number <int32>

Admissions Rep Type Id

campusGroupId
number <int32>

Campus Group Id

cellPhoneNumber
string

Cell Phone Number

certificationList
string

Certification List

city
string

City

code
string

Code

contactManagereStudentListInclude
string

Contact Managere Student List Include

contactManagerStudentListShow
string

Contact Manager Student List Show

countryId
number <int32>

Country Id

createdDateTime
string <date-time>

Created Date Time

defaultAwardYearId
string

Default Award Year Id

defaultModule
string

Default Module

defaultSyCampusId
number <int32>

Default Sy Campus Id

defaultTermId
number <int32>

Default Term Id

degree
string

Degree

department
string

Department

documentPolicyId
number <int32>

Document Policy Id

emailAddress
string

Email Address

emailReplyTo
string

Email Reply To

employeeNumber
string

Employee Number

employmentLegalEntityIdentifier
string

Employment Legal Entity Identifier

extension
string

Extension

firstName
string

First Name

hiredDate
string <date-time>

Hired Date

homePhoneNumber
string

Home Phone Number

isActive
boolean

Is Active

isAllowedAccessConnectedStudentEnrollmentPeriod
boolean

Is Allowed Access Connected Student Enrollment Period

isAllowedAccessMasterCourseProgramOverride
boolean

Is Allowed Access Master Course Program Override

isAllowedCommonlineHoldRelease
boolean

Is Allowed Commonline Hold Release

isAllowedContactManagerShowAllOption
boolean

Is Allowed Contact Manager Show All Option

isAllowedDateExclusion
boolean

Is Allowed Date Exclusion

isAllowedEditTaskTemplateSource
boolean

Is Allowed Edit Task Template Source

isAllowedEditTaxRatesPendingCharges
boolean

Is Allowed Edit Tax Rates Pending Charges

isAllowedFulfillmentDpa
boolean

Is Allowed Fulfillment Dpa

isAllowedMultipleCampusGroups
number <int32>

Is Allowed Multiple Campus Groups

isAllowedOverrideAuditDesignationDeadline
boolean

Is Allowed Override Audit Designation Deadline

isAllowedOverrideClosedTerm
boolean

Is Allowed Override Closed Term

isAllowedOverrideEnrollmentDates
boolean

Is Allowed Override Enrollment Dates

isAllowedOverrideMaxClass
boolean

Is Allowed Override Max Class

isAllowedReassignCourse
boolean

Is Allowed Reassign Course

isAllowedToAccessTransferCampus
boolean

Is Allowed To Access Transfer Campus

isAllowedToAccessTransferEnrollment
boolean

Is Allowed To Access Transfer Enrollment

isAllowedToAccessTransferEnrollmentAndCampus
boolean

Is Allowed To Access Transfer Enrollment And Campus

isAllowedToAddCollege
boolean

Is Allowed To Add College

isAllowedToAddCourse
boolean

Is Allowed To Add Course

isAllowedToAssignAdmissionsRepEnrollment
boolean

Is Allowed To Assign Admissions Rep Enrollment

isAllowedToAssignPreviousEducationEnrollment
boolean

Is Allowed To Assign Previous Education Enrollment

isAllowedToCancelClassSection
boolean

Is Allowed To Cancel Class Section

isAllowedToClearWaitlist
boolean

Is Allowed To Clear Waitlist

isAllowedToEditAdvisor
boolean

Is Allowed To Edit Advisor

isAllowedToEditDisbursementDates
boolean

Is Allowed To Edit Disbursement Dates

isAllowedToEditExceptionDetails
boolean

Is Allowed To Edit Exception Details

isAllowedToEditPaymentPeriods
boolean

Is Allowed To Edit Payment Periods

isAllowedToEditSystemDefinedBillingTransactionCode
boolean

Is Allowed To Edit System Defined Billing Transaction Code

isAllowedToModifyFeeSchedule
boolean

Is Allowed To Modify Fee Schedule

isAllowedToOverrideCodChangeStatus
boolean

Is Allowed To Override Cod Change Status

isAllowedToOverrideCourseContactHourComparison
boolean

Is Allowed To Override Course Contact Hour Comparison

isAllowedToOverrideCoursePreRequisites
boolean

Is Allowed To Override Course Pre Requisites

isAllowedToOverrideCutoffDate
boolean

Is Allowed To Override Cutoff Date

isAllowedToOverrideDisbursementBatch
boolean

Is Allowed To Override Disbursement Batch

isAllowedToOverrideFaHoldGroup
boolean

Is Allowed To Override Fa Hold Group

isAllowedToOverrideIncompleteGradeExpirationDate
boolean

Is Allowed To Override Incomplete Grade Expiration Date

isAllowedToOverrideInstructorCourseAssociation
boolean

Is Allowed To Override Instructor Course Association

isAllowedToOverrideLastDateToWithdraw
boolean

Is Allowed To Override Last Date To Withdraw

isAllowedToOverrideLockedTermSequence
boolean

Is Allowed To Override Locked Term Sequence

isAllowedToOverrideMaxClassUserCampuses
boolean

Is Allowed To Override Max Class User Campuses

isAllowedToOverrideMaxWaitList
boolean

Represents the is allow to override max wait list associated with this staff.

isAllowedToOverridePreCoRequisiteRequirement
boolean

Is Allowed To Override Pre Co Requisite Requirement

isAllowedToOverrideRegistrationGroup
boolean

Is Allowed To Override Registration Group

isAllowedToOverrideRegistrationHold
boolean

Is Allowed To Override Registration Hold

isAllowedToOverrideRegistrationLocks
boolean

Is Allowed To Override Registration Locks

isAllowedToOverrideSapDefinedDates
boolean

Is Allowed To Override Sap Defined Dates

isAllowedToOverrideSapPartialTerm
boolean

Is Allowed To Override Sap Partial Term

isAllowedToOverrideSapPpDefinedDates
boolean

Is Allowed To Override Sap Pp Defined Dates

isAllowedToOverrideSapStatus
boolean

Is Allowed To Override Sap Status

isAllowedToOverrideStatusChangeDays
boolean

Is Allowed To Override Status Change Days

isAllowedToOverrideTranscriptHoldGroup
boolean

Is Allowed To Override Transcript Hold Group

isAllowedToOverrideTransferCreditApproval
boolean

Is Allowed To Override Transfer Credit Approval

isAllowedToOverrideTransferOptions
boolean

Is Allowed To Override Transfer Options

isAllowedToPerformManualRefundCalculation
boolean

Is Allowed To Perform Manual Refund Calculation

isAllowedToPrintChecksEditComment
boolean

Is Allowed To Print Checks Edit Comment

isAllowedToReallocateCenter
boolean

Is Allowed To Reallocate Center

isAllowedToRebuildTermSummaryRelationships
boolean

Is Allowed To Rebuild Term Summary Relationships

isAllowedToViewSsnReports
boolean

Is Allowed To View Ssn Reports

isAllowedToWaiveDegreeProgressRequirement
boolean

Is Allowed To Waive Degree Progress Requirement

isAllowedToWaiveRetakeFee
boolean

Is Allowed To Waive Retake Fee

isAssociateEmployerOtherCampusAllowed
boolean

Is Associate Employer Other Campus Allowed

isAutoCmActivitiesAllowed
boolean

Is Auto Cm Activities Allowed

isAutomatedUser
boolean

Is Automated User

isAxFaculty
boolean

Is Ax Faculty

isBlockedViewSsnUi
boolean

Is Blocked View Ssn Ui

isCashier
boolean

Is Cashier

isConflictsChecked
boolean

Is Conflicts Checked

isContactManagerShownOnStartup
boolean

Is Contact Manager Shown On Startup

isCustomSearchAllowed
boolean

Is Custom Search Allowed

isDefaultReportWizardUsed
boolean

Is Default Report Wizard Used

isDeleteBilledChargesLeaseAllowed
boolean

Is Delete Billed Charges Lease Allowed

isDeleteUnbilledChargesLeaseAllowed
boolean

Is Delete Unbilled Charges Lease Allowed

isDropStatusMessageBox
boolean

Is Drop Status Message Box

isDuplicateEmpOverrideAllowed
boolean

Is Duplicate Emp Override Allowed

isFacultySynced
boolean

Is Faculty Synced

isGlobalSearchAllowed
boolean

Is Global Search Allowed

isHousingPeriodDateEditAllowed
boolean

Is Housing Period Date Edit Allowed

isJobTypeEditingSecurityAllowed
boolean

Is Job Type Editing Security Allowed

isLocked
boolean

Is Locked

isManualBillingNotAllowed
boolean

Is Manual Billing Not Allowed

isOverrideExecutiveReportOptionsAllowed
boolean

Is Override Executive Report Options Allowed

isOverrideLeaseDateAllowed
boolean

Is Override Lease Date Allowed

isOverrideRoomMaxCapacityAllowed
boolean

Is Override Room Max Capacity Allowed

isPrimaryContactSecurityAllowed
boolean

Is Primary Contact Security Allowed

isReportServerSelected
boolean

Is Report Server Selected

isStudentListSaved
boolean

Is Student List Saved

isSystem
boolean

Is System

isTest
boolean

Is Test

isToolbarUsed
boolean

Is Toolbar Used

isUserLevelOverrideAccessAllowed
boolean

Is User Level Override Access Allowed

isViewListBar
boolean

Is View List Bar

isViewToolBar
boolean

Is View Tool Bar

key
string

Key

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lastName
string

Last Name

mi
string

Mi

moduleId
number <int32>

Module Id

note
string

Note

number
number <int32>

Number

officePhoneNumber
string

Office Phone Number

password
string

Password

passwordExpirationDate
string <date-time>

Password Expiration Date

passwordRuleProfileId
number <int32>

Password Rule Profile Id

payRate
number <double>

Pay Rate

payType
string

Pay Type

personId
number <int32>

Person Id

phoneNumber
string

Phone Number

position
string

Position

postalCode
string

Postal Code

reportDefault
string

Report Default

reportsToStaffId
number <int32>

Reports To Staff Id

resume
string

Resume

rowVersion
string
salt
string

Salt

searchResults
string

Search Results

showDefaultOnStartup
boolean

Show Default On Startup

signature
string <byte>

Signature

ssn
string

Ssn

staffName
string

Staff Name

staffPicture
string <byte>

Staff Picture

state
string

State

streetAddress
string

Street Address

streetAddress2
string

Street Address2

suffix
string

Suffix

taskPolicyId
number <int32>

Task Policy Id

title
string

Title

workCity
string

Work City

workCountryId
number <int32>

Work Country Id

workFaxPhoneNumber
string

Work Fax Phone Number

workPostalCode
string

Work Postal Code

workState
string

Work State

workStreetAddress
string

Work Street Address

workStreetAddress2
string

Work Street Address2

object (cmc-nexus-common-entities-campusGroupEntity)
Array of objects (cmc-nexus-common-entities-staffGroupMemberEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Staff

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-staff-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Staff

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-staff-save-request-payload)
isExcludedCrmIntegration
boolean
isAllowedToViewSsnUi
boolean
staffGroupTemplateSettingId
number <int32>
Array of objects (cmc-nexus-common-entities-instructorAttributeMappingExtended)
staffType
number <int32>
id
number <int32>

Id

admissionsRepTypeId
number <int32>

Admissions Rep Type Id

campusGroupId
number <int32>

Campus Group Id

cellPhoneNumber
string

Cell Phone Number

certificationList
string

Certification List

city
string

City

code
string

Code

contactManagereStudentListInclude
string

Contact Managere Student List Include

contactManagerStudentListShow
string

Contact Manager Student List Show

countryId
number <int32>

Country Id

createdDateTime
string <date-time>

Created Date Time

defaultAwardYearId
string

Default Award Year Id

defaultModule
string

Default Module

defaultSyCampusId
number <int32>

Default Sy Campus Id

defaultTermId
number <int32>

Default Term Id

degree
string

Degree

department
string

Department

documentPolicyId
number <int32>

Document Policy Id

emailAddress
string

Email Address

emailReplyTo
string

Email Reply To

employeeNumber
string

Employee Number

employmentLegalEntityIdentifier
string

Employment Legal Entity Identifier

extension
string

Extension

firstName
string

First Name

hiredDate
string <date-time>

Hired Date

homePhoneNumber
string

Home Phone Number

isActive
boolean

Is Active

isAllowedAccessConnectedStudentEnrollmentPeriod
boolean

Is Allowed Access Connected Student Enrollment Period

isAllowedAccessMasterCourseProgramOverride
boolean

Is Allowed Access Master Course Program Override

isAllowedCommonlineHoldRelease
boolean

Is Allowed Commonline Hold Release

isAllowedContactManagerShowAllOption
boolean

Is Allowed Contact Manager Show All Option

isAllowedDateExclusion
boolean

Is Allowed Date Exclusion

isAllowedEditTaskTemplateSource
boolean

Is Allowed Edit Task Template Source

isAllowedEditTaxRatesPendingCharges
boolean

Is Allowed Edit Tax Rates Pending Charges

isAllowedFulfillmentDpa
boolean

Is Allowed Fulfillment Dpa

isAllowedMultipleCampusGroups
number <int32>

Is Allowed Multiple Campus Groups

isAllowedOverrideAuditDesignationDeadline
boolean

Is Allowed Override Audit Designation Deadline

isAllowedOverrideClosedTerm
boolean

Is Allowed Override Closed Term

isAllowedOverrideEnrollmentDates
boolean

Is Allowed Override Enrollment Dates

isAllowedOverrideMaxClass
boolean

Is Allowed Override Max Class

isAllowedReassignCourse
boolean

Is Allowed Reassign Course

isAllowedToAccessTransferCampus
boolean

Is Allowed To Access Transfer Campus

isAllowedToAccessTransferEnrollment
boolean

Is Allowed To Access Transfer Enrollment

isAllowedToAccessTransferEnrollmentAndCampus
boolean

Is Allowed To Access Transfer Enrollment And Campus

isAllowedToAddCollege
boolean

Is Allowed To Add College

isAllowedToAddCourse
boolean

Is Allowed To Add Course

isAllowedToAssignAdmissionsRepEnrollment
boolean

Is Allowed To Assign Admissions Rep Enrollment

isAllowedToAssignPreviousEducationEnrollment
boolean

Is Allowed To Assign Previous Education Enrollment

isAllowedToCancelClassSection
boolean

Is Allowed To Cancel Class Section

isAllowedToClearWaitlist
boolean

Is Allowed To Clear Waitlist

isAllowedToEditAdvisor
boolean

Is Allowed To Edit Advisor

isAllowedToEditDisbursementDates
boolean

Is Allowed To Edit Disbursement Dates

isAllowedToEditExceptionDetails
boolean

Is Allowed To Edit Exception Details

isAllowedToEditPaymentPeriods
boolean

Is Allowed To Edit Payment Periods

isAllowedToEditSystemDefinedBillingTransactionCode
boolean

Is Allowed To Edit System Defined Billing Transaction Code

isAllowedToModifyFeeSchedule
boolean

Is Allowed To Modify Fee Schedule

isAllowedToOverrideCodChangeStatus
boolean

Is Allowed To Override Cod Change Status

isAllowedToOverrideCourseContactHourComparison
boolean

Is Allowed To Override Course Contact Hour Comparison

isAllowedToOverrideCoursePreRequisites
boolean

Is Allowed To Override Course Pre Requisites

isAllowedToOverrideCutoffDate
boolean

Is Allowed To Override Cutoff Date

isAllowedToOverrideDisbursementBatch
boolean

Is Allowed To Override Disbursement Batch

isAllowedToOverrideFaHoldGroup
boolean

Is Allowed To Override Fa Hold Group

isAllowedToOverrideIncompleteGradeExpirationDate
boolean

Is Allowed To Override Incomplete Grade Expiration Date

isAllowedToOverrideInstructorCourseAssociation
boolean

Is Allowed To Override Instructor Course Association

isAllowedToOverrideLastDateToWithdraw
boolean

Is Allowed To Override Last Date To Withdraw

isAllowedToOverrideLockedTermSequence
boolean

Is Allowed To Override Locked Term Sequence

isAllowedToOverrideMaxClassUserCampuses
boolean

Is Allowed To Override Max Class User Campuses

isAllowedToOverrideMaxWaitList
boolean

Represents the is allow to override max wait list associated with this staff.

isAllowedToOverridePreCoRequisiteRequirement
boolean

Is Allowed To Override Pre Co Requisite Requirement

isAllowedToOverrideRegistrationGroup
boolean

Is Allowed To Override Registration Group

isAllowedToOverrideRegistrationHold
boolean

Is Allowed To Override Registration Hold

isAllowedToOverrideRegistrationLocks
boolean

Is Allowed To Override Registration Locks

isAllowedToOverrideSapDefinedDates
boolean

Is Allowed To Override Sap Defined Dates

isAllowedToOverrideSapPartialTerm
boolean

Is Allowed To Override Sap Partial Term

isAllowedToOverrideSapPpDefinedDates
boolean

Is Allowed To Override Sap Pp Defined Dates

isAllowedToOverrideSapStatus
boolean

Is Allowed To Override Sap Status

isAllowedToOverrideStatusChangeDays
boolean

Is Allowed To Override Status Change Days

isAllowedToOverrideTranscriptHoldGroup
boolean

Is Allowed To Override Transcript Hold Group

isAllowedToOverrideTransferCreditApproval
boolean

Is Allowed To Override Transfer Credit Approval

isAllowedToOverrideTransferOptions
boolean

Is Allowed To Override Transfer Options

isAllowedToPerformManualRefundCalculation
boolean

Is Allowed To Perform Manual Refund Calculation

isAllowedToPrintChecksEditComment
boolean

Is Allowed To Print Checks Edit Comment

isAllowedToReallocateCenter
boolean

Is Allowed To Reallocate Center

isAllowedToRebuildTermSummaryRelationships
boolean

Is Allowed To Rebuild Term Summary Relationships

isAllowedToViewSsnReports
boolean

Is Allowed To View Ssn Reports

isAllowedToWaiveDegreeProgressRequirement
boolean

Is Allowed To Waive Degree Progress Requirement

isAllowedToWaiveRetakeFee
boolean

Is Allowed To Waive Retake Fee

isAssociateEmployerOtherCampusAllowed
boolean

Is Associate Employer Other Campus Allowed

isAutoCmActivitiesAllowed
boolean

Is Auto Cm Activities Allowed

isAutomatedUser
boolean

Is Automated User

isAxFaculty
boolean

Is Ax Faculty

isBlockedViewSsnUi
boolean

Is Blocked View Ssn Ui

isCashier
boolean

Is Cashier

isConflictsChecked
boolean

Is Conflicts Checked

isContactManagerShownOnStartup
boolean

Is Contact Manager Shown On Startup

isCustomSearchAllowed
boolean

Is Custom Search Allowed

isDefaultReportWizardUsed
boolean

Is Default Report Wizard Used

isDeleteBilledChargesLeaseAllowed
boolean

Is Delete Billed Charges Lease Allowed

isDeleteUnbilledChargesLeaseAllowed
boolean

Is Delete Unbilled Charges Lease Allowed

isDropStatusMessageBox
boolean

Is Drop Status Message Box

isDuplicateEmpOverrideAllowed
boolean

Is Duplicate Emp Override Allowed

isFacultySynced
boolean

Is Faculty Synced

isGlobalSearchAllowed
boolean

Is Global Search Allowed

isHousingPeriodDateEditAllowed
boolean

Is Housing Period Date Edit Allowed

isJobTypeEditingSecurityAllowed
boolean

Is Job Type Editing Security Allowed

isLocked
boolean

Is Locked

isManualBillingNotAllowed
boolean

Is Manual Billing Not Allowed

isOverrideExecutiveReportOptionsAllowed
boolean

Is Override Executive Report Options Allowed

isOverrideLeaseDateAllowed
boolean

Is Override Lease Date Allowed

isOverrideRoomMaxCapacityAllowed
boolean

Is Override Room Max Capacity Allowed

isPrimaryContactSecurityAllowed
boolean

Is Primary Contact Security Allowed

isReportServerSelected
boolean

Is Report Server Selected

isStudentListSaved
boolean

Is Student List Saved

isSystem
boolean

Is System

isTest
boolean

Is Test

isToolbarUsed
boolean

Is Toolbar Used

isUserLevelOverrideAccessAllowed
boolean

Is User Level Override Access Allowed

isViewListBar
boolean

Is View List Bar

isViewToolBar
boolean

Is View Tool Bar

key
string

Key

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lastName
string

Last Name

mi
string

Mi

moduleId
number <int32>

Module Id

note
string

Note

number
number <int32>

Number

officePhoneNumber
string

Office Phone Number

password
string

Password

passwordExpirationDate
string <date-time>

Password Expiration Date

passwordRuleProfileId
number <int32>

Password Rule Profile Id

payRate
number <double>

Pay Rate

payType
string

Pay Type

personId
number <int32>

Person Id

phoneNumber
string

Phone Number

position
string

Position

postalCode
string

Postal Code

reportDefault
string

Report Default

reportsToStaffId
number <int32>

Reports To Staff Id

resume
string

Resume

rowVersion
string
salt
string

Salt

searchResults
string

Search Results

showDefaultOnStartup
boolean

Show Default On Startup

signature
string <byte>

Signature

ssn
string

Ssn

staffName
string

Staff Name

staffPicture
string <byte>

Staff Picture

state
string

State

streetAddress
string

Street Address

streetAddress2
string

Street Address2

suffix
string

Suffix

taskPolicyId
number <int32>

Task Policy Id

title
string

Title

workCity
string

Work City

workCountryId
number <int32>

Work Country Id

workFaxPhoneNumber
string

Work Fax Phone Number

workPostalCode
string

Work Postal Code

workState
string

Work State

workStreetAddress
string

Work Street Address

workStreetAddress2
string

Work Street Address2

object (cmc-nexus-common-entities-campusGroupEntity)
Array of objects (cmc-nexus-common-entities-staffGroupMemberEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Staff

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-staff-savenew-request-payload)
isExcludedCrmIntegration
boolean
isAllowedToViewSsnUi
boolean
staffGroupTemplateSettingId
number <int32>
Array of objects (cmc-nexus-common-entities-instructorAttributeMappingExtended)
staffType
number <int32>
id
number <int32>

Id

admissionsRepTypeId
number <int32>

Admissions Rep Type Id

campusGroupId
number <int32>

Campus Group Id

cellPhoneNumber
string

Cell Phone Number

certificationList
string

Certification List

city
string

City

code
string

Code

contactManagereStudentListInclude
string

Contact Managere Student List Include

contactManagerStudentListShow
string

Contact Manager Student List Show

countryId
number <int32>

Country Id

createdDateTime
string <date-time>

Created Date Time

defaultAwardYearId
string

Default Award Year Id

defaultModule
string

Default Module

defaultSyCampusId
number <int32>

Default Sy Campus Id

defaultTermId
number <int32>

Default Term Id

degree
string

Degree

department
string

Department

documentPolicyId
number <int32>

Document Policy Id

emailAddress
string

Email Address

emailReplyTo
string

Email Reply To

employeeNumber
string

Employee Number

employmentLegalEntityIdentifier
string

Employment Legal Entity Identifier

extension
string

Extension

firstName
string

First Name

hiredDate
string <date-time>

Hired Date

homePhoneNumber
string

Home Phone Number

isActive
boolean

Is Active

isAllowedAccessConnectedStudentEnrollmentPeriod
boolean

Is Allowed Access Connected Student Enrollment Period

isAllowedAccessMasterCourseProgramOverride
boolean

Is Allowed Access Master Course Program Override

isAllowedCommonlineHoldRelease
boolean

Is Allowed Commonline Hold Release

isAllowedContactManagerShowAllOption
boolean

Is Allowed Contact Manager Show All Option

isAllowedDateExclusion
boolean

Is Allowed Date Exclusion

isAllowedEditTaskTemplateSource
boolean

Is Allowed Edit Task Template Source

isAllowedEditTaxRatesPendingCharges
boolean

Is Allowed Edit Tax Rates Pending Charges

isAllowedFulfillmentDpa
boolean

Is Allowed Fulfillment Dpa

isAllowedMultipleCampusGroups
number <int32>

Is Allowed Multiple Campus Groups

isAllowedOverrideAuditDesignationDeadline
boolean

Is Allowed Override Audit Designation Deadline

isAllowedOverrideClosedTerm
boolean

Is Allowed Override Closed Term

isAllowedOverrideEnrollmentDates
boolean

Is Allowed Override Enrollment Dates

isAllowedOverrideMaxClass
boolean

Is Allowed Override Max Class

isAllowedReassignCourse
boolean

Is Allowed Reassign Course

isAllowedToAccessTransferCampus
boolean

Is Allowed To Access Transfer Campus

isAllowedToAccessTransferEnrollment
boolean

Is Allowed To Access Transfer Enrollment

isAllowedToAccessTransferEnrollmentAndCampus
boolean

Is Allowed To Access Transfer Enrollment And Campus

isAllowedToAddCollege
boolean

Is Allowed To Add College

isAllowedToAddCourse
boolean

Is Allowed To Add Course

isAllowedToAssignAdmissionsRepEnrollment
boolean

Is Allowed To Assign Admissions Rep Enrollment

isAllowedToAssignPreviousEducationEnrollment
boolean

Is Allowed To Assign Previous Education Enrollment

isAllowedToCancelClassSection
boolean

Is Allowed To Cancel Class Section

isAllowedToClearWaitlist
boolean

Is Allowed To Clear Waitlist

isAllowedToEditAdvisor
boolean

Is Allowed To Edit Advisor

isAllowedToEditDisbursementDates
boolean

Is Allowed To Edit Disbursement Dates

isAllowedToEditExceptionDetails
boolean

Is Allowed To Edit Exception Details

isAllowedToEditPaymentPeriods
boolean

Is Allowed To Edit Payment Periods

isAllowedToEditSystemDefinedBillingTransactionCode
boolean

Is Allowed To Edit System Defined Billing Transaction Code

isAllowedToModifyFeeSchedule
boolean

Is Allowed To Modify Fee Schedule

isAllowedToOverrideCodChangeStatus
boolean

Is Allowed To Override Cod Change Status

isAllowedToOverrideCourseContactHourComparison
boolean

Is Allowed To Override Course Contact Hour Comparison

isAllowedToOverrideCoursePreRequisites
boolean

Is Allowed To Override Course Pre Requisites

isAllowedToOverrideCutoffDate
boolean

Is Allowed To Override Cutoff Date

isAllowedToOverrideDisbursementBatch
boolean

Is Allowed To Override Disbursement Batch

isAllowedToOverrideFaHoldGroup
boolean

Is Allowed To Override Fa Hold Group

isAllowedToOverrideIncompleteGradeExpirationDate
boolean

Is Allowed To Override Incomplete Grade Expiration Date

isAllowedToOverrideInstructorCourseAssociation
boolean

Is Allowed To Override Instructor Course Association

isAllowedToOverrideLastDateToWithdraw
boolean

Is Allowed To Override Last Date To Withdraw

isAllowedToOverrideLockedTermSequence
boolean

Is Allowed To Override Locked Term Sequence

isAllowedToOverrideMaxClassUserCampuses
boolean

Is Allowed To Override Max Class User Campuses

isAllowedToOverrideMaxWaitList
boolean

Represents the is allow to override max wait list associated with this staff.

isAllowedToOverridePreCoRequisiteRequirement
boolean

Is Allowed To Override Pre Co Requisite Requirement

isAllowedToOverrideRegistrationGroup
boolean

Is Allowed To Override Registration Group

isAllowedToOverrideRegistrationHold
boolean

Is Allowed To Override Registration Hold

isAllowedToOverrideRegistrationLocks
boolean

Is Allowed To Override Registration Locks

isAllowedToOverrideSapDefinedDates
boolean

Is Allowed To Override Sap Defined Dates

isAllowedToOverrideSapPartialTerm
boolean

Is Allowed To Override Sap Partial Term

isAllowedToOverrideSapPpDefinedDates
boolean

Is Allowed To Override Sap Pp Defined Dates

isAllowedToOverrideSapStatus
boolean

Is Allowed To Override Sap Status

isAllowedToOverrideStatusChangeDays
boolean

Is Allowed To Override Status Change Days

isAllowedToOverrideTranscriptHoldGroup
boolean

Is Allowed To Override Transcript Hold Group

isAllowedToOverrideTransferCreditApproval
boolean

Is Allowed To Override Transfer Credit Approval

isAllowedToOverrideTransferOptions
boolean

Is Allowed To Override Transfer Options

isAllowedToPerformManualRefundCalculation
boolean

Is Allowed To Perform Manual Refund Calculation

isAllowedToPrintChecksEditComment
boolean

Is Allowed To Print Checks Edit Comment

isAllowedToReallocateCenter
boolean

Is Allowed To Reallocate Center

isAllowedToRebuildTermSummaryRelationships
boolean

Is Allowed To Rebuild Term Summary Relationships

isAllowedToViewSsnReports
boolean

Is Allowed To View Ssn Reports

isAllowedToWaiveDegreeProgressRequirement
boolean

Is Allowed To Waive Degree Progress Requirement

isAllowedToWaiveRetakeFee
boolean

Is Allowed To Waive Retake Fee

isAssociateEmployerOtherCampusAllowed
boolean

Is Associate Employer Other Campus Allowed

isAutoCmActivitiesAllowed
boolean

Is Auto Cm Activities Allowed

isAutomatedUser
boolean

Is Automated User

isAxFaculty
boolean

Is Ax Faculty

isBlockedViewSsnUi
boolean

Is Blocked View Ssn Ui

isCashier
boolean

Is Cashier

isConflictsChecked
boolean

Is Conflicts Checked

isContactManagerShownOnStartup
boolean

Is Contact Manager Shown On Startup

isCustomSearchAllowed
boolean

Is Custom Search Allowed

isDefaultReportWizardUsed
boolean

Is Default Report Wizard Used

isDeleteBilledChargesLeaseAllowed
boolean

Is Delete Billed Charges Lease Allowed

isDeleteUnbilledChargesLeaseAllowed
boolean

Is Delete Unbilled Charges Lease Allowed

isDropStatusMessageBox
boolean

Is Drop Status Message Box

isDuplicateEmpOverrideAllowed
boolean

Is Duplicate Emp Override Allowed

isFacultySynced
boolean

Is Faculty Synced

isGlobalSearchAllowed
boolean

Is Global Search Allowed

isHousingPeriodDateEditAllowed
boolean

Is Housing Period Date Edit Allowed

isJobTypeEditingSecurityAllowed
boolean

Is Job Type Editing Security Allowed

isLocked
boolean

Is Locked

isManualBillingNotAllowed
boolean

Is Manual Billing Not Allowed

isOverrideExecutiveReportOptionsAllowed
boolean

Is Override Executive Report Options Allowed

isOverrideLeaseDateAllowed
boolean

Is Override Lease Date Allowed

isOverrideRoomMaxCapacityAllowed
boolean

Is Override Room Max Capacity Allowed

isPrimaryContactSecurityAllowed
boolean

Is Primary Contact Security Allowed

isReportServerSelected
boolean

Is Report Server Selected

isStudentListSaved
boolean

Is Student List Saved

isSystem
boolean

Is System

isTest
boolean

Is Test

isToolbarUsed
boolean

Is Toolbar Used

isUserLevelOverrideAccessAllowed
boolean

Is User Level Override Access Allowed

isViewListBar
boolean

Is View List Bar

isViewToolBar
boolean

Is View Tool Bar

key
string

Key

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lastName
string

Last Name

mi
string

Mi

moduleId
number <int32>

Module Id

note
string

Note

number
number <int32>

Number

officePhoneNumber
string

Office Phone Number

password
string

Password

passwordExpirationDate
string <date-time>

Password Expiration Date

passwordRuleProfileId
number <int32>

Password Rule Profile Id

payRate
number <double>

Pay Rate

payType
string

Pay Type

personId
number <int32>

Person Id

phoneNumber
string

Phone Number

position
string

Position

postalCode
string

Postal Code

reportDefault
string

Report Default

reportsToStaffId
number <int32>

Reports To Staff Id

resume
string

Resume

rowVersion
string
salt
string

Salt

searchResults
string

Search Results

showDefaultOnStartup
boolean

Show Default On Startup

signature
string <byte>

Signature

ssn
string

Ssn

staffName
string

Staff Name

staffPicture
string <byte>

Staff Picture

state
string

State

streetAddress
string

Street Address

streetAddress2
string

Street Address2

suffix
string

Suffix

taskPolicyId
number <int32>

Task Policy Id

title
string

Title

workCity
string

Work City

workCountryId
number <int32>

Work Country Id

workFaxPhoneNumber
string

Work Fax Phone Number

workPostalCode
string

Work Postal Code

workState
string

Work State

workStreetAddress
string

Work Street Address

workStreetAddress2
string

Work Street Address2

object (cmc-nexus-common-entities-campusGroupEntity)
Array of objects (cmc-nexus-common-entities-staffGroupMemberEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Search Properties

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-staff-savesearchproperties-request-payload)
id
number <int32>
searchResults
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Staff Password

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-staff-savestaffpassword-request-payload)
staffId
number <int32>
password
string
oldPassword
string
isAllowedToChangePassword
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Staff Policies

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-staff-savestaffpolicies-request-payload)
staffIdList
Array of numbers <int32> [ items <int32 > ]
documentPolicyId
number <int32>
taskPolicyId
number <int32>
isClearDocumentPolicy
boolean
isClearTaskPolicy
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Set Default Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-staff-setdefaultsetting-request-payload)
campusId
number <int32>
termId
number <int32>
awardYearId
string
showDefaultOnStartup
boolean
moduleId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

StudentGroup

Create Student Group

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create Student Group Staff Access

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentgroup-createstudentgroupstaffaccess-request-payload)
studentGroupId
number <int32>
staffId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Student Group

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentgroup-delete-request-payload)
id
number <int32>

Id

campusGroupId
number <int32>

Campus Group Id

code
string

Code

createdDateTime
string <date-time>

The date when the item or person was added or the status change was entered.

dataQueryIdentifier
object

Data Query Identifier

expirationDate
string <date-time>

The date that the item was updated or changed.

groupType
string

Specifies the type of group. M indicates a manual group. F indicates a frozen group. S indicates a static group. D indicates a dynamic group. D is disabled if the Allow Dynamic Groups check box is not selected when the system was configured. Once you have created or changed a group to manual, you cannot change it back to static, dynamic, or frozen. The field is disabled.

isActive
boolean

Specifies whether or not the associated record is active.

isPortalGroup
boolean

Specifies that the group will be available to select in the CampusNexus Portal.

isPublic
boolean

Specifies whether or not a group is public or private. A public group can be accessed and used by all staff members who have view authorization. A private group can only be accessed and used by the owner and the staff members with view authorization that the owner specifies. If you are filtering, select the option is true to display only the public groups and the option is false to display only the private groups.

isSprocQuery
boolean

Is Sproc Query

isTransferMonitoringGroup
boolean

Is Transfer Monitoring Group

isUsedForAutoAwardCoa
boolean

Specifies whether or not the group can be used to define cost of attendance (COA) awarding and disbursement rules for the auto-awarding engine.

isUsedForAutoAwardRules
boolean

Specifies whether or not the group can be used to define awarding and disbursement rules for the auto-awarding engine.

jobFrequency
string

Specifies how often the SQL query that generates the group is executed. The field applies only to dynamic groups. Unless you are authorized to view all job frequencies, it only displays the values that have been configured for Contact Manager for the CampusNexus Web staff group.

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.

lastRefreshDate
string <date-time>

Specifies the last date that the SQL query that generates the list was executed.

name
string

Specifies the name of the item or person. If it is the name of a person, the name is displayed last then first name.

ownerStaffId
number <int32>

Owner Staff Id

preserveManualAddedStudentsOnRefresh
boolean

The check box is only displayed for dynamic and static groups. When the check box is selected, the manually added students are included in the group and the manually removed students are excluded from the group. When the check box is not selected, the manually added students are excluded from the group and the manually removed students are included in the group.

rowVersion
string
sqlQuery
string

Sql Query

viewQuery
string

View Query

Array of objects (cmc-nexus-common-entities-studentGroupStaffAccessEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Student Group

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentgroup-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Purge Expired

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

payload
any (common-studentgroup-purgeexpired-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": null
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Refresh Members

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentgroup-refreshmembers-request-payload)
studentGroupId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Student Group

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentgroup-save-request-payload)
id
number <int32>

Id

campusGroupId
number <int32>

Campus Group Id

code
string

Code

createdDateTime
string <date-time>

The date when the item or person was added or the status change was entered.

dataQueryIdentifier
object

Data Query Identifier

expirationDate
string <date-time>

The date that the item was updated or changed.

groupType
string

Specifies the type of group. M indicates a manual group. F indicates a frozen group. S indicates a static group. D indicates a dynamic group. D is disabled if the Allow Dynamic Groups check box is not selected when the system was configured. Once you have created or changed a group to manual, you cannot change it back to static, dynamic, or frozen. The field is disabled.

isActive
boolean

Specifies whether or not the associated record is active.

isPortalGroup
boolean

Specifies that the group will be available to select in the CampusNexus Portal.

isPublic
boolean

Specifies whether or not a group is public or private. A public group can be accessed and used by all staff members who have view authorization. A private group can only be accessed and used by the owner and the staff members with view authorization that the owner specifies. If you are filtering, select the option is true to display only the public groups and the option is false to display only the private groups.

isSprocQuery
boolean

Is Sproc Query

isTransferMonitoringGroup
boolean

Is Transfer Monitoring Group

isUsedForAutoAwardCoa
boolean

Specifies whether or not the group can be used to define cost of attendance (COA) awarding and disbursement rules for the auto-awarding engine.

isUsedForAutoAwardRules
boolean

Specifies whether or not the group can be used to define awarding and disbursement rules for the auto-awarding engine.

jobFrequency
string

Specifies how often the SQL query that generates the group is executed. The field applies only to dynamic groups. Unless you are authorized to view all job frequencies, it only displays the values that have been configured for Contact Manager for the CampusNexus Web staff group.

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.

lastRefreshDate
string <date-time>

Specifies the last date that the SQL query that generates the list was executed.

name
string

Specifies the name of the item or person. If it is the name of a person, the name is displayed last then first name.

ownerStaffId
number <int32>

Owner Staff Id

preserveManualAddedStudentsOnRefresh
boolean

The check box is only displayed for dynamic and static groups. When the check box is selected, the manually added students are included in the group and the manually removed students are excluded from the group. When the check box is not selected, the manually added students are excluded from the group and the manually removed students are included in the group.

rowVersion
string
sqlQuery
string

Sql Query

viewQuery
string

View Query

Array of objects (cmc-nexus-common-entities-studentGroupStaffAccessEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Student Group

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentgroup-savenew-request-payload)
id
number <int32>

Id

campusGroupId
number <int32>

Campus Group Id

code
string

Code

createdDateTime
string <date-time>

The date when the item or person was added or the status change was entered.

dataQueryIdentifier
object

Data Query Identifier

expirationDate
string <date-time>

The date that the item was updated or changed.

groupType
string

Specifies the type of group. M indicates a manual group. F indicates a frozen group. S indicates a static group. D indicates a dynamic group. D is disabled if the Allow Dynamic Groups check box is not selected when the system was configured. Once you have created or changed a group to manual, you cannot change it back to static, dynamic, or frozen. The field is disabled.

isActive
boolean

Specifies whether or not the associated record is active.

isPortalGroup
boolean

Specifies that the group will be available to select in the CampusNexus Portal.

isPublic
boolean

Specifies whether or not a group is public or private. A public group can be accessed and used by all staff members who have view authorization. A private group can only be accessed and used by the owner and the staff members with view authorization that the owner specifies. If you are filtering, select the option is true to display only the public groups and the option is false to display only the private groups.

isSprocQuery
boolean

Is Sproc Query

isTransferMonitoringGroup
boolean

Is Transfer Monitoring Group

isUsedForAutoAwardCoa
boolean

Specifies whether or not the group can be used to define cost of attendance (COA) awarding and disbursement rules for the auto-awarding engine.

isUsedForAutoAwardRules
boolean

Specifies whether or not the group can be used to define awarding and disbursement rules for the auto-awarding engine.

jobFrequency
string

Specifies how often the SQL query that generates the group is executed. The field applies only to dynamic groups. Unless you are authorized to view all job frequencies, it only displays the values that have been configured for Contact Manager for the CampusNexus Web staff group.

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.

lastRefreshDate
string <date-time>

Specifies the last date that the SQL query that generates the list was executed.

name
string

Specifies the name of the item or person. If it is the name of a person, the name is displayed last then first name.

ownerStaffId
number <int32>

Owner Staff Id

preserveManualAddedStudentsOnRefresh
boolean

The check box is only displayed for dynamic and static groups. When the check box is selected, the manually added students are included in the group and the manually removed students are excluded from the group. When the check box is not selected, the manually added students are excluded from the group and the manually removed students are included in the group.

rowVersion
string
sqlQuery
string

Sql Query

viewQuery
string

View Query

Array of objects (cmc-nexus-common-entities-studentGroupStaffAccessEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Set Student Group Hold Code

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentgroup-setstudentgroupholdcode-request-payload)
studentGroupIdList
Array of numbers <int32> [ items <int32 > ]
holdType
number <int32>
holdMessage
string
holdFlags
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

StudentRelationshipAddress

Create Student Relationship Address

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Student Relationship Address

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentrelationshipaddress-delete-request-payload)
isPermanentAddress
boolean
isDefaultAddress
boolean
isExcludedCrmIntegration
boolean
id
number <int32>

Id

addressBeginDate
string <date-time>

Address Begin Date

addressEndDate
string <date-time>

Address End Date

addressTypeId
number <int32>

Address Type Id

admissionsRegionId
number <int32>

Admissions Region Id

city
string

City

countryId
number <int32>

Country Id

countryName
string

Country Name

countyId
number <int32>

County Id

createdDateTime
string <date-time>

Created Date Time

emailAddress
string

Email Address

employerName
string

Employer Name

firstName
string

First Name

isSeasonalAddress
boolean

Is Seasonal Address

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lastName
string

Last Name

mobileNumber
string

Mobile Number

note
string

Note

otherEmailAddress
string

Other Email Address

otherPhone
string

Other Phone

phoneNumber
string

Phone Number

plusReferenceNumber
number <int32>

Plus Reference Number

postalCode
string

Postal Code

printedOnMasterPromNote
string

Printed On Master Prom Note

printedOnPlusPromNote
string

Printed On Plus Prom Note

referenceConfirmed
string

Reference Confirmed

referenceConfirmedDate
string <date-time>

Reference Confirmed Date

referenceNumber
number <int32>

Reference Number

relationToStudent
string

Relation To Student

rowVersion
string
secondPhoneNumber
string

Second Phone Number

sourceSystem
string

Source System

ssn
string

Ssn

state
string

State

streetAddress
string

Street Address

streetAddress2
string

Street Address2

studentEnrollmentPeriodId
number <int32>

Student Enrollment Period Id

studentId
number <int32>

Student Id

titleId
number <int32>

Title Id

workPhoneNumber
string

Work Phone Number

yearsAtAddress
number <double>

Years At Address

yearsKnownStudent
number <double>

Years Known Student

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Student Relationship Address

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentrelationshipaddress-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Student Relationship Address

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentrelationshipaddress-save-request-payload)
isPermanentAddress
boolean
isDefaultAddress
boolean
isExcludedCrmIntegration
boolean
id
number <int32>

Id

addressBeginDate
string <date-time>

Address Begin Date

addressEndDate
string <date-time>

Address End Date

addressTypeId
number <int32>

Address Type Id

admissionsRegionId
number <int32>

Admissions Region Id

city
string

City

countryId
number <int32>

Country Id

countryName
string

Country Name

countyId
number <int32>

County Id

createdDateTime
string <date-time>

Created Date Time

emailAddress
string

Email Address

employerName
string

Employer Name

firstName
string

First Name

isSeasonalAddress
boolean

Is Seasonal Address

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lastName
string

Last Name

mobileNumber
string

Mobile Number

note
string

Note

otherEmailAddress
string

Other Email Address

otherPhone
string

Other Phone

phoneNumber
string

Phone Number

plusReferenceNumber
number <int32>

Plus Reference Number

postalCode
string

Postal Code

printedOnMasterPromNote
string

Printed On Master Prom Note

printedOnPlusPromNote
string

Printed On Plus Prom Note

referenceConfirmed
string

Reference Confirmed

referenceConfirmedDate
string <date-time>

Reference Confirmed Date

referenceNumber
number <int32>

Reference Number

relationToStudent
string

Relation To Student

rowVersion
string
secondPhoneNumber
string

Second Phone Number

sourceSystem
string

Source System

ssn
string

Ssn

state
string

State

streetAddress
string

Street Address

streetAddress2
string

Street Address2

studentEnrollmentPeriodId
number <int32>

Student Enrollment Period Id

studentId
number <int32>

Student Id

titleId
number <int32>

Title Id

workPhoneNumber
string

Work Phone Number

yearsAtAddress
number <double>

Years At Address

yearsKnownStudent
number <double>

Years Known Student

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Student Relationship Address

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentrelationshipaddress-savenew-request-payload)
isPermanentAddress
boolean
isDefaultAddress
boolean
isExcludedCrmIntegration
boolean
id
number <int32>

Id

addressBeginDate
string <date-time>

Address Begin Date

addressEndDate
string <date-time>

Address End Date

addressTypeId
number <int32>

Address Type Id

admissionsRegionId
number <int32>

Admissions Region Id

city
string

City

countryId
number <int32>

Country Id

countryName
string

Country Name

countyId
number <int32>

County Id

createdDateTime
string <date-time>

Created Date Time

emailAddress
string

Email Address

employerName
string

Employer Name

firstName
string

First Name

isSeasonalAddress
boolean

Is Seasonal Address

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lastName
string

Last Name

mobileNumber
string

Mobile Number

note
string

Note

otherEmailAddress
string

Other Email Address

otherPhone
string

Other Phone

phoneNumber
string

Phone Number

plusReferenceNumber
number <int32>

Plus Reference Number

postalCode
string

Postal Code

printedOnMasterPromNote
string

Printed On Master Prom Note

printedOnPlusPromNote
string

Printed On Plus Prom Note

referenceConfirmed
string

Reference Confirmed

referenceConfirmedDate
string <date-time>

Reference Confirmed Date

referenceNumber
number <int32>

Reference Number

relationToStudent
string

Relation To Student

rowVersion
string
secondPhoneNumber
string

Second Phone Number

sourceSystem
string

Source System

ssn
string

Ssn

state
string

State

streetAddress
string

Street Address

streetAddress2
string

Street Address2

studentEnrollmentPeriodId
number <int32>

Student Enrollment Period Id

studentId
number <int32>

Student Id

titleId
number <int32>

Title Id

workPhoneNumber
string

Work Phone Number

yearsAtAddress
number <double>

Years At Address

yearsKnownStudent
number <double>

Years Known Student

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Set Default

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentrelationshipaddress-setdefault-request-payload)
isDefaultAddress
boolean
studentId
number <int32>
addressId
number <int32>
isDeleteDefaultAddress
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

StudentSchoolDefinedFieldValue

Create Student School Defined Field Value

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Student School Defined Field Value

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentschooldefinedfieldvalue-delete-request-payload)
isExcludedCrmIntegration
boolean
id
number <int32>

Id

createdDateTime
string <date-time>

Created Date Time

fieldValue
string

Field Value

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

rowVersion
string
schoolDefinedFieldId
number <int32>

School Defined Field Id

studentId
number <int32>

Student Id

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Student School Defined Field Value

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentschooldefinedfieldvalue-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Student School Defined Field Value

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentschooldefinedfieldvalue-save-request-payload)
isExcludedCrmIntegration
boolean
id
number <int32>

Id

createdDateTime
string <date-time>

Created Date Time

fieldValue
string

Field Value

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

rowVersion
string
schoolDefinedFieldId
number <int32>

School Defined Field Id

studentId
number <int32>

Student Id

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Student School Defined Field Value

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-studentschooldefinedfieldvalue-savenew-request-payload)
isExcludedCrmIntegration
boolean
id
number <int32>

Id

createdDateTime
string <date-time>

Created Date Time

fieldValue
string

Field Value

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

rowVersion
string
schoolDefinedFieldId
number <int32>

School Defined Field Id

studentId
number <int32>

Student Id

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

SystemSetting

Get

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-systemsetting-get-request-payload)
chars
object
length
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Workspace

Create Workspace

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Workspace

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-workspace-delete-request-payload)
id
number <int32>
createdDateTime
string <date-time>
isActive
boolean
lastModifiedDateTime
string <date-time>
lastModifiedUserId
number <int32>
name
string
rowVersion
string
urlSlug
string
workspaceIdentifier
object
workspaceState
string

Workspace State

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Workspace

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-workspace-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get By Url Slug

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-workspace-getbyurlslug-request-payload)
urlSlug
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Workspace

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-workspace-save-request-payload)
id
number <int32>
createdDateTime
string <date-time>
isActive
boolean
lastModifiedDateTime
string <date-time>
lastModifiedUserId
number <int32>
name
string
rowVersion
string
urlSlug
string
workspaceIdentifier
object
workspaceState
string

Workspace State

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Workspace

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (common-workspace-savenew-request-payload)
id
number <int32>
createdDateTime
string <date-time>
isActive
boolean
lastModifiedDateTime
string <date-time>
lastModifiedUserId
number <int32>
name
string
rowVersion
string
urlSlug
string
workspaceIdentifier
object
workspaceState
string

Workspace State

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}