POST api/agreements/customer

Add an customer to agreement.

Request Information

URI Parameters

None.

Body Parameters

AgreementCustomerPostRequest
NameDescriptionTypeAdditional information
AgreementNumber

integer

None.
CustomerNumber

integer

None.
ContactId

globally unique identifier

None.
FixedProductRange

boolean

None.

Remarks

None.

Example

None.

Request Formats

application/json, text/json

Sample: 
{
  "AgreementNumber": 1,
  "CustomerNumber": 2,
  "ContactId": "4ed43cc9-2ae5-4122-993c-e4f94fb66dcd",
  "FixedProductRange": true
}

application/xml, text/xml

Sample: 
<AgreementCustomerPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
  <AgreementNumber>1</AgreementNumber>
  <ContactId>4ed43cc9-2ae5-4122-993c-e4f94fb66dcd</ContactId>
  <CustomerNumber>2</CustomerNumber>
  <FixedProductRange>true</FixedProductRange>
</AgreementCustomerPostRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AgreementCustomerPostResponse
NameDescriptionTypeAdditional information
Errors

Collection of PostAgreementCustomerError

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