PUT api/agreements/customer

Update customer on agreement.

Request Information

URI Parameters

None.

Body Parameters

AgreementCustomerPutRequest
NameDescriptionTypeAdditional information
AgreementNumber

integer

None.
CustomerNumber

integer

None.
ContactId

globally unique identifier

None.
FixedProductRange

boolean

None.

Remarks

Adds customer to agreement if customer can't be found on agreement

Example

None.

Request Formats

application/json, text/json

Sample: 
{
  "AgreementNumber": 1,
  "CustomerNumber": 2,
  "ContactId": "7be55d1c-5804-40f7-ac8f-d3ce5ed1ef9e",
  "FixedProductRange": true
}

application/xml, text/xml

Sample: 
<AgreementCustomerPutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
  <AgreementNumber>1</AgreementNumber>
  <ContactId>7be55d1c-5804-40f7-ac8f-d3ce5ed1ef9e</ContactId>
  <CustomerNumber>2</CustomerNumber>
  <FixedProductRange>true</FixedProductRange>
</AgreementCustomerPutRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AgreementCustomerPutResponse
NameDescriptionTypeAdditional information
Errors

Collection of PutAgreementCustomerError

None.
Success

boolean

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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