Administration Web Service

Administration

Click here for a complete list of operations.

OrganisationAdd

Provides a mechanism to create a new organisation.
Please note sParentOrganisationIdentifier is required to indicate placement in the tree (either a valid numeric OrganisationID or string OrganisationIdentifier).
The newly created organisation is returned or null if failed.

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

<?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>
    <OrganisationAdd xmlns="http://api.logicmelon.com/">
      <Request>
        <sCultureID>string</sCultureID>
        <sAPIKey>string</sAPIKey>
        <sUsername>string</sUsername>
        <sPassword>string</sPassword>
        <sParentOrganisationIdentifier>string</sParentOrganisationIdentifier>
        <Organisation>
          <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>
        </Organisation>
        <sBoolAdvancedDontUpdateCache>string</sBoolAdvancedDontUpdateCache>
      </Request>
    </OrganisationAdd>
  </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>
    <OrganisationAddResponse xmlns="http://api.logicmelon.com/">
      <OrganisationAddResult>
        <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>
      </OrganisationAddResult>
    </OrganisationAddResponse>
  </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.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>
    <OrganisationAdd xmlns="http://api.logicmelon.com/">
      <Request>
        <sCultureID>string</sCultureID>
        <sAPIKey>string</sAPIKey>
        <sUsername>string</sUsername>
        <sPassword>string</sPassword>
        <sParentOrganisationIdentifier>string</sParentOrganisationIdentifier>
        <Organisation>
          <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>
        </Organisation>
        <sBoolAdvancedDontUpdateCache>string</sBoolAdvancedDontUpdateCache>
      </Request>
    </OrganisationAdd>
  </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>
    <OrganisationAddResponse xmlns="http://api.logicmelon.com/">
      <OrganisationAddResult>
        <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>
      </OrganisationAddResult>
    </OrganisationAddResponse>
  </soap12:Body>
</soap12:Envelope>