REST API for Oracle Fusion Cloud Student Management

All REST Endpoints

Academic Buildings

The academic buildings resource is used to list academic buildings.

Create all buildings: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings
Delete a building: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}
Get a building: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}
Get all buildings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings
Update a building: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}

Academic Buildings/Contacts

The contacts resource is used to view all associated contacts.

Create a contact association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/contacts
Delete a contact association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/contacts/{ContactAssociationId}
Get all associated contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/contacts
Get an associated contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/contacts/{ContactAssociationId}
Update a contact association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/contacts/{ContactAssociationId}

Academic Buildings/Drop Scheme Settings Assignments

The assignments resource provides a list of academic entities which have been assigned.

Create all assignments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/assignments
Delete an assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/assignments/{SettingsAssignmentId}
Get all assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/assignments
Get an assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/assignments/{SettingsAssignmentId}
Update an assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/assignments/{SettingsAssignmentId}

Academic Buildings/Locations

The locations resource shows all associated locations.

Create a location association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/locations/{LocationAssociationId}
Create all location associations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/locations
Delete a location association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/locations/{LocationAssociationId}
Get a location association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/locations/{LocationAssociationId}
Get all location associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/locations

Academic Business Unit Assignment Details

The academic business unit assignment details resource lists all assignments of an academic business unit to an academic entity.

Create business unit assignments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/businessUnitAssignments
Delete a business unit assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/businessUnitAssignments/{BusinessUnitAssignmentId}
Get a business unit assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessUnitAssignments/{BusinessUnitAssignmentId}
Get all business unit assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessUnitAssignments
Get business unit assignments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/businessUnitAssignments/action/getBusinessUnitAssignment
Update a business unit assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/businessUnitAssignments/{BusinessUnitAssignmentId}

Academic Credentials

The academic credentials resource provides a complete list of institutionally defined credentials which can be assigned to students.

Get all academic credentials: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicCredentials
Get an academic credential row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicCredentials/{academicCredentialsUniqID}

Academic Entities

The academic entities resource is used to list academic entities such as system offices, institutions, academic organizations and campuses.

Get all academic entities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicEntities
Get an academic entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicEntities/{EntityId}
Retrieve inherited settings: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicEntities/action/getInheritedSettings

Academic Entities/Associated Academic Entities

The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.

Get all associated entities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicEntities/{EntityId}/child/associatedEntities
Get an associated entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicEntities/{EntityId}/child/associatedEntities/{EntityAssociationId}

Academic Entity Hierarchies

The academic entities resource is used to list academic entities such as system offices, institutions, academic organizations and campuses.

Get all academic entity hierarchies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicEntityHierarchies
Get an academic entity hierarchy: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicEntityHierarchies/{academicEntityHierarchiesUniqID}

Academic Facilities

The academic facilities resource is used to list academic facilities.

Create all facilities: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities
Delete a facility: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}
Get a facility: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}
Get all facilities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities
Update a facility: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}

Academic Facilities/Blackout Dates

The blackout dates resource is used to list the dates the facility is unavailable.

Create all blackout dates: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/blackoutDates
Delete a blackout date: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/blackoutDates/{BlackoutId}
Get a blackout date: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/blackoutDates/{BlackoutId}
Get all blackout dates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/blackoutDates
Update a blackout date: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/blackoutDates/{BlackoutId}

Academic Facilities/Contacts

The contacts resource is used to view all associated contacts.

Create a contact association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/contacts
Delete a contact association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/contacts/{ContactAssociationId}
Get all associated contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/contacts
Get an associated contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/contacts/{ContactAssociationId}
Update a contact association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/contacts/{ContactAssociationId}

Academic Facilities/Drop Scheme Settings Assignments

The assignments resource provides a list of academic entities which have been assigned.

Create all assignments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/assignments
Delete an assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/assignments/{SettingsAssignmentId}
Get all assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/assignments
Get an assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/assignments/{SettingsAssignmentId}
Update an assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/assignments/{SettingsAssignmentId}

Academic Facilities/Locations

The locations resource shows all associated locations.

Get a location association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/locations/{LocationAssociationId}
Get all location associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/locations

Academic Form Library Items

The academic form library items resource provides a list of all the academic form library items set up.

Get a academic form library item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}
Get all academic form library items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems

Academic Form Library Items/Resources

The resources resource provides a list of all the resources set up.

Get a resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/resources/{ResourceLibraryId}
Get all resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/resources

Academic Form Library Items/Resources/Resource Attributes

The resource attributes resource provides a list of all the resource attributes set up.

Get a resource attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/resources/{ResourceLibraryId}/child/resourceAttributes/{ResourceAttributeId}
Get all resource attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/resources/{ResourceLibraryId}/child/resourceAttributes

Academic Form Library Items/Sections

The sections resource provides a list of all the sections set up.

Get a section: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/sections/{SectionLibraryId}
Get all sections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/sections

Academic Form Library Items/Sections/Large Object (LOB) Attributes - SectionContent

Delete a SectionContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/sections/{SectionLibraryId}/enclosure/SectionContent
Get a SectionContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/sections/{SectionLibraryId}/enclosure/SectionContent
Replace a SectionContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/sections/{SectionLibraryId}/enclosure/SectionContent

Academic Form Library Items/Sections/Section Attributes

The section attributes resource provides a list of all the section attributes set up.

Get a section attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/sections/{SectionLibraryId}/child/sectionAttributes/{SectionAttributeId}
Get all section attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/sections/{SectionLibraryId}/child/sectionAttributes

Academic Form Library Items/Sections/Section Attributes/Large Object (LOB) Attributes - SectionAttributeContent

Delete a SectionAttributeContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/sections/{SectionLibraryId}/child/sectionAttributes/{SectionAttributeId}/enclosure/SectionAttributeContent
Get a SectionAttributeContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/sections/{SectionLibraryId}/child/sectionAttributes/{SectionAttributeId}/enclosure/SectionAttributeContent
Replace a SectionAttributeContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/academicFormLibraryItems/{FormTypeSetupId}/child/sections/{SectionLibraryId}/child/sectionAttributes/{SectionAttributeId}/enclosure/SectionAttributeContent

Academic Groups

The academic groups resource lists all the academic groups.

Get all academic groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicGroups
Get an academic group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicGroups/{academicGroupsUniqID}

Academic Groups/Elements

The elements resource is a child of the academic groups resource and lists all the elements associated with an academic group.

Get all elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicGroups/{academicGroupsUniqID}/child/elements
Get an element: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicGroups/{academicGroupsUniqID}/child/elements/{elementsUniqID}

Academic Groups/Parameters

The parameters resource is a child of the programs resource and provides a list of program parameters for a program.

Get a parameter: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicGroups/{academicGroupsUniqID}/child/parameters/{ParameterId}
Get all parameters: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicGroups/{academicGroupsUniqID}/child/parameters

Academic Groups/Results

The results resource is a child of the academic groups resource and lists all the results associated with an academic group.

Get a result: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicGroups/{academicGroupsUniqID}/child/results/{resultsUniqID}
Get all results: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicGroups/{academicGroupsUniqID}/child/results

Academic Institutions

This resource is used to manage Student Management academic institutions.

Create all academic institutions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions
Delete an academic institution: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}
Get all academic institutions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions
Get an academic institutions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}
Update an academic institution: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}

Academic Institutions/Academic Organizations

The academic organizations resource provides a list of academic organizations.

Get all academic organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/academicOrganizations
Get an academic organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/academicOrganizations/{AcademicOrgId}

Academic Institutions/Academic Organizations/Offering Storefronts

The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.

Get all offering storefronts for a course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/academicOrganizations/{AcademicOrgId}/child/organizationStorefronts
Get an offering storefront: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/academicOrganizations/{AcademicOrgId}/child/organizationStorefronts/{organizationStorefrontsUniqID}

Academic Institutions/Associated Academic Entities

The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.

Create all associated entities: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/associatedEntities
Delete an associated entity: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/associatedEntities/{EntityAssociationId}
Get all associated entities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/associatedEntities
Get an associated entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/associatedEntities/{EntityAssociationId}
Update an associated entity: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/associatedEntities/{EntityAssociationId}

Academic Institutions/Campuses

The campuses resource is a child of the academic institutions resource and provides a complete list of campuses associated with an institution.

Get a campus for an academic institution: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/campuses/{campusesUniqID}
Get all campuses for an academic institution: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/campuses

Academic Institutions/Contacts

The contacts resource is used to view all associated contacts.

Create a contact association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/contacts
Delete a contact association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/contacts/{ContactAssociationId}
Get all associated contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/contacts
Get an associated contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/contacts/{ContactAssociationId}
Update a contact association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/contacts/{ContactAssociationId}

Academic Institutions/Identifiers

The identifiers resource is used to view all associated identifiers.

Create an identifier association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/identifiers
Delete an identifier association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/identifiers/{IdentifierAssociationId}
Get all associated identifiers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/identifiers
Get an associated identifier: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/identifiers/{IdentifierAssociationId}
Update an identifier association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/identifiers/{IdentifierAssociationId}

Academic Institutions/Locations

The locations resource shows all associated locations.

Create a location association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/locations/{LocationAssociationId}
Create all location associations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/locations
Delete a location association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/locations/{LocationAssociationId}
Get a location association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/locations/{LocationAssociationId}
Get all location associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/locations

Academic Institutions/Subjects

The subjects resource is a child of the academic institutions resource and provides a complete list of subjects associated with an institution.

Get a subject for an academic institution: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/subjects/{subjectsUniqID}
Get all subjects for an academic institution: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/subjects

Academic Levels

The academic levels resource provides a complete list of academic levels.

Create all academic levels: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicLevels
Delete an academic level: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}
Get all academic levels: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicLevels
Get an academic level: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}
Update an academic level: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}

Academic Levels/Drop Scheme Settings Assignments

The assignments resource provides a list of academic entities which have been assigned.

Create all assignments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/assignments
Delete an assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/assignments/{SettingsAssignmentId}
Get all assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/assignments
Get an assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/assignments/{SettingsAssignmentId}
Update an assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/assignments/{SettingsAssignmentId}

Academic Levels/Enrollment Inclusions

The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.

Create all enrollment inclusions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/enrollmentInclusions
Delete an enrollment inclusion: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/enrollmentInclusions/{EnrollmentInclusionId}
Get all enrollment inclusions associated with an academic level: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/enrollmentInclusions
Get an enrollment inclusion associated with an academic level: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/enrollmentInclusions/{EnrollmentInclusionId}
Update an enrollment inclusion: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/enrollmentInclusions/{EnrollmentInclusionId}

Academic Levels/Institutions

The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.

Get all institutions associated with an academic level: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/institutions
Get an institution associated with an academic level: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/institutions/{institutionsUniqID}

Academic Organizations

The academic organizations resource provides a list of academic organizations.

Create all academic organizations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations
Delete an academic organization: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}
Get all academic organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations
Get an academic organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}
Update an academic organization: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}

Academic Organizations/Associated Academic Entities

The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.

Create all associated entities: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/associatedEntities
Delete an associated entity: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/associatedEntities/{EntityAssociationId}
Get all associated entities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/associatedEntities
Get an associated entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/associatedEntities/{EntityAssociationId}
Update an associated entity: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/associatedEntities/{EntityAssociationId}

Academic Organizations/Contacts

The contacts resource is used to view all associated contacts.

Create a contact association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/contacts
Delete a contact association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/contacts/{ContactAssociationId}
Get all associated contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/contacts
Get an associated contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/contacts/{ContactAssociationId}
Update a contact association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/contacts/{ContactAssociationId}

Academic Organizations/Identifiers

The identifiers resource is used to view all associated identifiers.

Create an identifier association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/identifiers
Delete an identifier association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/identifiers/{IdentifierAssociationId}
Get all associated identifiers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/identifiers
Get an associated identifier: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/identifiers/{IdentifierAssociationId}
Update an identifier association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/identifiers/{IdentifierAssociationId}

Academic Organizations/Locations

The locations resource shows all associated locations.

Create a location association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/locations/{LocationAssociationId}
Create all location associations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/locations
Delete a location association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/locations/{LocationAssociationId}
Get a location association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/locations/{LocationAssociationId}
Get all location associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/locations

Academic Organizations/Offering Storefronts

The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.

Get all offering storefronts for a course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/organizationStorefronts
Get an offering storefront: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/organizationStorefronts/{organizationStorefrontsUniqID}

Academic Period Sequences

The academic period sequence resource provides a list of institutionally defined ordered sequences of academic periods.

Create an academic period sequence: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences
Delete an academic period sequence: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}
Get all academic period sequences: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences
Get an academic period sequence: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}
Update an academic period sequence: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}

Academic Period Sequences/Academic Period Sequence Owners

The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence.

Create a period sequence owner: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/periodSequenceOwners
Delete a period sequence owner: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/periodSequenceOwners/{periodSequenceOwnersUniqID}
Get a period sequence owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/periodSequenceOwners/{periodSequenceOwnersUniqID}
Get all period sequence owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/periodSequenceOwners
Update a period sequence owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/periodSequenceOwners/{periodSequenceOwnersUniqID}

Academic Period Sequences/Level One Academic Periods

The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy.

Create a level one period: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/levelOnePeriods
Delete a level one period: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/levelOnePeriods/{PeriodSequenceDetailId}
Get a level one period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/levelOnePeriods/{PeriodSequenceDetailId}
Get all level one periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/levelOnePeriods
Update a level one period: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/levelOnePeriods/{PeriodSequenceDetailId}

Academic Period Sequences/Level One Academic Periods/Level Two Academic Periods

The level two academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the second level of the hierarchy.

Get a level two period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/levelOnePeriods/{PeriodSequenceDetailId}/child/levelTwoPeriods/{levelTwoPeriodsUniqID}
Get all level two periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/levelOnePeriods/{PeriodSequenceDetailId}/child/levelTwoPeriods

Academic Period Types

The academic period types resource provides a list of academic period types defined by institutions.

Get all academic period types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodTypes
Get an academic period type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodTypes/{AcademicPeriodTypeId}

Academic Period Types/Valid Date Times

The valid date times resource is a child of the academic period types resource and provides a list of valid date time definitions for an academic period type.

Get a valid date time: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodTypes/{AcademicPeriodTypeId}/child/validDateTimes/{AcademicPeriodValidId}
Get all valid date times: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodTypes/{AcademicPeriodTypeId}/child/validDateTimes

Academic Periods

The academic periods resource provides a list of institutionally defined time periods.

Get all academic periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriods
Get an academic period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriods/{AcademicPeriodId}

Academic Periods/Academic Periods

The academic periods resource provides a list of institutionally defined time periods.

Get all academic periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriods/{AcademicPeriodId}/child/academicPeriods
Get an academic period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriods/{AcademicPeriodId}/child/academicPeriods/{AcademicPeriodId2}

Academic Periods/Period Dates

The period dates resource is a child of the academic periods resource and provides a list of date definitions for an academic period.

Get a period date associated with an academic period parent resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriods/{AcademicPeriodId}/child/periodDates/{AcademicPeriodDateId}
Get all period dates associated with an academic period parent resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriods/{AcademicPeriodId}/child/periodDates

Academic Periods/Period Levels

The period levels resource is a child of the academic periods resource and provides a list of period levels for a academic period.

Get a period level associated with an academic period parent resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriods/{AcademicPeriodId}/child/periodLevels/{periodLevelsUniqID}
Get all period levels associated with an academic period parent resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriods/{AcademicPeriodId}/child/periodLevels

Academic Periods/Period Tags

The period tags resource is a child of the academic periods resource and provides a list of curriculum tags for a reporting academic period.

Get a period tag associated with an academic period parent resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriods/{AcademicPeriodId}/child/periodTags/{PeriodTagAssociationId}
Get all period tags associated with an academic period parent resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriods/{AcademicPeriodId}/child/periodTags

Academic Plan Formats

The academic plan formats resource provides a complete list of academic plan formats.

Get all academic plan formats: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanFormats
Get an academic plan format: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanFormats/{PlanFormatId}

Academic Plan Formats/Large Object (LOB) Attributes - PlanFormatDescription

Delete a PlanFormatDescription: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicPlanFormats/{PlanFormatId}/enclosure/PlanFormatDescription
Get a PlanFormatDescription: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanFormats/{PlanFormatId}/enclosure/PlanFormatDescription
Replace a PlanFormatDescription: Method: put
Path: /fscmRestApi/resources/11.13.18.05/academicPlanFormats/{PlanFormatId}/enclosure/PlanFormatDescription

Academic Plan Formats/Periods

The periods resource is a child of the academic plan formats resource and provides a complete list of academic periods associated with an academic plan format.

Get a period associated with an academic plan format: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanFormats/{PlanFormatId}/child/periods/{PeriodId}
Get all periods associated with an academic plan format: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanFormats/{PlanFormatId}/child/periods

Academic Plan Formats/Periods/Tags

The tags resource is a child resource of the periods resource and contains the valid period tags for a format period.

Get a tag associated with a format period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanFormats/{PlanFormatId}/child/periods/{PeriodId}/child/tags/{FormatPeriodTagId}
Get all tags associated with a format period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanFormats/{PlanFormatId}/child/periods/{PeriodId}/child/tags

Academic Plan Formats/Periods/Tiers

The tiers resource is a child resource of the periods resource and contains the valid period tiers for a format period.

Get a tier associated with a format period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanFormats/{PlanFormatId}/child/periods/{PeriodId}/child/tiers/{FormatPeriodTierId}
Get all tiers associated with a format period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanFormats/{PlanFormatId}/child/periods/{PeriodId}/child/tiers

Academic Plan Templates

The academic plan templates resource provides a complete list of academic plan templates.

Create all academic plan templates: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates
Delete an academic plan template: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}
Get all academic plan templates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates
Get an academic plan template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}
Update an academic plan template: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}

Academic Plan Templates/Instructions

The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template.

Create all instructions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/instructions
Delete an instruction: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/instructions/{TemplateInstructionId}
Get all instructions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/instructions
Get an instruction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/instructions/{TemplateInstructionId}
Update an instruction: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/instructions/{TemplateInstructionId}

Academic Plan Templates/Owners

The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.

Create all owners: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/owners
Delete an owner: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/owners/{ownersUniqID}
Get all owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/owners
Get an owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/owners/{ownersUniqID}
Update an owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/owners/{ownersUniqID}

Academic Plan Templates/Periods

The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.

Create all periods: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods
Delete a period: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}
Get a period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}
Get all periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods
Update a period: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}

Academic Plan Templates/Periods/Elements

The elements resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.

Create all elements: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements
Delete an element: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}
Get all elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements
Get an element: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}
Update an element: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}

Academic Plan Templates/Periods/Elements/Course Requisites

The courseRequisites resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.

Get all course requisites: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}/child/courseRequisites
Get all course requisites: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}/child/courseRequisites/{courseRequisitesUniqID}

Academic Plan Templates/Periods/Elements/Related Elements

The related elements resource is a child of the academic plan templates resource and provides a list of related elements associated with an academic plan template.

Create all related elements: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}/child/relatedElements
Delete a related element: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}/child/relatedElements/{relatedElementsUniqID}
Get a related element: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}/child/relatedElements/{relatedElementsUniqID}
Get all related elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}/child/relatedElements
Update a related element: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}/child/relatedElements/{relatedElementsUniqID}

Academic Plan Templates/Periods/Tiers

The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.

Create all tiers: Method: post
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/tiers
Delete a tier: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/tiers/{TemplatePeriodTierId}
Get a tier: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/tiers/{TemplatePeriodTierId}
Get all tiers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/tiers
Update a tier: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/tiers/{TemplatePeriodTierId}

Administrative Service Indicators

The administrative service indicators resource provides a list of service indicators that can be assigned to individuals, such as students. Examples of service indicators can include library fine, nonpayment of tuition fee, and early enrollment.

Get a service indicator: Method: get
Path: /fscmRestApi/resources/11.13.18.05/administrativeServiceIndicators/{ServiceIndicatorId}
Get all service indicators: Method: get
Path: /fscmRestApi/resources/11.13.18.05/administrativeServiceIndicators

Administrative Service Indicators/Indicator Impacts

The indicator impacts resource provides a list of services that are impacted due to the assignment of the service indicator.

Get all indicator impacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/administrativeServiceIndicators/{ServiceIndicatorId}/child/indicatorImpacts
Get an indicator impact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/administrativeServiceIndicators/{ServiceIndicatorId}/child/indicatorImpacts/{IndicatorImpactId}

Admission Applications

The admission application resource provides a list of all the applications submitted.

Create an admissions application: Method: post
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications
Get all admissions applications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications
Get an admission application: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}
Update an admission application: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}

Admission Applications/Academic Histories

The academic history section is a child resource of an admissions application and provides information about an applicant's academic history.

Create an academic history: Method: post
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/academicHistories
Delete an academic history: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/academicHistories/{academicHistoriesUniqID}
Get all academic histories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/academicHistories
Get an academic history: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/academicHistories/{academicHistoriesUniqID}
Update an academic history: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/academicHistories/{academicHistoriesUniqID}

Admission Applications/Addresses

The addresses resource contains information about the various addresses provided on the application.

Get all addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/addresses
Get an address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/addresses/{AddressId}

Admission Applications/Application Attachments

The application attachments are a child resource of an admissions application and provide information about the documents attached to an application.

Create an application attachment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationAttachments
Delete an application attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationAttachments/{HeyAttachmentId}
Get all application attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationAttachments
Get an application attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationAttachments/{HeyAttachmentId}
Update an application attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationAttachments/{HeyAttachmentId}

Admission Applications/Application Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationAttachments/{HeyAttachmentId}/enclosure/FileContents
Get a FileContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationAttachments/{HeyAttachmentId}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationAttachments/{HeyAttachmentId}/enclosure/FileContents

Admission Applications/Application Long Text Items

The application long text items resource captures application-specific long text data.

Create an application long text item: Method: post
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems
Delete an application long text item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems/{applicationLongTextItemsUniqID}
Get all application long text items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems
Get an application long text item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems/{applicationLongTextItemsUniqID}
Update an application long text item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems/{applicationLongTextItemsUniqID}

Admission Applications/Application Long Text Items/Large Object (LOB) Attributes - ClobData

Delete a ClobData: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems/{applicationLongTextItemsUniqID}/enclosure/ClobData
Get a ClobData: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems/{applicationLongTextItemsUniqID}/enclosure/ClobData
Replace a ClobData: Method: put
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems/{applicationLongTextItemsUniqID}/enclosure/ClobData

Admission Applications/Application Long Text Items/Large Object (LOB) Attributes - ClobMetadata

Delete a ClobMetadata: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems/{applicationLongTextItemsUniqID}/enclosure/ClobMetadata
Get a ClobMetadata: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems/{applicationLongTextItemsUniqID}/enclosure/ClobMetadata
Replace a ClobMetadata: Method: put
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems/{applicationLongTextItemsUniqID}/enclosure/ClobMetadata

Admission Applications/Application Programs

The application programs resource captures the programs for an application.

Get all application programs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationPrograms
Get an application program: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationPrograms/{ApplicationProgramId}
Update an application program: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationPrograms/{ApplicationProgramId}

Admission Applications/Application Programs/Application Program Item Statuses

The application program item statuses resource captures the status history of an application program.

Get all application program item statuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationPrograms/{ApplicationProgramId}/child/applicationProgramItemStatuses
Get an application program item status: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationPrograms/{ApplicationProgramId}/child/applicationProgramItemStatuses/{ApplicationProgramItemStatusId}

Admission Applications/Course Selections

The course selections resource captures course preference selections for an admissions application.

Create a course selection: Method: post
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/courseSelections
Delete a course selection: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/courseSelections/{CourseSelectionId}
Get a course selection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/courseSelections/{CourseSelectionId}
Get all course selections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/courseSelections
Update a course selection: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/courseSelections/{CourseSelectionId}

