Api Web Service

Api

Click here for a complete list of operations.

GetOpportunities

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

<?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>
    <GetOpportunities xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <ReturnOpportunityContacts>boolean</ReturnOpportunityContacts>
        <ReturnOpportunitySolicitors>boolean</ReturnOpportunitySolicitors>
        <Opportunity_Id>long</Opportunity_Id>
        <IsActive>boolean</IsActive>
        <Status_Id>int</Status_Id>
        <OpportunityPriority_Id>int</OpportunityPriority_Id>
        <OpportunityName>string</OpportunityName>
        <OwnerPrimaryContact_Id>long</OwnerPrimaryContact_Id>
        <TargetPrimaryContact_Id>long</TargetPrimaryContact_Id>
        <EstimatedValue_From>double</EstimatedValue_From>
        <EstimatedValue_To>double</EstimatedValue_To>
        <EstimatedCloseDate_From>dateTime</EstimatedCloseDate_From>
        <EstimatedCloseDate_To>dateTime</EstimatedCloseDate_To>
        <OpportunityTypeTrack_Id>long</OpportunityTypeTrack_Id>
        <CurrentStage_Id>long</CurrentStage_Id>
        <CurrentOpportunityTrackStep_Id>long</CurrentOpportunityTrackStep_Id>
        <DtStamp_From>dateTime</DtStamp_From>
        <DtStamp_To>dateTime</DtStamp_To>
        <DtModified_From>dateTime</DtModified_From>
        <DtModified_To>dateTime</DtModified_To>
      </queryParameters>
    </GetOpportunities>
  </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>
    <GetOpportunitiesResponse xmlns="https://api.bisglobal.net/">
      <GetOpportunitiesResult>
        <Opportunities>
          <OpportunityRecord>
            <Opportunity_Id>long</Opportunity_Id>
            <OwnerPrimaryContact xsi:nil="true" />
            <TargetPrimaryContact xsi:nil="true" />
            <Status xsi:nil="true" />
            <Priority xsi:nil="true" />
            <Track xsi:nil="true" />
            <TrackCurrentStep xsi:nil="true" />
            <EstimatedValue>double</EstimatedValue>
            <EstimatedCloseDate>dateTime</EstimatedCloseDate>
            <IsActive>boolean</IsActive>
            <OpportunityName>string</OpportunityName>
            <OpportunityDescription>string</OpportunityDescription>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
            <Contacts xsi:nil="true" />
            <Solicitors xsi:nil="true" />
          </OpportunityRecord>
          <OpportunityRecord>
            <Opportunity_Id>long</Opportunity_Id>
            <OwnerPrimaryContact xsi:nil="true" />
            <TargetPrimaryContact xsi:nil="true" />
            <Status xsi:nil="true" />
            <Priority xsi:nil="true" />
            <Track xsi:nil="true" />
            <TrackCurrentStep xsi:nil="true" />
            <EstimatedValue>double</EstimatedValue>
            <EstimatedCloseDate>dateTime</EstimatedCloseDate>
            <IsActive>boolean</IsActive>
            <OpportunityName>string</OpportunityName>
            <OpportunityDescription>string</OpportunityDescription>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
            <Contacts xsi:nil="true" />
            <Solicitors xsi:nil="true" />
          </OpportunityRecord>
        </Opportunities>
      </GetOpportunitiesResult>
    </GetOpportunitiesResponse>
  </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>
    <GetOpportunities xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <ReturnOpportunityContacts>boolean</ReturnOpportunityContacts>
        <ReturnOpportunitySolicitors>boolean</ReturnOpportunitySolicitors>
        <Opportunity_Id>long</Opportunity_Id>
        <IsActive>boolean</IsActive>
        <Status_Id>int</Status_Id>
        <OpportunityPriority_Id>int</OpportunityPriority_Id>
        <OpportunityName>string</OpportunityName>
        <OwnerPrimaryContact_Id>long</OwnerPrimaryContact_Id>
        <TargetPrimaryContact_Id>long</TargetPrimaryContact_Id>
        <EstimatedValue_From>double</EstimatedValue_From>
        <EstimatedValue_To>double</EstimatedValue_To>
        <EstimatedCloseDate_From>dateTime</EstimatedCloseDate_From>
        <EstimatedCloseDate_To>dateTime</EstimatedCloseDate_To>
        <OpportunityTypeTrack_Id>long</OpportunityTypeTrack_Id>
        <CurrentStage_Id>long</CurrentStage_Id>
        <CurrentOpportunityTrackStep_Id>long</CurrentOpportunityTrackStep_Id>
        <DtStamp_From>dateTime</DtStamp_From>
        <DtStamp_To>dateTime</DtStamp_To>
        <DtModified_From>dateTime</DtModified_From>
        <DtModified_To>dateTime</DtModified_To>
      </queryParameters>
    </GetOpportunities>
  </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>
    <GetOpportunitiesResponse xmlns="https://api.bisglobal.net/">
      <GetOpportunitiesResult>
        <Opportunities>
          <OpportunityRecord>
            <Opportunity_Id>long</Opportunity_Id>
            <OwnerPrimaryContact xsi:nil="true" />
            <TargetPrimaryContact xsi:nil="true" />
            <Status xsi:nil="true" />
            <Priority xsi:nil="true" />
            <Track xsi:nil="true" />
            <TrackCurrentStep xsi:nil="true" />
            <EstimatedValue>double</EstimatedValue>
            <EstimatedCloseDate>dateTime</EstimatedCloseDate>
            <IsActive>boolean</IsActive>
            <OpportunityName>string</OpportunityName>
            <OpportunityDescription>string</OpportunityDescription>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
            <Contacts xsi:nil="true" />
            <Solicitors xsi:nil="true" />
          </OpportunityRecord>
          <OpportunityRecord>
            <Opportunity_Id>long</Opportunity_Id>
            <OwnerPrimaryContact xsi:nil="true" />
            <TargetPrimaryContact xsi:nil="true" />
            <Status xsi:nil="true" />
            <Priority xsi:nil="true" />
            <Track xsi:nil="true" />
            <TrackCurrentStep xsi:nil="true" />
            <EstimatedValue>double</EstimatedValue>
            <EstimatedCloseDate>dateTime</EstimatedCloseDate>
            <IsActive>boolean</IsActive>
            <OpportunityName>string</OpportunityName>
            <OpportunityDescription>string</OpportunityDescription>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
            <Contacts xsi:nil="true" />
            <Solicitors xsi:nil="true" />
          </OpportunityRecord>
        </Opportunities>
      </GetOpportunitiesResult>
    </GetOpportunitiesResponse>
  </soap12:Body>
</soap12:Envelope>