API


Click here for a complete list of operations.

UpsertStopWorkDictionaryAutoRule

Creates or updates a stoptwork(assigned to users and/or roles) dictionary autorule. Both can be simple(sample contains one parameter) or complex(sample contains more than 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: kr.jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/UpsertStopWorkDictionaryAutoRule"

<?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>
    <UpsertStopWorkDictionaryAutoRule xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <stopWorkDictionaryAutoRule>
        <Id>int</Id>
        <OrderNumber>int</OrderNumber>
        <Assignment />
        <Content />
      </stopWorkDictionaryAutoRule>
    </UpsertStopWorkDictionaryAutoRule>
  </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>
    <UpsertStopWorkDictionaryAutoRuleResponse xmlns="http://jobctrl.com/">
      <UpsertStopWorkDictionaryAutoRuleResult>OK or UnknownError or AuthCodeNotValid or AccessDenied or AtLeastOneSampleIsInactiveError or CannotAssignToNotActiveNode or DictionaryAutoRuleIdDoesNotExist or InvalidAssignments or InvalidContent</UpsertStopWorkDictionaryAutoRuleResult>
      <upsertedDictionaryAutoRule>
        <Id>int</Id>
        <OrderNumber>int</OrderNumber>
        <Assignment />
        <Content />
      </upsertedDictionaryAutoRule>
    </UpsertStopWorkDictionaryAutoRuleResponse>
  </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>
    <UpsertStopWorkDictionaryAutoRule xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <stopWorkDictionaryAutoRule>
        <Id>int</Id>
        <OrderNumber>int</OrderNumber>
        <Assignment />
        <Content />
      </stopWorkDictionaryAutoRule>
    </UpsertStopWorkDictionaryAutoRule>
  </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>
    <UpsertStopWorkDictionaryAutoRuleResponse xmlns="http://jobctrl.com/">
      <UpsertStopWorkDictionaryAutoRuleResult>OK or UnknownError or AuthCodeNotValid or AccessDenied or AtLeastOneSampleIsInactiveError or CannotAssignToNotActiveNode or DictionaryAutoRuleIdDoesNotExist or InvalidAssignments or InvalidContent</UpsertStopWorkDictionaryAutoRuleResult>
      <upsertedDictionaryAutoRule>
        <Id>int</Id>
        <OrderNumber>int</OrderNumber>
        <Assignment />
        <Content />
      </upsertedDictionaryAutoRule>
    </UpsertStopWorkDictionaryAutoRuleResponse>
  </soap12:Body>
</soap12:Envelope>