PUT api/Subcontracts/{subcontractId}/Certifications/{certificationId}/Versions/{certificationVersionId}/Retentions

Updates a certification retention

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subcontractId

integer

Required

certificationId

integer

Required

certificationVersionId

integer

Required

Body Parameters

CertificationRetentionUpdateDto
NameDescriptionTypeAdditional information
ActualRetentionRateCalculated

decimal number

None.

AmountToApplyRetentionCalculated

decimal number

None.

RetentionReleasedAmount

decimal number

None.

ThisPeriodRetentionAmount

decimal number

None.

RetentionAppliedTypeId

AmountAppliedTypeId

None.

Request Formats

application/json, text/json

Sample:
{
  "actualRetentionRateCalculated": 1.0,
  "amountToApplyRetentionCalculated": 1.0,
  "retentionReleasedAmount": 1.0,
  "thisPeriodRetentionAmount": 1.0,
  "retentionAppliedTypeId": 1
}

text/html

Sample:
{"actualRetentionRateCalculated":1.0,"amountToApplyRetentionCalculated":1.0,"retentionReleasedAmount":1.0,"thisPeriodRetentionAmount":1.0,"retentionAppliedTypeId":1}

application/xml, text/xml

Sample:
<CertificationRetentionUpdateDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.CertificationAgg">
  <ActualRetentionRateCalculated>1</ActualRetentionRateCalculated>
  <AmountToApplyRetentionCalculated>1</AmountToApplyRetentionCalculated>
  <RetentionAppliedTypeId>Amount</RetentionAppliedTypeId>
  <RetentionReleasedAmount>1</RetentionReleasedAmount>
  <ThisPeriodRetentionAmount>1</ThisPeriodRetentionAmount>
</CertificationRetentionUpdateDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiDataResultOfBoolean
NameDescriptionTypeAdditional information
Data

boolean

None.

Success

boolean

None.

Message

string

None.

Errors

Collection of CustomError

None.

Warnings

Collection of string

None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.