CollectiveAPIWebService Web Service

CollectiveAPIWebService

Click here for a complete list of operations.

Premises_Events_Types_Get

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-R1604/CollectiveAPI.asmx HTTP/1.1
Host: collectiveapi.bartec-systems.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://bartec-systems.com/Premises_Events_Types_Get"

<?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>
    <Premises_Events_Types_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <EventID>int</EventID>
    </Premises_Events_Types_Get>
  </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>
    <Premises_Events_Types_GetResponse xmlns="http://bartec-systems.com/">
      <Premises_Events_Types_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Premises_Events_Types_Get.xsd">
        <EventTypes RecordCount="int">
          <EventType>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <SystemEvent xmlns="http://www.bartec-systems.com">boolean</SystemEvent>
            <ClosingEvent xmlns="http://www.bartec-systems.com">boolean</ClosingEvent>
            <APIVisibility xmlns="http://www.bartec-systems.com">string</APIVisibility>
            <AvailableOnMobile xmlns="http://www.bartec-systems.com">boolean</AvailableOnMobile>
            <MultipleSubEvents xmlns="http://www.bartec-systems.com">boolean</MultipleSubEvents>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <EventClass xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <SubEventType xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <SubEventType xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </EventType>
          <EventType>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <SystemEvent xmlns="http://www.bartec-systems.com">boolean</SystemEvent>
            <ClosingEvent xmlns="http://www.bartec-systems.com">boolean</ClosingEvent>
            <APIVisibility xmlns="http://www.bartec-systems.com">string</APIVisibility>
            <AvailableOnMobile xmlns="http://www.bartec-systems.com">boolean</AvailableOnMobile>
            <MultipleSubEvents xmlns="http://www.bartec-systems.com">boolean</MultipleSubEvents>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <EventClass xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <SubEventType xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <SubEventType xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </EventType>
          <SubEventTypes RecordCount="int">
            <SubEventType xsi:nil="true" />
            <SubEventType xsi:nil="true" />
          </SubEventTypes>
          <EventClasses RecordCount="int">
            <EventClass xsi:nil="true" />
            <EventClass xsi:nil="true" />
            <Errors xsi:nil="true" />
          </EventClasses>
        </EventTypes>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Premises_Events_Types_GetResult>
    </Premises_Events_Types_GetResponse>
  </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-R1604/CollectiveAPI.asmx HTTP/1.1
Host: collectiveapi.bartec-systems.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>
    <Premises_Events_Types_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <EventID>int</EventID>
    </Premises_Events_Types_Get>
  </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>
    <Premises_Events_Types_GetResponse xmlns="http://bartec-systems.com/">
      <Premises_Events_Types_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Premises_Events_Types_Get.xsd">
        <EventTypes RecordCount="int">
          <EventType>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <SystemEvent xmlns="http://www.bartec-systems.com">boolean</SystemEvent>
            <ClosingEvent xmlns="http://www.bartec-systems.com">boolean</ClosingEvent>
            <APIVisibility xmlns="http://www.bartec-systems.com">string</APIVisibility>
            <AvailableOnMobile xmlns="http://www.bartec-systems.com">boolean</AvailableOnMobile>
            <MultipleSubEvents xmlns="http://www.bartec-systems.com">boolean</MultipleSubEvents>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <EventClass xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <SubEventType xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <SubEventType xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </EventType>
          <EventType>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <SystemEvent xmlns="http://www.bartec-systems.com">boolean</SystemEvent>
            <ClosingEvent xmlns="http://www.bartec-systems.com">boolean</ClosingEvent>
            <APIVisibility xmlns="http://www.bartec-systems.com">string</APIVisibility>
            <AvailableOnMobile xmlns="http://www.bartec-systems.com">boolean</AvailableOnMobile>
            <MultipleSubEvents xmlns="http://www.bartec-systems.com">boolean</MultipleSubEvents>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <EventClass xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <SubEventType xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <SubEventType xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </EventType>
          <SubEventTypes RecordCount="int">
            <SubEventType xsi:nil="true" />
            <SubEventType xsi:nil="true" />
          </SubEventTypes>
          <EventClasses RecordCount="int">
            <EventClass xsi:nil="true" />
            <EventClass xsi:nil="true" />
            <Errors xsi:nil="true" />
          </EventClasses>
        </EventTypes>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Premises_Events_Types_GetResult>
    </Premises_Events_Types_GetResponse>
  </soap12:Body>
</soap12:Envelope>