Administration


Click here for a complete list of operations.

UserList

from 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/UserList HTTP/1.1
Host: api.logicmelon.com
Content-Type: application/json; charset=utf-8
Content-Length: length

{
  "Request": {
    "sCultureID": "string",
    "sAPIKey": "string",
    "sUsername": "string",
    "sPassword": "string",
    "sStartOrganisation": "string",
    "sUserIdentifier": "string"
  }
}
  
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

  
{ "d": [ or {
    "CUser": [
      "UserID": int,
      "OrganisationID": int,
      "UserIdentifier": "string",
      "FirstName": "string",
      "LastName": "string",
      "Phone": "string",
      "Email": {string",
      "ApplicationsEmail": "string",
      "Fax": "string",
      "Username": "string",
      "Password": "string",
      "UserRoleID": int,
      "UserCultureID": "string",
      "WebSite": "string",
      "UserAddress1": "string",
      "UserAddress2": "string",
      "UserAddress3": "string",
      "UserState": "string",
      "UserCountry": "string",
      "UserPostCode": "string",
      "UserWebSite": "string",
      "Mobile": "string",
      "Position": "string",
      "BBDCopySentMessages": boolean,
      "BBDLiveAdvertEmail": boolean,
      "BBDExpiringEmail": boolean,
      "BBDExpiredEmail": boolean,
      "DailyNewCandidatesEmail": boolean,
      "BBDInformCandidatesEmail": boolean,
      "BBDRemovedManuallyEmail": boolean
   },
    "CUser": [
      "UserID": int,
      "OrganisationID": int,
      "UserIdentifier": "string",
      "FirstName": "string",
      "LastName": "string",
      "Phone": "string",
      "Email": {string",
      "ApplicationsEmail": "string",
      "Fax": "string",
      "Username": "string",
      "Password": "string",
      "UserRoleID": int,
      "UserCultureID": "string",
      "WebSite": "string",
      "UserAddress1": "string",
      "UserAddress2": "string",
      "UserAddress3": "string",
      "UserState": "string",
      "UserCountry": "string",
      "UserPostCode": "string",
      "UserWebSite": "string",
      "Mobile": "string",
      "Position": "string",
      "BBDCopySentMessages": boolean,
      "BBDLiveAdvertEmail": boolean,
      "BBDExpiringEmail": boolean,
      "BBDExpiredEmail": boolean,
      "DailyNewCandidatesEmail": boolean,
      "BBDInformCandidatesEmail": boolean,
      "BBDRemovedManuallyEmail": boolean
   }
  ]
}

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/UserList HTTP/1.1
Host: api.logicmelon.com
Content-Type: application/json; charset=utf-8
Content-Length: length

{
  "Request": {
    "sCultureID": "string",
    "sAPIKey": "string",
    "sUsername": "string",
    "sPassword": "string",
    "sStartOrganisation": "string",
    "sUserIdentifier": "string"
  }
}
  
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

  
{ "d": [ or {
    "CUser": [
      "UserID": int,
      "OrganisationID": int,
      "UserIdentifier": "string",
      "FirstName": "string",
      "LastName": "string",
      "Phone": "string",
      "Email": {string",
      "ApplicationsEmail": "string",
      "Fax": "string",
      "Username": "string",
      "Password": "string",
      "UserRoleID": int,
      "UserCultureID": "string",
      "WebSite": "string",
      "UserAddress1": "string",
      "UserAddress2": "string",
      "UserAddress3": "string",
      "UserState": "string",
      "UserCountry": "string",
      "UserPostCode": "string",
      "UserWebSite": "string",
      "Mobile": "string",
      "Position": "string",
      "BBDCopySentMessages": boolean,
      "BBDLiveAdvertEmail": boolean,
      "BBDExpiringEmail": boolean,
      "BBDExpiredEmail": boolean,
      "DailyNewCandidatesEmail": boolean,
      "BBDInformCandidatesEmail": boolean,
      "BBDRemovedManuallyEmail": boolean
   },
    "CUser": [
      "UserID": int,
      "OrganisationID": int,
      "UserIdentifier": "string",
      "FirstName": "string",
      "LastName": "string",
      "Phone": "string",
      "Email": {string",
      "ApplicationsEmail": "string",
      "Fax": "string",
      "Username": "string",
      "Password": "string",
      "UserRoleID": int,
      "UserCultureID": "string",
      "WebSite": "string",
      "UserAddress1": "string",
      "UserAddress2": "string",
      "UserAddress3": "string",
      "UserState": "string",
      "UserCountry": "string",
      "UserPostCode": "string",
      "UserWebSite": "string",
      "Mobile": "string",
      "Position": "string",
      "BBDCopySentMessages": boolean,
      "BBDLiveAdvertEmail": boolean,
      "BBDExpiringEmail": boolean,
      "BBDExpiredEmail": boolean,
      "DailyNewCandidatesEmail": boolean,
      "BBDInformCandidatesEmail": boolean,
      "BBDRemovedManuallyEmail": boolean
   }
  ]
}