AdvisorConnect

<back to all web services

ContactCampaignRequest

The following routes are available for this service:
GET,OPTIONS/v1/Contact/Campaign/{CampaignListId}

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/ContactCampaignRequest HTTP/1.1 
Host: api.peraconnect.us 
Content-Type: application/xml
Content-Length: length

<ContactCampaignRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdvisorConnectAPI.Library">
  <CampaignListId>00000000-0000-0000-0000-000000000000</CampaignListId>
  <Contact>
    <ContactCount>0</ContactCount>
    <ContactId>0</ContactId>
    <ContactType>String</ContactType>
    <Department>String</Department>
    <DoNotContact>false</DoNotContact>
    <EmailPersonal>String</EmailPersonal>
    <EmailWork>String</EmailWork>
    <FirstName>String</FirstName>
    <LastContact>0001-01-01T00:00:00</LastContact>
    <LastName>String</LastName>
    <MiddleName>String</MiddleName>
    <Organization>String</Organization>
    <OrganizationType>String</OrganizationType>
    <PensionPlan>String</PensionPlan>
    <Phone>String</Phone>
    <State>String</State>
    <Title>String</Title>
    <Unit>String</Unit>
    <UnitType>String</UnitType>
  </Contact>
</ContactCampaignRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContactCampaignResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdvisorConnectAPI.Library">
  <AllowOnsiteAppt>false</AllowOnsiteAppt>
  <ApptTimeMinutes>0</ApptTimeMinutes>
  <Campaign>
    <AllowOnsiteAppt>false</AllowOnsiteAppt>
    <AssignmentType>0</AssignmentType>
    <CampaignId>0</CampaignId>
    <CampaignName>String</CampaignName>
    <CampaignTypeId>0</CampaignTypeId>
    <DateCompleted>0001-01-01T00:00:00</DateCompleted>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <DateStarted>0001-01-01T00:00:00</DateStarted>
    <DomainId>0</DomainId>
    <EmailCount>0</EmailCount>
    <FromEmail>String</FromEmail>
    <LandingSiteId>00000000-0000-0000-0000-000000000000</LandingSiteId>
    <ListId>0</ListId>
    <Paused>false</Paused>
    <RoundRobinAgents>
      <Agent>
        <AcceptAllAppts>false</AcceptAllAppts>
        <AgentId>0</AgentId>
        <AgentLevel>0</AgentLevel>
        <AgreementDate>0001-01-01T00:00:00</AgreementDate>
        <AsapLockOut>false</AsapLockOut>
        <AsapLockOutDate>0001-01-01T00:00:00</AsapLockOutDate>
        <AsapOptIn>false</AsapOptIn>
        <AsapOptOut>false</AsapOptOut>
        <AsapWeeklyAppts>0</AsapWeeklyAppts>
        <CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
        <CompanyAssociation>String</CompanyAssociation>
        <CompanyId>0</CompanyId>
        <Customer>false</Customer>
        <DOB>String</DOB>
        <Districts>
          <AgentDistrict>
            <AgentId>0</AgentId>
            <CampaignTypeId>0</CampaignTypeId>
            <DistrictId>0</DistrictId>
            <Id>0</Id>
            <Name>String</Name>
          </AgentDistrict>
        </Districts>
        <Email>String</Email>
        <FirstName>String</FirstName>
        <GoogleCalendar>String</GoogleCalendar>
        <LastName>String</LastName>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
        <OptOutDate>0001-01-01T00:00:00</OptOutDate>
        <PaymentPlan>String</PaymentPlan>
        <ProfileImage>AA==</ProfileImage>
        <ReferredBy>String</ReferredBy>
        <RegistrantNumber>String</RegistrantNumber>
        <SSN>String</SSN>
        <SaturdayAppts>false</SaturdayAppts>
        <SplitAgentId>0</SplitAgentId>
        <StatusFollowUpDate>0001-01-01T00:00:00</StatusFollowUpDate>
        <StatusId>0</StatusId>
        <StatusNote>String</StatusNote>
        <SundayAppts>false</SundayAppts>
        <TimeZone>String</TimeZone>
        <UserId>00000000-0000-0000-0000-000000000000</UserId>
        <VendorType>String</VendorType>
      </Agent>
    </RoundRobinAgents>
    <SleepAfter>0</SleepAfter>
    <Stopped>false</Stopped>
    <TemplateId>0</TemplateId>
    <TimeZone>String</TimeZone>
  </Campaign>
  <CampaignId>0</CampaignId>
  <CampaignTimeRanges>
    <CampaignTimeRange>
      <CampaignId>0</CampaignId>
      <CampaignTimeRangeId>0</CampaignTimeRangeId>
      <EndTime>String</EndTime>
      <StartTime>String</StartTime>
    </CampaignTimeRange>
  </CampaignTimeRanges>
  <Contact>
    <ContactCount>0</ContactCount>
    <ContactId>0</ContactId>
    <ContactType>String</ContactType>
    <Department>String</Department>
    <DoNotContact>false</DoNotContact>
    <EmailPersonal>String</EmailPersonal>
    <EmailWork>String</EmailWork>
    <FirstName>String</FirstName>
    <LastContact>0001-01-01T00:00:00</LastContact>
    <LastName>String</LastName>
    <MiddleName>String</MiddleName>
    <Organization>String</Organization>
    <OrganizationType>String</OrganizationType>
    <PensionPlan>String</PensionPlan>
    <Phone>String</Phone>
    <State>String</State>
    <Title>String</Title>
    <Unit>String</Unit>
    <UnitType>String</UnitType>
  </Contact>
  <ContactAppointment>
    <Address>String</Address>
    <AgentId>0</AgentId>
    <AlternativeAppointment>String</AlternativeAppointment>
    <CalendarEventId>0</CalendarEventId>
    <CampaignId>0</CampaignId>
    <City>String</City>
    <ContactAppointmentRequestId>0</ContactAppointmentRequestId>
    <ContactId>0</ContactId>
    <ContactNumber>String</ContactNumber>
    <DateAssigned>0001-01-01T00:00:00</DateAssigned>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <DateUpdated>0001-01-01T00:00:00</DateUpdated>
    <Deleted>false</Deleted>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
    <MeetingLocation>String</MeetingLocation>
    <MeetingLocationOther>String</MeetingLocationOther>
    <Notes>String</Notes>
    <PreferredAppointment>String</PreferredAppointment>
    <ReceiveText>false</ReceiveText>
    <State>String</State>
    <TextVerificationSentDate>0001-01-01T00:00:00</TextVerificationSentDate>
    <TimeZone>String</TimeZone>
    <Zip>String</Zip>
  </ContactAppointment>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <TravelTimeMinutes>0</TravelTimeMinutes>
</ContactCampaignResponse>