API


Click here for a complete list of operations.

CreateUser

Creates a user. If domain login is going to be used, domain users are upserted every 12 hours.

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 /api/api.asmx HTTP/1.1
Host: jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/CreateUser"

<?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>
    <CreateUser xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <parentUserGroupId>int</parentUserGroupId>
      <firstName>string</firstName>
      <lastName>string</lastName>
      <email>string</email>
      <accessLevel>Worker or Supervisor or Administrator</accessLevel>
      <cultureId>string</cultureId>
      <autoActivate>boolean</autoActivate>
      <sendActivationEmail>boolean</sendActivationEmail>
      <extId>string</extId>
      <activeDirectoryUserPrincipalName>string</activeDirectoryUserPrincipalName>
      <password>string</password>
    </CreateUser>
  </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>
    <CreateUserResponse xmlns="http://jobctrl.com/">
      <CreateUserResult>OK or AuthCodeNotValid or AccessDenied or UnknownError or CannotCreateGroupInThisNode or EmailAddressIsAlreadyInUse or ExtIdMustBeUnique or ActiveDirectoryUserPrincipalNameMustBeUnique or NameCannotBeEmpty or EmailCannotBeEmpty or InvalidAccessLevel or OnlyAdminsCanManageSupervisorsAndAdmins or PasswordAndConfirmationMustMatch or CultureNotSupported or PasswordMustMeetPolicy or PasswordLengthInvalid or TargetNodeHasNoUserSpecified or RoleIdDoesNotBelongToCompany or CannotSendEmailWithoutUserActivation or MissingActiveDirectoryUserPrincipalName</CreateUserResult>
      <createdUserId>int</createdUserId>
    </CreateUserResponse>
  </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 /api/api.asmx HTTP/1.1
Host: jobctrl.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>
    <CreateUser xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <parentUserGroupId>int</parentUserGroupId>
      <firstName>string</firstName>
      <lastName>string</lastName>
      <email>string</email>
      <accessLevel>Worker or Supervisor or Administrator</accessLevel>
      <cultureId>string</cultureId>
      <autoActivate>boolean</autoActivate>
      <sendActivationEmail>boolean</sendActivationEmail>
      <extId>string</extId>
      <activeDirectoryUserPrincipalName>string</activeDirectoryUserPrincipalName>
      <password>string</password>
    </CreateUser>
  </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>
    <CreateUserResponse xmlns="http://jobctrl.com/">
      <CreateUserResult>OK or AuthCodeNotValid or AccessDenied or UnknownError or CannotCreateGroupInThisNode or EmailAddressIsAlreadyInUse or ExtIdMustBeUnique or ActiveDirectoryUserPrincipalNameMustBeUnique or NameCannotBeEmpty or EmailCannotBeEmpty or InvalidAccessLevel or OnlyAdminsCanManageSupervisorsAndAdmins or PasswordAndConfirmationMustMatch or CultureNotSupported or PasswordMustMeetPolicy or PasswordLengthInvalid or TargetNodeHasNoUserSpecified or RoleIdDoesNotBelongToCompany or CannotSendEmailWithoutUserActivation or MissingActiveDirectoryUserPrincipalName</CreateUserResult>
      <createdUserId>int</createdUserId>
    </CreateUserResponse>
  </soap12:Body>
</soap12:Envelope>