Administration Web Service

Administration

Click here for a complete list of operations.

OrganisationUpdate

Provides a mechanism to update an existing organisation.
It is suggested to get an organisation object using OrganisationList, modify values, and then submit back in this function.
Only certain fields are updateable.
The updated organisation is returned.

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

<?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>
    <OrganisationUpdate xmlns="http://api.logicmelon.com/">
      <Request>
        <sCultureID>string</sCultureID>
        <sAPIKey>string</sAPIKey>
        <sUsername>string</sUsername>
        <sPassword>string</sPassword>
        <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>
      </Request>
    </OrganisationUpdate>
  </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>
    <OrganisationUpdateResponse xmlns="http://api.logicmelon.com/">
      <OrganisationUpdateResult>
        <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>
      </OrganisationUpdateResult>
    </OrganisationUpdateResponse>
  </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>
    <OrganisationUpdate xmlns="http://api.logicmelon.com/">
      <Request>
        <sCultureID>string</sCultureID>
        <sAPIKey>string</sAPIKey>
        <sUsername>string</sUsername>
        <sPassword>string</sPassword>
        <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>
      </Request>
    </OrganisationUpdate>
  </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>
    <OrganisationUpdateResponse xmlns="http://api.logicmelon.com/">
      <OrganisationUpdateResult>
        <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>
      </OrganisationUpdateResult>
    </OrganisationUpdateResponse>
  </soap12:Body>
</soap12:Envelope>