Admission Applications/Course Selections/Large Object (LOB) Attributes - CourseDescription

Get a CourseDescription: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/courseSelections/{CourseSelectionId}/enclosure/CourseDescription

Admission Applications/Emails

The emails resource contains information about the various email addresses provided on the application.

Get all email addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/emails
Get an email address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/emails/{EmailId}

Admission Applications/Emergency Contacts

The emergency contacts resource contains information about the various emergency contacts provided on the application.

Get all emergency contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/emergencyContacts
Get an emergency contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/emergencyContacts/{EmergencyContactId}

Admission Applications/Extracurricular Activities

The extracurricular activities section is a child resource of an admissions application and provides information about an applicant's extracurricular activities.

Create an extracurricular activity: Method: post
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/extracurricularActivities
Delete an extracurricular activity: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/extracurricularActivities/{extracurricularActivitiesUniqID}
Get all extracurricular activities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/extracurricularActivities
Get an extracurricular activity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/extracurricularActivities/{extracurricularActivitiesUniqID}
Update an extracurricular activity: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/extracurricularActivities/{extracurricularActivitiesUniqID}

Admission Applications/Names

The names resource contains information about the various names provided on the application.

Get a name: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/names/{NameId}
Get all names: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/names

Admission Applications/Person Details

The person details resource provides information about the applicant's person profile.

Get a person details instance: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/personDetails/{PersonalDetailId}
Get all person details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/personDetails

Admission Applications/Phones

The phones resource contains information about the various phone numbers provided on the application.

Get a phone number: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/phones/{PhoneId}
Get all phone numbers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/phones

Admission Applications/Races

The races resource contains information about the various races provided on the application.

Get a race: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/races/{RaceId}
Get all races: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/races

Admission Applications/Recommendations

The recommendation section is a child resource of an admissions application and provides information about an applicant's recommenders.

Create a recommendation: Method: post
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/recommendations
Delete a recommendation: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/recommendations/{recommendationsUniqID}
Get a recommendation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/recommendations/{recommendationsUniqID}
Get all recommendations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/recommendations
Update a recommendation: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/recommendations/{recommendationsUniqID}

Admission Applications/Relationships

The relationships section is a child resource of an admissions application and provides information about an applicant's relationships.

Create a relationship: Method: post
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/relationships
Delete a relationship: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/relationships/{relationshipsUniqID}
Get a relationship: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/relationships/{relationshipsUniqID}
Get all relationships: Method: get
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/relationships
Update a relationship: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/relationships/{relationshipsUniqID}

Application Action Reasons

The application action reasons resource contains the configured action reasons that can be assigned to admissions applications, for example, Manually activate application or Application incomplete.

Get all application action reasons: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationActionReasons
Get an application action reason: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationActionReasons/{ActionReasonId}

Application Form Definitions

The application form definition resource provides a list of all the forms available for an application.

Create an application form: Method: post
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions
Delete an application form: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}
Get all application forms: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions
Get an application form: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}
Update an application form: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}

Application Form Definitions/Application Admit Periods

The application admit period is child to application form definition and provides information about the admit periods form metadata.

Create an application admit period: Method: post
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationAdmitPeriods
Delete an application admit period: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationAdmitPeriods/{FormAdmitPeriodId}
Get all application admit periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationAdmitPeriods
Get an application admit period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationAdmitPeriods/{FormAdmitPeriodId}
Update an application admit period: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationAdmitPeriods/{FormAdmitPeriodId}

Application Form Definitions/Application Programs

The application program is child to application form definition and provides information about the programs form metadata.

Create a form fragment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/formFragments
Delete a form fragment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/formFragments/{FormFragmentId}
Get a form fragment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/formFragments/{FormFragmentId}
Get all form fragments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/formFragments
Update a form fragment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/formFragments/{FormFragmentId}

Application Form Definitions/Application Programs/Large Object (LOB) Attributes - FragmentContent

Delete a FragmentContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/formFragments/{FormFragmentId}/enclosure/FragmentContent
Get a FragmentContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/formFragments/{FormFragmentId}/enclosure/FragmentContent
Replace a FragmentContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/formFragments/{FormFragmentId}/enclosure/FragmentContent

Application Form Definitions/Form Fragments

The application program is child to application form definition and provides information about various parts of the form.

Create an application program: Method: post
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationPrograms
Delete an application program: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationPrograms/{applicationProgramsUniqID}
Get all application programs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationPrograms
Get an application program: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationPrograms/{applicationProgramsUniqID}
Update an application program: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationPrograms/{applicationProgramsUniqID}

Application Page Assignments

The application page assignments resource is used to view, create, modify or delete role associated with application pages.

Create a role page assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments
Create bulk assignments for page access.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/action/createBulkAssignments
Delete a role page assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/{AssignmentId}
Get a role page assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/{AssignmentId}
Get all role page assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments
Update a role page assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/{AssignmentId}

Application Page Assignments/Page Permission Assignment to Role

The role page permission resource is used to view, create, modify or delete permissions associated with role for a application page.

Create a page permission for a role: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/{AssignmentId}/child/rolePagePermissions
Delete a page permission for a role: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/{AssignmentId}/child/rolePagePermissions/{PermissionMappingId}
Get a page permission for a role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/{AssignmentId}/child/rolePagePermissions/{PermissionMappingId}
Get all page permissions for a role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/{AssignmentId}/child/rolePagePermissions
Update a page permission for a role: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/{AssignmentId}/child/rolePagePermissions/{PermissionMappingId}

Application Pages

The application pages resource is used to view all the Student Management application pages.

Get a page: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPages/{PageId}
Get all pages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPages

Application Pages/Application Page Elements

The application page elements resource is used to view all the page elements.

Get a page element: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPages/{PageId}/child/pageElements/{PageElementId}
Get all page elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPages/{PageId}/child/pageElements

Application Pages/Application Page Elements/Application Page Element Permissions

The application page element permissions resource is used to view all the page element permissions.

Get a page element permission: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPages/{PageId}/child/pageElements/{PageElementId}/child/permissions/{PermissionId}
Get all page element permissions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPages/{PageId}/child/pageElements/{PageElementId}/child/permissions

Application Pages/Application Page Elements/Associated Business Objects

The associated business objects resource is used to view all the business objects associated with the page element.

Get all associated business objects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPages/{PageId}/child/pageElements/{PageElementId}/child/associatedBusinessObjects
Get an associated business object: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPages/{PageId}/child/pageElements/{PageElementId}/child/associatedBusinessObjects/{associatedBusinessObjectsUniqID}

Application Registrations

The application registrations resource provides a list of applications that have access to the Student Management Cloud.

Create application registrations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/applicationRegistrations
Delete an application registration: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/applicationRegistrations/{ApplicationRegistrationId}
Get all application registrations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationRegistrations
Get an application registration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationRegistrations/{ApplicationRegistrationId}
Update an application registration: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/applicationRegistrations/{ApplicationRegistrationId}

Application Snapshot Settings

The application snapshot settings resource is used to view, create, or modify application snapshot setup.

Create a snapshot setting instance: Method: post
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings
Get a snapshot setting instance: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}
Get all snapshot settings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings
Update a snapshot setting instance: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}

Application Snapshot Settings/Application Snapshot Settings Assignments

The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.

Create an assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/assignments
Delete an assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/assignments/{SettingsAssignmentId}
Get all assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/assignments
Get an assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/assignments/{SettingsAssignmentId}
Update an assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/assignments/{SettingsAssignmentId}

Application Snapshot Settings/Application Snapshot Settings Statuses

The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.

Create a snapshot setting status: Method: post
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/applicationStatuses
Delete a snapshot setting status: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/applicationStatuses/{SnapshotStatusId}
Get a snapshot setting status: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/applicationStatuses/{SnapshotStatusId}
Get all snapshot setting statuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/applicationStatuses
Update a snapshot setting status: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/applicationStatuses/{SnapshotStatusId}

Artifact Data Groups

The resource is used to view data artifact groups. The resource stores information about data contracts and data profiles that can be used by tools such as rules. A data profile is a group of data artifacts. A data contract provides a predefined interface with which a tool, such as rules, can interact with for a transaction.

Get all artifact groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups
Get an artifact group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}

Artifact Data Groups/Artifact Group Details

The resource is used to view artifact group resources.

Get all artifact group details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupDetails
Get an artifact group detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupDetails/{ArtifactGroupDetailId}

Artifact Data Groups/Artifact Group Details/Artifact Element Relations

The resource is used to view the artifact element relations. For example, an artifact element can be a REST resource and this element has related child resources.

Get all relations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupDetails/{ArtifactGroupDetailId}/child/artifactRelations
Get an artifact relation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupDetails/{ArtifactGroupDetailId}/child/artifactRelations/{ArtifactRelationId}

Artifact Data Groups/Artifact Group Details/Artifact Element Relations/Artifact Element Attributes

The resource is used to view data artifact element attributes. The attributes could be, for example, curriculum ID and curriculum name.

Get all element attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupDetails/{ArtifactGroupDetailId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementAttributes
Get an element attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupDetails/{ArtifactGroupDetailId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementAttributes/{AttributeId}

Artifact Data Groups/Artifact Group Details/Artifact Element Relations/Artifact Element Attributes/Large Object (LOB) Attributes - DefaultValueJSON

Delete a DefaultValueJSON: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupDetails/{ArtifactGroupDetailId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementAttributes/{AttributeId}/enclosure/DefaultValueJSON
Get a DefaultValueJSON: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupDetails/{ArtifactGroupDetailId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementAttributes/{AttributeId}/enclosure/DefaultValueJSON
Replace a DefaultValueJSON: Method: put
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupDetails/{ArtifactGroupDetailId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementAttributes/{AttributeId}/enclosure/DefaultValueJSON

Artifact Data Groups/Artifact Group Details/Artifact Element Relations/Artifact Element Properties

The resource is used to view data artifact element properties. The properties could be, for example, finders and actions.

Get all element properties: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupDetails/{ArtifactGroupDetailId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementProperties
Get an element property: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupDetails/{ArtifactGroupDetailId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementProperties/{PropertyId}

Artifact Data Groups/Artifact Group Processes

The resource is used to view artifact group processes.

Get all artifact group processes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupProcesses
Get an artifact group process: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactDataGroups/{ArtifactGroupId}/child/artifactGroupProcesses/{ArtifactGroupProcId}

Artifact Elements

The resource is used to view data artifact elements. A data artifact element can be a REST resource or variable. A data artifact element can be accessed by tools such as rules.

Get all artifact elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactElements
Get an artifact element: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactElements/{ElementId}

Artifact Elements/Artifact Element Attributes

The resource is used to view data artifact element attributes. The attributes could be, for example, curriculum ID and curriculum name.

Get all element attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactElements/{ElementId}/child/artifactElementAttributes
Get an element attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactElements/{ElementId}/child/artifactElementAttributes/{AttributeId}

Artifact Elements/Artifact Element Attributes/Large Object (LOB) Attributes - DefaultValueJSON

Delete a DefaultValueJSON: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/artifactElements/{ElementId}/child/artifactElementAttributes/{AttributeId}/enclosure/DefaultValueJSON
Get a DefaultValueJSON: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactElements/{ElementId}/child/artifactElementAttributes/{AttributeId}/enclosure/DefaultValueJSON
Replace a DefaultValueJSON: Method: put
Path: /fscmRestApi/resources/11.13.18.05/artifactElements/{ElementId}/child/artifactElementAttributes/{AttributeId}/enclosure/DefaultValueJSON

Artifact Elements/Artifact Element Properties

The resource is used to view data artifact element properties. The properties could be, for example, finders and actions.

Get all element properties: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactElements/{ElementId}/child/artifactElementProperties
Get an element property: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactElements/{ElementId}/child/artifactElementProperties/{PropertyId}

Artifact Resources

The resource is used to view data artifact resources. The resource stores information about a collection of REST resources and variables that can be used by tools such as rules.

Get all artifact resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactResources
Get an artifact resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}

Artifact Resources/Artifact Element Relations

The resource is used to view the artifact element relations. For example, an artifact element can be a REST resource and this element has related child resources.

Get all relations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}/child/artifactRelations
Get an artifact relation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}/child/artifactRelations/{ArtifactRelationId}

Artifact Resources/Artifact Element Relations/Artifact Element Attributes

The resource is used to view data artifact element attributes. The attributes could be, for example, curriculum ID and curriculum name.

Get all element attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementAttributes
Get an element attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementAttributes/{AttributeId}

Artifact Resources/Artifact Element Relations/Artifact Element Attributes/Large Object (LOB) Attributes - DefaultValueJSON

Delete a DefaultValueJSON: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementAttributes/{AttributeId}/enclosure/DefaultValueJSON
Get a DefaultValueJSON: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementAttributes/{AttributeId}/enclosure/DefaultValueJSON
Replace a DefaultValueJSON: Method: put
Path: /fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementAttributes/{AttributeId}/enclosure/DefaultValueJSON

Artifact Resources/Artifact Element Relations/Artifact Element Properties

The resource is used to view data artifact element properties. The properties could be, for example, finders and actions.

Get all element properties: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementProperties
Get an element property: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementProperties/{PropertyId}

Artifact Statements

The resource is used to view data artifact statements. The resource stores information about predefined statements that can be used by tools such as rules.

Get all artifact statements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactStatements
Get an artifact statement: Method: get
Path: /fscmRestApi/resources/11.13.18.05/artifactStatements/{StatementId}

Bills

The bills resource is a child of the student account resource and provides a list of bill numbers for a student account.

Get a bill: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentBills/{BillNumber}
Get all bills: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentBills

Bills/Large Object (LOB) Attributes - Report

Get a Report: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentBills/{BillNumber}/enclosure/Report

Business Objects

The business objects resource provides a list of secure business objects.

Get a business object: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedBusinessObjects/{ObjectId}
Get all business objects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedBusinessObjects

Business Objects/Business Objects

The data privileges resource provides a list of data security privileges granted to the data condition assigned to the data security profile assignee.

Get a data privilege: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedBusinessObjects/{ObjectId}/child/dataPrivileges/{PrivilegeId}
Get a security field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedBusinessObjects/{ObjectId}/child/securityFields/{PrivilegeId}
Get all data privileges: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedBusinessObjects/{ObjectId}/child/dataPrivileges
Get all security fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedBusinessObjects/{ObjectId}/child/securityFields

Business Rule Configurations

The resource is used to view business rule configurations.

Get a business rule configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleConfigurations/{ConfigurationId}
Get all business rule configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleConfigurations

Business Rule Definitions

The resource is used to view, create, modify, or delete business rule definitions.

Evaluate passed rule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/action/evaluateRuleJSON
Get a business rule definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}
Get all business rule definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions

Business Rule Definitions List of Values

The business rule definitions list of values resource is used to view a list of business rule definitions.

Get a business rule definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitionsLOV/{RuleId}
Get all business rule definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitionsLOV

Business Rule Definitions/Rule Tag Assignments

Rule tag assignments represent tags assigned to rules. For example, a tuition fee tag and an admissions application fee tag can be assigned to rules.

Get a tag assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTagAssignments/{TagAssignmentId}
Get all tag assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTagAssignments

Business Rule Definitions/Rule Test Cases

The resource is used to view, create, modify or delete rule test cases.

Get a rule test case: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}
Get all rule test cases: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases

Business Rule Definitions/Rule Test Cases/Large Object (LOB) Attributes - InputPayloadJSON

Delete an InputPayloadJSON: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/enclosure/InputPayloadJSON
Get an InputPayloadJSON: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/enclosure/InputPayloadJSON
Replace an InputPayloadJSON: Method: put
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/enclosure/InputPayloadJSON

Business Rule Definitions/Rule Test Cases/Rule Test Case Runs

The resource is used to view, create, modify or delete rule version test case run details.

Get a rule test case run details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}
Get all rule test cases run details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns

Business Rule Definitions/Rule Test Cases/Rule Test Case Runs/Large Object (LOB) Attributes - InputPayloadJSON

Delete an InputPayloadJSON: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/InputPayloadJSON
Get an InputPayloadJSON: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/InputPayloadJSON
Replace an InputPayloadJSON: Method: put
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/InputPayloadJSON

Business Rule Definitions/Rule Test Cases/Rule Test Case Runs/Large Object (LOB) Attributes - MessagesJSON

Delete a MessagesJSON: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/MessagesJSON
Get a MessagesJSON: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/MessagesJSON
Replace a MessagesJSON: Method: put
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/MessagesJSON

Business Rule Definitions/Rule Test Cases/Rule Test Case Runs/Large Object (LOB) Attributes - OutputPayloadJSON

Delete an OutputPayloadJSON: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/OutputPayloadJSON
Get an OutputPayloadJSON: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/OutputPayloadJSON
Replace an OutputPayloadJSON: Method: put
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/OutputPayloadJSON

Business Rule Definitions/Rule Test Cases/Rule Test Case Runs/Large Object (LOB) Attributes - RuleJSON

Get a RuleJSON: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/RuleJSON

Business Rule Definitions/Rule Test Cases/Rule Test Case Runs/Large Object (LOB) Attributes - TraceLogJSON

Delete a TraceLogJSON: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/TraceLogJSON
Get a TraceLogJSON: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/TraceLogJSON
Replace a TraceLogJSON: Method: put
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases/{RuleTestId}/child/ruleTestcaseRuns/{RuleTestRunId}/enclosure/TraceLogJSON

Business Rule Definitions/Rule Versions

The resource is used to view, create, modify, or delete rule versions.

Get a rule version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}
Get all rule versions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions

Business Rule Definitions/Rule Versions/Large Object (LOB) Attributes - RuleJSON

Delete a RuleJSON: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/enclosure/RuleJSON
Get a RuleJSON: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/enclosure/RuleJSON
Replace a RuleJSON: Method: put
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/enclosure/RuleJSON

Business Rule Definitions/Rule Versions/Rule Expressions

The resource is used to view rule expressions.

Get a rule expression: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/child/ruleExpressions/{RuleDetailId}
Get all rule expressions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/child/ruleExpressions

Business Rule Definitions/Rule Versions/Rule Variables

The resource is used to view, create, modify, or delete rule variables.

Get a rule variable: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/child/ruleVariables/{VariableId}
Get all rule variables: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/child/ruleVariables

Business Rule Definitions/Rule Versions/Rule Variables/Large Object (LOB) Attributes - DefaultValueJSON

Delete a DefaultValueJSON: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/child/ruleVariables/{VariableId}/enclosure/DefaultValueJSON
Get a DefaultValueJSON: Method: get
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/child/ruleVariables/{VariableId}/enclosure/DefaultValueJSON
Replace a DefaultValueJSON: Method: put
Path: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/child/ruleVariables/{VariableId}/enclosure/DefaultValueJSON

Campuses

The campuses resource is a child of the academic institutions resource and provides a complete list of campuses associated with an institution.

Create all campuses: Method: post
Path: /fscmRestApi/resources/11.13.18.05/campuses
Delete a campus: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}
Get a campus: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}
Get all campuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campuses
Update a campus: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}

Campuses/Associated Academic Entities

The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.

Create all associated entities: Method: post
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/associatedEntities
Delete an associated entity: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/associatedEntities/{EntityAssociationId}
Get all associated entities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/associatedEntities
Get an associated entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/associatedEntities/{EntityAssociationId}
Update an associated entity: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/associatedEntities/{EntityAssociationId}

Campuses/Contacts

The contacts resource is used to view all associated contacts.

Create a contact association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/contacts
Delete a contact association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/contacts/{ContactAssociationId}
Get all associated contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/contacts
Get an associated contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/contacts/{ContactAssociationId}
Update a contact association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/contacts/{ContactAssociationId}

Campuses/Identifiers

The identifiers resource is used to view all associated identifiers.

Create an identifier association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/identifiers
Delete an identifier association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/identifiers/{IdentifierAssociationId}
Get all associated identifiers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/identifiers
Get an associated identifier: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/identifiers/{IdentifierAssociationId}
Update an identifier association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/identifiers/{IdentifierAssociationId}

Campuses/Locations

The locations resource shows all associated locations.

Create a location association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/locations/{LocationAssociationId}
Create all location associations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/locations
Delete a location association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/locations/{LocationAssociationId}
Get a location association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/locations/{LocationAssociationId}
Get all location associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campuses/{CampusId}/child/locations

Carts

Use the carts resource to view, create, or modify shopping carts available for users.

Create a cart: Method: post
Path: /fscmRestApi/resources/11.13.18.05/carts
Delete a cart: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}
Get a cart as logged-in user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}
Get all carts as administrator: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts
Update a cart: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}

Carts/Miscellaneous Fee Items

The miscellaneous fee items resource provides a list of miscellaneous fee items present in the cart.

Create a miscellaneous fee: Method: post
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/miscellaneousFeeItems
Delete a miscellaneous fee: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/miscellaneousFeeItems/{CartDetailId}
Get a miscellaneous fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/miscellaneousFeeItems/{CartDetailId}
Get all miscellaneous fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/miscellaneousFeeItems

Carts/Miscellaneous Fee Items/Miscellaneous Discounts

The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.

Get a miscellaneous fee discount: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/miscellaneousFeeItems/{CartDetailId}/child/miscDiscounts/{miscDiscountsUniqID}
Get all miscellaneous fee discounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/miscellaneousFeeItems/{CartDetailId}/child/miscDiscounts

Carts/Scheduled Course Items

The scheduled course items resource provides a list of scheduled course items present in the cart.

Create a scheduled course item: Method: post
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems
Delete a scheduled course item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}
Get a scheduled course item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}
Get all scheduled course items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems
Update a scheduled course item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}

Carts/Scheduled Course Items/Course Fees

The course fees resource provides a list of fees associated with a course.

Get a course fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseFees/{courseFeesUniqID}
Get all course fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseFees

Carts/Scheduled Course Items/Course Fees/Course Discounts

The course discounts resource provides a list of discounts associated with a course.

Get a course discount: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseFees/{courseFeesUniqID}/child/courseDiscounts/{courseDiscountsUniqID}
Get all course discounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseFees/{courseFeesUniqID}/child/courseDiscounts

Carts/Scheduled Course Items/Course Requisites

The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course.

Get a course requisite: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseRequisites/{courseRequisitesUniqID}
Get all course requisites: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseRequisites

Carts/Scheduled Course Items/Scheduled Course Fees

The scheduled course fees resource provides a list of fees associated with a scheduled course.

Get a scheduled course fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourseFees/{scheduledCourseFeesUniqID}
Get all scheduled course fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourseFees

Carts/Scheduled Course Items/Scheduled Course Fees/Scheduled Course Discounts

The scheduled course discounts resource provides a list of discounts associated with a scheduled course.

Get a scheduled course discount: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourseFees/{scheduledCourseFeesUniqID}/child/scheduledCourseDiscounts/{scheduledCourseDiscountsUniqID}
Get all scheduled course discounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourseFees/{scheduledCourseFeesUniqID}/child/scheduledCourseDiscounts

Carts/Scheduled Course Items/Scheduled Courses

The scheduled courses resource provides a list of scheduled courses offered by institutions.

Get a scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}
Get all scheduled courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses

Carts/Scheduled Course Items/Scheduled Courses/Meeting Patterns

The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.

Get a meeting pattern: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns/{meetingPatternsUniqID}
Get all meeting patterns: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns

Carts/Scheduled Course Items/Scheduled Courses/Offering Organization Staff

The offering organization staff resource is a child of the scheduled courses resource and provides a list of staff associated with a scheduled course.

Get all offering organization staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff
Get an offering organization staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}

Carts/Scheduled Course Items/Scheduled Courses/Offering Organization Staff/Large Object (LOB) Attributes - PersonImageContent

