Administration Web Service

Administration

Click here for a complete list of operations.

FeedAuthenticationAddUpdate

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.
AuthValue1..5 Depending on feed requirements

The following items are processed on the CFeedWithAuthentication class and the CFeed items are in general ignored
FeedID, FeedIdentifier, FeedCost, FeedCostTypeID, CurrencyID, TurnOffDate, DefaultSelected, ForceSelected, Restricted, ReferencePrefix, ReferenceSuffix, ClientIdentifier, ClientName, OrganisationID, OrganisationIdentifier, UserID, UserIdentifier, AuthValue1, AuthValue2, AuthValue3, AuthValue4, AuthValue5,

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.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.logicmelon.com/FeedAuthenticationAddUpdate"

<?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>
    <FeedAuthenticationAddUpdate xmlns="http://api.logicmelon.com/">
      <sCultureID>string</sCultureID>
      <sAPIKey>string</sAPIKey>
      <sUsername>string</sUsername>
      <sPassword>string</sPassword>
      <sOrganisationIdentifier>string</sOrganisationIdentifier>
      <sUserIdentifier>string</sUserIdentifier>
      <FeedAuthentications>
        <CFeedAuthentication>
          <FeedCost>decimal</FeedCost>
          <FeedCostTypeID>Posting or Week</FeedCostTypeID>
          <CurrencyID>string</CurrencyID>
          <TurnOffDate>dateTime</TurnOffDate>
          <DefaultSelected>boolean</DefaultSelected>
          <ForceSelected>boolean</ForceSelected>
          <Restricted>boolean</Restricted>
          <ReferencePrefix>string</ReferencePrefix>
          <ReferenceSuffix>string</ReferenceSuffix>
          <ClientIdentifier>string</ClientIdentifier>
          <ClientName>string</ClientName>
          <FeedID>int</FeedID>
          <FeedIdentifier>string</FeedIdentifier>
          <OrganisationID>int</OrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <UserID>int</UserID>
          <UserIdentifier>string</UserIdentifier>
          <UserFullName>string</UserFullName>
          <AuthValue1>string</AuthValue1>
          <AuthValue2>string</AuthValue2>
          <AuthValue3>string</AuthValue3>
          <AuthValue4>string</AuthValue4>
          <AuthValue5>string</AuthValue5>
        </CFeedAuthentication>
        <CFeedAuthentication>
          <FeedCost>decimal</FeedCost>
          <FeedCostTypeID>Posting or Week</FeedCostTypeID>
          <CurrencyID>string</CurrencyID>
          <TurnOffDate>dateTime</TurnOffDate>
          <DefaultSelected>boolean</DefaultSelected>
          <ForceSelected>boolean</ForceSelected>
          <Restricted>boolean</Restricted>
          <ReferencePrefix>string</ReferencePrefix>
          <ReferenceSuffix>string</ReferenceSuffix>
          <ClientIdentifier>string</ClientIdentifier>
          <ClientName>string</ClientName>
          <FeedID>int</FeedID>
          <FeedIdentifier>string</FeedIdentifier>
          <OrganisationID>int</OrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <UserID>int</UserID>
          <UserIdentifier>string</UserIdentifier>
          <UserFullName>string</UserFullName>
          <AuthValue1>string</AuthValue1>
          <AuthValue2>string</AuthValue2>
          <AuthValue3>string</AuthValue3>
          <AuthValue4>string</AuthValue4>
          <AuthValue5>string</AuthValue5>
        </CFeedAuthentication>
      </FeedAuthentications>
      <sBoolAdvancedDontUpdateCache>string</sBoolAdvancedDontUpdateCache>
    </FeedAuthenticationAddUpdate>
  </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>
    <FeedAuthenticationAddUpdateResponse xmlns="http://api.logicmelon.com/">
      <FeedAuthenticationAddUpdateResult>boolean</FeedAuthenticationAddUpdateResult>
    </FeedAuthenticationAddUpdateResponse>
  </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.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>
    <FeedAuthenticationAddUpdate xmlns="http://api.logicmelon.com/">
      <sCultureID>string</sCultureID>
      <sAPIKey>string</sAPIKey>
      <sUsername>string</sUsername>
      <sPassword>string</sPassword>
      <sOrganisationIdentifier>string</sOrganisationIdentifier>
      <sUserIdentifier>string</sUserIdentifier>
      <FeedAuthentications>
        <CFeedAuthentication>
          <FeedCost>decimal</FeedCost>
          <FeedCostTypeID>Posting or Week</FeedCostTypeID>
          <CurrencyID>string</CurrencyID>
          <TurnOffDate>dateTime</TurnOffDate>
          <DefaultSelected>boolean</DefaultSelected>
          <ForceSelected>boolean</ForceSelected>
          <Restricted>boolean</Restricted>
          <ReferencePrefix>string</ReferencePrefix>
          <ReferenceSuffix>string</ReferenceSuffix>
          <ClientIdentifier>string</ClientIdentifier>
          <ClientName>string</ClientName>
          <FeedID>int</FeedID>
          <FeedIdentifier>string</FeedIdentifier>
          <OrganisationID>int</OrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <UserID>int</UserID>
          <UserIdentifier>string</UserIdentifier>
          <UserFullName>string</UserFullName>
          <AuthValue1>string</AuthValue1>
          <AuthValue2>string</AuthValue2>
          <AuthValue3>string</AuthValue3>
          <AuthValue4>string</AuthValue4>
          <AuthValue5>string</AuthValue5>
        </CFeedAuthentication>
        <CFeedAuthentication>
          <FeedCost>decimal</FeedCost>
          <FeedCostTypeID>Posting or Week</FeedCostTypeID>
          <CurrencyID>string</CurrencyID>
          <TurnOffDate>dateTime</TurnOffDate>
          <DefaultSelected>boolean</DefaultSelected>
          <ForceSelected>boolean</ForceSelected>
          <Restricted>boolean</Restricted>
          <ReferencePrefix>string</ReferencePrefix>
          <ReferenceSuffix>string</ReferenceSuffix>
          <ClientIdentifier>string</ClientIdentifier>
          <ClientName>string</ClientName>
          <FeedID>int</FeedID>
          <FeedIdentifier>string</FeedIdentifier>
          <OrganisationID>int</OrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <UserID>int</UserID>
          <UserIdentifier>string</UserIdentifier>
          <UserFullName>string</UserFullName>
          <AuthValue1>string</AuthValue1>
          <AuthValue2>string</AuthValue2>
          <AuthValue3>string</AuthValue3>
          <AuthValue4>string</AuthValue4>
          <AuthValue5>string</AuthValue5>
        </CFeedAuthentication>
      </FeedAuthentications>
      <sBoolAdvancedDontUpdateCache>string</sBoolAdvancedDontUpdateCache>
    </FeedAuthenticationAddUpdate>
  </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>
    <FeedAuthenticationAddUpdateResponse xmlns="http://api.logicmelon.com/">
      <FeedAuthenticationAddUpdateResult>boolean</FeedAuthenticationAddUpdateResult>
    </FeedAuthenticationAddUpdateResponse>
  </soap12:Body>
</soap12:Envelope>