API


Click here for a complete list of operations.

GetOrganizationHierarchy

Gets the organization hierarchy of the company

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

<?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>
    <GetOrganizationHierarchy xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <IncludeDeletedUsers>boolean</IncludeDeletedUsers>
    </GetOrganizationHierarchy>
  </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>
    <GetOrganizationHierarchyResponse xmlns="http://jobctrl.com/">
      <GetOrganizationHierarchyResult>OK or UnknownError or AuthCodeNotValid</GetOrganizationHierarchyResult>
      <Hierarchy>
        <Root>
          <Id>int</Id>
          <ParentId>int</ParentId>
          <ExtId>int</ExtId>
          <Children>
            <OrganizationHierarchyItem xsi:nil="true" />
            <OrganizationHierarchyItem xsi:nil="true" />
          </Children>
          <Status>Active or Disabled or Deleted</Status>
          <DeletedAt>dateTime</DeletedAt>
        </Root>
      </Hierarchy>
    </GetOrganizationHierarchyResponse>
  </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>
    <GetOrganizationHierarchy xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <IncludeDeletedUsers>boolean</IncludeDeletedUsers>
    </GetOrganizationHierarchy>
  </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>
    <GetOrganizationHierarchyResponse xmlns="http://jobctrl.com/">
      <GetOrganizationHierarchyResult>OK or UnknownError or AuthCodeNotValid</GetOrganizationHierarchyResult>
      <Hierarchy>
        <Root>
          <Id>int</Id>
          <ParentId>int</ParentId>
          <ExtId>int</ExtId>
          <Children>
            <OrganizationHierarchyItem xsi:nil="true" />
            <OrganizationHierarchyItem xsi:nil="true" />
          </Children>
          <Status>Active or Disabled or Deleted</Status>
          <DeletedAt>dateTime</DeletedAt>
        </Root>
      </Hierarchy>
    </GetOrganizationHierarchyResponse>
  </soap12:Body>
</soap12:Envelope>