Get a PersonImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}/enclosure/PersonImageContent

Carts/Scheduled Course Items/Validation Messages

The validation messages resource provides a list of validation messages associated with a cart.

Get a validation message: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/validationMessages/{MessageId}
Get all validation messages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/validationMessages

Change Workflow States

The change workflow states resource modifies the state of workflow instances based on data provided in the payload attribute.

Get a workflow state change: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStateChanges/{WorkflowStateChangeId}
Get all workflow state changes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStateChanges

Checklist Assignments

The higher education checklist assignments resource provides a list of checklist assignments assigned to the user.

Create a checklist assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistAssignments
Get a checklist assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistAssignments/{hedChecklistAssignmentsUniqID}
Get all checklist assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistAssignments
Update a checklist assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistAssignments/{hedChecklistAssignmentsUniqID}

Checklist Assignments/Checklist Task Assignments

The HED checklist task assignments resource is a child of the HED checklist assignments resource and provides a complete list of tasks assigned to a checklist of assignments.

Create a checklist task assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistAssignments/{hedChecklistAssignmentsUniqID}/child/checklistTaskAssignments
Get a checklist task assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistAssignments/{hedChecklistAssignmentsUniqID}/child/checklistTaskAssignments/{TaskAssignmentId}
Get all checklist task assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistAssignments/{hedChecklistAssignmentsUniqID}/child/checklistTaskAssignments
Update a checklist task assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistAssignments/{hedChecklistAssignmentsUniqID}/child/checklistTaskAssignments/{TaskAssignmentId}

Communication Histories

The communication histories resource provides the list of communication messages that were sent. An entry to this resource can be an email that the application sends to a student, to confirm enrollment in a scheduled course.

Create a communication record: Method: post
Path: /fscmRestApi/resources/11.13.18.05/communicationHistories
Get a communication history: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationHistories/{CommHistoryId}
Get all communication histories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationHistories
Process communication records: Method: post
Path: /fscmRestApi/resources/11.13.18.05/communicationHistories/action/processCommunications
Update a communication record: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/communicationHistories/{CommHistoryId}

Communication Histories/Large Object (LOB) Attributes - TrackingMessageText

Delete a TrackingMessageText: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/communicationHistories/{CommHistoryId}/enclosure/TrackingMessageText
Get a TrackingMessageText: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationHistories/{CommHistoryId}/enclosure/TrackingMessageText
Replace a TrackingMessageText: Method: put
Path: /fscmRestApi/resources/11.13.18.05/communicationHistories/{CommHistoryId}/enclosure/TrackingMessageText

Communication Responses

The communication responses resource is used to view or update the information regarding recipient response for a communication.

Get a communication response row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationResponses/{ResponseToken}
Get all communication responses rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationResponses
Update a communication response row: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/communicationResponses/{ResponseToken}

Communication Setups

The communication setups resource provides a list of setups for creating and sending communication messages. An example of a communication message is an email that the application sends to a student to confirm enrollment in a scheduled course.

Create a communication setup: Method: post
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups
Delete a communication setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}
Get a communication setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}
Get all communication setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups
Update a communication setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}

Communication Setups/Communication Email Setups

The communication email setups resource provides a list of setups for creating and sending communication email messages.

Create a communication email setup: Method: post
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEmailSetup
Delete a communication email setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEmailSetup/{EmailSetupId}
Get a communication email setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEmailSetup/{EmailSetupId}
Get all communication email setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEmailSetup
Update a communication email setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEmailSetup/{EmailSetupId}

Communication Setups/Communication Event Mapping

The communication event mapping resource provides the list of events mapped with communications. For example, an admissions application submission event could be mapped to a communication sent to notify the applicants that their applications were submitted.

Create a communication event mapping: Method: post
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEventMappings
Delete a communication event mapping: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEventMappings/{CommEventId}
Get a communication event mapping: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEventMappings/{CommEventId}
Get all communication event mappings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEventMappings

Communication Template Setups

Communication setups provides a list of communication templates for creating and sending communications. An example of a communication is an email that the application sends to a student to confirm enrollment in a scheduled course.

Create a communication setup: Method: post
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups
Delete a communication setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}
Get a communication setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}
Get all communication setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups
Update a communication setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}

Communication Template Setups/Communication Categories

The communication categories resource lists all the categories a communication is mapped to.

Create a communication and category mapping: Method: post
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/mappedCommCategories
Delete a communication and category mapping: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/mappedCommCategories/{CommCategoryId}
Get a communication and category mapping: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/mappedCommCategories/{CommCategoryId}
Get all communication and category mappings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/mappedCommCategories

Communication Template Setups/Communication Channel Setups

The list of channels that are supported by the communication template.

Create a communication channel: Method: post
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels
Delete a communication channel: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels/{CommChannelId}
Get a communication channel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels/{CommChannelId}
Get all communication channels: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels

Communication Template Setups/Communication Channel Setups/Communication Content Properties

The properties for a communication that hold information about the communication template for specific channels. For example, information for From, Reply to, and Subject.

Create a Property for a communication channel: Method: post
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels/{CommChannelId}/child/commContentProperties
Delete a communication channel property: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels/{CommChannelId}/child/commContentProperties/{PropertyId}
Get a property for a communication channel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels/{CommChannelId}/child/commContentProperties/{PropertyId}
Get all communication channel properties: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels/{CommChannelId}/child/commContentProperties
Update a communication channel property: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels/{CommChannelId}/child/commContentProperties/{PropertyId}

Communication Template Setups/Communication Channel Setups/Communication Content Properties/Large Object (LOB) Attributes - PropertyLongValue

Delete a PropertyLongValue: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels/{CommChannelId}/child/commContentProperties/{PropertyId}/enclosure/PropertyLongValue
Get a PropertyLongValue: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels/{CommChannelId}/child/commContentProperties/{PropertyId}/enclosure/PropertyLongValue
Replace a PropertyLongValue: Method: put
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels/{CommChannelId}/child/commContentProperties/{PropertyId}/enclosure/PropertyLongValue

Communication Template Setups/Communication Event Mappings

The list of events mapped to a communication. For example, Proxy Added event is mapped with a communication.

Create a communication event mapping: Method: post
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings
Delete a communication event mapping: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings/{CommEventId}
Get a single communication event mapping: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings/{CommEventId}
Get all communication and event mappings.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings
Get all communication and event mappings.: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings/{CommEventId}

Communication Template Setups/Communication Event Mappings/Communication Scheduler

The list of schedules for a specific communication template in relation to an event.

Create a communication schedule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings/{CommEventId}/child/commSchedulers
Delete a communication schedule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings/{CommEventId}/child/commSchedulers/{CommSchedulerId}
Get a communication schedule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings/{CommEventId}/child/commSchedulers/{CommSchedulerId}
Get all communication schedules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings/{CommEventId}/child/commSchedulers
Update a communication schedule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings/{CommEventId}/child/commSchedulers/{CommSchedulerId}

Communication Tokens

The communication tokens resource provides a list of tokens for a communication. A token is a placeholder for displaying a dynamic value at runtime.

Get a communication token: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTokens/{TokenId}
Get all communication tokens: Method: get
Path: /fscmRestApi/resources/11.13.18.05/communicationTokens

Course Lists

The course lists resource provides a collection of courses offered by institutions.

Create a course list: Method: post
Path: /fscmRestApi/resources/11.13.18.05/courseLists
Delete a course list: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}
Get a course list: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}
Get all course lists: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists
Update a course list: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}

Course Lists/Element Groups

The elements group resource is a child of the course lists resource and lists all the element groups associated with a course list.

Create an elements group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/groups
Delete an elements group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/groups/{GroupId}
Get all elements groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/groups
Get an elements group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/groups/{GroupId}
Update an elements group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/groups/{GroupId}

Course Lists/Elements

The elements resource is a child of the course lists resource and lists all the elements associated with a course list.

Create an element: Method: post
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements
Delete an element: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}
Get all elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements
Get an element: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}
Update an element: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}

Course Lists/Elements/Course Offerings

The course offerings resource is a child of the elements resource and lists all the offerings for the associated course element.

Get a course offering: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/courseOfferings/{courseOfferingsUniqID}
Get all course offerings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/courseOfferings

Course Lists/Elements/Smart Lists

The smart lists resource is a child of the elements resource and lists attributes of the smart list associated with the element.

Create a smart list: Method: post
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists
Delete a smart list: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}
Get a smart list: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}
Get all smart lists: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists
Update a smart list: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}

Course Lists/Elements/Smart Lists/Smart List Courses

The courses resource is a child resource of the smart list resource and lists the courses matching the smart list criteria.

Get a smart list course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/courses/{coursesUniqID}
Get all smart list courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/courses

Course Lists/Elements/Smart Lists/Smart List Courses/Smart List Course Campuses

The course campuses resource is a child resource of the smart list course resource and lists the campuses matching the smart list course.

Get a smart list course campus: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/courses/{coursesUniqID}/child/courseCampuses/{courseCampusesUniqID}
Get all smart list course campuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/courses/{coursesUniqID}/child/courseCampuses

Course Lists/Elements/Smart Lists/Smart List Courses/Smart List Course Curriculum Tags

The course tags resource is a child resource of the smart list course resource and lists the tags matching the smart list course.

Get a smart list course tag: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/courses/{coursesUniqID}/child/tags/{tagsUniqID}
Get all smart list course tags: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/courses/{coursesUniqID}/child/tags

Course Lists/Elements/Smart Lists/Smart List Courses/Smart List Course Organizations

The course organizations resource is a child resource of the smart list course resource and lists the organizations matching the smart list course.

Get a smart list course organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/courses/{coursesUniqID}/child/courseOrganizations/{courseOrganizationsUniqID}
Get all smart list course organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/courses/{coursesUniqID}/child/courseOrganizations

Course Lists/Elements/Smart Lists/Smart List Criteria Values

The smart list criteria values resource is a child resource of the smart lists resource and lists the criteria associated with the smart list.

Create a smart list criteria: Method: post
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/smartListCriteria
Delete a smart list criteria: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/smartListCriteria/{SmartlistCriteriaId}
Get a smart list criteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/smartListCriteria/{SmartlistCriteriaId}
Get all smart list criteria values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/smartListCriteria
Update a smart list criteria: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/smartListCriteria/{SmartlistCriteriaId}

Course Lists/Parameters

The parameters resource is a child of the course lists resource and lists all the parameters associated with a course list.

Create a parameter: Method: post
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/parameters
Delete a parameter: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/parameters/{ParameterId}
Get a parameter: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/parameters/{ParameterId}
Get all parameters: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/parameters
Update a parameter: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/parameters/{ParameterId}

Course Lists/Results

The results resource is a child of the course lists resource and lists all the results associated with a course list.

Create a result: Method: post
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/results
Delete a result: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/results/{resultsUniqID}
Get a result: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/results/{resultsUniqID}
Get all results: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/results
Update a result: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/results/{resultsUniqID}

Course Offerings

The course offerings resource provides a list of course offerings from institutions.

Get a course offering: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}
Get all course offerings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings

Course Offerings/Curriculum Tags

The curriculum tags resource is a child of the course offerings resource and provides a list of active curriculum tags as of the current date.

Get a curriculum tag: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/tags/{tagsUniqID}
Get all curriculum tags: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/tags

Course Offerings/Offering Academic Organizations

The offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering.

Get all offering academic organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations
Get an offering academic organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID}

Course Offerings/Offering Academic Organizations/Offering Organization Staff

The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a course offering.

Get all offering organization staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID}/child/offeringOrganizationStaff
Get an offering organization staff member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}

Course Offerings/Offering Academic Organizations/Offering Organization Staff/Large Object (LOB) Attributes - PersonImageContent

Get a PersonImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}/enclosure/PersonImageContent

Course Offerings/Offering Campuses

The offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.

Get all offering campuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/offeringCampuses
Get an offering campus: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/offeringCampuses/{offeringCampusesUniqID}

Course Offerings/Offering Result Sets

The offering result sets resource is a child of the course offerings resource and provides a list of result sets associated with a course offering.

Get all offering result sets: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/offeringResultSets
Get an offering result set: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/offeringResultSets/{offeringResultSetsUniqID}

Course Offerings/Scheduled Courses

The scheduled courses resource is a child of the course offerings resource and provides a list of scheduled instances of a course offering.

Get a scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}
Get all scheduled courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courseOfferings/{courseOfferingsUniqID}/child/scheduledCourses

Courses

The courses resource provides a list of courses offered by institutions.

Get a course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}
Get all courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses

Courses/Additional Information

The additional information resource is a child of the courses resource and provides a list of messages associated with a course.

Get all additional information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/additionalInformation
Get an additional information row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/additionalInformation/{additionalInformationUniqID}

Courses/Course Offerings

The course offerings resource is a child of the courses resource and provides a list of offerings for a course.

Get a course offering: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}
Get all course offerings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings

Courses/Course Offerings/Offering Academic Organizations

The offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering.

Get all offering academic organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations
Get an offering academic organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID}

Courses/Course Offerings/Offering Campuses

The offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.

Get all offering campuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/offeringCampuses
Get an offering campus: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/offeringCampuses/{offeringCampusesUniqID}

Courses/Course Offerings/Results

The results resource is a child of the course offerings resource and provides a list of result type and result set combinations associated with the course offering.

Get a result: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/results/{resultsUniqID}
Get all results: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/results

Courses/Course Offerings/Scheduled Courses

The scheduled courses resource is a child of the course offerings resource and provides a list of scheduled courses offered by institutions.

Get a scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}
Get all scheduled courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/scheduledCourses

Courses/Course Offerings/Scheduled Courses/Meeting Patterns

The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.

Get a meeting pattern: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns/{meetingPatternsUniqID}
Get all meeting patterns: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns

Courses/Course Offerings/Scheduled Courses/Offering Organization Staff

The offering organization staff resource is a child of the scheduled courses resource and provides a list of staff associated with a scheduled course.

Get all offering organization staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff
Get an offering organization staff member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}

Courses/Course Offerings/Scheduled Courses/Offering Organization Staff/Large Object (LOB) Attributes - PersonImageContent

Get a PersonImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}/enclosure/PersonImageContent

Courses/Course Offerings/Tags

The tags resource is a child of the courses resource and provides a list of tags associated with a course.

Get a tag: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/tags/{tagsUniqID}
Get all tags: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseOfferings/{courseOfferingsUniqID}/child/tags

Courses/Course Requisites

The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course.

Get a course requisite: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseRequisites/{courseRequisitesUniqID}
Get all course requisites: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/courseRequisites

Courses/Images

The images resource is a child of the courses resource and provides a list of image attachments associated with a course.

Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/images
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/images/{imagesUniqID}

Courses/Images/Large Object (LOB) Attributes - ImageContent

Delete an ImageContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Replace an ImageContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent

Courses/Offering Storefronts

The offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.

Get all offering storefronts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/offeringStorefronts
Get an offering storefront: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/offeringStorefronts/{offeringStorefrontsUniqID}

Courses/Staff Summaries

The staff summary resource is a child of the course resource and provides a unique list of all associated staff.

Get a staff member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/staffSummary/{staffSummaryUniqID}
Get all staff members: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/staffSummary

Courses/Tags

The tags resource is a child of the courses resource and provides a list of tags associated with a course.

Get a tag: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/tags/{tagsUniqID}
Get all tags: Method: get
Path: /fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}/child/tags

Curriculum Build Statuses

The curriculum build statuses resource provides a list of statuses that can be associated with a curriculum item.

Get a curriculum build status: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumBuildStatuses/{CurriculumBuildStatusId}
Get all curriculum build statuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumBuildStatuses

Curriculum Build Statuses/Curriculum Types

The curriculum types resource is a child of the curriculum build statuses resource and lists all the curriculum types that can use this curriculum build status.

Get a curriculum build status curriculum type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumBuildStatuses/{CurriculumBuildStatusId}/child/curriculumTypes/{CurriculumTypeBuildStatusId}
Get all curriculum build status curriculum types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumBuildStatuses/{CurriculumBuildStatusId}/child/curriculumTypes

Curriculum Items

The curriculum items resource provides a list of curriculum items offered in institutions.

Get a curriculum item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}
Get all curriculum items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems

Curriculum Items/Offering Storefronts

The offering storefronts resource is a child of the curriculum items resource and provides a list of offering storefronts associated with a curriculum item.

Get all offering storefronts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/offeringStorefronts
Get an offering storefront: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/offeringStorefronts/{offeringStorefrontsUniqID}

Curriculum Items/Programs

The program resource is a child of the curriculum items resource and provides the information for a program curriculum item.

Get a program: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}
Get all programs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program

Curriculum Items/Programs/Images

The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a unscheduled course offering.

Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/images
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/images/{imagesUniqID}

Curriculum Items/Programs/Images/Large Object (LOB) Attributes - ImageContent

Delete an ImageContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Replace an ImageContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent

Curriculum Items/Programs/Offering Campuses

The offering campuses resource is a child of the unscheduled course offering resource and provides a list of campuses associated with a unscheduled course offering.

Get all offering campuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/offeringCampuses
Get an offering campus: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/offeringCampuses/{offeringCampusesUniqID}

Curriculum Items/Programs/Offering Credentials

The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.

Get all offering credentials available for a program curriculum item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/offeringCredentials
Get an offering credential available for a program curriculum item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/offeringCredentials/{offeringCredentialsUniqID}

Curriculum Items/Programs/Parameters

The parameters resource is a child of the programs resource and provides a list of program parameters for a program.

Get a parameter available for a program curriculum item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/parameters/{parametersUniqID}
Get all parameters available for a program curriculum item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/parameters

Curriculum Items/Programs/Tags

The tags resource is a child of the unscheduled course offering resource and provides a list of tags associated with a unscheduled course offering.

Get a tag: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/tags/{tagsUniqID}
Get all tags: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/tags

Curriculum Items/Scheduled Courses

The scheduled course resource is a child of the curriculum items resource and provides the information for a scheduled course curriculum item.

Get a scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/scheduledCourse/{scheduledCourseUniqID}
Get all scheduled courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/scheduledCourse

Curriculum Items/Scheduled Courses/Images

The images resource is a child of the scheduled course resource and provides a list of image attachments associated with a scheduled course.

Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/scheduledCourse/{scheduledCourseUniqID}/child/images
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/scheduledCourse/{scheduledCourseUniqID}/child/images/{imagesUniqID}

Curriculum Items/Scheduled Courses/Images/Large Object (LOB) Attributes - ImageContent

Delete an ImageContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/scheduledCourse/{scheduledCourseUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/scheduledCourse/{scheduledCourseUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Replace an ImageContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/scheduledCourse/{scheduledCourseUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent

Curriculum Items/Scheduled Courses/Meeting Patterns

The meeting patterns resource is a child of the scheduled course resource and provides a list of meeting patterns associated with a scheduled course.

Get a meeting pattern: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/scheduledCourse/{scheduledCourseUniqID}/child/meetingPatterns/{meetingPatternsUniqID}
Get all meeting patterns: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/scheduledCourse/{scheduledCourseUniqID}/child/meetingPatterns

Curriculum Items/Unscheduled Course Offerings

The unscheduled course offering resource is a child of the curriculum items resource and provides the information for a course offering curriculum item.

Get all unscheduled course offerings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/unscheduledCourseOffering
Get an unscheduled course offering: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/unscheduledCourseOffering/{unscheduledCourseOfferingUniqID}

Curriculum Items/Unscheduled Course Offerings/Images

The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a unscheduled course offering.

Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/unscheduledCourseOffering/{unscheduledCourseOfferingUniqID}/child/images
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/unscheduledCourseOffering/{unscheduledCourseOfferingUniqID}/child/images/{imagesUniqID}

Curriculum Items/Unscheduled Course Offerings/Images/Large Object (LOB) Attributes - ImageContent

Delete an ImageContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/unscheduledCourseOffering/{unscheduledCourseOfferingUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/unscheduledCourseOffering/{unscheduledCourseOfferingUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Replace an ImageContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/unscheduledCourseOffering/{unscheduledCourseOfferingUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent

Curriculum Items/Unscheduled Course Offerings/Offering Campuses

The offering campuses resource is a child of the unscheduled course offering resource and provides a list of campuses associated with a unscheduled course offering.

Get all offering campuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/unscheduledCourseOffering/{unscheduledCourseOfferingUniqID}/child/offeringCampuses
Get an offering campus: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/unscheduledCourseOffering/{unscheduledCourseOfferingUniqID}/child/offeringCampuses/{offeringCampusesUniqID}

Curriculum Items/Unscheduled Course Offerings/Tags

The tags resource is a child of the unscheduled course offering resource and provides a list of tags associated with a unscheduled course offering.

Get a tag: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/unscheduledCourseOffering/{unscheduledCourseOfferingUniqID}/child/tags/{tagsUniqID}
Get all tags: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/unscheduledCourseOffering/{unscheduledCourseOfferingUniqID}/child/tags

Curriculum Tags

The curriculum tags resource provides a list of active curriculum tags as of the current date.

Get a curriculum tag: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}
Get all curriculum tags: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags

Curriculum Tags/Curriculum Tag Values

The curriculum tag values resource is a child of the curriculum tags resource and provides a list of tag values for a curriculum tag.

Get a curriculum tag value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}
Get all curriculum tag values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues

Curriculum Tags/Curriculum Tag Values/Images

The images resource is a child of the curriculum tag values resource and provides a list of all image attachments for a curriculum tag value.

Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/images
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/images/{TagValueAttachmentId}

Curriculum Tags/Curriculum Tag Values/Images/Large Object (LOB) Attributes - ImageContent

Delete an ImageContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/images/{TagValueAttachmentId}/enclosure/ImageContent
Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/images/{TagValueAttachmentId}/enclosure/ImageContent
Replace an ImageContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/images/{TagValueAttachmentId}/enclosure/ImageContent

Curriculum Tags/Curriculum Tag Values/Tagged Courses

The tagged courses resource is a child of the curriculum tag values resource and provides a list of courses that are associated with a curriculum tag value.

Get a tagged course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/taggedCourses/{taggedCoursesUniqID}
Get all tagged courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/taggedCourses

Curriculum Tags/Curriculum Tag Values/Tagged Courses/Course Storefronts

The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a course.

Get all offering storefronts for a course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/taggedCourses/{taggedCoursesUniqID}/child/courseStorefronts
Get an offering storefront for a course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/taggedCourses/{taggedCoursesUniqID}/child/courseStorefronts/{courseStorefrontsUniqID}

Curriculum Tags/Curriculum Tag Values/Tagged Programs

The tagged programs resource is a child of the curriculum tag values resource and provides a list of programs that are associated with a curriculum tag value.

Get a tagged program: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/taggedPrograms/{taggedProgramsUniqID}
Get all tagged programs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/taggedPrograms

Curriculum Tags/Curriculum Tag Values/Tagged Programs/Program Storefronts

The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.

Get all offering storefronts for a program: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/taggedPrograms/{taggedProgramsUniqID}/child/programStorefronts
Get an offering storefront for a program: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}/child/curriculumTagValues/{CurriculumTagValueId}/child/taggedPrograms/{taggedProgramsUniqID}/child/programStorefronts/{programStorefrontsUniqID}

Curriculum Types

The curriculum types resource provides a complete list of predefined academic curriculum types.

Get a curriculum type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTypes/{CurriculumTypeId}
Get all curriculum types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTypes

Data Loader Rules

The data loader rules resource is used to view the rule associated with a loaded file's field. The rule can represent a single validation applied to a file's field. A rule can also represent a transformation applied to a file's field. You can only have one rule for each type of a field.

Get a data loader rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderRules/{LoaderRuleId}
Get all data loader rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderRules

Data Loader Rules/Data Loader Rule Parameters

The data loader rule parameters resource is used to view additional data required by a rule to fulfill its function. You can have one or more parameters that are associated with a rule.

Get a data loader rule parameter: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderRules/{LoaderRuleId}/child/ruleParameters/{LoaderRuleParameterId}
Get all data loader rule parameters: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderRules/{LoaderRuleId}/child/ruleParameters

Data Loader Settings

Use the data loader resource to view, create, or modify settings for importing external data into Oracle Student Management Cloud.

Create a data loader setting: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderSettings
Delete a data loader setting: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderSettings/{dataLoaderSettingsUniqID}
Delete a staging header: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingHeaders/{LoadRequestId}
Get a data loader setting: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderSettings/{dataLoaderSettingsUniqID}
Get a staging header: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingHeaders/{LoadRequestId}
Get all data loader settings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderSettings
Get all staging headers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingHeaders
Update a data loader setting: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderSettings/{dataLoaderSettingsUniqID}
Update a staging header: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingHeaders/{LoadRequestId}

Data Loader Settings/Data Loader Mappings

Use the data loader mappings resource to view, create, or modify the mapping information. This mapping information indicates how data coming in from the external file should be mapped to the interface and production application tables.

Create a data loader mapping: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderSettings/{dataLoaderSettingsUniqID}/child/dataLoaderMappings
Delete a data loader mapping: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderSettings/{dataLoaderSettingsUniqID}/child/dataLoaderMappings/{LoaderMapId}
Get a data loader mapping: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderSettings/{dataLoaderSettingsUniqID}/child/dataLoaderMappings/{LoaderMapId}
Get all data loader mappings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderSettings/{dataLoaderSettingsUniqID}/child/dataLoaderMappings
Update a data loader mapping: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderSettings/{dataLoaderSettingsUniqID}/child/dataLoaderMappings/{LoaderMapId}

Data Loader Settings/Data Loader Statistics

Use the data loader statistics resource to view the statistics of the data import process.

Get all data loader statistic data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingHeaders/{LoadRequestId}/child/statistics
Get data loader statistic data: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingHeaders/{LoadRequestId}/child/statistics/{LoadStatisticsId}

Data Loader Staging Data Rows

Use the data loader staging data rows resource to view, modify, or delete imported data stored temporarily in interface tables. Later on, this staged data in interface tables is posted to target application tables.

Delete a staging data row: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}
Get a staging data row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}
Get all staging data rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData
Retrieve the duplicate row: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}/action/retrieveDuplicateRow
Update a staging data row: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}

