Api

Click here for a complete list of operations.

GetEvents

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 /v/2/Api.asmx HTTP/1.1
Host: api.charityengine.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.bisglobal.net/GetEvents"

<?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>
    <GetEvents xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <Event_Id>long</Event_Id>
        <EventType_Id>long</EventType_Id>
        <IsActive>boolean</IsActive>
        <EventName>string</EventName>
        <Event_StartDate_From>dateTime</Event_StartDate_From>
        <Event_StartDate_To>dateTime</Event_StartDate_To>
        <Event_EndDate_From>dateTime</Event_EndDate_From>
        <Event_EndDate_To>dateTime</Event_EndDate_To>
        <DtStamp_From>dateTime</DtStamp_From>
        <DtStamp_To>dateTime</DtStamp_To>
        <DtModified_From>dateTime</DtModified_From>
        <DtModified_To>dateTime</DtModified_To>
      </queryParameters>
    </GetEvents>
  </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>
    <GetEventsResponse xmlns="https://api.bisglobal.net/">
      <GetEventsResult>
        <Events>
          <EventRecord>
            <Event_Id>long</Event_Id>
            <EventType xsi:nil="true" />
            <EventName>string</EventName>
            <EventDescription>string</EventDescription>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
          </EventRecord>
          <EventRecord>
            <Event_Id>long</Event_Id>
            <EventType xsi:nil="true" />
            <EventName>string</EventName>
            <EventDescription>string</EventDescription>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
          </EventRecord>
        </Events>
      </GetEventsResult>
    </GetEventsResponse>
  </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 /v/2/Api.asmx HTTP/1.1
Host: api.charityengine.net
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>
    <GetEvents xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <Event_Id>long</Event_Id>
        <EventType_Id>long</EventType_Id>
        <IsActive>boolean</IsActive>
        <EventName>string</EventName>
        <Event_StartDate_From>dateTime</Event_StartDate_From>
        <Event_StartDate_To>dateTime</Event_StartDate_To>
        <Event_EndDate_From>dateTime</Event_EndDate_From>
        <Event_EndDate_To>dateTime</Event_EndDate_To>
        <DtStamp_From>dateTime</DtStamp_From>
        <DtStamp_To>dateTime</DtStamp_To>
        <DtModified_From>dateTime</DtModified_From>
        <DtModified_To>dateTime</DtModified_To>
      </queryParameters>
    </GetEvents>
  </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>
    <GetEventsResponse xmlns="https://api.bisglobal.net/">
      <GetEventsResult>
        <Events>
          <EventRecord>
            <Event_Id>long</Event_Id>
            <EventType xsi:nil="true" />
            <EventName>string</EventName>
            <EventDescription>string</EventDescription>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
          </EventRecord>
          <EventRecord>
            <Event_Id>long</Event_Id>
            <EventType xsi:nil="true" />
            <EventName>string</EventName>
            <EventDescription>string</EventDescription>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
          </EventRecord>
        </Events>
      </GetEventsResult>
    </GetEventsResponse>
  </soap12:Body>
</soap12:Envelope>