PUT api/agreements/articlegroupline

Updates an article group line on agreement.

Request Information

URI Parameters

None.

Body Parameters

AgreementArticleGroupLinePutRequest
NameDescriptionTypeAdditional information
Id

Id of the agreement article group line

globally unique identifier

None.

MainGroupId

Id of main group

integer

None.

SubGroupId

Id of sub group

integer

None.

DiscountFactor

Discount factor, 1.0 = 100% discount, 0.5 = 50%
decimal(18,4)

decimal number

Required

SpeedRatingId

Id of speed rating

integer

None.

AspectRatio

decimal(9,2)

decimal number

None.

Pattern

Tread pattern

string

Max length: 50

RimDiameter

decimal(9,2)

decimal number

None.

Design

string

Max length: 50

CalculatedPrice

If true, discount will not appear on orderlines

boolean

Required

Remarks

None.

Example

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "0cb429ec-6860-4591-b9c1-a97e256bea70",
  "MainGroupId": 2,
  "SubGroupId": 3,
  "DiscountFactor": 4.0,
  "SpeedRatingId": 1,
  "AspectRatio": 1.0,
  "Pattern": "sample string 5",
  "RimDiameter": 1.0,
  "Design": "sample string 6",
  "CalculatedPrice": true
}

application/xml, text/xml

Sample:
<AgreementArticleGroupLinePutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
  <AspectRatio>1</AspectRatio>
  <CalculatedPrice>true</CalculatedPrice>
  <Design>sample string 6</Design>
  <DiscountFactor>4</DiscountFactor>
  <MainGroupId>2</MainGroupId>
  <Pattern>sample string 5</Pattern>
  <RimDiameter>1</RimDiameter>
  <SpeedRatingId>1</SpeedRatingId>
  <SubGroupId>3</SubGroupId>
  <Id>0cb429ec-6860-4591-b9c1-a97e256bea70</Id>
</AgreementArticleGroupLinePutRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AgreementArticleGroupLinePutRequest'.

Response Information

Resource Description

AgreementArticleGroupLinePutResponse
NameDescriptionTypeAdditional information
Errors

List of errors when updating an article group line on agreement

Collection of PutAgreementArticleGroupLineError

None.

Success

Returns true if article group line is updated on agreement

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