Data Loader Staging Data Rows/Data Loader Staging Data Changes

Use the data loader staging data changes resource to retrieve the changes of the particular data loader staging data rows.

Get a data change: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}/child/dataChanges/{LoadChangeId}
Get all data changes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}/child/dataChanges
Update a data change: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}/child/dataChanges/{LoadChangeId}

Data Loader Staging Data Rows/Data Loader Staging Data Changes/Data Loader Staging Messages

Use the data loader staging messages resource to retrieve the messages of the particular data loader staging data field.

Get a text message: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}/child/dataChanges/{LoadChangeId}/child/messages/{LoadMessageId}
Get all text messages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}/child/dataChanges/{LoadChangeId}/child/messages

Data Loader Staging Data Rows/Data Loader Staging Row Messages

Use the data loader staging row messages resource to retrieve the messages of the particular data loader staging data row

Get a row message: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}/child/rowMessages/{LoadMessageId}
Get all row messages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}/child/rowMessages

Data Security Profile Assignments

The data security profile assignments resource provides a list of data security profiles to assignees.

Create a data security profile assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments
Delete a data security profile assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}
Get a data security profile assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}
Get all data security profile assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments
Update a data security profile assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}

Data Security Profile Assignments/Data Conditions

The data conditions resource provides a list of values that define the data condition assigned to the data security profile assignee (either a role or a user).

Create a data condition grant: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions
Delete a data condition grant: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}
Get a data condition grant: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}
Get all data condition grants: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions
Update a data condition grant: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}

Data Security Profile Assignments/Data Conditions/Data Privileges

The data privileges resource provides a list of data security privileges available to be granted to the data condition assigned for the associated business object.

Create a data privilege grant: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}/child/dataPrivileges
Delete a data privilege grant: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}/child/dataPrivileges/{PrivilegeGrantId}
Get a data privilege grant: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}/child/dataPrivileges/{PrivilegeGrantId}
Get all data privilege grants: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}/child/dataPrivileges
Update a data privilege grant: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}/child/dataPrivileges/{PrivilegeGrantId}

Data Security Profile Role Group Assignments

The data security profile role group assignments resource is used to create, view, and modify the data security profiles for a role group assignment. The data security profile role group assignment will assign the data security profile to all the roles within a role group.

Create a data security profile assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments
Delete a data security profile assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}
Get a data security profile assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}
Get all data security profile assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments
Update a data security profile assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}

Data Security Profile Role Group Assignments/Data Conditions

The data conditions resource is used to create, view, and modify the list of values that define the data condition assigned to a data security profile role group assignee.

Create a data condition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions
Delete a data condition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}
Get a data condition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}
Get all data conditions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions
Update a data condition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}

Data Security Profile Role Group Assignments/Data Conditions/Data Privileges

The data privileges resource is used to create, view, and modify the data security privileges for a data condition.

Create a data privilege grant: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}/child/dataPrivileges
Delete a data privilege grant: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}/child/dataPrivileges/{PrivilegeGrantId}
Get a data privilege grant: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}/child/dataPrivileges/{PrivilegeGrantId}
Get all data privilege grants: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}/child/dataPrivileges
Update a data privilege grant: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}/child/dataPrivileges/{PrivilegeGrantId}

Data Security Profiles

The data security profiles resource provides a complete list of security profile definitions that document the specific combination of the valid fields used to secure a business object.

Create a new data security profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles
Delete a data security profile: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles/{ProfileId}
Get a data security profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles/{ProfileId}
Get all data security profiles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles
Update a data security profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles/{ProfileId}

Data Security Profiles/Profile Fields

The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile.

Create a new data profile: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles/{ProfileId}/child/profileFields
Delete a profile field: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles/{ProfileId}/child/profileFields/{ProfileFieldId}
Get a profile field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles/{ProfileId}/child/profileFields/{ProfileFieldId}
Get all profile fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles/{ProfileId}/child/profileFields
Update a profile field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles/{ProfileId}/child/profileFields/{ProfileFieldId}

Data Selection Tool Consumers

The data selection tool consumers resource provides a list of consumers that are using the data selection tool. For example, a consumer can be a process that's using this tool to select data.

Get a consumer row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterConsumers/{ConsumerId}
Get all consumer rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterConsumers

Data Selection Tool Consumers/Data Selection Tool Consumer Profile Mappings

The data selection tool consumer profile mappings resource provides a list of artifact data profiles mapped to a data selection tool consumer.

Get a consumer profile mapping row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterConsumers/{ConsumerId}/child/dataGetterConsumerProfileMappings/{ConsumerProfileMappingId}
Get all consumer profile mapping rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterConsumers/{ConsumerId}/child/dataGetterConsumerProfileMappings

Data Selection Tool Consumers/Data Selection Tool Consumer Tool Mappings

The data selection tool consumer tool mappings resource provides a list of selection tools mapped for a data selection tool consumer.

Get a consumer tool mapping row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterConsumers/{ConsumerId}/child/dataGetterConsumerToolMappings/{ConsumerToolMappingId}
Get all consumer tool mapping rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterConsumers/{ConsumerId}/child/dataGetterConsumerToolMappings

Data Selection Tool Queries

Use the data selection tool queries resource to view, create, modify, or delete queries in data selection tool. Processes can use data selection tool to fetch data and the tool uses queries to fetch data. This resource stores the queries created by users.

Create a data selection query: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries
Delete a data selection query: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}
Execute query and get data: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/action/getQueryData
Get a data selection query: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}
Get all data selection queries: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries
Update a data selection query: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}

Data Selection Tool Queries/Data Selection Tool Query Elements

Use the data selection tool query elements resource to view, create, modify, or delete query elements in data selection tool. This resource stores the elements of a query.

Create a data selection query element: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterQueryElements
Delete a data selection query element: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterQueryElements/{QueryElementId}
Get a data selection query element: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterQueryElements/{QueryElementId}
Get all data selection query elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterQueryElements
Update a data selection query element: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterQueryElements/{QueryElementId}

Data Selection Tool Queries/Data Selection Tool Query Tag Assignments

Use the data selection tool query tag assignments resource to view, create, modify, or delete data selection tool query tag assignments.

Create a tag assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/queryTagAssignments
Delete a tag assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/queryTagAssignments/{TagAssignmentId}
Get a tag assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/queryTagAssignments/{TagAssignmentId}
Get all tag assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/queryTagAssignments
Update a tag assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/queryTagAssignments/{TagAssignmentId}

Data Selection Tool Queries/Data Selection Tool Subquery Usages

Use the data selection tool subquery usages resource to view subquery usage information of a main query in data selection tool.

Get a data selection tool subquery usage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterSubQueryUsages/{dataGetterSubQueryUsagesUniqID}
Get all data selection tool subquery usages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterSubQueryUsages

Data Selection Tools

The data selection tools resource provides a list of data selection tools that consumers can use to build data selection queries.

Get a data selection tool row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterSelectionTools/{SelectionToolId}
Get all data selection tool rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataGetterSelectionTools

Drop Scheme Settings

The drop scheme settings resource is used to manage drop or withdrawal settings.

Create all drop schemes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes
Delete a drop scheme: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}
Get a drop scheme: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}
Get all drop schemes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes
Update a drop scheme: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}

Drop Scheme Settings Assignments

The subjects resource provides a list of academic subjects taught in institutions.

Create all subjects: Method: post
Path: /fscmRestApi/resources/11.13.18.05/subjects
Delete a subject: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}
Get a subject: Method: get
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}
Get all subjects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/subjects
Update a subject: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}

Drop Scheme Settings Assignments/Drop Scheme Settings Assignments

The assignments resource provides a list of academic entities which have been assigned.

Create all assignments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}/child/assignments
Delete an assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}/child/assignments/{SettingsAssignmentId}
Get all assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}/child/assignments
Get an assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}/child/assignments/{SettingsAssignmentId}
Update an assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}/child/assignments/{SettingsAssignmentId}

Drop Scheme Settings Assignments/Subject Owners

The subject owners resource is a child of the subjects resource and provides a list of organizations that own a subject.

Create all subject owners: Method: post
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}/child/subjectOwners
Delete a subject owner: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}/child/subjectOwners/{subjectOwnersUniqID}
Get a subject owner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}/child/subjectOwners/{subjectOwnersUniqID}
Get all subject owners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}/child/subjectOwners
Update a subject owner: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}/child/subjectOwners/{subjectOwnersUniqID}

Drop Scheme Settings/Drop Scheme Settings Assignments

Drop scheme assignments represent the academic entities assigned to the drop scheme settings.

Create all assignments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments
Delete an assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments/{SettingsAssignmentId}
Get all assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments
Get an assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments/{SettingsAssignmentId}
Update an assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments/{SettingsAssignmentId}

Drop Scheme Settings/Drop Scheme Settings Assignments/Drop Scheme Settings Associated Assignments

The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.

Create all drop scheme entity academic level assignments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments/{SettingsAssignmentId}/child/associatedAssignments
Delete a drop scheme entity academic level assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments/{SettingsAssignmentId}/child/associatedAssignments/{AssociatedAssignmentId}
Get a drop scheme entity academic level assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments/{SettingsAssignmentId}/child/associatedAssignments/{AssociatedAssignmentId}
Get all drop scheme entity academic level assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments/{SettingsAssignmentId}/child/associatedAssignments
Update a drop scheme entity academic level assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments/{SettingsAssignmentId}/child/associatedAssignments/{AssociatedAssignmentId}

Drop Scheme Settings/Drop Scheme Types

The drop scheme types resource maps predefined drop types to predefined enrollment statuses.

Create all drop scheme types: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes
Delete a drop scheme type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes/{DropSchemeTypeId}
Get a drop scheme type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes/{DropSchemeTypeId}
Get all drop scheme types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes
Update a drop scheme type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes/{DropSchemeTypeId}

Drop Scheme Settings/Drop Scheme Types/Drop Scheme Type Results

The drop scheme type results resource maps penalty drop type to penalty result.

Create all drop scheme type results: Method: post
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes/{DropSchemeTypeId}/child/dropTypeResults
Delete a drop scheme type result: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes/{DropSchemeTypeId}/child/dropTypeResults/{dropTypeResultsUniqID}
Get a drop scheme type result: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes/{DropSchemeTypeId}/child/dropTypeResults/{dropTypeResultsUniqID}
Get all drop scheme type results: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes/{DropSchemeTypeId}/child/dropTypeResults
Update a drop scheme type result: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes/{DropSchemeTypeId}/child/dropTypeResults/{dropTypeResultsUniqID}

Entity Relationships

Use the entity relationships resource to view relationships between entities. An entity is a feature, such as business rules or workflow. If a workflow and a rule are referencing each other, and the workflow is using the rule, then the workflow is a consumer and the rule is a producer.

Get all entity relationship records: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedEntityRelationships
Get an entity relationship record: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedEntityRelationships/{ReferenceMappingId}

Evaluation Requests

Use the evaluation request resource to view, create, or modify information regarding evaluation requests. An example of an evaluation request is admission application evaluation request.

Create a workflow evaluation request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedEvaluationRequests
Get a workflow evaluation request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedEvaluationRequests/{hedEvaluationRequestsUniqID}
Get all workflow evaluation requests: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedEvaluationRequests
Update a workflow evaluation request: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedEvaluationRequests/{hedEvaluationRequestsUniqID}

Evaluation Requests/Evaluation Responses

Use the evaluation response resource to view, create, or modify information regarding evaluation responses.

Create an evaluation response: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedEvaluationRequests/{hedEvaluationRequestsUniqID}/child/EvaluationResponse
Delete an evaluation response: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedEvaluationRequests/{hedEvaluationRequestsUniqID}/child/EvaluationResponse/{EvaluationResponseId}
Get all evaluation responses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedEvaluationRequests/{hedEvaluationRequestsUniqID}/child/EvaluationResponse
Get an evaluation response: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedEvaluationRequests/{hedEvaluationRequestsUniqID}/child/EvaluationResponse/{EvaluationResponseId}
Update an evaluation response: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedEvaluationRequests/{hedEvaluationRequestsUniqID}/child/EvaluationResponse/{EvaluationResponseId}

Event Instance Subscribers

The event instance subscribers resource provides information about the subscribers related to triggered events. Examples of triggered events are Enrollment Drop and Refund Posted. Additionally, with the patch action the resource can be used for retrying an event delivery which had failed.

Calculate subscriber statistics: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventInstanceSubscribers/action/calculateSubscriberStatistics
Create an event instance subscriber: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventInstanceSubscribers
Get all event instance subscribers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventInstanceSubscribers
Get an event instance subscriber: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventInstanceSubscribers/{SubscriberStatusId}
Run instances of events again: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventInstanceSubscribers/action/retryEventInstances
Update an event instance subscriber: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/eventInstanceSubscribers/{SubscriberStatusId}

Event Instances

The event instances resource provides information about the event instances that have occurred. Examples of event instances are instances of Enrollment Drop and Refund Posted events.

Calculate events statistics: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventInstances/action/calculateEventStatistics
Create an event instance: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventInstances
Get all event instances: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventInstances
Get an event instance: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventInstances/{EventInstanceId}
Update an event instance: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/eventInstances/{EventInstanceId}

Event Instances/Large Object (LOB) Attributes - Payload

Delete a Payload: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/eventInstances/{EventInstanceId}/enclosure/Payload
Get a Payload: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventInstances/{EventInstanceId}/enclosure/Payload
Replace a Payload: Method: put
Path: /fscmRestApi/resources/11.13.18.05/eventInstances/{EventInstanceId}/enclosure/Payload

Event Setups

The event setups resource provides information about an event definition. For example, an event definition can exist for student enrollment event.

Create an event setup: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventSetups
Delete an event setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}
Get all event setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSetups
Get an event setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}
Update an event setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}

Event Setups/Event Categories

The event categories resource lists all the categories of an event.

Create an event category: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/mappedEventCategories
Delete an event category: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/mappedEventCategories/{CategoryEventMapId}
Get all event categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/mappedEventCategories
Get an event category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/mappedEventCategories/{CategoryEventMapId}

Event Setups/Event Subscribers

The event subscribers resource lists all the subscribers of an event. For example, communications is a subscriber for student enrollment event.

Create an event subscriber: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers
Delete an event subscriber: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers/{EventSubscriberId}
Get all event subscribers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers
Get an event subscriber: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers/{EventSubscriberId}
Update an event subscriber: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers/{EventSubscriberId}

Event Setups/Event Subscribers/Event Subscriber Timing Rules

The event subscriber timing rules resource provides information on the timing rules for the event subscriber trigger, in relation to the event date. For example, a timing rule could be 2 days before event date.

Create an event subscriber timing rule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers/{EventSubscriberId}/child/eventSubscriberTimingRules
Delete an event subscriber timing rule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers/{EventSubscriberId}/child/eventSubscriberTimingRules/{EventSubscrTimingRuleId}
Get all event subscriber timing rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers/{EventSubscriberId}/child/eventSubscriberTimingRules
Get an event subscriber timing rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers/{EventSubscriberId}/child/eventSubscriberTimingRules/{EventSubscrTimingRuleId}
Update an event subscriber timing rule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers/{EventSubscriberId}/child/eventSubscriberTimingRules/{EventSubscrTimingRuleId}

Event Setups/Large Object (LOB) Attributes - EventPayloadFormat

Delete an EventPayloadFormat: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/enclosure/EventPayloadFormat
Get an EventPayloadFormat: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/enclosure/EventPayloadFormat
Replace an EventPayloadFormat: Method: put
Path: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/enclosure/EventPayloadFormat

Event Subscriber Targets

The event subscriber targets resource provides information on the targets for the events. Each subscriber has its defined target information. A target provides more details and URL suffix information for event subscribers.

Create an event subscriber target: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets
Delete an event subscriber target: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets/{TargetId}
Get all event subscriber targets: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets
Get an event subscriber target: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets/{TargetId}
Update an event subscriber target: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets/{TargetId}
Validate subscriber end point: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets/action/validateEndpoint

Event Subscriber Targets/Event Setups

The event setups resource lists all the events associated with the target.

Create an event-subscriber mapping: Method: post
Path: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets/{TargetId}/child/eventSetups
Delete an event subscriber mapping: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets/{TargetId}/child/eventSetups/{EventSubscriberId}
Get all event setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets/{TargetId}/child/eventSetups
Get an event setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets/{TargetId}/child/eventSetups/{EventSubscriberId}

External Fund Credits

The external fund credits resource lists all student credits with a credit type of external fund.

Create an external fund credit: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds
Delete an external fund credit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds/{studentCreditExternalFundsUniqID}
Get all external fund credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds
Get an external fund credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds/{studentCreditExternalFundsUniqID}
Update an external fund credit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds/{studentCreditExternalFundsUniqID}

External Fund Credits/Period Overrides

The period overrides resource lists all the academic periods that are excluded from the external fund credits.

Create an academic period credit exception: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds/{studentCreditExternalFundsUniqID}/child/periodOverrides
Delete an academic period credit exception: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds/{studentCreditExternalFundsUniqID}/child/periodOverrides/{CreditPeriodId}
Get all academic period credit exceptions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds/{studentCreditExternalFundsUniqID}/child/periodOverrides
Get an academic period credit exception: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds/{studentCreditExternalFundsUniqID}/child/periodOverrides/{CreditPeriodId}
Update an academic period credit exception: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds/{studentCreditExternalFundsUniqID}/child/periodOverrides/{CreditPeriodId}

External Organizations

The external organizations resource provides a list of external organizations. Examples of external organizations include the previous schools of students.

Create an external organization: Method: post
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations
Create an external organization: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations
Delete an external organization: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}
Delete an external organization: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}
Get all external organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations
Get all external organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations
Get an external organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}
Get an external organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}
Update an external organization: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}
Update an external organization: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}

External Organizations/Addresses

The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.

Create an address: Method: post
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/addresses
Delete an address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/addresses/{addressesUniqID}
Get all addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/addresses
Get an address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/addresses/{addressesUniqID}
Update an address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/addresses/{addressesUniqID}

External Organizations/Contacts

The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.

Create a contact: Method: post
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/contacts
Create a contact association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/contacts
Delete a contact: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/contacts/{contactsUniqID}
Delete a contact association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/contacts/{ContactAssociationId}
Get a contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/contacts/{contactsUniqID}
Get all associated contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/contacts
Get all contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/contacts
Get an associated contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/contacts/{ContactAssociationId}
Update a contact: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/contacts/{contactsUniqID}
Update a contact association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/contacts/{ContactAssociationId}

External Organizations/External Courses

The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.

Create an external course: Method: post
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalCourses
Delete an external course: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalCourses/{ExternalCourseRowId}
Get all external courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalCourses
Get an external course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalCourses/{ExternalCourseRowId}
Update an external course: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalCourses/{ExternalCourseRowId}

External Organizations/External Organization History Names

The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.

Get all external organization history names: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/nameHistory
Get all external organization history names: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/nameHistory/{nameHistoryUniqID}

External Organizations/External Subjects

The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.

Create an external subject: Method: post
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalSubjects
Delete an external subject: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalSubjects/{ExternalSubjectId}
Get all external subjects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalSubjects
Get an external subject: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalSubjects/{ExternalSubjectId}
Update an external subject: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalSubjects/{ExternalSubjectId}

External Organizations/Identifiers

The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.

Create an identifier: Method: post
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/identifiers
Create an identifier association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/identifiers
Delete an identifier: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/identifiers/{IdentifierId}
Delete an identifier association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/identifiers/{IdentifierAssociationId}
Get all associated identifiers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/identifiers
Get all identifiers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/identifiers
Get an associated identifier: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/identifiers/{IdentifierAssociationId}
Get an identifier: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/identifiers/{IdentifierId}
Update an identifier: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/identifiers/{IdentifierId}
Update an identifier association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/identifiers/{IdentifierAssociationId}

External Organizations/Locations

The locations resource shows all associated locations.

Create a location association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/locations/{LocationAssociationId}
Create all location associations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/locations
Delete a location association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/locations/{LocationAssociationId}
Get a location association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/locations/{LocationAssociationId}
Get all location associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/locations

Fee Assessments

The fee assessment resource is used to calculate fees and post calculated fees.

Create fee assessments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedFeeAssessments
Get a fee assessment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedFeeAssessments/{SourceObjectId}
Get all fee assessments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedFeeAssessments

Fee Association Groups

The fee association groups resource stores information for the different types of fee associations.

Get a fee association group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociationGroups/{FeeAssociationGroupId}
Get all fee association groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociationGroups

Fee Association Groups/Fee Types

The fee types resource stores the fee types used in a fee association.

Get a fee type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociationGroups/{FeeAssociationGroupId}/child/feeTypes/{FeeAssociationGroupTypeId}
Get all fee types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociationGroups/{FeeAssociationGroupId}/child/feeTypes

Fee Associations

The fee associations setup resource is used to view, create, or modify fee association setup information. It stores the data that links fees to academic structures and other higher education data.

Create a fee association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations
Get a fee association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}
Get all fee associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations
Update a fee association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}

Fee Associations/Fee Association Fees

The fee association fees resource stores the fees used in a fee association.

Create a fee association fee: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFees
Delete a fee association fee: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFees/{FeeAssociationFeeId}
Get a fee association fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFees/{FeeAssociationFeeId}
Get all fee association fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFees
Update a fee association fee: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFees/{FeeAssociationFeeId}

