POST Admin/CourseCleanUp

Request Information

URI Parameters

None.

Body Parameters

NameDescriptionTypeAdditional information
DoPackageCleanup

None.

IncludeAllPackages

None.

IncludeOnlyYorbitPackages

None.

IncludeOnlyAccountPackages

None.

IncludePackagesForCleanup

None.

ExcludePackagesForCleanup

None.

DoCourseCleanup

None.

IncludeAllCourses

None.

IncludeOnlyYorbitCourses

None.

IncludeOnlyAccountCourses

None.

IncludeCourseIdsForCleanup

None.

ExcludeCourseIdsForCleanup

None.

DoUnitsCleanup

None.

IncludeAllUnits

None.

IncludeOnlyYorbitUnits

None.

IncludeOnlyAccountUnits

None.

IncludeUnitIdsForCleanup

None.

ExcludeUnitIdsForCleanup

None.

DoDocDBCleanup

None.

IncludeMIDsForCleanup

None.

ExcludeMIDsForCleanup

None.

Request Formats

application/json, text/json

Sample:
{
  "DoPackageCleanup": true,
  "IncludeAllPackages": true,
  "IncludeOnlyYorbitPackages": true,
  "IncludeOnlyAccountPackages": true,
  "IncludePackagesForCleanup": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludePackagesForCleanup": [
    "sample string 1",
    "sample string 2"
  ],
  "DoCourseCleanup": true,
  "IncludeAllCourses": true,
  "IncludeOnlyYorbitCourses": true,
  "IncludeOnlyAccountCourses": true,
  "IncludeCourseIdsForCleanup": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludeCourseIdsForCleanup": [
    "sample string 1",
    "sample string 2"
  ],
  "DoUnitsCleanup": true,
  "IncludeAllUnits": true,
  "IncludeOnlyYorbitUnits": true,
  "IncludeOnlyAccountUnits": true,
  "IncludeUnitIdsForCleanup": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludeUnitIdsForCleanup": [
    "sample string 1",
    "sample string 2"
  ],
  "DoDocDBCleanup": true,
  "IncludeMIDsForCleanup": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludeMIDsForCleanup": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<PackageCleanUpPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SkillPortal.Data.Models">
  <DoCourseCleanup>true</DoCourseCleanup>
  <DoDocDBCleanup>true</DoDocDBCleanup>
  <DoPackageCleanup>true</DoPackageCleanup>
  <DoUnitsCleanup>true</DoUnitsCleanup>
  <ExcludeCourseIdsForCleanup xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeCourseIdsForCleanup>
  <ExcludeMIDsForCleanup xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeMIDsForCleanup>
  <ExcludePackagesForCleanup xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludePackagesForCleanup>
  <ExcludeUnitIdsForCleanup xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeUnitIdsForCleanup>
  <IncludeAllCourses>true</IncludeAllCourses>
  <IncludeAllPackages>true</IncludeAllPackages>
  <IncludeAllUnits>true</IncludeAllUnits>
  <IncludeCourseIdsForCleanup xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </IncludeCourseIdsForCleanup>
  <IncludeMIDsForCleanup xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </IncludeMIDsForCleanup>
  <IncludeOnlyAccountCourses>true</IncludeOnlyAccountCourses>
  <IncludeOnlyAccountPackages>true</IncludeOnlyAccountPackages>
  <IncludeOnlyAccountUnits>true</IncludeOnlyAccountUnits>
  <IncludeOnlyYorbitCourses>true</IncludeOnlyYorbitCourses>
  <IncludeOnlyYorbitPackages>true</IncludeOnlyYorbitPackages>
  <IncludeOnlyYorbitUnits>true</IncludeOnlyYorbitUnits>
  <IncludePackagesForCleanup xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </IncludePackagesForCleanup>
  <IncludeUnitIdsForCleanup xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </IncludeUnitIdsForCleanup>
</PackageCleanUpPayload>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NameDescriptionTypeAdditional information
Version

None.

Content

None.

StatusCode

None.

ReasonPhrase

None.

Headers

None.

RequestMessage

None.

IsSuccessStatusCode

None.