Administration Web Service

Administration

Click here for a complete list of operations.

FeedQuotaAddUpdate

Update one or more sets of feed credentials.
Optionally specify a higher level login and a sOrganisationIdentifier or sUserIdentifier.

OrganisationID or OrganisationIdentifier required.
UserID or UserIdentifier Optional to target a specific user
FeedID or FeedIdentifier required.

The following items are processed on the CFeedWithQuota class and the CFeed items are in general ignored
FeedID, FeedIdentifier, Slots, Postings, Spend, QuotaWarningLevel, SchedulePostings, ScheduleSpend, ScheduleTrigger, OrganisationID, OrganisationIdentifier, UserID, UserIdentifier,

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /SOAP/Administration.asmx HTTP/1.1
Host: api.logicmelon.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.logicmelon.com/FeedQuotaAddUpdate"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FeedQuotaAddUpdate xmlns="http://api.logicmelon.com/">
      <sCultureID>string</sCultureID>
      <sAPIKey>string</sAPIKey>
      <sUsername>string</sUsername>
      <sPassword>string</sPassword>
      <sOrganisationIdentifier>string</sOrganisationIdentifier>
      <sUserIdentifier>string</sUserIdentifier>
      <FeedQuotas>
        <CFeedQuota>
          <Slots>decimal</Slots>
          <Postings>decimal</Postings>
          <Spend>decimal</Spend>
          <CurrencyID>string</CurrencyID>
          <QuotaWarningLevel>decimal</QuotaWarningLevel>
          <SchedulePostings>decimal</SchedulePostings>
          <ScheduleSpend>decimal</ScheduleSpend>
          <ScheduleTrigger>long</ScheduleTrigger>
          <FeedID>int</FeedID>
          <FeedIdentifier>string</FeedIdentifier>
          <OrganisationID>int</OrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <UserID>int</UserID>
          <UserIdentifier>string</UserIdentifier>
          <UserFullName>string</UserFullName>
        </CFeedQuota>
        <CFeedQuota>
          <Slots>decimal</Slots>
          <Postings>decimal</Postings>
          <Spend>decimal</Spend>
          <CurrencyID>string</CurrencyID>
          <QuotaWarningLevel>decimal</QuotaWarningLevel>
          <SchedulePostings>decimal</SchedulePostings>
          <ScheduleSpend>decimal</ScheduleSpend>
          <ScheduleTrigger>long</ScheduleTrigger>
          <FeedID>int</FeedID>
          <FeedIdentifier>string</FeedIdentifier>
          <OrganisationID>int</OrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <UserID>int</UserID>
          <UserIdentifier>string</UserIdentifier>
          <UserFullName>string</UserFullName>
        </CFeedQuota>
      </FeedQuotas>
      <sBoolAdvancedDontUpdateCache>string</sBoolAdvancedDontUpdateCache>
    </FeedQuotaAddUpdate>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FeedQuotaAddUpdateResponse xmlns="http://api.logicmelon.com/">
      <FeedQuotaAddUpdateResult>boolean</FeedQuotaAddUpdateResult>
    </FeedQuotaAddUpdateResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /SOAP/Administration.asmx HTTP/1.1
Host: api.logicmelon.co.uk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FeedQuotaAddUpdate xmlns="http://api.logicmelon.com/">
      <sCultureID>string</sCultureID>
      <sAPIKey>string</sAPIKey>
      <sUsername>string</sUsername>
      <sPassword>string</sPassword>
      <sOrganisationIdentifier>string</sOrganisationIdentifier>
      <sUserIdentifier>string</sUserIdentifier>
      <FeedQuotas>
        <CFeedQuota>
          <Slots>decimal</Slots>
          <Postings>decimal</Postings>
          <Spend>decimal</Spend>
          <CurrencyID>string</CurrencyID>
          <QuotaWarningLevel>decimal</QuotaWarningLevel>
          <SchedulePostings>decimal</SchedulePostings>
          <ScheduleSpend>decimal</ScheduleSpend>
          <ScheduleTrigger>long</ScheduleTrigger>
          <FeedID>int</FeedID>
          <FeedIdentifier>string</FeedIdentifier>
          <OrganisationID>int</OrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <UserID>int</UserID>
          <UserIdentifier>string</UserIdentifier>
          <UserFullName>string</UserFullName>
        </CFeedQuota>
        <CFeedQuota>
          <Slots>decimal</Slots>
          <Postings>decimal</Postings>
          <Spend>decimal</Spend>
          <CurrencyID>string</CurrencyID>
          <QuotaWarningLevel>decimal</QuotaWarningLevel>
          <SchedulePostings>decimal</SchedulePostings>
          <ScheduleSpend>decimal</ScheduleSpend>
          <ScheduleTrigger>long</ScheduleTrigger>
          <FeedID>int</FeedID>
          <FeedIdentifier>string</FeedIdentifier>
          <OrganisationID>int</OrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <UserID>int</UserID>
          <UserIdentifier>string</UserIdentifier>
          <UserFullName>string</UserFullName>
        </CFeedQuota>
      </FeedQuotas>
      <sBoolAdvancedDontUpdateCache>string</sBoolAdvancedDontUpdateCache>
    </FeedQuotaAddUpdate>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FeedQuotaAddUpdateResponse xmlns="http://api.logicmelon.com/">
      <FeedQuotaAddUpdateResult>boolean</FeedQuotaAddUpdateResult>
    </FeedQuotaAddUpdateResponse>
  </soap12:Body>
</soap12:Envelope>