Fee Associations/Fee Association Fees/Fee Association Attributes

The fee association attributes resource stores the attributes used for a fee in a fee association.

Create a fee association attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFees/{FeeAssociationFeeId}/child/feeAssociationAttributes
Delete a fee association attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFees/{FeeAssociationFeeId}/child/feeAssociationAttributes/{FeeAssociationAttributeId}
Get a fee association attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFees/{FeeAssociationFeeId}/child/feeAssociationAttributes/{FeeAssociationAttributeId}
Get all fee association attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFees/{FeeAssociationFeeId}/child/feeAssociationAttributes
Update a fee association attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFees/{FeeAssociationFeeId}/child/feeAssociationAttributes/{FeeAssociationAttributeId}

Fee Associations/Fee Associations Object

Fee association objects store information about objects like courses, programs, forms, transcripts, and so on, that are mapped to the fee association.

Delete a fee association object: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationObjects/{FeeAssociationObjectId}
Get a fee association object: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationObjects/{FeeAssociationObjectId}
Get all fee association objects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationObjects
Update a fee association object: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationObjects/{FeeAssociationObjectId}
Update or create a fee association object: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationObjects

Fee Discounts

The fee discounts resource is used to view, create, or modify discounts. It stores information about the discounts which are offered by an institution.

Create a discount: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeDiscounts
Delete a discount: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/feeDiscounts/{DiscountId}
Get a discount: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeDiscounts/{DiscountId}
Get all discounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeDiscounts
Update a discount: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/feeDiscounts/{DiscountId}

Fee Groups

The fee groups resource is used to view, create, or modify an institution's fee groups. It stores information about how fees are grouped: whether they're used in tuition calculation or payment application.

Create a fee group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeGroups
Delete a fee group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}
Get a fee group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}
Get all fee groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups
Update a fee group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}

Fee Groups/Fee Criteria

Criteria that determines fee attribute values that are used to dynamically retrieve fees into a list.

Create a fee criteria: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeCriterias
Delete a fee criteria: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeCriterias/{FeeGroupCriteriaId}
Get a fee criteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeCriterias/{FeeGroupCriteriaId}
Get all fee criteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeCriterias
Update a fee criteria: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeCriterias/{FeeGroupCriteriaId}

Fee Groups/Fee Details

The fee details resource is used to associate the fees with the fee group.

Create a fee detail: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeDetails
Delete a fee detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeDetails/{FeeDetailId}
Get a fee detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeDetails/{FeeDetailId}
Get all fee details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeDetails
Update a fee detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeDetails/{FeeDetailId}

Fee Groups/Fee Lists

Fees added to a list.

Create a fee list: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeLists
Delete a fee list: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeLists/{FeeGroupListId}
Get a fee list: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeLists/{FeeGroupListId}
Get all fee lists: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeLists
Update a fee list: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeLists/{FeeGroupListId}

Fee Groups/Grouping Structures

Fee group structures define the method in which fees are grouped in a list.

Create a fee list structure: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures
Delete a fee list structure: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures/{FeeGroupStructureId}
Get a fee list structure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures/{FeeGroupStructureId}
Get all fee list structures: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures
Update a fee list structure: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures/{FeeGroupStructureId}

Fee Groups/Grouping Structures/Structure Details

Details about the fee group structure, such as name and description.

Create a group structure detail: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures/{FeeGroupStructureId}/child/structureDetails
Delete a group structure detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures/{FeeGroupStructureId}/child/structureDetails/{StructureDetailId}
Get all group structure details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures/{FeeGroupStructureId}/child/structureDetails
Get group structure details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures/{FeeGroupStructureId}/child/structureDetails/{StructureDetailId}
Update a group structure detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures/{FeeGroupStructureId}/child/structureDetails/{StructureDetailId}

Fee Groups/Tag Assignments

Tags assigned to a fee list.

Create a tag assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/tagAssignments
Delete a tag assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/tagAssignments/{TagAssignmentId}
Get a tag assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/tagAssignments/{TagAssignmentId}
Get all tag assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/tagAssignments

Financial Mapping Attributes

The mapping attributes resource is used to view, create, or modify an institution's mapping attributes. It stores information about how the receipts can be allocated across academic periods.

Create a financial mapping attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialMappingAttributes
Delete a financial mapping attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/financialMappingAttributes/{MappingAttributeId}
Get a financial mapping attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialMappingAttributes/{MappingAttributeId}
Get all financial mapping attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialMappingAttributes
Update a financial mapping attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/financialMappingAttributes/{MappingAttributeId}

General Settings

The general settings resource is used to create, view, and modify the settings that are applicable across student management. General settings include age settings that define age limits across student management.

Create a setting: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedGeneralSettings
Get a setting: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedGeneralSettings/{SettingId}
Get all settings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedGeneralSettings
Update a setting: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedGeneralSettings/{SettingId}

General Task and Checklist Settings

The general settings resource is used to create, view and modify the settings that are applicable across all tasks and checklists.

Create a setting: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSettings
Get a setting: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSettings/{SettingId}
Get all settings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSettings
Update a setting: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSettings/{SettingId}

HED Checklist Setups

The higher education checklist setups resource provides a list of checklist setups.

Create a higher education checklist setups: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups
Delete a higher education checklist setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}
Get a higher education checklist setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}
Get all higher education checklist setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups
Update a higher education checklist setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}

HED Checklist Setups/Checklist Tags

The checklist tags provide a user with a complete list of tags assigned to a checklist.

Create a checklist tag assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/tagAssignments
Delete a checklist tag assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/tagAssignments/{TagAssignmentId}
Get a checklist tag assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/tagAssignments/{TagAssignmentId}
Get all checklist tags assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/tagAssignments
Update a checklist tag assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/tagAssignments/{TagAssignmentId}

HED Checklist Setups/HED Checklist Tasks

The HED checklist tasks resource is a child of the HED checklist setups resource and provides a complete list of tasks added to a checklist setup.

Create a higher education checklist task: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/checklistTasks
Delete a higher education checklist task: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/checklistTasks/{ChecklistTaskId}
Get a higher education checklist task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/checklistTasks/{ChecklistTaskId}
Get all higher education checklist tasks: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/checklistTasks
Update a higher education checklist task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/checklistTasks/{ChecklistTaskId}

HED Payments

The higher education payments resource offers generic payment processing options based on the payment option selected by the calling consumer.

Create a higher education payment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPayments
Delete a higher education payment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPayments/{PaymentId}
Get a single higher education payment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPayments/{PaymentId}
Get all higher education payments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPayments
Update a higher education payment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedPayments/{PaymentId}

HED Task Setups

The higher education task setups resource provides a list of task setups. Examples include Task to provide letter of recommendation or Task to submit certificates.

Create a higher education task setups: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSetups
Delete a higher education task setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSetups/{TaskId}
Get a higher education task setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSetups/{TaskId}
Get all higher education task setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSetups
Update a higher education task setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSetups/{TaskId}

HED Task Setups/Task Tags

The task tags provide a user with a complete list of tags assigned to a task.

Create a task tag assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSetups/{TaskId}/child/tagAssignments
Delete a task tag assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSetups/{TaskId}/child/tagAssignments/{TagAssignmentId}
Get a task tag assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSetups/{TaskId}/child/tagAssignments/{TagAssignmentId}
Get all task tags assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSetups/{TaskId}/child/tagAssignments
Update a task tag assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedTaskSetups/{TaskId}/child/tagAssignments/{TagAssignmentId}

Higher Education Customer Accounts

The higher education customer accounts resource checks if the customer account for a given user, either a proxy or student, exists. This resource also checks whether an active customer account relationship exists between the proxy and student. If neither customer account nor relationship exists, both are automatically created.

Create a higher education customer account: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedCustomerAccounts
Get all higher education customer accounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedCustomerAccounts
Get higher education customer account: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedCustomerAccounts/{PartyId}

Home Page Setups

The home page setups resource is used to define how widgets should display for a home page, and how they should function.

Create a home page setup definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups
Delete a home page setup definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}
Get a home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}
Get all home page setup definitions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups
Update a home page setup definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}

Home Page Setups/Roles

The roles resource is used to define the security roles that have access to a home page.

Create a role mapping to the home page setup definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/roles
Delete a role mapping to the home page setup definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/roles/{RoleMapId}
Get a role belonging to the home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/roles/{RoleMapId}
Get all roles belonging to the home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/roles

Home Page Setups/Zones

The zones resource is used to define where a widget is displayed on the home page.

Add a zone to the home page setup definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones
Delete a zone for the home page setup definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}
Get a zone belonging to the home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}
Get all zones belonging to the home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones
Update a zone for the home page setup definition: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}

Home Page Setups/Zones/Widgets

The widgets resource is used to define which widgets appear on a home page.

Create a widget within a home page setup zone: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets
Delete a widget within a home page setup zone: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}
Get a widget belonging to a zone of a home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}
Get all widgets belonging to a zone of a home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets
Update a widget within a home page setup zone: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}

Home Page Setups/Zones/Widgets/Widget Properties

The widget properties resource is used to define how a widget functions on a home page.

Create a property belonging to a widget of a home page setup definition: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}/child/widgetProperties
Delete a property belonging to a widget of a home page setup definition: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}/child/widgetProperties/{PageWidgetPropertyId}
Get a property belonging to a widget of a home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}/child/widgetProperties/{PageWidgetPropertyId}
Get all properties belonging to a widget of a home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}/child/widgetProperties
Update a property of a home page widget: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}/child/widgetProperties/{PageWidgetPropertyId}

Home Page Setups/Zones/Widgets/Widget Properties/Property Validations

The property validations resource is used to define how to validate a widget property.

Get a validation belonging to a property of a widget: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}/child/widgetProperties/{PageWidgetPropertyId}/child/propertyValidations/{PropertyValidationId}
Get all validations belonging to a property of a widget: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}/child/widgetProperties/{PageWidgetPropertyId}/child/propertyValidations

Home Page Widgets

The home page widgets resource is used to define the widgets that display on a home page.

Get a home page widget configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}
Get all available home page widget configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets
Update default attributes of a home page widget: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}

Home Page Widgets/Home Page Widget Properties

The home page widget properties resource is used to define how a widget functions on a default version of the home page.

Get a property belonging to a widget of a home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}/child/widgetProperties/{WidgetPropertyId}
Get all properties belonging to a widget of a home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}/child/widgetProperties
Update a property of a home page widget: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}/child/widgetProperties/{WidgetPropertyId}

Home Page Widgets/Home Page Widget Properties/Property Validations

The property validations resource is used to define how to validate a widget property.

Get a validation belonging to a property of a widget: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}/child/widgetProperties/{WidgetPropertyId}/child/propertyValidations/{PropertyValidationId}
Get all validations belonging to a property of a widget: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}/child/widgetProperties/{WidgetPropertyId}/child/propertyValidations

Home Page Widgets/Roles

The roles resource is used to define the security roles that have access to a widget.

Get a role belonging to the home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}/child/roles/{RoleMapId}
Get all roles belonging to the home page setup definition: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}/child/roles

List of Values/Academic Groups List of Values

The academic groups list of values resource is used to view a list academic groups. An academic group represents an entity at an educational institution that's responsible for offering and administering academic programs. It's used to create groupings of programs for both curriculum and student program management purposes.

Get all academic groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicGroupsLOV
Get an academic group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicGroupsLOV/{academicGroupsLOVUniqID}

List of Values/Academic Institutions List of Values

The academic institutions list of values resource is used to view a list of institutions. An academic institution is a representation of a college, university of some other type of educational institution. An institution typically has ownership and responsibility for its own curriculum offerings and students and the institution definition is used to convey ownership on these objects, as well as other high level configuration structures such as campuses and academic organizations.

Get all academic institutions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutionsLOV
Get an academic institution: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicInstitutionsLOV/{academicInstitutionsLOVUniqID}

List of Values/Academic Levels List of Values

The academic levels list of values resource is used to view a list academic levels. An academic level definition represents the educational level, such as undergraduate or graduate, of a curriculum offering. It's used to categorize programs and courses, as well as other curriculum items such as academic groups.

Get all academic levels: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicLevelsLOV
Get an academic level: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicLevelsLOV/{AcademicLevelId}

List of Values/Academic Organizations List of Values

The academic organizations list of values resource is used to view a list of academic organizations. An academic organization represents an entity at an academic institution that's charged with ownership and administration of a particular area of the curriculum. Examples include Chemistry Department or College of Letters and Science. It's used to signify control and ownership of courses, programs, and other curriculum items.

Get all academic organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizationsLOV
Get an academic organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicOrganizationsLOV/{academicOrganizationsLOVUniqID}

List of Values/Academic Periods List of Values

The academic periods list of values resource is used to view a list of academic periods. An academic period represents the period of time in which an educational institution offers its academic programs and courses. It could represent a timeline for a limited set of course offerings or the entire academic calendar for a semester or quarter. It's used for defining key academic dates such as admission and graduate dates and also for course scheduling.

Get all academic periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodsLOV
Get an academic period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/academicPeriodsLOV/{AcademicPeriodId}

List of Values/Administrative Service Indicators LOV

Administrative service indicators list of values.

Get a service indicator: Method: get
Path: /fscmRestApi/resources/11.13.18.05/administrativeServiceIndicatorSetupsLOV/{IndicatorId}
Get all service indicator types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/administrativeServiceIndicatorSetupsLOV

List of Values/Business Object Security Fields List of Values

The business object security fields list of values resource provides a list of fields that can be used to secure a business object.

Get a business object security field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedBusinessObjectSecurityFieldsLOV/{hedBusinessObjectSecurityFieldsLOVUniqID}
Get all business object security fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedBusinessObjectSecurityFieldsLOV

List of Values/Campuses List of Values

The campuses list of values resource is used to view a list of campuses. A campus represents an entity within an academic institution that's organized around a physical location, although a campus could also be virtual. An institution might have one or many campuses. It's used to indicate ownership and location of curriculum items such as programs, courses, and scheduled courses.

Get a campus: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campusesLOV/{campusesLOVUniqID}
Get all campuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/campusesLOV

List of Values/Charge Priority Mappings List of Values

The charge priority mapping list of values resource is used to find charge priority mapping attributes to associate to a student credit.

Get a charge priority mapping: Method: get
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappingsLOV/{ChargePriorityId}
Get all charge priority mappings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappingsLOV

List of Values/Courses List of Values

The courses list of values resource is used to view a list of courses. A course represents a plan or set of study sessions in a particular area or subject. A course encapsulates learning materials and requirements and can lead to some kind of formal outcome and credit. It's used to represent a unit of curriculum that's typically scheduled to meet at a place and time over a set number of weeks or term. Courses serve as the main components of a program.

Get a course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/coursesLOV/{coursesLOVUniqID}
Get all courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/coursesLOV

List of Values/Credit Types List of Values

The credit type list of values resource is used to find different credit types to associate with a credit setup.

Get a credit type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/creditTypesLOV/{CreditTypeId}
Get all credit types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/creditTypesLOV

List of Values/Current Curriculum Items List of Values

The current curriculum items list of values resource is used to view a list of current instances of the curriculum items like courses and programs.

Get a curriculum item current instance: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumCurrentItemsLOV/{CurriculumInstanceId}
Get all curriculum item current instances: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumCurrentItemsLOV

List of Values/Current Curriculum Items List of Values/Large Object (LOB) Attributes - CurriculumLongDescription

Delete a CurriculumLongDescription: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/curriculumCurrentItemsLOV/{CurriculumInstanceId}/enclosure/CurriculumLongDescription
Get a CurriculumLongDescription: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumCurrentItemsLOV/{CurriculumInstanceId}/enclosure/CurriculumLongDescription
Replace a CurriculumLongDescription: Method: put
Path: /fscmRestApi/resources/11.13.18.05/curriculumCurrentItemsLOV/{CurriculumInstanceId}/enclosure/CurriculumLongDescription

List of Values/Curriculum Tag Values List of Values

The curriculum tag values list of values resource provides a view of the values associated with a curriculum tag. Curriculum tags, which can be user defined or delivered by Oracle, are used to categorize or segment curriculum offerings for various purposes. Tag values are user defined codes that are associated with a curriculum tag.

Get a curriculum tag value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTagValuesLOV/{CurriculumTagValueId}
Get all curriculum tag values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/curriculumTagValuesLOV

List of Values/Customer Profile Classes List of Values

The customer profile classes list of values resource is used to find a customer profile class to associate to an academic business unit. Customer profile classes are assigned to customers through account creation for financial reconciliation.

Get a customer profile class: Method: get
Path: /fscmRestApi/resources/11.13.18.05/customerProfileClassesLOV/{customerProfileClassesLOVUniqID}
Get all customer profile classes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/customerProfileClassesLOV

List of Values/Discounts List of Values

The discount list of values returns a list of the available discounts in Student Management.

Get a discount: Method: get
Path: /fscmRestApi/resources/11.13.18.05/discountsLOV/{DiscountId}
Get all discounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/discountsLOV

List of Values/Due Date Calendars List of Values

The due date calendar LOV returns due date calendars.

Get a due date calendar: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dueDateCalendarsLOV/{DueDateCalendarId}
Get all due date calendars: Method: get
Path: /fscmRestApi/resources/11.13.18.05/dueDateCalendarsLOV

List of Values/Events Setup List of Values

The events setup list of values resource provides a smaller set of information about an event definition. An example of an event is a student enrollment.

Get all events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSetupsLOV
Get an event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventSetupsLOV/{EventId}

List of Values/External Organizations

The external organizations list of values resource is used to view Student Management external organizations. External organizations are used by Student Management to facilitate such things as third party payments, transfer credits, and admissions application processing.

Get all external organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizationsLOV
Get an external organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizationsLOV/{PartyId}

List of Values/External Organizations List of Values

The external organizations list of values resource provides a list of organizations that are external to the academic institution. Examples of external organizations include the previous schools of students.

Get all external organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizationsLOV
Get an external organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalOrganizationsLOV/{PartyId}

List of Values/Fee Groups List of Values

The fee group list of values resource is used to find fee groups to associate to a charge priority mapping.

Get a fee group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroupsLOV/{FeeGroupId}
Get all fee groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeGroupsLOV

List of Values/Fee Types List of Values

The fee type list of values resource is used to find the fee category.

Get a fee type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeTypesLOV/{FeeTypeId}
Get all fee types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feeTypesLOV

List of Values/Fees List of Values

The fee list of values resource is used to find fees to be associated to a fee group.

Get a fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feesLOV/{FeeId}
Get all fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/feesLOV

List of Values/Financials Business Units List of Values

The Financials business units list of values resource is used to view information on defined business units. A business unit is a unit of an enterprise that performs one or many business functions that can be rolled up in a management hierarchy and can process transactions on behalf of many legal entities.

Get all business units: Method: get
Path: /fscmRestApi/resources/11.13.18.05/finBusinessUnitsLOV

List of Values/Generic Lookups List of Values

The generic lookups list of values resource is used to query the list of values of lookups that belongs to a lookup view, such as standard lookups view or common lookups view. The ApplicationCode finder parameter determines which lookup view is referenced.

Get all generic lookups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

List of Values/HED Phone Country Codes List of Values

The higher education phone country codes resource provides a list of all the phone country codes set up.

Get a single higher education phone country code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPhoneCountryCodes/{PhoneCountryCodeId}
Get all higher education phone country codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPhoneCountryCodes

List of Values/HED Role Types List of Values

The role types LOV returns security role types.

Get a security role type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRoleTypesLOV/{RoleTypeId}
Get all security role types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRoleTypesLOV

List of Values/HED Territories

The higher education territories resource provides a list of all the territories set up.

Get a single higher education territory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTerritories/{TerritoryCode}
Get all higher education territories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTerritories

List of Values/HEQ Lookups

The HEQ lookups resource provides a list of lookup types and values defined in the Student Admissions application.

Get a lookup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/heqLookups/{heqLookupsUniqID}
Get all lookups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/heqLookups

List of Values/HER Lookups List of Values

The HER Lookups resource provides a view of all Student Records related lookup codes. Lookups are used to represent a set of codes and their translated meanings.

Get all HER Lookups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/herLookups
Get an HER Lookup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/herLookups/{herLookupsUniqID}

List of Values/HEY Lookups List of Values

The HEY lookups resource provides a list of lookup types and values defined in the Campus Community application.

Get a lookup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/heyLookups/{heyLookupsUniqID}
Get all lookups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/heyLookups

List of Values/Mapping Attributes List of Values

The mapping attribute list of values resource is used to find mapping attributes to associate to a charge priority mapping.

Get a financial mapping attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialMappingAttributesLOV/{MappingAttributeId}
Get all financial mapping attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialMappingAttributesLOV

List of Values/National Identifier Countries List of Values

This resource returns national identifier countries.

Get a country: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedNationalIdentifierCountriesLOV/{CountryCode}
Get all countries: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedNationalIdentifierCountriesLOV

List of Values/National Identifier Types List of Values

This resource returns national identifier types for a particular country name.

Get all identifier types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedNationalIdentifierTypesLOV
Get an identifier type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedNationalIdentifierTypesLOV/{NationalIdentifierTypeId}

List of Values/Page Permissions List of Values

The page permissions list of values resource is used to view a list of action permissions associated with a page element.

Get a page permission: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPagePermissionsLOV/{hedPagePermissionsLOVUniqID}
Get all page permissions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPagePermissionsLOV

List of Values/Payment Terms List of Values

The payment terms list of values resource is used to find the payment terms that can be associated with an academic business unit.

Get a payment term: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPaymentTermsLOV/{PaymentTermId}
Get all payment terms: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPaymentTermsLOV

List of Values/Period Attributes List of Values

The period attributes list of values resource is used to view a list of period attributes.

Get a period attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributesLOV/{PeriodAttributeId}
Get all period attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributesLOV

List of Values/Person Profile Lookups List of Values

The person profile lookups resource provides a list of lookup types and values defined for person profile.

Get a lookup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfileLookups/{personProfileLookupsUniqID}
Get all lookups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfileLookups

List of Values/Person Tag Names List of Values

Person tag names list of values.

Get a person tag name: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPersonTagNamesLOV/{PersonTagNameId}
Get all person tag names: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPersonTagNamesLOV

List of Values/Program Type List of Values

The program types list of values resource is used to view a list of program types. Program types can be assigned to programs.

Get a program type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProgramTypesLOV/{ProgramTypeId}
Get all program types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProgramTypesLOV

List of Values/Programs List of Values

The programs list of values resource is used to view a list of programs. A program represents a set of academic requirements, including courses, that typically lead to the award of a certification or credential. It's used to provide a container for course requirements and other program completion rules.

Get a program: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programsLOV/{programsLOVUniqID}
Get all programs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programsLOV

List of Values/Receipt Methods List of Values

The receipt method list of values resource is used to find receipt methods which you set up in Oracle Financials.

Get a receipt method: Method: get
Path: /fscmRestApi/resources/11.13.18.05/receiptMethodsLOV/{ReceiptMethodId}
Get all receipt methods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/receiptMethodsLOV

List of Values/Receivable Transactions List of Values

The receivable transactions list of values resource is used to find receivable activities that you set up in Oracle Financials Cloud.

Get a receivable transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentReceivableTransactionsLOV/{studentReceivableTransactionsLOVUniqID}
Get all receivable transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentReceivableTransactionsLOV

List of Values/Standard Lookups List of Values

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

Get all standard lookups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

List of Values/Standardized Test Setups List of Values

The standardized test setups list of values resource is used to manage the lookup for standardized test data security.

Get a standardized test setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetupsLOV/{StandardizedTestSetupId}
Get all standardized test setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetupsLOV

List of Values/Status Scheme Statuses List of Values

