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 /json/Administration.asmx/UserAdd HTTP/1.1
Host: api.logicmelon.co.uk
Content-Type: application/json; charset=utf-8
Content-Length: length

{
  "Request": {
    "sCultureID": "string",
    "sAPIKey": "string",
    "sUsername": "string",
    "sPassword": "string",
    "sParentOrganisationIdentifier": "string",
    "User": [
      "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
   },
    "sBoolAdvancedDontUpdateCache": "string"
  }
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

  
{ "d": [ or {
    "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/UserAdd HTTP/1.1
Host: api.logicmelon.co.uk
Content-Type: application/json; charset=utf-8
Content-Length: length

{
  "Request": {
    "sCultureID": "string",
    "sAPIKey": "string",
    "sUsername": "string",
    "sPassword": "string",
    "sParentOrganisationIdentifier": "string",
    "User": [
      "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
   },
    "sBoolAdvancedDontUpdateCache": "string"
  }
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

  
{ "d": [ or {
    "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
  ]
}