Api

Click here for a complete list of operations.

CreateActivity

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

<?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>
    <CreateActivity xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <parameters>
        <Activities>
          <CreateActivityParameters>
            <Activity_Id>long</Activity_Id>
            <ActivityType_Id>long</ActivityType_Id>
            <ActivityStatus_Id>long</ActivityStatus_Id>
            <CreatedBy_Contact_Id>long</CreatedBy_Contact_Id>
            <ActivityTitle>string</ActivityTitle>
            <ActivityLocation>string</ActivityLocation>
            <ActivityDescription>string</ActivityDescription>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Opportunity_Id>long</Opportunity_Id>
            <OpportunityTypeTrackStep_Id>long</OpportunityTypeTrackStep_Id>
            <caseId>long</caseId>
            <Contacts xsi:nil="true" />
            <AssignedContacts xsi:nil="true" />
            <Notes xsi:nil="true" />
            <ConversationId>string</ConversationId>
            <ConversationIndex>string</ConversationIndex>
          </CreateActivityParameters>
          <CreateActivityParameters>
            <Activity_Id>long</Activity_Id>
            <ActivityType_Id>long</ActivityType_Id>
            <ActivityStatus_Id>long</ActivityStatus_Id>
            <CreatedBy_Contact_Id>long</CreatedBy_Contact_Id>
            <ActivityTitle>string</ActivityTitle>
            <ActivityLocation>string</ActivityLocation>
            <ActivityDescription>string</ActivityDescription>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Opportunity_Id>long</Opportunity_Id>
            <OpportunityTypeTrackStep_Id>long</OpportunityTypeTrackStep_Id>
            <caseId>long</caseId>
            <Contacts xsi:nil="true" />
            <AssignedContacts xsi:nil="true" />
            <Notes xsi:nil="true" />
            <ConversationId>string</ConversationId>
            <ConversationIndex>string</ConversationIndex>
          </CreateActivityParameters>
        </Activities>
      </parameters>
    </CreateActivity>
  </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>
    <CreateActivityResponse xmlns="https://api.bisglobal.net/">
      <CreateActivityResult>
        <Activities>
          <ActivityDetail>
            <Contacts xsi:nil="true" />
            <AssignedContacts xsi:nil="true" />
            <Notes xsi:nil="true" />
          </ActivityDetail>
          <ActivityDetail>
            <Contacts xsi:nil="true" />
            <AssignedContacts xsi:nil="true" />
            <Notes xsi:nil="true" />
          </ActivityDetail>
        </Activities>
      </CreateActivityResult>
    </CreateActivityResponse>
  </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>
    <CreateActivity xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <parameters>
        <Activities>
          <CreateActivityParameters>
            <Activity_Id>long</Activity_Id>
            <ActivityType_Id>long</ActivityType_Id>
            <ActivityStatus_Id>long</ActivityStatus_Id>
            <CreatedBy_Contact_Id>long</CreatedBy_Contact_Id>
            <ActivityTitle>string</ActivityTitle>
            <ActivityLocation>string</ActivityLocation>
            <ActivityDescription>string</ActivityDescription>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Opportunity_Id>long</Opportunity_Id>
            <OpportunityTypeTrackStep_Id>long</OpportunityTypeTrackStep_Id>
            <caseId>long</caseId>
            <Contacts xsi:nil="true" />
            <AssignedContacts xsi:nil="true" />
            <Notes xsi:nil="true" />
            <ConversationId>string</ConversationId>
            <ConversationIndex>string</ConversationIndex>
          </CreateActivityParameters>
          <CreateActivityParameters>
            <Activity_Id>long</Activity_Id>
            <ActivityType_Id>long</ActivityType_Id>
            <ActivityStatus_Id>long</ActivityStatus_Id>
            <CreatedBy_Contact_Id>long</CreatedBy_Contact_Id>
            <ActivityTitle>string</ActivityTitle>
            <ActivityLocation>string</ActivityLocation>
            <ActivityDescription>string</ActivityDescription>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Opportunity_Id>long</Opportunity_Id>
            <OpportunityTypeTrackStep_Id>long</OpportunityTypeTrackStep_Id>
            <caseId>long</caseId>
            <Contacts xsi:nil="true" />
            <AssignedContacts xsi:nil="true" />
            <Notes xsi:nil="true" />
            <ConversationId>string</ConversationId>
            <ConversationIndex>string</ConversationIndex>
          </CreateActivityParameters>
        </Activities>
      </parameters>
    </CreateActivity>
  </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>
    <CreateActivityResponse xmlns="https://api.bisglobal.net/">
      <CreateActivityResult>
        <Activities>
          <ActivityDetail>
            <Contacts xsi:nil="true" />
            <AssignedContacts xsi:nil="true" />
            <Notes xsi:nil="true" />
          </ActivityDetail>
          <ActivityDetail>
            <Contacts xsi:nil="true" />
            <AssignedContacts xsi:nil="true" />
            <Notes xsi:nil="true" />
          </ActivityDetail>
        </Activities>
      </CreateActivityResult>
    </CreateActivityResponse>
  </soap12:Body>
</soap12:Envelope>