The status schemes statuses resource is used to map user-defined statuses to a status type within a status scheme.

Get a status scheme status: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemesStatusesLOV/{hedWorkflowStatusSchemesStatusesLOVUniqID}
Get all status scheme statuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemesStatusesLOV

List of Values/Status Schemes List of Values

The status schemes list of values resource is used to provide a list of available status schemes.

Get a status scheme: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemesLOV/{hedWorkflowStatusSchemesLOVUniqID}
Get all status schemes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemesLOV

List of Values/Storefronts List of Values

The storefronts list of values resource is used to view a list of storefronts. A storefront represents an externally facing view of an institution's curriculum offerings or a subset of those offerings. It's used to filter curriculum offerings.

Get a storefront: Method: get
Path: /fscmRestApi/resources/11.13.18.05/storefrontsLOV/{StorefrontId}
Get all storefronts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/storefrontsLOV

List of Values/Student Financial System Configurations List of Values

The student financial system configurations list of values provides a list of business units valid for Student Cloud.

Get a student financial system configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurationsLOV/{BusinessUnitId}
Get all student financial system configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurationsLOV

List of Values/Student Management Categories List of Values

The student management categories list of values resource is used to view categories. A student management category is a group of objects for shared features. An example of a shared feature is communications. An example of a category is an enrollment category.

Get a category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategoriesLOV/{CategoryId}
Get all categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategoriesLOV

List of Values/Student Management Lookup Types List of Values

List of lookup types and their meanings that are common for all cloud applications and those that are specific to student management.

Get a lookup type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedLookupTypesLOV/{hedLookupTypesLOVUniqID}
Get all lookup types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedLookupTypesLOV

List of Values/Student Memo Lines List of Values

The student memo lines list of values returns memo lines.

Get a memo line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentMemoLinesLOV/{MemoLineId}
Get all memo lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentMemoLinesLOV

List of Values/Student Transaction Types List of Values

The student transaction types list of values returns transaction types.

Get a transaction type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentTransactionTypesLOV/{TransactionTypeId}
Get all transaction types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentTransactionTypesLOV

List of Values/Subjects List of Values

The subjects list of values resource is used to view a list of subjects. A subject is a label for the general subject matter and learning objectives for a set of courses, such as History or Chemistry. It's used to categorize and identify course offerings and scheduled courses.

Get a subject: Method: get
Path: /fscmRestApi/resources/11.13.18.05/subjectsLOV/{subjectsLOVUniqID}
Get all subjects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/subjectsLOV

List of Values/Territories

The territories list of values resource is used to query the ISO standard territories.

Get all territories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/territoriesLOV

List of Values/Time Zones

The time zones list of values resource is used to query the time zones.

Get all time zones: Method: get
Path: /fscmRestApi/resources/11.13.18.05/timezonesLOV

List of Values/Transaction Sources List of Values

The transaction sources list of values resource is used to find transaction sources to map to a fee type. Transaction source to fee type mappings are associated to an academic business unit.

Get a batch transaction source: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTransactionSourcesLOV/{BatchSourceSequenceId}
Get all batch transaction sources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTransactionSourcesLOV

Managed Student Group Configurations

The managed student group configurations resource provides the configuration settings for managed student groups.

Create a managed student group configuration: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupConfigurations
Get a managed student group configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupConfigurations/{ConfigurationId}
Get all managed student group configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupConfigurations
Update a managed student group configuration: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupConfigurations/{ConfigurationId}

Managed Student Group Member Approvals

The managed student group member approvals resource provides the approval details of the members in the managed student group.

Get a managed student group member approval: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupMemberApprovals/{ApprovalId}
Get all managed student group member approvals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupMemberApprovals
Update a managed student group member approval: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupMemberApprovals/{ApprovalId}

Managed Student Group Students

The managed student group students resource provides the students associated with all the managed student groups of the logged in user.

Get a managed student group student: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupLearners/{LearnerPartyId}
Get all managed student group students: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupLearners

Managed Student Group Students/Managed Student Groups

The managed student groups resource provides the managed student groups that a student is a member of.

Get a managed student group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupLearners/{LearnerPartyId}/child/proxyGroups/{MemberId}
Get all managed student groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupLearners/{LearnerPartyId}/child/proxyGroups

Managed Student Group Students/Student Images

The student images resource provides the images of a student.

Get a student image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupLearners/{LearnerPartyId}/child/images/{ImageId}
Get all student images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupLearners/{LearnerPartyId}/child/images

Managed Student Group Students/Student Images/Large Object (LOB) Attributes - ImageContent

Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroupLearners/{LearnerPartyId}/child/images/{ImageId}/enclosure/ImageContent

Managed Student Groups

The managed student groups resource provides the list of group managers and students.

Create a managed student group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups
Delete a managed student group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}
Get a managed student group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}
Get all managed student groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups
Update a managed student group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}

Managed Student Groups/Group Managers

The group managers resource is a child of the managed student groups resource and provides the list of associated group manager members.

Create a group manager member belonging to a managed student group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/proxies
Delete a group manager member associated with a managed student group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/proxies/{ProxyMemberId}
Get a group manager member associated with a managed student group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/proxies/{ProxyMemberId}
Get all group manager members of a managed student group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/proxies
Sends reminder to a group manager member.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/proxies/{ProxyMemberId}/action/sendReminder
Update a managed student group's group manager member: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/proxies/{ProxyMemberId}

Managed Student Groups/Group Managers/Student Images

The student images resource provides the images of a student.

Get a student image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/proxies/{ProxyMemberId}/child/proxyImages/{ImageId}
Get all student images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/proxies/{ProxyMemberId}/child/proxyImages

Managed Student Groups/Group Managers/Student Images/Large Object (LOB) Attributes - ImageContent

Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/proxies/{ProxyMemberId}/child/proxyImages/{ImageId}/enclosure/ImageContent

Managed Student Groups/Students

The students resource is a child of the managed student groups resource and provides the list of associated student members.

Create a student member belonging to a managed student group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/learners
Delete a managed student group's student member: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/learners/{LearnerMemberId}
Get a managed student group's student member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/learners/{LearnerMemberId}
Get all student members of a managed student group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/learners
Sends reminder to a student member.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/learners/{LearnerMemberId}/action/sendReminder
Update a managed student group's student member: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/learners/{LearnerMemberId}

Managed Student Groups/Students/Student Images

The student images resource provides the images of a student.

Get a student image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/learners/{LearnerMemberId}/child/learnerImages/{ImageId}
Get all student images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/learners/{LearnerMemberId}/child/learnerImages

Managed Student Groups/Students/Student Images/Large Object (LOB) Attributes - ImageContent

Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/learners/{LearnerMemberId}/child/learnerImages/{ImageId}/enclosure/ImageContent

Mapping Attributes

The charge priority mappings resource is used to view, create, or modify an institution's charge priority mapping. It stores information about how fees or fee groups are prioritized for payment application.

Create a charge priority mapping: Method: post
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings
Delete a charge priority mapping: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}
Get a charge priority mapping: Method: get
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}
Get all charge priority mappings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings
Update a charge priority mapping: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}

Mapping Attributes/Fee Group Mapping Details

The fee group mapping details resource is used to associate the fee group with the charge priority mapping.

Create a fee group mapping detail: Method: post
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeGroupMappingDetails
Delete a fee group mapping detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeGroupMappingDetails/{FeeGroupMappingDetailId}
Get a fee group mapping detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeGroupMappingDetails/{FeeGroupMappingDetailId}
Get all fee group mapping details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeGroupMappingDetails
Update a fee group mapping detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeGroupMappingDetails/{FeeGroupMappingDetailId}

Mapping Attributes/Fee Mapping Details

The fee mapping details resource is used to associate individual fees with the charge priority mapping.

Create a fee mapping detail: Method: post
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeMappingDetails
Delete a fee mapping detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeMappingDetails/{FeeMappingDetailId}
Get a fee mapping detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeMappingDetails/{FeeMappingDetailId}
Get all fee mapping details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeMappingDetails
Update a fee mapping detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeMappingDetails/{FeeMappingDetailId}

Mapping Attributes/Fee Type Mapping Details

The fee type mapping details resource is used to associate all fees with the charge priority mapping.

Create a fee type mapping detail: Method: post
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeTypeMappingDetails
Delete a fee type mapping detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeTypeMappingDetails/{FeeTypeMappingDetailId}
Get a fee type mapping detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeTypeMappingDetails/{FeeTypeMappingDetailId}
Get all fee type mapping details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeTypeMappingDetails
Update a fee type mapping detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeTypeMappingDetails/{FeeTypeMappingDetailId}

Miscellaneous Fees

The miscellaneous fees resource provides a list of miscellaneous fees defined by institutions.

Get a miscellaneous fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/miscellaneousFees/{miscellaneousFeesUniqID}
Get all miscellaneous fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/miscellaneousFees

National Identifier Types

The national identifier types resource is a list of acceptable identification types by country. An identification type can be compulsory or optional for a specific country. An identification type such as a passport or a driver's license can be used for a particular person.

Create a national identifier type: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedNationalIdentifierTypes
Delete a national identifier type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedNationalIdentifierTypes/{NationalIdentifierTypeId}
Get a national identifier type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedNationalIdentifierTypes/{NationalIdentifierTypeId}
Get all national identifier types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedNationalIdentifierTypes
Update a national identifier type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedNationalIdentifierTypes/{NationalIdentifierTypeId}

Official Residencies

The official residencies resource is a collection of one or more in-state, out-of state or other residency determinations that typically affect the tuition rates for a given student.

Create a student official residency: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentOfficialResidencies
Delete a student official residency: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentOfficialResidencies/{ResidencyId}
Get a student official residency: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentOfficialResidencies/{ResidencyId}
Get all student official residencies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentOfficialResidencies
Update a student official residency: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentOfficialResidencies/{ResidencyId}

Official Residencies/Residency Exceptions

The residency exceptions resource contains the residency exception type and related notes that are used to grant official residency determination, where without the exception, the student wouldn't qualify for the residency.

Create a residency exception: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentOfficialResidencies/{ResidencyId}/child/residencyExceptions
Delete a residency exception: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentOfficialResidencies/{ResidencyId}/child/residencyExceptions/{ResidencyExceptionId}
Get a residency exception: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentOfficialResidencies/{ResidencyId}/child/residencyExceptions/{ResidencyExceptionId}
Get all residency exceptions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentOfficialResidencies/{ResidencyId}/child/residencyExceptions
Update a residency exception: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentOfficialResidencies/{ResidencyId}/child/residencyExceptions/{ResidencyExceptionId}

Page Groups

The page groups resource is used to view, create, or modify page groups.

Create a page group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPageGroups
Delete a page group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPageGroups/{GroupId}
Get a page group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageGroups/{GroupId}
Get all page groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageGroups
Update a page group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedPageGroups/{GroupId}

Page Groups/Page Group Members

The page group members resource is used to view, create, or modify the memberships of page groups.

Create a page group member: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPageGroups/{GroupId}/child/pageGroupMembers
Delete a page group member: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPageGroups/{GroupId}/child/pageGroupMembers/{GroupMemberId}
Get a page group member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageGroups/{GroupId}/child/pageGroupMembers/{GroupMemberId}
Get all page group members: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageGroups/{GroupId}/child/pageGroupMembers
Update a page group member: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedPageGroups/{GroupId}/child/pageGroupMembers/{GroupMemberId}

Page to Role Group Assignments

The page to role group assignments resource is used to define the assignment of page to a role group.

Create a role group page assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments
Delete a role group page assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments/{AssignmentId}
Get a role group page assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments/{AssignmentId}
Get all role group page assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments
Update a role group page assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments/{AssignmentId}

Page to Role Group Assignments/Page Permissions to Role Group Assignments

The page permissions to role group assignments resource is used to define the assignment of page permissions to a role group.

Create a page permission for a role group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments/{AssignmentId}/child/roleGroupPagePermissions
Delete a page permission for a role group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments/{AssignmentId}/child/roleGroupPagePermissions/{PermissionMappingId}
Get a page permission for a role group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments/{AssignmentId}/child/roleGroupPagePermissions/{PermissionMappingId}
Get all page permissions for a role group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments/{AssignmentId}/child/roleGroupPagePermissions
Update a page permission for a role group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments/{AssignmentId}/child/roleGroupPagePermissions/{PermissionMappingId}

Payment Preferences

The higher education payment preferences resource is used to view, create, or modify refund payment preferences. It stores information about refund payment priorities and refund methods.

Create payment preference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPaymentPreferences
Delete a payment preference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPaymentPreferences/{PaymentPreferenceId}
Get all payment preferences: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPaymentPreferences
Get payment preference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPaymentPreferences/{PaymentPreferenceId}
Update a payment preference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedPaymentPreferences/{PaymentPreferenceId}

Period Attributes

The period attributes resource is used to manage period attributes.

Create all attributes: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributes
Delete a period attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributes/{PeriodAttributeId}
Get a period attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributes/{PeriodAttributeId}
Get all period attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributes
Update a period attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributes/{PeriodAttributeId}

Period Attributes/Period Attribute Tags

The tag assignments resource is used to manage tag assignments of period attributes.

Create a tag assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributes/{PeriodAttributeId}/child/tagAssignments
Delete a tag assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributes/{PeriodAttributeId}/child/tagAssignments/{TagAssignmentId}
Get a tag assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributes/{PeriodAttributeId}/child/tagAssignments/{TagAssignmentId}
Get all tag assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributes/{PeriodAttributeId}/child/tagAssignments

Person Profiles

Use the person profiles resource to view, create, or modify person profile details. For example, use this resource to update a student's address.

Get a person profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}
Get all person profiles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles
Update a person profile: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}

Person Profiles/Academic Histories

The academic histories resource is a child of person profiles resource and provides information about the various academic histories associated with the user.

Create an academic history: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/academicHistories
Delete an academic history: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/academicHistories/{AcademicHistoriesId}
Get all academic histories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/academicHistories
Get an academic history: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/academicHistories/{AcademicHistoriesId}
Update an academic history: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/academicHistories/{AcademicHistoriesId}

Person Profiles/Addresses

The addresses resource is a child of the person profiles resource and provides information about the various addresses associated with the user.

Create an address: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/addresses
Delete an address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/addresses/{addressesUniqID}
Get all addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/addresses
Get an address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/addresses/{addressesUniqID}
Update an address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/addresses/{addressesUniqID}

Person Profiles/Emails

The emails resource is a child of person profiles resource and provides information about the various email addresses associated with the user.

Create an email address: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emails
Delete an email address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emails/{EmailId}
Get all email addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emails
Get an email address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emails/{EmailId}
Update an email address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emails/{EmailId}

Person Profiles/Emergency Contacts

The emergency contacts resource is a child of person profiles resource and provides information about the various emergency contacts provided by the user.

Create an emergency contact: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emergencyContacts
Delete an emergency contact: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emergencyContacts/{EmergencyContactId}
Get all emergency contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emergencyContacts
Get an emergency contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emergencyContacts/{EmergencyContactId}
Update an emergency contact: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emergencyContacts/{EmergencyContactId}

Person Profiles/Images

The images resource is a child of person profiles resource and provides information about the image uploaded by the user.

Create an image: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/images
Delete an image: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/images/{ImageId}
Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/images
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/images/{ImageId}
Update an image: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/images/{ImageId}

Person Profiles/Images/Large Object (LOB) Attributes - ImageContent

Delete an ImageContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/images/{ImageId}/enclosure/ImageContent
Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/images/{ImageId}/enclosure/ImageContent
Replace an ImageContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/images/{ImageId}/enclosure/ImageContent

Person Profiles/Learners

The learners resource is the child of personProfiles resource and provides information about the learner, and the relationship details of the corresponding proxy.

Get a learner: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/learners/{learnersUniqID}
Get all learners: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/learners

Person Profiles/Names

The names resource is a child of person profiles resource and provides information about the various names associated with the user.

Create a name: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/names
Delete a name: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/names/{namesUniqID}
Get a name: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/names/{namesUniqID}
Get all names: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/names
Update a name: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/names/{namesUniqID}

Person Profiles/National Identifiers

The national identifiers resource is a child of person profiles resource and provides information about the various national identifiers associated with the user.

Create a national identifier: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/nationalIdentifiers
Delete a national identifier: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/nationalIdentifiers/{nationalIdentifiersUniqID}
Get a national identifier: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/nationalIdentifiers/{nationalIdentifiersUniqID}
Get all national identifiers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/nationalIdentifiers
Update a national identifier: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/nationalIdentifiers/{nationalIdentifiersUniqID}

Person Profiles/Phones

The phones resource is a child of person profiles resource and provides information about the various phone numbers associated with the user.

Create a phone number: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/phones
Delete a phone number: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/phones/{PhoneId}
Get a phone number: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/phones/{PhoneId}
Get all phone numbers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/phones
Update a phone number: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/phones/{PhoneId}

Person Profiles/Proxies

The proxies resource is the child of personProfiles resource and provides information about the proxy, and the relationship details of the corresponding learner.

Get a proxy: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/proxies/{ProxyRelationshipId}
Get all proxies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/proxies

Person Profiles/Races

The races resource is a child of person profiles resource and provides information about the various races associated with the user.

Create a race: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/races
Delete a race: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/races/{PersonalRaceId}
Get a race: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/races/{PersonalRaceId}
Get all races: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/races
Update a race: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/races/{PersonalRaceId}

Person Profiles/Security Roles

The security roles resource returns all security roles with the user.

Get a security role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/securityRoles/{securityRolesUniqID}
Get all security roles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/securityRoles

Person Profiles/Social Networks

The social networks resource is a child of person profiles resource and provides information about the various networks associated with the user.

Create a social network: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/socialNetworks
Delete a social network: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/socialNetworks/{SocialNetworkId}
Get a social network: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/socialNetworks/{SocialNetworkId}
Get all social networks: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/socialNetworks
Update a social network: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/socialNetworks/{SocialNetworkId}

Person Profiles/Student Curriculums

The student curriculum resource is a child of person profiles resource and provides a list of academic groups and programs associated with a student.

Get a student curriculum row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}
Get all student curriculum rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/studentCurriculums

Person Service Holds

The person service holds resource is a collection of one or more service holds for a given person.

Create a person service hold: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPersonServiceHolds
Delete a person service hold: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPersonServiceHolds/{PersonServiceHoldId}
Get a person service hold: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPersonServiceHolds/{PersonServiceHoldId}
Get all person service holds: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPersonServiceHolds
Update a person service hold: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedPersonServiceHolds/{PersonServiceHoldId}

Person Tags

The person tags resource is a collection of one or more tags for a given person.

Create a person tag: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedPersonTags
Delete a person tag: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedPersonTags/{PersonTagId}
Get a person tag: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPersonTags/{PersonTagId}
Get all person tags: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedPersonTags
Update a person tag: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedPersonTags/{PersonTagId}

Process Withdrawals

The process withdrawals resource drops enrolled courses for a student who has withdrawn from the institution.

Create a withdrawal: Method: post
Path: /fscmRestApi/resources/11.13.18.05/processWithdrawals
Get a withdrawal: Method: get
Path: /fscmRestApi/resources/11.13.18.05/processWithdrawals/{WithdrawalId}
Get all withdrawals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/processWithdrawals

Programs

The programs resource provides a list of programs offered by institutions.

Get a program: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}
Get all programs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs

Programs/Academic Groups

The academic groups resource is a child of the programs resource and provides a list of academic groups associated with a program.

Get all academic groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/academicGroups
Get an academic group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/academicGroups/{academicGroupsUniqID}

Programs/Academic Groups/Additional Information

The additional information resource is a child of the courses resource and provides a list of messages associated with a course.

Get all additional information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/academicGroups/{academicGroupsUniqID}/child/additionalInformation
Get an additional information row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/academicGroups/{academicGroupsUniqID}/child/additionalInformation/{additionalInformationUniqID}

Programs/Additional Information

The additional information resource is a child of the courses resource and provides a list of messages associated with a course.

Get all additional information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/additionalInformation
Get an additional information row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/additionalInformation/{additionalInformationUniqID}

Programs/Fees

The fees resource is a child of the program elements resource and provides a list of fees for a program.

Get a fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/fees/{CurriculumFeeId}
Get all fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/fees

Programs/Images

The images resource is a child of the programs resource and provides a list of image attachments for a program.

Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/images
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/images/{imagesUniqID}

Programs/Images/Large Object (LOB) Attributes - ImageContent

Delete an ImageContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Replace an ImageContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent

Programs/Offering Academic Organizations

The offering academic organizations resource is a child of the programs resource and provides a list of academic organizations associated with a program.

Get all offering academic organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/offeringAcademicOrganizations
Get an offering academic organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID}

Programs/Offering Academic Organizations/Offering Organization Staff

The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.

Get all offering organization staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID}/child/offeringOrganizationStaff
Get an offering organization staff member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}

Programs/Offering Academic Organizations/Offering Organization Staff/Large Object (LOB) Attributes - PersonImageContent

Get a PersonImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}/enclosure/PersonImageContent

Programs/Offering Campuses

The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.

Get all offering campuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/offeringCampuses
Get an offering campus: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/offeringCampuses/{offeringCampusesUniqID}

Programs/Offering Credentials

The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.

Get all offering credentials: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/offeringCredentials
Get an offering credential: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/offeringCredentials/{offeringCredentialsUniqID}

Programs/Offering Storefronts

The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.

Get all offering storefronts for a course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/offeringStorefronts
Get an offering storefront: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/offeringStorefronts/{offeringStorefrontsUniqID}

Programs/Parameters

The parameters resource is a child of the programs resource and provides a list of program parameters for a program.

Get a parameter: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/parameters/{parametersUniqID}
Get all parameters: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/parameters

Programs/Program Elements

The program elements resource is a child of the programs resource and provides a flattened list of courses and course list elements associated with a program.

Get a program element: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}
Get all program elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements

Programs/Program Elements/Additional Information

The additional information resource is a child of the courses resource and provides a list of messages associated with a course.

Get all additional information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/additionalInformation
Get an additional information row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/additionalInformation/{additionalInformationUniqID}

Programs/Program Elements/Course Offerings

The course offering resource is a child of the program elements resource and provides a list of offerings associated with a course.

Get a course offering: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/courseOfferings/{courseOfferingsUniqID}
Get all course offerings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/courseOfferings

Programs/Program Elements/Course Offerings/Offering Academic Organizations

The offering academic organizations resource is a child of the programs resource and provides a list of academic organizations associated with a program.

Get all offering academic organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations
Get an offering academic organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID}

Programs/Program Elements/Course Offerings/Offering Academic Organizations/Offering Organization Staff

The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.

Get all offering organization staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID}/child/offeringOrganizationStaff
Get an offering organization staff member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID2}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}

Programs/Program Elements/Course Offerings/Offering Academic Organizations/Offering Organization Staff/Large Object (LOB) Attributes - PersonImageContent

Get a PersonImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/courseOfferings/{courseOfferingsUniqID}/child/offeringAcademicOrganizations/{offeringAcademicOrganizationsUniqID2}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}/enclosure/PersonImageContent

Programs/Program Elements/Course Offerings/Offering Campuses

The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.

Get all offering campuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/courseOfferings/{courseOfferingsUniqID}/child/offeringCampuses
Get an offering campus: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/courseOfferings/{courseOfferingsUniqID}/child/offeringCampuses/{offeringCampusesUniqID}

Programs/Program Elements/Offering Campuses

The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.

Get all offering campuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/offeringCampuses
Get an offering campus: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/offeringCampuses/{offeringCampusesUniqID}

Programs/Program Elements/Parameters

The parameters resource is a child of the programs resource and provides a list of program parameters for a program.

Get a parameter: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/parameters/{ParameterId}
Get all parameters: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/parameters

Programs/Program Elements/Requisites

The requisites resource is a child of the program elements resource and provides a list of prerequisite or corequisite courses for a course.

