PUT api/ApplicationContractTrainee/SubstituteExisting

Substitute the ItemThatIsToBeReplaced with the NewItem. Mark the ItemThatIsToBeReplaced as deleted.

Request Information

URI Parameters

None.

Body Parameters

contains: BusinessID ApplicationID NewItemID = record that is to replace the substituted record ItemThatISToBeReplacedID = record that is to be substituted

ApplicationContractTraineeSubstituteExistingDTO
NameDescriptionTypeAdditional information
BusinessID

integer

None.

ApplicationID

integer

None.

NewItemID

integer

None.

ItemThatISToBeReplacedID

integer

None.

IsPreObligation

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "BusinessID": 1,
  "ApplicationID": 2,
  "NewItemID": 3,
  "ItemThatISToBeReplacedID": 4,
  "IsPreObligation": true
}

text/html

Sample:
{"BusinessID":1,"ApplicationID":2,"NewItemID":3,"ItemThatISToBeReplacedID":4,"IsPreObligation":true}

application/xml, text/xml

Sample:
<ApplicationContractTraineeSubstituteExistingDTO 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>
  <ItemThatISToBeReplacedID>4</ItemThatISToBeReplacedID>
  <NewItemID>3</NewItemID>
</ApplicationContractTraineeSubstituteExistingDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ID of the "new" ApplicationContractTrainee (NewItemID) record

StatusDTO
NameDescriptionTypeAdditional 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>