PUT api/InsertionOrder?sessionId={sessionId}

Updates an existing insertion order

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionId

string

Required

Body Parameters

APIInsertionOrder
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

AdvertiserId

Unique identifier of advertiser to which this belongs

integer

None.

CampaignId

Unique identifier of campaign to which this belongs

integer

None.

OrderNumber

Order number used for display purposes only

string

None.

EffectiveFromTimestamp

Timestamp from whence this becomes effective

string

None.

EffectiveToTimestamp

Timestamp until which this remains active

string

None.

Amount

Total value of insertion order

decimal number

None.

Adjustment

Denotes an insertion order added as an adjustment which will not cancel the residual balance of any prior insertion order (if that behaviour is enabled)

boolean

None.

Spent

Amount of spend assigned to insertion order

decimal number

None.

CancellationBalance

Value of insertion order cancelled when it expires or is superceded

decimal number

None.

CancellationTimestamp

Timestamp of expiry or when all funds have been consumed

string

None.

FirstSpendDate

Date of first spend assigned

string

None.

LastSpendDate

Date of last spend assigned

string

None.

Notes

Texual notes

string

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "advertiserId": 2,
  "campaignId": 1,
  "orderNumber": "sample string 3",
  "effectiveFromTimestamp": "sample string 4",
  "effectiveToTimestamp": "sample string 5",
  "amount": 1.1,
  "adjustment": true,
  "spent": 1.1,
  "cancellationBalance": 1.1,
  "cancellationTimestamp": "sample string 6",
  "firstSpendDate": "sample string 7",
  "lastSpendDate": "sample string 8",
  "notes": "sample string 9"
}

application/xml, text/xml

Sample:
<APIInsertionOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <Adjustment>true</Adjustment>
  <AdvertiserId>2</AdvertiserId>
  <Amount>1.1</Amount>
  <CampaignId>1</CampaignId>
  <CancellationBalance>1.1</CancellationBalance>
  <CancellationTimestamp>sample string 6</CancellationTimestamp>
  <EffectiveFromTimestamp>sample string 4</EffectiveFromTimestamp>
  <EffectiveToTimestamp>sample string 5</EffectiveToTimestamp>
  <FirstSpendDate>sample string 7</FirstSpendDate>
  <Id>1</Id>
  <LastSpendDate>sample string 8</LastSpendDate>
  <Notes>sample string 9</Notes>
  <OrderNumber>sample string 3</OrderNumber>
  <Spent>1.1</Spent>
</APIInsertionOrder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.