Administration Web Service

Administration

Click here for a complete list of operations.

OrganisationList

Provides a mechanism to search for a list of organisations based on a administrators credentials and optional a top level organisation identifier.
If an organisation identifier (numeric OrganisationID or string OrganisationIdentifier) it will look for the specific active organisation.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
sCultureID:
sAPIKey:
sUsername:
sPassword:
sStartOrganisation:
sOrganisationIdentifier:

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/OrganisationList"

<?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>
    <OrganisationList xmlns="http://api.logicmelon.com/">
      <sCultureID>string</sCultureID>
      <sAPIKey>string</sAPIKey>
      <sUsername>string</sUsername>
      <sPassword>string</sPassword>
      <sStartOrganisation>string</sStartOrganisation>
      <sOrganisationIdentifier>string</sOrganisationIdentifier>
    </OrganisationList>
  </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>
    <OrganisationListResponse xmlns="http://api.logicmelon.com/">
      <OrganisationListResult>
        <COrganisation>
          <SchemaIdentifier>string</SchemaIdentifier>
          <OrganisationID>int</OrganisationID>
          <ParentOrganisationID>int</ParentOrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <OrganisationTZID>short</OrganisationTZID>
          <OrganisationCultureID>string</OrganisationCultureID>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <State>string</State>
          <Country>string</Country>
          <PostCode>string</PostCode>
          <MainContactName>string</MainContactName>
          <MainContactPhone>string</MainContactPhone>
          <MainContactFax>string</MainContactFax>
          <MainContactEmail>string</MainContactEmail>
          <WebSite>string</WebSite>
          <OrganisationLogoURL>string</OrganisationLogoURL>
        </COrganisation>
        <COrganisation>
          <SchemaIdentifier>string</SchemaIdentifier>
          <OrganisationID>int</OrganisationID>
          <ParentOrganisationID>int</ParentOrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <OrganisationTZID>short</OrganisationTZID>
          <OrganisationCultureID>string</OrganisationCultureID>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <State>string</State>
          <Country>string</Country>
          <PostCode>string</PostCode>
          <MainContactName>string</MainContactName>
          <MainContactPhone>string</MainContactPhone>
          <MainContactFax>string</MainContactFax>
          <MainContactEmail>string</MainContactEmail>
          <WebSite>string</WebSite>
          <OrganisationLogoURL>string</OrganisationLogoURL>
        </COrganisation>
      </OrganisationListResult>
    </OrganisationListResponse>
  </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>
    <OrganisationList xmlns="http://api.logicmelon.com/">
      <sCultureID>string</sCultureID>
      <sAPIKey>string</sAPIKey>
      <sUsername>string</sUsername>
      <sPassword>string</sPassword>
      <sStartOrganisation>string</sStartOrganisation>
      <sOrganisationIdentifier>string</sOrganisationIdentifier>
    </OrganisationList>
  </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>
    <OrganisationListResponse xmlns="http://api.logicmelon.com/">
      <OrganisationListResult>
        <COrganisation>
          <SchemaIdentifier>string</SchemaIdentifier>
          <OrganisationID>int</OrganisationID>
          <ParentOrganisationID>int</ParentOrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <OrganisationTZID>short</OrganisationTZID>
          <OrganisationCultureID>string</OrganisationCultureID>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <State>string</State>
          <Country>string</Country>
          <PostCode>string</PostCode>
          <MainContactName>string</MainContactName>
          <MainContactPhone>string</MainContactPhone>
          <MainContactFax>string</MainContactFax>
          <MainContactEmail>string</MainContactEmail>
          <WebSite>string</WebSite>
          <OrganisationLogoURL>string</OrganisationLogoURL>
        </COrganisation>
        <COrganisation>
          <SchemaIdentifier>string</SchemaIdentifier>
          <OrganisationID>int</OrganisationID>
          <ParentOrganisationID>int</ParentOrganisationID>
          <OrganisationIdentifier>string</OrganisationIdentifier>
          <OrganisationName>string</OrganisationName>
          <OrganisationTZID>short</OrganisationTZID>
          <OrganisationCultureID>string</OrganisationCultureID>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <State>string</State>
          <Country>string</Country>
          <PostCode>string</PostCode>
          <MainContactName>string</MainContactName>
          <MainContactPhone>string</MainContactPhone>
          <MainContactFax>string</MainContactFax>
          <MainContactEmail>string</MainContactEmail>
          <WebSite>string</WebSite>
          <OrganisationLogoURL>string</OrganisationLogoURL>
        </COrganisation>
      </OrganisationListResult>
    </OrganisationListResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /SOAP/Administration.asmx/OrganisationList?sCultureID=string&sAPIKey=string&sUsername=string&sPassword=string&sStartOrganisation=string&sOrganisationIdentifier=string HTTP/1.1
