Administration Web Service

Administration

Click here for a complete list of operations.

FeedQuotaList

Provides a mechanism to retrieve the feed credentials for a specific organisation or user.
Optionally specify a higher level login and a sOrganisationIdentifier or sUserIdentifier

DestinationsAsCSV Optional list of feeds as either numeric id's or string identifiers

This item contains both Quota details (AuthValue1..5, FeedCost.. etc) and feed list details (FeedIdentifier, FeedName, AuthNotes, etc).

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 /json/Administration.asmx HTTP/1.1
Host: api.logicmelon.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.logicmelon.com/FeedQuotaList"

<?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>
    <FeedQuotaList xmlns="http://api.logicmelon.com/">
      <Request>
        <sCultureID>string</sCultureID>
        <sAPIKey>string</sAPIKey>
        <sUsername>string</sUsername>
        <sPassword>string</sPassword>
        <sOrganisationIdentifier>string</sOrganisationIdentifier>
        <sUserIdentifier>string</sUserIdentifier>
        <DestinationsAsCSV>string</DestinationsAsCSV>
      </Request>
    </FeedQuotaList>
  </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>
    <FeedQuotaListResponse xmlns="http://api.logicmelon.com/">
      <FeedQuotaListResult>
        <CFeedQuotaWithFeedList>
          <Auth1>string</Auth1>
          <Auth2>string</Auth2>
          <Auth3>string</Auth3>
          <Auth4>string</Auth4>
          <Auth5>string</Auth5>
          <AuthNotes>string</AuthNotes>
          <CultureID>string</CultureID>
          <FeedName>string</FeedName>
          <FeedTypeID>unsignedByte</FeedTypeID>
          <Free>unsignedByte</Free>
          <HomePageURL>string</HomePageURL>
          <LogoURL>string</LogoURL>
          <ContactName>string</ContactName>
          <ContactPhone>string</ContactPhone>
          <ContactEmail>string</ContactEmail>
          <SupportDelete>boolean</SupportDelete>
          <SupportFix>boolean</SupportFix>
          <UploadTimes>string</UploadTimes>
          <UploadTimesCache>string</UploadTimesCache>
          <Visibility>int</Visibility>
          <LiveDate>dateTime</LiveDate>
          <ShortDescription>string</ShortDescription>
          <SpecialHandlingRequired>boolean</SpecialHandlingRequired>
        </CFeedQuotaWithFeedList>
        <CFeedQuotaWithFeedList>
          <Auth1>string</Auth1>
          <Auth2>string</Auth2>
          <Auth3>string</Auth3>
          <Auth4>string</Auth4>
          <Auth5>string</Auth5>
          <AuthNotes>string</AuthNotes>
          <CultureID>string</CultureID>
          <FeedName>string</FeedName>
          <FeedTypeID>unsignedByte</FeedTypeID>
          <Free>unsignedByte</Free>
          <HomePageURL>string</HomePageURL>
          <LogoURL>string</LogoURL>
          <ContactName>string</ContactName>
          <ContactPhone>string</ContactPhone>
          <ContactEmail>string</ContactEmail>
          <SupportDelete>boolean</SupportDelete>
          <SupportFix>boolean</SupportFix>
          <UploadTimes>string</UploadTimes>
          <UploadTimesCache>string</UploadTimesCache>
          <Visibility>int</Visibility>
          <LiveDate>dateTime</LiveDate>
          <ShortDescription>string</ShortDescription>
          <SpecialHandlingRequired>boolean</SpecialHandlingRequired>
        </CFeedQuotaWithFeedList>
      </FeedQuotaListResult>
    </FeedQuotaListResponse>
  </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 /json/Administration.asmx HTTP/1.1
Host: api.logicmelon.com
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>
    <FeedQuotaList xmlns="http://api.logicmelon.com/">
      <Request>
        <sCultureID>string</sCultureID>
        <sAPIKey>string</sAPIKey>
        <sUsername>string</sUsername>
        <sPassword>string</sPassword>
        <sOrganisationIdentifier>string</sOrganisationIdentifier>
        <sUserIdentifier>string</sUserIdentifier>
        <DestinationsAsCSV>string</DestinationsAsCSV>
      </Request>
    </FeedQuotaList>
  </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>
    <FeedQuotaListResponse xmlns="http://api.logicmelon.com/">
      <FeedQuotaListResult>
        <CFeedQuotaWithFeedList>
          <Auth1>string</Auth1>
          <Auth2>string</Auth2>
          <Auth3>string</Auth3>
          <Auth4>string</Auth4>
          <Auth5>string</Auth5>
          <AuthNotes>string</AuthNotes>
          <CultureID>string</CultureID>
          <FeedName>string</FeedName>
          <FeedTypeID>unsignedByte</FeedTypeID>
          <Free>unsignedByte</Free>
          <HomePageURL>string</HomePageURL>
          <LogoURL>string</LogoURL>
          <ContactName>string</ContactName>
          <ContactPhone>string</ContactPhone>
          <ContactEmail>string</ContactEmail>
          <SupportDelete>boolean</SupportDelete>
          <SupportFix>boolean</SupportFix>
          <UploadTimes>string</UploadTimes>
          <UploadTimesCache>string</UploadTimesCache>
          <Visibility>int</Visibility>
          <LiveDate>dateTime</LiveDate>
          <ShortDescription>string</ShortDescription>
          <SpecialHandlingRequired>boolean</SpecialHandlingRequired>
        </CFeedQuotaWithFeedList>
        <CFeedQuotaWithFeedList>
          <Auth1>string</Auth1>
          <Auth2>string</Auth2>
          <Auth3>string</Auth3>
          <Auth4>string</Auth4>
          <Auth5>string</Auth5>
          <AuthNotes>string</AuthNotes>
          <CultureID>string</CultureID>
          <FeedName>string</FeedName>
          <FeedTypeID>unsignedByte</FeedTypeID>
          <Free>unsignedByte</Free>
          <HomePageURL>string</HomePageURL>
          <LogoURL>string</LogoURL>
          <ContactName>string</ContactName>
          <ContactPhone>string</ContactPhone>
          <ContactEmail>string</ContactEmail>
          <SupportDelete>boolean</SupportDelete>
          <SupportFix>boolean</SupportFix>
          <UploadTimes>string</UploadTimes>
          <UploadTimesCache>string</UploadTimesCache>
          <Visibility>int</Visibility>
          <LiveDate>dateTime</LiveDate>
          <ShortDescription>string</ShortDescription>
          <SpecialHandlingRequired>boolean</SpecialHandlingRequired>
        </CFeedQuotaWithFeedList>
      </FeedQuotaListResult>
    </FeedQuotaListResponse>
  </soap12:Body>
</soap12:Envelope>