POST api/Student/TriggerStudentCompletedProgram

Request Information

URI Parameters

None.

Body Parameters

SchoolRequest
NameDescriptionTypeAdditional information
Id

integer

None.

AuthToken

string

None.

Payload

Object

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "AuthToken": "sample string 2",
  "Payload": {}
}

application/xml, text/xml

Sample:
<SchoolRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BSTServices.Models">
  <AuthToken>sample string 2</AuthToken>
  <Id>1</Id>
  <Payload />
</SchoolRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
Code

HttpStatusCode

None.

Message

string

None.

Body

Object

None.

Error

Error

None.

Response Formats

application/json, text/json

Sample:
{
  "Code": 100,
  "Message": "sample string 1",
  "Body": {},
  "Error": {
    "ID": "sample string 1",
    "RawError": "sample string 2",
    "StackTrace": "sample string 3",
    "FriendlyMessage": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BSTData">
  <Body />
  <Code>Continue</Code>
  <Error xmlns:d2p1="http://schemas.datacontract.org/2004/07/BSTServices.Models">
    <d2p1:FriendlyMessage>sample string 4</d2p1:FriendlyMessage>
    <d2p1:ID>sample string 1</d2p1:ID>
    <d2p1:RawError>sample string 2</d2p1:RawError>
    <d2p1:StackTrace>sample string 3</d2p1:StackTrace>
  </Error>
  <Message>sample string 1</Message>
</ApiResponse>