POST api/Student?StudentIdToAssign={StudentIdToAssign}&PartnerIdToAssociate={PartnerIdToAssociate}&CourseLockStatus={CourseLockStatus}

Request Information

URI Parameters

Name	Type	Additional information
StudentIdToAssign	integer	Required
PartnerIdToAssociate	integer	Required
CourseLockStatus	byte	Required

Body Parameters

CompContent

Name	Type	Additional information
CreatedBy	integer	None.
CourseId	integer	None.
CourseIds	Collection of integer	None.
TestProductID	integer	None.
TestProductIDs	Collection of integer	None.
NumTests	integer	None.
BookID	integer	None.
BookIDs	Collection of integer	None.
Identifier	string	None.
Name	string	None.
ImageURL	string	None.
StartDate	date	None.
EndDate	date	None.
StudentCutDate	date	None.
NumRedemptions	integer	None.
VisibleToPublic	boolean	None.
Priority	integer	None.
UsageDays	integer	None.
Notes	string	None.
ExternalReference	string	None.
PurchasePrice	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "CreatedBy": 1,
  "CourseId": 2,
  "CourseIds": [
    1,
    2
  ],
  "TestProductID": 3,
  "TestProductIDs": [
    1,
    2
  ],
  "NumTests": 4,
  "BookID": 5,
  "BookIDs": [
    1,
    2
  ],
  "Identifier": "sample string 6",
  "Name": "sample string 7",
  "ImageURL": "sample string 8",
  "StartDate": "2025-12-13T03:38:01.2128849-08:00",
  "EndDate": "2025-12-13T03:38:01.2128849-08:00",
  "StudentCutDate": "2025-12-13T03:38:01.2128849-08:00",
  "NumRedemptions": 12,
  "VisibleToPublic": true,
  "Priority": 14,
  "UsageDays": 15,
  "Notes": "sample string 16",
  "ExternalReference": "sample string 17",
  "PurchasePrice": 18.0
}

application/xml, text/xml

Sample:

<CompContent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ManagementServicesApi.Models">
  <BookID>5</BookID>
  <BookIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BookIDs>
  <CourseId>2</CourseId>
  <CourseIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CourseIds>
  <CreatedBy>1</CreatedBy>
  <EndDate>2025-12-13T03:38:01.2128849-08:00</EndDate>
  <ExternalReference>sample string 17</ExternalReference>
  <Identifier>sample string 6</Identifier>
  <ImageURL>sample string 8</ImageURL>
  <Name>sample string 7</Name>
  <Notes>sample string 16</Notes>
  <NumRedemptions>12</NumRedemptions>
  <NumTests>4</NumTests>
  <Priority>14</Priority>
  <PurchasePrice>18</PurchasePrice>
  <StartDate>2025-12-13T03:38:01.2128849-08:00</StartDate>
  <StudentCutDate>2025-12-13T03:38:01.2128849-08:00</StudentCutDate>
  <TestProductID>3</TestProductID>
  <TestProductIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TestProductIDs>
  <UsageDays>15</UsageDays>
  <VisibleToPublic>true</VisibleToPublic>
</CompContent>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Success

Name	Description	Type	Additional information
Successful		boolean	None.
MsgSuccess		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Successful": true,
  "MsgSuccess": "sample string 2"
}

application/xml, text/xml

Sample:

<Success xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ManagementServices.Repositories.Response">
  <MsgSuccess>sample string 2</MsgSuccess>
  <Successful>true</Successful>
</Success>