API


Click here for a complete list of operations.

CreateNotificationForm

Creates a new notification form

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

<?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>
    <CreateNotificationForm xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <name>string</name>
      <description>string</description>
      <taskId>int</taskId>
      <form>
        <MessageBox>
          <Title>string</Title>
          <Text>string</Text>
          <Buttons>
            <JcButton xsi:nil="true" />
            <JcButton xsi:nil="true" />
          </Buttons>
        </MessageBox>
        <BeforeShowActions>
          <string>string</string>
          <string>string</string>
        </BeforeShowActions>
        <CloseButtonId>string</CloseButtonId>
      </form>
    </CreateNotificationForm>
  </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>
    <CreateNotificationFormResponse xmlns="http://jobctrl.com/">
      <CreateNotificationFormResult>OK or UnknownError or AuthCodeNotValid</CreateNotificationFormResult>
      <createdFormId>int</createdFormId>
    </CreateNotificationFormResponse>
  </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>
    <CreateNotificationForm xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <name>string</name>
      <description>string</description>
      <taskId>int</taskId>
      <form>
        <MessageBox>
          <Title>string</Title>
          <Text>string</Text>
          <Buttons>
            <JcButton xsi:nil="true" />
            <JcButton xsi:nil="true" />
          </Buttons>
        </MessageBox>
        <BeforeShowActions>
          <string>string</string>
          <string>string</string>
        </BeforeShowActions>
        <CloseButtonId>string</CloseButtonId>
      </form>
    </CreateNotificationForm>
  </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>
    <CreateNotificationFormResponse xmlns="http://jobctrl.com/">
      <CreateNotificationFormResult>OK or UnknownError or AuthCodeNotValid</CreateNotificationFormResult>
      <createdFormId>int</createdFormId>
    </CreateNotificationFormResponse>
  </soap12:Body>
</soap12:Envelope>