GET api/agreements/customer?agreementNumber={agreementNumber}

Get all customers on an agreement.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
agreementNumber

Agreement number

 integer

Required

Body Parameters

None.

Remarks

Use api/agreements/customer?agreementNumber=5555 to get all customers for agreement with number 5555.
Returns empty list if no agreement or no customers was found

Example

None.

Response Information

Resource Description

Collection of AgreementCustomerResponse
NameDescriptionTypeAdditional information
AgreementNumber

integer

None.
CustomerNumber

integer

None.
ContactId

globally unique identifier

None.
FixedProductRange

boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "AgreementNumber": 1,
    "CustomerNumber": 2,
    "ContactId": "770fccb7-342b-4baa-aea2-9d8817a2fbe9",
    "FixedProductRange": true
  },
  {
    "AgreementNumber": 1,
    "CustomerNumber": 2,
    "ContactId": "770fccb7-342b-4baa-aea2-9d8817a2fbe9",
    "FixedProductRange": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfAgreementCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
  <AgreementCustomerResponse>
    <AgreementNumber>1</AgreementNumber>
    <ContactId>770fccb7-342b-4baa-aea2-9d8817a2fbe9</ContactId>
    <CustomerNumber>2</CustomerNumber>
    <FixedProductRange>true</FixedProductRange>
  </AgreementCustomerResponse>
  <AgreementCustomerResponse>
    <AgreementNumber>1</AgreementNumber>
    <ContactId>770fccb7-342b-4baa-aea2-9d8817a2fbe9</ContactId>
    <CustomerNumber>2</CustomerNumber>
    <FixedProductRange>true</FixedProductRange>
  </AgreementCustomerResponse>
</ArrayOfAgreementCustomerResponse>