DELETE api/agreements/customer/{agreementNumber}/{customerNumber}

Deletes an customer on agreement.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
agreementNumber

Agreement number

 integer

Required
customerNumber

Customer number that should be deleted from agreement

 integer

Required

Body Parameters

None.

Remarks

None.

Example

None.

Response Information

Resource Description

AgreementCustomerDeleteResponse
NameDescriptionTypeAdditional information
Success

Returns true if customer is deleted on agreement

 boolean

None.
Errors

List of errors when deleting an customer on agreement

 Collection of DeleteAgreementCustomerError

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: 
<AgreementCustomerDeleteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
  <Errors>
    <DeleteAgreementCustomerError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </DeleteAgreementCustomerError>
    <DeleteAgreementCustomerError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </DeleteAgreementCustomerError>
  </Errors>
  <Success>true</Success>
</AgreementCustomerDeleteResponse>