Administration Web Service

Administration

Click here for a complete list of operations.

UserList

Provides a mechanism to search for a list of users based on a administrators credentials and optional a top level organisation identifier.
If a user identifier (numeric UserID or string UserIdentifier) it will look for the specific active user.

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

<?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>
    <UserList xmlns="http://api.logicmelon.com/">
      <Request>
        <sCultureID>string</sCultureID>
        <sAPIKey>string</sAPIKey>
        <sUsername>string</sUsername>
        <sPassword>string</sPassword>
        <sStartOrganisation>string</sStartOrganisation>
        <sUserIdentifier>string</sUserIdentifier>
      </Request>
    </UserList>
  </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>
    <UserListResponse xmlns="http://api.logicmelon.com/">
      <UserListResult>
        <CUser>
          <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>
        </CUser>
        <CUser>
          <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>
        </CUser>
      </UserListResult>
    </UserListResponse>
  </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>
    <UserList xmlns="http://api.logicmelon.com/">
      <Request>
        <sCultureID>string</sCultureID>
        <sAPIKey>string</sAPIKey>
        <sUsername>string</sUsername>
        <sPassword>string</sPassword>
        <sStartOrganisation>string</sStartOrganisation>
        <sUserIdentifier>string</sUserIdentifier>
      </Request>
    </UserList>
  </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>
    <UserListResponse xmlns="http://api.logicmelon.com/">
      <UserListResult>
        <CUser>
          <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>
        </CUser>
        <CUser>
          <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>
        </CUser>
      </UserListResult>
    </UserListResponse>
  </soap12:Body>
</soap12:Envelope>