API


Click here for a complete list of operations.

ImportUsersAndGroups_v2

Imports users and groups into JobCTRL with detailed errors if any

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: kr.jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/ImportUsersAndGroups_v2"

<?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>
    <ImportUsersAndGroups_v2 xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <organizationHierarchy>
        <Root>
          <Id>int</Id>
          <ParentId>int</ParentId>
          <ExtId>string</ExtId>
          <Children>
            <OrganizationHierarchyItem_v2 xsi:nil="true" />
            <OrganizationHierarchyItem_v2 xsi:nil="true" />
          </Children>
          <Status>Active or Disabled or Deleted</Status>
          <DeletedAt>dateTime</DeletedAt>
        </Root>
      </organizationHierarchy>
      <activateUsers>boolean</activateUsers>
      <deleteUnmatchedItemsWithExtId>boolean</deleteUnmatchedItemsWithExtId>
      <sendActivationEmailsImmediately>boolean</sendActivationEmailsImmediately>
    </ImportUsersAndGroups_v2>
  </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>
    <ImportUsersAndGroups_v2Response xmlns="http://jobctrl.com/">
      <ImportUsersAndGroups_v2Result>
        <ImportUsersAndGroupsResult>
          <ErrorCode>int</ErrorCode>
          <ErrorCodeType>string</ErrorCodeType>
          <EnumValue>string</EnumValue>
          <CauseIdentifier>string</CauseIdentifier>
          <Description>string</Description>
        </ImportUsersAndGroupsResult>
        <ImportUsersAndGroupsResult>
          <ErrorCode>int</ErrorCode>
          <ErrorCodeType>string</ErrorCodeType>
          <EnumValue>string</EnumValue>
          <CauseIdentifier>string</CauseIdentifier>
          <Description>string</Description>
        </ImportUsersAndGroupsResult>
      </ImportUsersAndGroups_v2Result>
    </ImportUsersAndGroups_v2Response>
  </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: kr.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>
    <ImportUsersAndGroups_v2 xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <organizationHierarchy>
        <Root>
          <Id>int</Id>
          <ParentId>int</ParentId>
          <ExtId>string</ExtId>
          <Children>
            <OrganizationHierarchyItem_v2 xsi:nil="true" />
            <OrganizationHierarchyItem_v2 xsi:nil="true" />
          </Children>
          <Status>Active or Disabled or Deleted</Status>
          <DeletedAt>dateTime</DeletedAt>
        </Root>
      </organizationHierarchy>
      <activateUsers>boolean</activateUsers>
      <deleteUnmatchedItemsWithExtId>boolean</deleteUnmatchedItemsWithExtId>
      <sendActivationEmailsImmediately>boolean</sendActivationEmailsImmediately>
    </ImportUsersAndGroups_v2>
  </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>
    <ImportUsersAndGroups_v2Response xmlns="http://jobctrl.com/">
      <ImportUsersAndGroups_v2Result>
        <ImportUsersAndGroupsResult>
          <ErrorCode>int</ErrorCode>
          <ErrorCodeType>string</ErrorCodeType>
          <EnumValue>string</EnumValue>
          <CauseIdentifier>string</CauseIdentifier>
          <Description>string</Description>
        </ImportUsersAndGroupsResult>
        <ImportUsersAndGroupsResult>
          <ErrorCode>int</ErrorCode>
          <ErrorCodeType>string</ErrorCodeType>
          <EnumValue>string</EnumValue>
          <CauseIdentifier>string</CauseIdentifier>
          <Description>string</Description>
        </ImportUsersAndGroupsResult>
      </ImportUsersAndGroups_v2Result>
    </ImportUsersAndGroups_v2Response>
  </soap12:Body>
</soap12:Envelope>