PUT api/Compute/Substitute
Substitute trainee for another trainee. This end point will mark the trainee that is to be substituted (pointed to by SubstituteTraineeID) as "deleted." int BusinessID int ApplicationID int NewTraineeID - This is the id of the new trainee that is to be added int SubstituteTraineeID - This is the id of the trainee that is being substituted.
Request Information
URI Parameters
None.
Body Parameters
SubstituteDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| BusinessID | integer |
None. |
|
| ApplicationID | integer |
None. |
|
| NewTraineeID | integer |
None. |
|
| SubstituteTraineeID | integer |
None. |
|
| IsPreObligation | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"BusinessID": 1,
"ApplicationID": 2,
"NewTraineeID": 3,
"SubstituteTraineeID": 4,
"IsPreObligation": true
}
text/html
Sample:
{"BusinessID":1,"ApplicationID":2,"NewTraineeID":3,"SubstituteTraineeID":4,"IsPreObligation":true}
application/xml, text/xml
Sample:
<SubstituteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TrainingFundREST._BOL"> <ApplicationID>2</ApplicationID> <BusinessID>1</BusinessID> <IsPreObligation>true</IsPreObligation> <NewTraineeID>3</NewTraineeID> <SubstituteTraineeID>4</SubstituteTraineeID> </SubstituteDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
StatusDTO id less than 0 means error
StatusDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
None. |
|
| msg | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"id": 1,
"msg": "sample string 1"
}
text/html
Sample:
{"id":1,"msg":"sample string 1"}
application/xml, text/xml
Sample:
<StatusDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TrainingFundREST._DAL"> <id>1</id> <msg>sample string 1</msg> </StatusDTO>