Administration Web Service

Administration

Click here for a complete list of operations.

OrganisationAndUserAdd

Sep 2018. Provides a mechanism to create a new organisation and user at the same time.
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 /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/OrganisationAndUserAdd"

<?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>
    <OrganisationAndUserAdd xmlns="http://api.logicmelon.com/">
      <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>
      <User>
        <UserID>int</UserID>
        <OrganisationID>int</OrganisationID>
        <UserIdentifier>string</UserIdentifier>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Phone>string</Phone>
        <Email>string</Email>
        <ApplicationsEmail>string</ApplicationsEmail>
        <Fax>string</Fax>
        <Username>string</Username>
        <Password>string</Password>
        <UserRoleID>int</UserRoleID>
        <UserCultureID>string</UserCultureID>
        <WebSite>string</WebSite>
        <UserAddress1>string</UserAddress1>
        <UserAddress2>string</UserAddress2>
        <UserAddress3>string</UserAddress3>
        <UserState>string</UserState>
        <UserCountry>string</UserCountry>
        <UserPostCode>string</UserPostCode>
        <UserWebSite>string</UserWebSite>
        <Mobile>string</Mobile>
        <Position>string</Position>
        <BBDCopySentMessages>boolean</BBDCopySentMessages>
        <BBDLiveAdvertEmail>boolean</BBDLiveAdvertEmail>
        <BBDExpiringEmail>boolean</BBDExpiringEmail>
        <BBDExpiredEmail>boolean</BBDExpiredEmail>
        <DailyNewCandidatesEmail>boolean</DailyNewCandidatesEmail>
        <BBDInformCandidatesEmail>boolean</BBDInformCandidatesEmail>
        <BBDRemovedManuallyEmail>boolean</BBDRemovedManuallyEmail>
      </User>
      <sBoolAdvancedDontUpdateCache>string</sBoolAdvancedDontUpdateCache>
    </OrganisationAndUserAdd>
  </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>
    <OrganisationAndUserAddResponse xmlns="http://api.logicmelon.com/">
      <OrganisationAndUserAddResult>
        <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>
        <User>
          <UserID>int</UserID>
          <OrganisationID>int</OrganisationID>
          <UserIdentifier>string</UserIdentifier>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Phone>string</Phone>
          <Email>string</Email>
          <ApplicationsEmail>string</ApplicationsEmail>
          <Fax>string</Fax>
          <Username>string</Username>
          <Password>string</Password>
          <UserRoleID>int</UserRoleID>
          <UserCultureID>string</UserCultureID>
          <WebSite>string</WebSite>
          <UserAddress1>string</UserAddress1>
          <UserAddress2>string</UserAddress2>
          <UserAddress3>string</UserAddress3>
          <UserState>string</UserState>
          <UserCountry>string</UserCountry>
          <UserPostCode>string</UserPostCode>
          <UserWebSite>string</UserWebSite>
          <Mobile>string</Mobile>
          <Position>string</Position>
          <BBDCopySentMessages>boolean</BBDCopySentMessages>
          <BBDLiveAdvertEmail>boolean</BBDLiveAdvertEmail>
          <BBDExpiringEmail>boolean</BBDExpiringEmail>
          <BBDExpiredEmail>boolean</BBDExpiredEmail>
          <DailyNewCandidatesEmail>boolean</DailyNewCandidatesEmail>
          <BBDInformCandidatesEmail>boolean</BBDInformCandidatesEmail>
          <BBDRemovedManuallyEmail>boolean</BBDRemovedManuallyEmail>
        </User>
      </OrganisationAndUserAddResult>
    </OrganisationAndUserAddResponse>
  </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>
    <OrganisationAndUserAdd xmlns="http://api.logicmelon.com/">
      <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>
      <User>
        <UserID>int</UserID>
        <OrganisationID>int</OrganisationID>
        <UserIdentifier>string</UserIdentifier>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Phone>string</Phone>
        <Email>string</Email>
        <ApplicationsEmail>string</ApplicationsEmail>
        <Fax>string</Fax>
        <Username>string</Username>
        <Password>string</Password>
        <UserRoleID>int</UserRoleID>
        <UserCultureID>string</UserCultureID>
        <WebSite>string</WebSite>
        <UserAddress1>string</UserAddress1>
        <UserAddress2>string</UserAddress2>
        <UserAddress3>string</UserAddress3>
        <UserState>string</UserState>
        <UserCountry>string</UserCountry>
        <UserPostCode>string</UserPostCode>
        <UserWebSite>string</UserWebSite>
        <Mobile>string</Mobile>
        <Position>string</Position>
        <BBDCopySentMessages>boolean</BBDCopySentMessages>
        <BBDLiveAdvertEmail>boolean</BBDLiveAdvertEmail>
        <BBDExpiringEmail>boolean</BBDExpiringEmail>
        <BBDExpiredEmail>boolean</BBDExpiredEmail>
        <DailyNewCandidatesEmail>boolean</DailyNewCandidatesEmail>
        <BBDInformCandidatesEmail>boolean</BBDInformCandidatesEmail>
        <BBDRemovedManuallyEmail>boolean</BBDRemovedManuallyEmail>
      </User>
      <sBoolAdvancedDontUpdateCache>string</sBoolAdvancedDontUpdateCache>
    </OrganisationAndUserAdd>
  </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>
    <OrganisationAndUserAddResponse xmlns="http://api.logicmelon.com/">
      <OrganisationAndUserAddResult>
        <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>
        <User>
          <UserID>int</UserID>
          <OrganisationID>int</OrganisationID>
          <UserIdentifier>string</UserIdentifier>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Phone>string</Phone>
          <Email>string</Email>
          <ApplicationsEmail>string</ApplicationsEmail>
          <Fax>string</Fax>
          <Username>string</Username>
          <Password>string</Password>
          <UserRoleID>int</UserRoleID>
          <UserCultureID>string</UserCultureID>
          <WebSite>string</WebSite>
          <UserAddress1>string</UserAddress1>
          <UserAddress2>string</UserAddress2>
          <UserAddress3>string</UserAddress3>
          <UserState>string</UserState>
          <UserCountry>string</UserCountry>
          <UserPostCode>string</UserPostCode>
          <UserWebSite>string</UserWebSite>
          <Mobile>string</Mobile>
          <Position>string</Position>
          <BBDCopySentMessages>boolean</BBDCopySentMessages>
          <BBDLiveAdvertEmail>boolean</BBDLiveAdvertEmail>
          <BBDExpiringEmail>boolean</BBDExpiringEmail>
          <BBDExpiredEmail>boolean</BBDExpiredEmail>
          <DailyNewCandidatesEmail>boolean</DailyNewCandidatesEmail>
          <BBDInformCandidatesEmail>boolean</BBDInformCandidatesEmail>
          <BBDRemovedManuallyEmail>boolean</BBDRemovedManuallyEmail>
        </User>
      </OrganisationAndUserAddResult>
    </OrganisationAndUserAddResponse>
  </soap12:Body>
</soap12:Envelope>