AdvisorConnect

CampaignAddAgentRequest

The following routes are available for this service:
PUT,OPTIONS	/v1/Campaign/{CampaignId}/AddAgents

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/CampaignAddAgentRequest HTTP/1.1 
Host: api.test1.advisorconnect.us 
Content-Type: application/xml
Content-Length: length

<CampaignAddAgentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdvisorConnectAPI.Library">
  <Agent>
    <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>
  </Agent>
  <CampaignId>0</CampaignId>
</CampaignAddAgentRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdvisorConnectAPI.Library">
  <Campaign>
    <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>
  </Campaign>
  <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>
</CampaignResponse>