DELETE api/Agreements/{agreementNumber}

Deletes an agreement.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
agreementNumber

Agreement number to delete

 integer

Required

Body Parameters

None.

Remarks

None.

Example

None.

Response Information

Resource Description

AgreementDeleteResponse
NameDescriptionTypeAdditional information
Success

True if agreement is deleted otherwise false

 boolean

None.
Errors

Returns list of errors if agreement couldn't be deleted

 Collection of DeleteAgreementError

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Errors": [
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    },
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample: 
<AgreementDeleteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
  <Errors>
    <DeleteAgreementError>
      <ErrorCode>NotFound</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </DeleteAgreementError>
    <DeleteAgreementError>
      <ErrorCode>NotFound</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </DeleteAgreementError>
  </Errors>
  <Success>true</Success>
</AgreementDeleteResponse>