Host: api.logicmelon.com

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCOrganisation xmlns="http://api.logicmelon.com/">
  <COrganisation>
    <SchemaIdentifier>string</SchemaIdentifier>
    <OrganisationID>int</OrganisationID>
    <ParentOrganisationID>int</ParentOrganisationID>
    <OrganisationIdentifier>string</OrganisationIdentifier>
    <OrganisationName>string</OrganisationName>
    <OrganisationTZID>short</OrganisationTZID>
    <OrganisationCultureID>string</OrganisationCultureID>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <Address3>string</Address3>
    <State>string</State>
    <Country>string</Country>
    <PostCode>string</PostCode>
    <MainContactName>string</MainContactName>
    <MainContactPhone>string</MainContactPhone>
    <MainContactFax>string</MainContactFax>
    <MainContactEmail>string</MainContactEmail>
    <WebSite>string</WebSite>
    <OrganisationLogoURL>string</OrganisationLogoURL>
  </COrganisation>
  <COrganisation>
    <SchemaIdentifier>string</SchemaIdentifier>
    <OrganisationID>int</OrganisationID>
    <ParentOrganisationID>int</ParentOrganisationID>
    <OrganisationIdentifier>string</OrganisationIdentifier>
    <OrganisationName>string</OrganisationName>
    <OrganisationTZID>short</OrganisationTZID>
    <OrganisationCultureID>string</OrganisationCultureID>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <Address3>string</Address3>
    <State>string</State>
    <Country>string</Country>
    <PostCode>string</PostCode>
    <MainContactName>string</MainContactName>
    <MainContactPhone>string</MainContactPhone>
    <MainContactFax>string</MainContactFax>
    <MainContactEmail>string</MainContactEmail>
    <WebSite>string</WebSite>
    <OrganisationLogoURL>string</OrganisationLogoURL>
  </COrganisation>
</ArrayOfCOrganisation>

HTTP POST

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

POST /SOAP/Administration.asmx/OrganisationList HTTP/1.1
Host: api.logicmelon.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sCultureID=string&sAPIKey=string&sUsername=string&sPassword=string&sStartOrganisation=string&sOrganisationIdentifier=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCOrganisation xmlns="http://api.logicmelon.com/">
  <COrganisation>
    <SchemaIdentifier>string</SchemaIdentifier>
    <OrganisationID>int</OrganisationID>
    <ParentOrganisationID>int</ParentOrganisationID>
    <OrganisationIdentifier>string</OrganisationIdentifier>
    <OrganisationName>string</OrganisationName>
    <OrganisationTZID>short</OrganisationTZID>
    <OrganisationCultureID>string</OrganisationCultureID>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <Address3>string</Address3>
    <State>string</State>
    <Country>string</Country>
    <PostCode>string</PostCode>
    <MainContactName>string</MainContactName>
    <MainContactPhone>string</MainContactPhone>
    <MainContactFax>string</MainContactFax>
    <MainContactEmail>string</MainContactEmail>
    <WebSite>string</WebSite>
    <OrganisationLogoURL>string</OrganisationLogoURL>
  </COrganisation>
  <COrganisation>
    <SchemaIdentifier>string</SchemaIdentifier>
    <OrganisationID>int</OrganisationID>
    <ParentOrganisationID>int</ParentOrganisationID>
    <OrganisationIdentifier>string</OrganisationIdentifier>
    <OrganisationName>string</OrganisationName>
    <OrganisationTZID>short</OrganisationTZID>
    <OrganisationCultureID>string</OrganisationCultureID>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <Address3>string</Address3>
    <State>string</State>
    <Country>string</Country>
    <PostCode>string</PostCode>
    <MainContactName>string</MainContactName>
    <MainContactPhone>string</MainContactPhone>
    <MainContactFax>string</MainContactFax>
    <MainContactEmail>string</MainContactEmail>
    <WebSite>string</WebSite>
    <OrganisationLogoURL>string</OrganisationLogoURL>
  </COrganisation>
</ArrayOfCOrganisation>