API


Click here for a complete list of operations.

GetCompanyDictionaryAutoRuleSamples

Gets dictionary autorule samples and their parameters that are assigned to the company. Dictionary autorules can be assigned to these parameters

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

<?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>
    <GetCompanyDictionaryAutoRuleSamples xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
    </GetCompanyDictionaryAutoRuleSamples>
  </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>
    <GetCompanyDictionaryAutoRuleSamplesResponse xmlns="http://jobctrl.com/">
      <GetCompanyDictionaryAutoRuleSamplesResult>OK or UnknownError or AuthCodeNotValid or AccessDenied</GetCompanyDictionaryAutoRuleSamplesResult>
      <dictionaryAutoRuleSamples>
        <DictionaryAutoRuleSample>
          <Id>int</Id>
          <Name>string</Name>
          <Priority>short</Priority>
          <IsComplex>boolean</IsComplex>
          <Type>StartWork or StopWork</Type>
          <Parameters>
            <DictionaryAutoRuleSampleParameter xsi:nil="true" />
            <DictionaryAutoRuleSampleParameter xsi:nil="true" />
          </Parameters>
        </DictionaryAutoRuleSample>
        <DictionaryAutoRuleSample>
          <Id>int</Id>
          <Name>string</Name>
          <Priority>short</Priority>
          <IsComplex>boolean</IsComplex>
          <Type>StartWork or StopWork</Type>
          <Parameters>
            <DictionaryAutoRuleSampleParameter xsi:nil="true" />
            <DictionaryAutoRuleSampleParameter xsi:nil="true" />
          </Parameters>
        </DictionaryAutoRuleSample>
      </dictionaryAutoRuleSamples>
    </GetCompanyDictionaryAutoRuleSamplesResponse>
  </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>
    <GetCompanyDictionaryAutoRuleSamples xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
    </GetCompanyDictionaryAutoRuleSamples>
  </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>
    <GetCompanyDictionaryAutoRuleSamplesResponse xmlns="http://jobctrl.com/">
      <GetCompanyDictionaryAutoRuleSamplesResult>OK or UnknownError or AuthCodeNotValid or AccessDenied</GetCompanyDictionaryAutoRuleSamplesResult>
      <dictionaryAutoRuleSamples>
        <DictionaryAutoRuleSample>
          <Id>int</Id>
          <Name>string</Name>
          <Priority>short</Priority>
          <IsComplex>boolean</IsComplex>
          <Type>StartWork or StopWork</Type>
          <Parameters>
            <DictionaryAutoRuleSampleParameter xsi:nil="true" />
            <DictionaryAutoRuleSampleParameter xsi:nil="true" />
          </Parameters>
        </DictionaryAutoRuleSample>
        <DictionaryAutoRuleSample>
          <Id>int</Id>
          <Name>string</Name>
          <Priority>short</Priority>
          <IsComplex>boolean</IsComplex>
          <Type>StartWork or StopWork</Type>
          <Parameters>
            <DictionaryAutoRuleSampleParameter xsi:nil="true" />
            <DictionaryAutoRuleSampleParameter xsi:nil="true" />
          </Parameters>
        </DictionaryAutoRuleSample>
      </dictionaryAutoRuleSamples>
    </GetCompanyDictionaryAutoRuleSamplesResponse>
  </soap12:Body>
</soap12:Envelope>