Get a requisite element: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/requisites/{requisitesUniqID}
Get all requisite elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/requisites

Programs/Program Elements/Staff Summaries

The staff summary resource is a child of the program elements resource and provides a unique list of all associated staff.

Get a staff member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/staffSummary/{staffSummaryUniqID}
Get all staff members: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/staffSummary

Programs/Program Elements/Tags

The tags resource is a child of the courses resource and provides a list of tags associated with a course.

Get a tag: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/tags/{tagsUniqID}
Get all tags: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/tags

Programs/Tags

The tags resource is a child of the courses resource and provides a list of tags associated with a course.

Get a tag: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/tags/{tagsUniqID}
Get all tags: Method: get
Path: /fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/tags

Requirement Categories

The requirement categories resource provides a list of attributes that define a curriculum item's level of importance in terms of satisfying an academic requirement.

Get a requirement category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirementCategories/{RequirementCategoryId}
Get all requirement categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirementCategories

Result Types

The result types resource provides a complete list of institutionally defined result types.

Get a result type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resultTypes/{ResultTypeId}
Get all result types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resultTypes

Result Types/Result Type Curriculums

The curriculum types resource is a child of the result types resource and provides a complete list of curriculum types associated with a result type for a specific institution.

Get a curriculum type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resultTypes/{ResultTypeId}/child/curriculumTypes/{ResultTypeCurriculumId}
Get all curriculum types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resultTypes/{ResultTypeId}/child/curriculumTypes

Result Types/Result Type Sets

The result type sets resource is a child of the result types resource and provides a complete list of result sets associated with a result type for a specific institution.

Get a result type set: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resultTypes/{ResultTypeId}/child/resultTypeSets/{resultTypeSetsUniqID}
Get all result type sets: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resultTypes/{ResultTypeId}/child/resultTypeSets

Result Types/Result Type Sets/Result Set Details

The result set values resource is a child of the result type sets resource and provides a complete list of result set values associated with a result type set for a specific institution.

Get a result set value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resultTypes/{ResultTypeId}/child/resultTypeSets/{resultTypeSetsUniqID}/child/resultSetValues/{resultSetValuesUniqID}
Get all result set values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resultTypes/{ResultTypeId}/child/resultTypeSets/{resultTypeSetsUniqID}/child/resultSetValues

Role Security Groups

The role security groups resource is used to view, create, or modify role security groups.

Create a security role group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups
Delete a security role group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups/{GroupId}
Get a security role group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups/{GroupId}
Get all security role groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups
Update a security role group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups/{GroupId}

Role Security Groups/Role Security Group Members

The role security group members resource is used to view, create, or modify the memberships of role security groups.

Create a security role group member: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups/{GroupId}/child/hedRoleGroupMembers
Delete a security role group member: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups/{GroupId}/child/hedRoleGroupMembers/{GroupMemberId}
Get a security role group member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups/{GroupId}/child/hedRoleGroupMembers/{GroupMemberId}
Get all security role group members: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups/{GroupId}/child/hedRoleGroupMembers
Update a security role group member: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups/{GroupId}/child/hedRoleGroupMembers/{GroupMemberId}

Saved Carts

The saved carts resource is used to view, create, or modify saved shopping carts.

Create a saved cart: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts
Delete a saved cart: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}
Get a saved cart: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}
Get all saved carts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts
Update a saved cart: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}

Saved Carts/Miscellaneous Fee Items

The miscellaneous fee items resource provides a list of miscellaneous fee items present in the cart.

Create a miscellaneous fee: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/miscellaneousFeeItems
Delete a miscellaneous fee: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/miscellaneousFeeItems/{CartDetailId}
Get a miscellaneous fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/miscellaneousFeeItems/{CartDetailId}
Get all miscellaneous fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/miscellaneousFeeItems

Saved Carts/Scheduled Course

The scheduled course items resource provides a list of scheduled course items present in the cart.

Create a scheduled course item: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems
Delete a scheduled course item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}
Get a scheduled course item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}
Get all scheduled course items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems
Update a scheduled course item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}

Saved Carts/Scheduled Course/Course Fees

The course fees resource provides a list of fees associated with a course.

Get a course fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseFees/{courseFeesUniqID}
Get all course fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseFees

Saved Carts/Scheduled Course/Course Requisites

The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course.

Get a course requisite: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseRequisites/{courseRequisitesUniqID}
Get all course requisites: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseRequisites

Saved Carts/Scheduled Course/Scheduled Course Fees

The scheduled course fees resource provides a list of fees associated with a scheduled course.

Get a scheduled course fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourseFees/{scheduledCourseFeesUniqID}
Get all scheduled course fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourseFees

Saved Carts/Scheduled Course/Scheduled Courses

The scheduled courses resource is a child of the student scheduled course resource and provides a list of scheduled courses offered by institutions.

Get a scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}
Get all scheduled courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses

Saved Carts/Scheduled Course/Scheduled Courses/Meeting Patterns

The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.

Get a meeting pattern: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns/{meetingPatternsUniqID}
Get all meeting patterns: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns

Saved Carts/Scheduled Course/Scheduled Courses/Offering Organization Staff

The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.

Get all offering organization staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff
Get an offering organization staff member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}

Saved Carts/Scheduled Course/Scheduled Courses/Offering Organization Staff/Large Object (LOB) Attributes - PersonImageContent

Get a PersonImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSavedCarts/{SavedCartId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}/enclosure/PersonImageContent

Scheduled Courses

The scheduled courses resource is a child of the student scheduled course resource and provides a list of scheduled courses offered by institutions.

Get a scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}
Get all scheduled courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses

Scheduled Courses/Additional Information

The additional information resource is a child of the courses resource and provides a list of messages associated with a course.

Get all additional information: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/additionalInformation
Get an additional information row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/additionalInformation/{additionalInformationUniqID}

Scheduled Courses/Fees

The fees resource is a child of the scheduled courses resource and provides a list of fees associated with a scheduled course.

Get a fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/fees/{feesUniqID}
Get all fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/fees

Scheduled Courses/Images

The images resource is a child of the programs resource and provides a list of image attachments for a program.

Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/images
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/images/{imagesUniqID}

Scheduled Courses/Images/Large Object (LOB) Attributes - ImageContent

Delete an ImageContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent
Replace an ImageContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/images/{imagesUniqID}/enclosure/ImageContent

Scheduled Courses/Meeting Dates

The meeting dates resource is a child of the scheduled courses resource and provides a list of meetings associated with a scheduled course.

Get a meeting date: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/meetingDates/{CurriculumDateId}
Get all meeting dates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/meetingDates

Scheduled Courses/Meeting Patterns

The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.

Get a meeting pattern: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns/{meetingPatternsUniqID}
Get all meeting patterns: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns

Scheduled Courses/Offering Academic Periods

The offering academic periods resource is a child of the scheduled courses resource and provides a list of academic periods associated with a scheduled course.

Get all offering academic periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/offeringAcademicPeriods
Get an offering academic period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/offeringAcademicPeriods/{offeringAcademicPeriodsUniqID}

Scheduled Courses/Offering Organization Staff

The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.

Get all offering organization staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff
Get an offering organization staff member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}

Scheduled Courses/Offering Organization Staff/Large Object (LOB) Attributes - PersonImageContent

Get a PersonImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}/enclosure/PersonImageContent

Scheduled Courses/Offering Storefronts

The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.

Get all offering storefronts for a course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/offeringStorefronts
Get an offering storefront: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/offeringStorefronts/{offeringStorefrontsUniqID}

Scheduled Courses/Results

The results resource is a child of the course offerings resource and provides a list of result type and result set combinations associated with the course offering.

Get a result: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/offeringResultSets/{offeringResultSetsUniqID}
Get all results: Method: get
Path: /fscmRestApi/resources/11.13.18.05/scheduledCourses/{scheduledCoursesUniqID}/child/offeringResultSets

Scheduled Process Trackers

The scheduled process trackers resource provides a list of scheduled processes submitted from the student management cloud.

Delete a scheduled process tracker: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedScheduledProcessTrackers/{TrackId}
Get a scheduled process tracker: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedScheduledProcessTrackers/{TrackId}
Get all scheduled process trackers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedScheduledProcessTrackers

Scheduled Process Trackers/Large Object (LOB) Attributes - LogContents

Get a LogContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedScheduledProcessTrackers/{TrackId}/enclosure/LogContents

Scheduler Setups

Scheduler setups provide information about a scheduler definition. For example, a scheduler definition can exist for an event.

Create a scheduler setup: Method: post
Path: /fscmRestApi/resources/11.13.18.05/schedulerSetups
Delete a scheduler setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/schedulerSetups/{SchedulerId}
Get a scheduler setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/schedulerSetups/{SchedulerId}
Get all scheduler setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/schedulerSetups
Update a scheduler setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/schedulerSetups/{SchedulerId}

Scheduler Setups/Scheduler Details

Scheduler details provide metadata information for the scheduler. For example, information for the scheduler scheduled for task due event.

Create a scheduler detail: Method: post
Path: /fscmRestApi/resources/11.13.18.05/schedulerSetups/{SchedulerId}/child/schedulerDetails
Delete a scheduler detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/schedulerSetups/{SchedulerId}/child/schedulerDetails/{SchedulerDetailId}
Get a scheduler detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/schedulerSetups/{SchedulerId}/child/schedulerDetails/{SchedulerDetailId}
Get details for all schedulers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/schedulerSetups/{SchedulerId}/child/schedulerDetails
Update a scheduler detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/schedulerSetups/{SchedulerId}/child/schedulerDetails/{SchedulerDetailId}

Search Curriculum Items

The search curriculum items resource lists all the curriculum items such as programs, courses, and course lists, defined in the curriculum registry.

Get a curriculum item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchCurriculumItems/{searchCurriculumItemsUniqID}
Get all curriculum items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchCurriculumItems

Search Person Profiles

Use the search person profiles resource to search for persons, such as students.

Get a person profile: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}
Get all person profiles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles

Search Person Profiles/Images

The images resource is a child of search person profiles resource and provides information about the image uploaded by the user.

Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/images
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/images/{ImageId}

Search Person Profiles/Images/Large Object (LOB) Attributes - ImageContent

Delete an ImageContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/images/{ImageId}/enclosure/ImageContent
Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/images/{ImageId}/enclosure/ImageContent
Replace an ImageContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/images/{ImageId}/enclosure/ImageContent

Search Person Profiles/Phones

The phones resource is a child of search person profiles resource and provides information about the various phone numbers associated with the user.

Get a phone number: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/phones/{PhoneId}
Get all phone numbers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/phones

Search Person Profiles/Student Credentials

The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.

Get a student credential row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCredentials/{studentCredentialsUniqID}
Get all student credentials: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCredentials

Search Person Profiles/Student Curriculums

The student curriculum resource is a child of search person profiles resource and provides a list of academic groups and programs associated with a student.

Get a student curriculum row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}
Get all student curriculum rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums

Search Person Profiles/Student Curriculums/Advisors

The advisors resource is a child of the search person profiles resource and provides a list of advisors assigned to a student.

Get all advisors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}/child/advisors
Get an advisor: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}/child/advisors/{advisorsUniqID}

Search Person Profiles/Student Curriculums/Student Academic Levels

The student academic levels resource is a child of the search person profiles resource and provides a list of academic levels calculated for a student under each reporting period.

Get a student academic level row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}/child/studentAcademicLevels/{studentAcademicLevelsUniqID}
Get all student academic level rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}/child/studentAcademicLevels

Search Person Profiles/Student Curriculums/Student Academic Loads

The student academic loads resource is a child of the search person profiles resource and provides a list of academic loads calculated for a student under each reporting period.

Get a student academic load row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}/child/studentAcademicLoads/{studentAcademicLoadsUniqID}
Get all student academic load rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}/child/studentAcademicLoads

Search Person Profiles/Student Curriculums/Student Credentials

The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.

Get a student credential row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}/child/studentCredentials/{studentCredentialsUniqID}
Get all student credentials: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}/child/studentCredentials

Search Person Profiles/Student Curriculums/Student Curriculum Elements

The student curriculum elements resource is a child of the search person profiles resource and provides a list of programs enrolled for a student under an academic group.

Get a student curriculum element row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}/child/studentCurriculumElements/{studentCurriculumElementsUniqID}
Get all student curriculum elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}/child/studentCurriculumElements

Security Roles

The security roles resource returns all security roles.

Get a security role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSecurityRoles/{RoleId}
Get all security roles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSecurityRoles

Settings Menu Items

The settings menu item resource is used to retrieve all the pages a user has access to, so they can be displayed in search results and settings menu.

Get a settings menu item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSettingsMenuItems/{MenuItemId}
Get all available settings menu items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSettingsMenuItems

Standardized Test Setups

Standardized test setups allows user to manage the configuration for standardized tests.

Create all standardized test setups: Method: post
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups
Delete a standardized test setup: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}
Get a standardized test setup: Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}
Get all standardized test setups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups
Update a standardized test setup: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}

Standardized Test Setups/Test Instances

Test instances allows user to manage the effective dated instances for a standardized test setup.

Create a test instance: Method: post
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances
Delete a test instance: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances/{TestInstanceId}
Get a test instance: Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances/{TestInstanceId}
Get all test instances: Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances
Update a test instance: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances/{TestInstanceId}

Standardized Test Setups/Test Instances/Test Components

Test components allows user to manage the components associated to a standardized test setup.

Create a test component: Method: post
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances/{TestInstanceId}/child/testComponents
Delete a test component: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances/{TestInstanceId}/child/testComponents/{TestComponentId}
Get a test component: Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances/{TestInstanceId}/child/testComponents/{TestComponentId}
Get all test components: Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances/{TestInstanceId}/child/testComponents
Update a test component: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances/{TestInstanceId}/child/testComponents/{TestComponentId}

Status Schemes

The status schemes resource is used to view, create, or modify status schemes for workflows. A status scheme is a grouping of statuses. For example, a scheme can be admissions for which statuses can be admit or deny.

Create a status scheme: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes
Delete a status scheme: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes/{StatusSchemeId}
Get a status scheme: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes/{StatusSchemeId}
Get all status schemes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes
Update a status scheme: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes/{StatusSchemeId}

Status Schemes/Statuses

The statuses resource is used to view, create, or modify statuses in a status scheme.

Create a status scheme status: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes/{StatusSchemeId}/child/statuses
Delete a status scheme status: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes/{StatusSchemeId}/child/statuses/{StatusSchemeStatusId}
Get a status scheme status: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes/{StatusSchemeId}/child/statuses/{StatusSchemeStatusId}
Get all status scheme statuses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes/{StatusSchemeId}/child/statuses
Update a status scheme status: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes/{StatusSchemeId}/child/statuses/{StatusSchemeStatusId}

Storefronts

The storefronts resource provides a list of storefronts defined by institutions.

Create a storefront: Method: post
Path: /fscmRestApi/resources/11.13.18.05/storefronts
Delete a storefront: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}
Get a storefront: Method: get
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}
Get all storefronts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/storefronts
Update a storefront: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}

Storefronts/Images

The images resource is a child of the storefronts resource and provides a list of image attachments associated with a storefront.

Create an image: Method: post
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/child/images
Delete an image: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/child/images/{imagesUniqID}
Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/child/images
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/child/images/{imagesUniqID}
Update an image: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/child/images/{imagesUniqID}

Storefronts/Images/Large Object (LOB) Attributes - ImageContent

Delete an ImageContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/child/images/{imagesUniqID}/enclosure/ImageContent
Get an ImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/child/images/{imagesUniqID}/enclosure/ImageContent
Replace an ImageContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/child/images/{imagesUniqID}/enclosure/ImageContent

Storefronts/Large Object (LOB) Attributes - StorefrontURL

Delete a StorefrontURL: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/enclosure/StorefrontURL
Get a StorefrontURL: Method: get
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/enclosure/StorefrontURL
Replace a StorefrontURL: Method: put
Path: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/enclosure/StorefrontURL

Student Academic Plans

The student academic plans resource provides a list of student academic plans.

Create a plan from the matching template or the matching academic plan format.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/action/createFromTemplate
Create all student academic plans: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans
Delete a student academic plan: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}
Get a student academic plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}
Get all student academic plans: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans
Update a student academic plan: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}

Student Academic Plans/Conflicts

The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.

Get a conflict: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/conflicts/{ConflictId}
Get all conflicts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/conflicts

Student Academic Plans/Items

The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan.

Create all items: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/items
Delete an item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/items/{itemsUniqID}
Get all items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/items
Get an item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/items/{itemsUniqID}
Update an item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/items/{itemsUniqID}

Student Academic Plans/Periods

The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.

Create all periods: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods
Delete a period: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}
Get a period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}
Get all periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods
Update a period: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}

Student Academic Plans/Periods/Elements

The elements resource is a child of the periods resource and provides a list of curriculum items associated with a student academic plan.

Create all elements: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements
Delete an element: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements/{elementsUniqID}
Get all elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements
Get an element: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements/{elementsUniqID}
Update an element: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements/{elementsUniqID}

Student Academic Plans/Periods/Elements/Related Elements

The related elements resource is a child of the elements resource and provides a list of related elements associated with a student academic plan.

Create all related elements: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements/{elementsUniqID}/child/relatedElements
Delete a related element: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements/{elementsUniqID}/child/relatedElements/{relatedElementsUniqID}
Get a related element: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements/{elementsUniqID}/child/relatedElements/{relatedElementsUniqID}
Get all related elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements/{elementsUniqID}/child/relatedElements
Update a related element: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements/{elementsUniqID}/child/relatedElements/{relatedElementsUniqID}

Student Accounts

The student accounts resource provides a list of accounts a student has transactions in.

Create a student account: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts
Get a student account as logged-in user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}
Get action not supported: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts

Student Accounts/Account Relationships

The account relationships resource is a child of the student accounts resource. It lists the financial accounts that are actively related to this student account.

Get all account relationships: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/accountRelationships
Get an account relationship: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/accountRelationships/{CustomerAccountRelationshipId}

Student Accounts/Bills

The bills resource is a child of the student accounts resource and provides a list of bill numbers for a student account.

Get a bill: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/bills/{BillNumber}
Get all bills: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/bills

Student Accounts/Bills/Large Object (LOB) Attributes - Report

Get a Report: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/bills/{BillNumber}/enclosure/Report

Student Accounts/Transaction Applications

The transaction applications resource is a child of the student accounts resource. It lists all the payments applied to a charge for a student account.

Get a transaction application: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/transactionApplications/{TransactionApplicationId}
Get all transaction applications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/transactionApplications

Student Accounts/Transactions

The transactions resource is a child of the student accounts resource and provides a list of charges and payments for a student account.

Get a transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/transactions/{transactionsUniqID}
Get all transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/transactions

Student Accounts/Transactions/Transaction Activities

The transaction activities resource is a child of the transactions resource. For a charge, it lists the initial charge details and any changes in the amount of the charge, such as a charge reversal, or a discount. For a payment, it lists any refunds emanating from that payment.

Get a transaction activity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/transactions/{transactionsUniqID}/child/transactionActivities/{TransactionActivityId}
Get all transaction activities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/transactions/{transactionsUniqID}/child/transactionActivities

Student Credentials

The student credentials resource is a child of the student curriculum resource and provides a list of credentials awarded to a student.

Get a student credential row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCredentials/{studentCredentialsUniqID}
Get all student credentials: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCredentials

Student Credit Assignments

The student credit assignment resource lists all assignments of a student credit to a customer account.

Create a student credit assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditAssignments
Get a student credit assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditAssignments/{CreditAssignmentId}
Get all student credit assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditAssignments
Update a student credit assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditAssignments/{CreditAssignmentId}

Student Credit Assignments/Credit Curriculums

The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.

Create a credit curriculum: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditAssignments/{CreditAssignmentId}/child/creditCurriculums
Delete a credit curriculum: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditAssignments/{CreditAssignmentId}/child/creditCurriculums/{CreditCurriculumId}
Get a credit curriculum: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditAssignments/{CreditAssignmentId}/child/creditCurriculums/{CreditCurriculumId}
Get all credit curriculums: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditAssignments/{CreditAssignmentId}/child/creditCurriculums
Update a credit curriculum: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditAssignments/{CreditAssignmentId}/child/creditCurriculums/{CreditCurriculumId}

Student Credit Posting

The student credit posting resource is used to view, post, or reverse credits on student accounts.

Create an on-account credit memo on a student account.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditPostings
Get a posted credit.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditPostings/{CreditPostingId}
Get all credits posted on student accounts.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditPostings
Update a student credit transaction status.: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditPostings/{CreditPostingId}

Student Credit Receipts

The student receipt credits resource is used to view, create, or modify credits you set up for a business unit. It stores information about what charges these credits can pay and other financial attributes for accounting.

Create a student receipt credit: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditReceipts
Delete a student receipt credit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditReceipts/{CreditId}
Get a student receipt credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditReceipts/{CreditId}
Get all student receipt credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditReceipts
Update a student receipt credit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditReceipts/{CreditId}

Student Credit Receipts/Receipt Methods

The receipt methods resource is used to associate charge priority mappings with receipt methods.

Create a receipt method: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditReceipts/{CreditId}/child/receiptMethods
Delete a receipt method: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditReceipts/{CreditId}/child/receiptMethods/{CreditReceiptId}
Get a receipt method: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditReceipts/{CreditId}/child/receiptMethods/{CreditReceiptId}
Get all receipt methods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditReceipts/{CreditId}/child/receiptMethods
Update a receipt method: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditReceipts/{CreditId}/child/receiptMethods/{CreditReceiptId}

Student Credit Waivers

The student credit waiver resource lists all student credits with a credit type of waiver.

Create a student waiver credit: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers
Delete a student waiver credit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}
Get a student waiver credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}
Get all student waiver credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers
Update a student waiver credit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}

Student Credit Waivers/Student Credit Waiver Curriculums

The student credit curriculums resource lists all curriculums associated with a waiver.

Create a credit curriculum association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}/child/creditCurriculums
Create a credit curriculum association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}/child/creditCurriculums/{CreditCurriculumId}
Delete a credit curriculum association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}/child/creditCurriculums/{CreditCurriculumId}
Get all credit curriculum associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}/child/creditCurriculums
Update a credit curriculum association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}/child/creditCurriculums/{CreditCurriculumId}

Student Credit Waivers/Student Credit Waiver Periods

The student credit periods resource lists all credit periods associated with a waiver.

Create a student credit period: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}/child/creditPeriods
Delete a student credit period: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}/child/creditPeriods/{CreditPeriodId}
Get a student credit period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}/child/creditPeriods/{CreditPeriodId}
Get all student credit periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}/child/creditPeriods
Update a student credit period: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}/child/creditPeriods/{CreditPeriodId}

Student Credits

The student credit resource lists all student credits and all credit types.

Get a student credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCredits/{CreditId}
Get all student credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCredits

Student Credits Sponsorship

The student sponsorship credits resource is used to view, create, or modify sponsorship credits you set up for a business unit. It stores information about what charges these credits can pay and other financial attributes for accounting.

Create a student sponsorship credit: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships
Delete a student sponsorship credit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}
Get a student sponsorship credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}
Get all student sponsorship credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships
Update a student sponsorship credit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}

Student Credits Sponsorship/Credit Assignments

The credit assignments resource is used to assign a student to a sponsorship credit.

Create a credit assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments
Delete a credit assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}
Get a credit assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}
Get all credit assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments
Update a credit assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}

Student Credits Sponsorship/Credit Assignments/Credit Curriculums

The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.

