Administration Web Service

Administration

Click here for a complete list of operations.

UserAdd

Provides a mechanism to create a new user.
Please note sParentOrganisationIdentifier is required to indicate placement in the tree (either a valid numeric OrganisationID or string OrganisationIdentifier).
The newly created user 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 /SOAP/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/UserAdd"

<?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>
    <UserAdd xmlns="http://api.logicmelon.com/">
      <sCultureID>string</sCultureID>
      <sAPIKey>string</sAPIKey>
      <sUsername>string</sUsername>
      <sPassword>string</sPassword>
      <sParentOrganisationIdentifier>string</sParentOrganisationIdentifier>
      <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>
    </UserAdd>
  </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>
    <UserAddResponse xmlns="http://api.logicmelon.com/">
      <UserAddResult>
        <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>
      </UserAddResult>
    </UserAddResponse>
  </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.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>
    <UserAdd xmlns="http://api.logicmelon.com/">
      <sCultureID>string</sCultureID>
      <sAPIKey>string</sAPIKey>
      <sUsername>string</sUsername>
      <sPassword>string</sPassword>
      <sParentOrganisationIdentifier>string</sParentOrganisationIdentifier>
      <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>
    </UserAdd>
  </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>
    <UserAddResponse xmlns="http://api.logicmelon.com/">
      <UserAddResult>
        <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>
      </UserAddResult>
    </UserAddResponse>
  </soap12:Body>
</soap12:Envelope>