Create a credit curriculum: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}/child/creditCurriculums
Delete a credit curriculum: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}/child/creditCurriculums/{CreditCurriculumId}
Get a credit curriculum: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}/child/creditCurriculums/{CreditCurriculumId}
Get all credit curriculums: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}/child/creditCurriculums
Update a credit curriculum: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}/child/creditCurriculums/{CreditCurriculumId}

Student Credits Sponsorship/Credit Assignments/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}/enclosure/Comments
Get a Comments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}/enclosure/Comments
Replace a Comments: Method: put
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}/enclosure/Comments

Student Credits Sponsorship/Credit Periods

The credit periods resource is used to associate reporting academic periods with a sponsorship credit.

Create a credit period: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods
Delete a credit period: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods/{CreditPeriodId}
Get a credit period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods/{CreditPeriodId}
Get all credit periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods
Update a credit period: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods/{CreditPeriodId}

Student Credits Sponsorship/Credit Periods/Credit Period Curriculums

The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit.

Create a credit period curriculum: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods/{CreditPeriodId}/child/creditPeriodCurriculums
Delete a credit period curriculum: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods/{CreditPeriodId}/child/creditPeriodCurriculums/{CreditPeriodCurriculumId}
Get a credit period curriculum: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods/{CreditPeriodId}/child/creditPeriodCurriculums/{CreditPeriodCurriculumId}
Get all credit period curriculums: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods/{CreditPeriodId}/child/creditPeriodCurriculums
Update a credit period curriculum: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods/{CreditPeriodId}/child/creditPeriodCurriculums/{CreditPeriodCurriculumId}

Student Curriculums

The student curriculum resource provides a list of academic groups and programs associated with a student.

Get a student curriculum row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}
Get all student curriculum rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums

Student Curriculums/Advisors

The advisors resource is a child of the student curriculum resource and provides a list of advisors assigned to a student.

Get all advisors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/advisors
Get an advisor: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/advisors/{advisorsUniqID}

Student Curriculums/Images

The images resource is a child of the student curriculum resource and provides a list of image attachments for a student's program.

Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/images
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/images/{imagesUniqID}

Student Curriculums/Images/Large Object (LOB) Attributes - AttachmentContent

Delete an AttachmentContent: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/images/{imagesUniqID}/enclosure/AttachmentContent
Get an AttachmentContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/images/{imagesUniqID}/enclosure/AttachmentContent
Replace an AttachmentContent: Method: put
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/images/{imagesUniqID}/enclosure/AttachmentContent

Student Curriculums/Student Academic Levels

The student academic levels resource is a child of the student curriculum resource and provides a list of academic levels calculated for a student under each reporting period.

Get a student academic level row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/studentAcademicLevels/{studentAcademicLevelsUniqID}
Get all student academic level rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/studentAcademicLevels

Student Curriculums/Student Academic Loads

The student academic loads resource is a child of the student curriculum resource and provides a list of academic loads calculated for a student under each reporting period.

Get a student academic load row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/studentAcademicLoads/{studentAcademicLoadsUniqID}
Get all student academic load rows: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/studentAcademicLoads

Student Curriculums/Student Credentials

The student credentials resource is a child of the student curriculum resource and provides a list of credentials awarded to a student.

Get a student credential row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/studentCredentials/{studentCredentialsUniqID}
Get all student credentials: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/studentCredentials

Student Curriculums/Student Curriculum Elements

The student curriculum elements resource is a child of the student curriculum resource and provides a list of programs enrolled for a student under an academic group.

Get a student curriculum element row: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/studentCurriculumElements/{studentCurriculumElementsUniqID}
Get all student curriculum elements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}/child/studentCurriculumElements

Student Financial System Configurations

The student financial system configurations resource provides a default higher education financial system configuration.

Create student financial system configurations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations
Delete a student financial system configuration: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}
Get a student financial system configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}
Get all student financial system configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations
Update a student financial system configuration: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}

Student Financial System Configurations/Refund Methods

The refund methods resource is used to find refund methods to associate to an academic business unit. Refund methods are used in the issue refunds process.

Create refund methods: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}/child/refundMethods
Delete a refund method: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}/child/refundMethods/{OrganizationRefundMethodId}
Get a refund method: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}/child/refundMethods/{OrganizationRefundMethodId}
Get all refund methods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}/child/refundMethods
Update a refund method: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}/child/refundMethods/{OrganizationRefundMethodId}

Student Financial System Configurations/Transaction Sources

The transaction sources resource is used to find transaction sources to map user-defined fee types. Transaction source to fee type mapping is also associated to an academic business unit.

Create transaction sources: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}/child/transactionSources
Delete a transaction source: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}/child/transactionSources/{TransactionSourceId}
Get a transaction source: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}/child/transactionSources/{TransactionSourceId}
Get all transaction sources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}/child/transactionSources
Update a transaction source: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations/{BusinessUnitId}/child/transactionSources/{TransactionSourceId}

Student Financial Transactions

The student financial transactions resource is used to view, create, or modify all charges and receipts that are associated to a student. It stores information that's needed to post a charge or receipt to a student account.

Create a student financial transaction: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialTransactions
Get a student financial transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialTransactions/{studentFinancialTransactionsUniqID}
Get all student financial transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialTransactions
Update a student financial transaction: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentFinancialTransactions/{studentFinancialTransactionsUniqID}

Student Management Categories

Use the student management categories resource to view, create, modify, or delete categories. A student management category is a group of objects for shared features. An example of a shared feature is communications. An example of a category is an enrollment category.

Create a student management category: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories
Delete a student management category: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}
Get a student management category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}
Get all student management categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories
Update a student management category: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}

Student Management Categories/Category Data Groups

Use the category data groups resource to view, create, modify, or delete category data groups.

Create a category data group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryDataGroups
Delete a category data group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryDataGroups/{CategoryArtifactGroupId}
Get a category data group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryDataGroups/{CategoryArtifactGroupId}
Get all category data groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryDataGroups
Update a category data group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryDataGroups/{CategoryArtifactGroupId}

Student Management Categories/Category Events

Use the category events resource to view, create, modify, or delete category events.

Create a category event: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryEvents
Delete a category event: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryEvents/{CategoryEventMapId}
Get a category event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryEvents/{CategoryEventMapId}
Get all category events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryEvents
Update a category event: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryEvents/{CategoryEventMapId}

Student Management Categories/Category Events/Event Tokens

The event tokens resource provides a list of event tokens.

Get all event tokens: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryEvents/{CategoryEventMapId}/child/eventTokens
Get an event token: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryEvents/{CategoryEventMapId}/child/eventTokens/{TokenId}

Student Management Categories/Category Rule Attributes

Use the category rule attributes resource to view, create, modify, or delete category rule attributes.

Create a category rule attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryRuleAttributes
Delete a category rule attribute: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryRuleAttributes/{CategoryRuleId}
Get a category rule attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryRuleAttributes/{CategoryRuleId}
Get all category rule attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryRuleAttributes
Update a category rule attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryRuleAttributes/{CategoryRuleId}

Student Management Categories/Subcategories

Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.

Create a subcategory: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/subcategories
Delete a subcategory: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/subcategories/{CategoryAssociationId}
Get a subcategory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/subcategories/{CategoryAssociationId}
Get all subcategories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/subcategories
Update a subcategory: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/subcategories/{CategoryAssociationId}

Student Management Locations

The Student Management locations resource is used to document locations which can be associated with Student Management entities.

Create a Student Management location: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationLocations/{hedOrganizationLocationsUniqID}
Create all Student Management locations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationLocations
Delete a student management location: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationLocations/{hedOrganizationLocationsUniqID}
Get a Student Management location: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationLocations/{hedOrganizationLocationsUniqID}
Get all Student Management locations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationLocations

Student Management Locations/Student Management Location Associations

The Student Management location associations are used to associate a location with a Student Management entity.

Get a Student Management location association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationLocations/{hedOrganizationLocationsUniqID}/child/locationAssociations/{LocationAssociationId}
Get all Student Management location associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationLocations/{hedOrganizationLocationsUniqID}/child/locationAssociations

Student Management Organization Contacts

The Student Management organization contacts resource is used to document persons who can be associated with a Student Management organization.

Create all Student Management organization contacts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts
Delete a Student Management organization contact: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}
Get a Student Management organization contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}
Get all Student Management organization contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts
Update a Student Management organization contact: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}

Student Management Organization Contacts/Student Management Organization Contact Associations

The contact associations resource is used to associate a Student Management organization contact with a Student Management organization.

Get a Student Management organization contact association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/contactAssociations/{ContactAssociationId}
Get all Student Management organization contact associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/contactAssociations

Student Management Organization Contacts/Student Management Organization Contact Emails

The emails resource contains the email addresses of the Student Management organization contacts.

Create all Student Management organization email addresses: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/emails
Delete a Student Management organization email address: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/emails/{EmailId}
Get a Student Management organization email address: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/emails/{EmailId}
Get all Student Management organization email addresses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/emails
Update a Student Management organization email address: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/emails/{EmailId}

Student Management Organization Contacts/Student Management Organization Contact Names

The names resource contains the names of the Student Management organization contacts.

Create all Student Management organization names: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/names
Delete a Student Management organization name: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/names/{namesUniqID}
Get a Student Management organization name: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/names/{namesUniqID}
Get all Student Management organization names: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/names
Update a Student Management organization name: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/names/{namesUniqID}

Student Management Organization Contacts/Student Management Organization Contact Phones

The phones resource contains the phone numbers of the Student Management organization contacts.

Create all Student Management organization phone numbers: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/phones
Delete a Student Management organization phone number: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/phones/{PhoneId}
Get a Student Management organization phone number: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/phones/{PhoneId}
Get all Student Management organization phone numbers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/phones
Update a Student Management organization phone number: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/phones/{PhoneId}

Student Management Organization Identifiers

The Student Management organization identifiers resource is used to document identifiers, such as CEEB code, that can be associated with a Student Management organization.

Create all student management organization identifiers: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers
Delete a student management organization identifier: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers/{OrganizationIdentifierId}
Get a student management organization identifier: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers/{OrganizationIdentifierId}
Get all student management organization identifiers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers
Update a student management organization identifier: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers/{OrganizationIdentifierId}

Student Management Organization Identifiers/Student Management Organization Identifier Associations

The identifier associations resource is used to associate an organization identifier with an organization.

Create all student management organization identifier associations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers/{OrganizationIdentifierId}/child/identifierAssociations
Delete a student management organization identifier association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers/{OrganizationIdentifierId}/child/identifierAssociations/{identifierAssociationsUniqID}
Get a student management organization identifier association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers/{OrganizationIdentifierId}/child/identifierAssociations/{identifierAssociationsUniqID}
Get all student management organization identifier associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers/{OrganizationIdentifierId}/child/identifierAssociations
Update a student management organization identifier association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers/{OrganizationIdentifierId}/child/identifierAssociations/{identifierAssociationsUniqID}

Student Management Refund Details

The student refund details resource contains details of refunds initiated by students and sponsoring organizations.

Get all student refund details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRefundDetails
Get student refund detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRefundDetails/{RefundDetailId}
Update a student refund detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedRefundDetails/{RefundDetailId}

Student Management Refund Details/Large Object (LOB) Attributes - StatusDetails

Get a StatusDetails: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRefundDetails/{RefundDetailId}/enclosure/StatusDetails

Student Management Refund Details/Student Management Refund Detail Payments

The refund detail payments resource is a child of the refund details resource. It lists all of the refund payments associated with a given refund.

Get all student refund detail payments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRefundDetails/{RefundDetailId}/child/payments
Get student refund detail payment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRefundDetails/{RefundDetailId}/child/payments/{CheckId}

Student Refunds

The student refunds resource invokes an ESS job that issues refunds to students and student sponsors.

Create refund process: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedRefunds
Delete a refund process: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedRefunds/{RefundHeaderId}
Get a refund process: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRefunds/{RefundHeaderId}
Get all refund processes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRefunds
Update a refund process: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedRefunds/{RefundHeaderId}

Student Refunds/Large Object (LOB) Attributes - LogContents

Get a LogContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedRefunds/{RefundHeaderId}/enclosure/LogContents

Student Schedule by Periods

The student schedule by periods resource is used to help students schedule courses for upcoming academic periods.

Create a student schedule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods
Delete a student schedule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}
Get a student schedule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}
Get all student schedules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods
Update a student schedule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}

Student Schedule by Periods/Schedule Periods

The schedule periods resource is used to show optional and mandatory reporting periods for a student.

Create a schedule period: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods
Delete a schedule period: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}
Get a schedule period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}
Get all schedule periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods
Update a schedule period: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}
Validate scheduled items: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/action/validateItems

Student Schedule by Periods/Schedule Periods/Enrolled Items

The enrolled items resource lists course section enrollments associated with a student.

Get all enrolled items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrolledItems
Get an enrolled item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrolledItems/{enrolledItemsUniqID}

Student Schedule by Periods/Schedule Periods/Enrolled Items/Instructors

The instructors resource lists the instructors for the enrolled or scheduled items.

Get all instructors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrolledItems/{enrolledItemsUniqID}/child/instructors
Get an instructor: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrolledItems/{enrolledItemsUniqID}/child/instructors/{CurriculumStaffId}

Student Schedule by Periods/Schedule Periods/Enrolled Items/Instructors/Large Object (LOB) Attributes - PersonImageContent

Get a PersonImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrolledItems/{enrolledItemsUniqID}/child/instructors/{CurriculumStaffId}/enclosure/PersonImageContent

Student Schedule by Periods/Schedule Periods/Enrolled Items/Instructors/Large Object (LOB) Attributes - StaffBiography

Get a StaffBiography: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrolledItems/{enrolledItemsUniqID}/child/instructors/{CurriculumStaffId}/enclosure/StaffBiography

Student Schedule by Periods/Schedule Periods/Enrolled Items/Meeting Patterns

The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.

Get a meeting pattern: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrolledItems/{enrolledItemsUniqID}/child/meetingPatterns/{meetingPatternsUniqID}
Get all meeting patterns: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrolledItems/{enrolledItemsUniqID}/child/meetingPatterns

Student Schedule by Periods/Schedule Periods/Enrollment Periods

The enrollment periods resource is used to document academic and academic self-paced periods for a schedule reporting period.

Get all enrollment periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrollmentPeriods
Get an enrollment period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrollmentPeriods/{AcademicPeriodId}

Student Schedule by Periods/Schedule Periods/Enrollment Periods/Period Dates

The enrollment period dates resource is used to display key dates for an enrollment period.

Get a period date: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrollmentPeriods/{AcademicPeriodId}/child/enrollmentPeriodDates/{AcademicPeriodDateId}
Get all period dates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrollmentPeriods/{AcademicPeriodId}/child/enrollmentPeriodDates

Student Schedule by Periods/Schedule Periods/Period Dates

The enrollment period dates resource is used to display key dates for an enrollment period.

Get a period date: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/schedulePeriodDates/{AcademicPeriodDateId}
Get all period dates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/schedulePeriodDates

Student Schedule by Periods/Schedule Periods/Recommended Items

The recommended items resource is used to display recommended courses from the student's program templates.

Get a recommended item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/recommendedItems/{ItemCurriculumId}
Get all recommended items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/recommendedItems

Student Schedule by Periods/Schedule Periods/Recommended Items/Large Object (LOB) Attributes - RequisiteInformation

Get a RequisiteInformation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/recommendedItems/{ItemCurriculumId}/enclosure/RequisiteInformation

Student Schedule by Periods/Schedule Periods/Scheduled Items

The scheduled items resource is used to identify courses and course sections that the student is planning to enroll in for a schedule period.

Create all scheduled items: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems
Delete a scheduled item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}
Get a scheduled item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}
Get all scheduled items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems
Update or create a scheduled item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}

Student Schedule by Periods/Schedule Periods/Scheduled Items/Instructors

The instructors resource lists the instructors for the enrolled or scheduled items.

Get all instructors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}/child/instructors
Get an instructor: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}/child/instructors/{CurriculumStaffId}

Student Schedule by Periods/Schedule Periods/Scheduled Items/Instructors/Large Object (LOB) Attributes - PersonImageContent

Get a PersonImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}/child/instructors/{CurriculumStaffId}/enclosure/PersonImageContent

Student Schedule by Periods/Schedule Periods/Scheduled Items/Instructors/Large Object (LOB) Attributes - StaffBiography

Get a StaffBiography: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}/child/instructors/{CurriculumStaffId}/enclosure/StaffBiography

Student Schedule by Periods/Schedule Periods/Scheduled Items/Meeting Patterns

The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.

Get a meeting pattern: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}/child/meetingPatterns/{meetingPatternsUniqID}
Get all meeting patterns: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}/child/meetingPatterns

Student Scheduled Courses

The student scheduled course resource provides a complete list of courses in which a student has enrolled.

Get a student's scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}
Get all scheduled courses of a student: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses
Update a student's scheduled course: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}

Student Scheduled Courses/Control Dates

The control dates resource is a child of the student scheduled course resource and provides a list of enrollment related dates associated with a scheduled course.

Get a control date for a student's scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/controlDates/{ControlDateId}
Get all control dates for a student's scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/controlDates

Student Scheduled Courses/Results

The results resource is a child of the student scheduled course resource and provides a list of results associated with a scheduled course.

Get a result for a student's scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/results/{resultsUniqID}
Get all results for a student's scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/results

Student Scheduled Courses/Scheduled Courses

The scheduled courses resource is a child of the student scheduled course resource and provides a list of scheduled courses offered by institutions.

Get a scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}
Get all scheduled courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/scheduledCourses

Student Scheduled Courses/Scheduled Courses/Meeting Patterns

The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.

Get a meeting pattern: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns/{meetingPatternsUniqID}
Get all meeting patterns: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns

Student Scheduled Courses/Scheduled Courses/Offering Organization Staff

The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.

Get all offering organization staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff
Get an offering organization staff member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}

Student Scheduled Courses/Scheduled Courses/Offering Organization Staff/Large Object (LOB) Attributes - PersonImageContent

Get a PersonImageContent: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}/enclosure/PersonImageContent

Student Schedulers

The student schedulers resource provides a complete list of courses which a student has added to the shopping cart.

Create a student schedulers: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers
Delete a student scheduler: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}
Get a student scheduler: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}
Get all student schedulers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers
Update a student scheduler: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}

Student Schedulers/Scheduled Course Items

The scheduled course items resource is a child of the student schedulers resource and provides a complete list of courses in which a student has enrolled.

Create a scheduled course items: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems
Delete a scheduled course item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}
Get a scheduled course item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}
Get all scheduled course items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems
Update a scheduled course item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}

Student Schedulers/Scheduled Course Items/Course Requisites

The course requisites resource is a child of the scheduled course items resource and provides a list of requisites associated with a course.

Get a course requisite: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseRequisites/{courseRequisitesUniqID}
Get all course requisites: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/courseRequisites

Student Schedulers/Scheduled Course Items/Scheduled Courses

The scheduled courses resource is a child of the student schedulers resource and provides a list of scheduled courses offered by institutions.

Get a scheduled course: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}
Get all scheduled courses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses

Student Schedulers/Scheduled Course Items/Scheduled Courses/Meeting Patterns

The meeting patterns resource is a child of the student schedulers resource and provides a list of meeting patterns associated with a scheduled course.

Get a meeting pattern: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns/{meetingPatternsUniqID}
Get all meeting patterns: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns

Student Schedulers/Scheduled Course Items/Scheduled Courses/Offering Organization Staff

The offering organization staff resource is a child of the scheduled courses resource and provides a list of staff associated with a scheduled course.

Get all offering organization staff: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff
Get an offering organization staff member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}

Student Schedulers/Scheduled Course Items/Scheduled Courses/Offering Organization Staff/Large Object (LOB) Attributes - Staff Image

The content of a staff attachment such as an image file.

Get a Staff Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/offeringOrganizationStaff/{offeringOrganizationStaffUniqID}/enclosure/PersonImageContent

Student Schedulers/Scheduled Course Items/Validation Massages

The validation messages resource is a child of the scheduled course items resource and provides a list of validation messages associated with the scheduled course items.

Get a validation message: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/validationMessages/{MessageId}
Get all validation messages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSchedulers/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/validationMessages

Student Sponsor Fees

The student sponsor fees resource is used to view, create, or modify sponsor fees that can be associated to a sponsorship agreement. It stores information that's needed to post a charge to a sponsor account when a corresponding credit's posted on a student's account to pay for the student's fees.

Create student sponsor fees: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentSponsorFees
Get a student sponsor fee: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSponsorFees/{FeeId}
Get all sponsor fee periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSponsorFees
Update a student sponsor fee: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentSponsorFees/{FeeId}

Student Sponsor Fees/Sponsor Fee Periods

The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.

Create sponsor fee periods: Method: post
Path: /fscmRestApi/resources/11.13.18.05/studentSponsorFees/{FeeId}/child/sponsorFeePeriods
Delete a sponsor fee period: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/studentSponsorFees/{FeeId}/child/sponsorFeePeriods/{FeeAttributeId}
Get a sponsor fee period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSponsorFees/{FeeId}/child/sponsorFeePeriods/{FeeAttributeId}
Get all student sponsor fees: Method: get
Path: /fscmRestApi/resources/11.13.18.05/studentSponsorFees/{FeeId}/child/sponsorFeePeriods
Update a sponsor fee period: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/studentSponsorFees/{FeeId}/child/sponsorFeePeriods/{FeeAttributeId}

System Offices

The system offices resource is used to list student management system offices.

Create all system offices: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices
Delete a system office: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}
Get a system office: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}
Get all system offices: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices
Update a system office: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}

System Offices/Associated Academic Entities

The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.

Create all associated entities: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/associatedEntities
Delete an associated entity: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/associatedEntities/{EntityAssociationId}
Get all associated entities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/associatedEntities
Get an associated entity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/associatedEntities/{EntityAssociationId}
Update an associated entity: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/associatedEntities/{EntityAssociationId}

System Offices/Contacts

The contacts resource is used to view all associated contacts.

Create a contact association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/contacts
Delete a contact association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/contacts/{ContactAssociationId}
Get all associated contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/contacts
Get an associated contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/contacts/{ContactAssociationId}
Update a contact association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/contacts/{ContactAssociationId}

System Offices/Identifiers

The identifiers resource is used to view all associated identifiers.

Create an identifier association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/identifiers
Delete an identifier association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/identifiers/{IdentifierAssociationId}
Get all associated identifiers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/identifiers
Get an associated identifier: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/identifiers/{IdentifierAssociationId}
Update an identifier association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/identifiers/{IdentifierAssociationId}

System Offices/Locations

The locations resource shows all associated locations.

Create a location association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/locations/{LocationAssociationId}
Create all location associations: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/locations
Delete a location association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/locations/{LocationAssociationId}
Get a location association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/locations/{LocationAssociationId}
Get all location associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/locations

Tag Groups

The tag groups resource is used to manage tag groups.

Create a tag group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedTagGroups
Delete a tag group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedTagGroups/{TagGroupId}
Get a tag group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTagGroups/{TagGroupId}
Get all tag groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTagGroups
Update a tag group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/hedTagGroups/{TagGroupId}

Tag Groups List of Values

This resource provides a list of tag groups.

Get a tag group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTagGroupsLOV/{TagGroupId}
Get all tag groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTagGroupsLOV

Tag Groups/Associated Tags

The associated tags resource is used to manage associated tags of the tag group.

Create an associated tag for a tag group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/hedTagGroups/{TagGroupId}/child/associatedTags
Delete an associated tag for a tag group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/hedTagGroups/{TagGroupId}/child/associatedTags/{AssociatedTagId}
Get all associated tags for a tag group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTagGroups/{TagGroupId}/child/associatedTags
Get an associated tag for a tag group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/hedTagGroups/{TagGroupId}/child/associatedTags/{AssociatedTagId}