GET v3/CampaignMigration?clientID={clientID}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of GetCampaignsForMigration_Result

Name	Type	Additional information
CampaignId	integer	None.
ClientIntId	integer	None.
Clientguid	globally unique identifier	None.
CampaignType	integer	None.
TemplateID	integer	None.
CampName	string	None.
CampCreatedOn	date	None.
CampLastProcessed	date	None.
SendEmail	boolean	None.
SendSMS	boolean	None.
SendInApp	boolean	None.
CampNextRuntime	date	None.
CampActive	boolean	None.
LastUpdated	date	None.
IsMonthly	boolean	None.
IsDaily	boolean	None.
IsOnceWeekly	boolean	None.
IsOneTime	boolean	None.
Sunday	boolean	None.
Monday	boolean	None.
Tuesday	boolean	None.
Wednesday	boolean	None.
Thursday	boolean	None.
Friday	boolean	None.
Saturday	boolean	None.
DailyTime	string	None.
DayofMonth	integer	None.
Monthlytime	string	None.
OneTimeDateTime	date	None.
Recurring	boolean	None.
Expires	boolean	None.
StartDate	date	None.
ExpireDate	date	None.
CreatedOn	date	None.
demogFilterID	integer	None.
demofilterfk	integer	None.
male	boolean	None.
female	boolean	None.
BirthdayDays	integer	None.
casetype	string	None.
RetPurp	string	None.
RetCaseType	string	None.
MissedApptDays	integer	None.
HaveAnyFutureAppot	boolean	None.
RetDocs	string	None.
FirstApptYesterday	boolean	None.
FirstApptInLast30	boolean	None.
FirstApptInLast90	boolean	None.
RecDocs	string	None.
RecCaseType	string	None.
RecallDays	string	None.
apptFilterID	integer	None.
Purpose	string	None.
AppointmentDays	integer	None.
ApprCaseType	string	None.
IsFirstAppointment	boolean	None.
ApptDocs	string	None.
MinutesBeforeAppointment	integer	None.
TimeZone	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CampaignId": 1,
    "ClientIntId": 1,
    "Clientguid": "5a0da513-b37b-44b1-bf04-ca1f49889f74",
    "CampaignType": 1,
    "TemplateID": 1,
    "CampName": "sample string 2",
    "CampCreatedOn": "2025-04-03T18:18:30.1435139-07:00",
    "CampLastProcessed": "2025-04-03T18:18:30.1435139-07:00",
    "SendEmail": true,
    "SendSMS": true,
    "SendInApp": true,
    "CampNextRuntime": "2025-04-03T18:18:30.1445158-07:00",
    "CampActive": true,
    "LastUpdated": "2025-04-03T18:18:30.1445158-07:00",
    "IsMonthly": true,
    "IsDaily": true,
    "IsOnceWeekly": true,
    "IsOneTime": true,
    "Sunday": true,
    "Monday": true,
    "Tuesday": true,
    "Wednesday": true,
    "Thursday": true,
    "Friday": true,
    "Saturday": true,
    "DailyTime": "sample string 3",
    "DayofMonth": 1,
    "Monthlytime": "sample string 4",
    "OneTimeDateTime": "2025-04-03T18:18:30.1445158-07:00",
    "Recurring": true,
    "Expires": true,
    "StartDate": "2025-04-03T18:18:30.1445158-07:00",
    "ExpireDate": "2025-04-03T18:18:30.1445158-07:00",
    "CreatedOn": "2025-04-03T18:18:30.1445158-07:00",
    "demogFilterID": 1,
    "demofilterfk": 1,
    "male": true,
    "female": true,
    "BirthdayDays": 1,
    "casetype": "sample string 5",
    "RetPurp": "sample string 6",
    "RetCaseType": "sample string 7",
    "MissedApptDays": 1,
    "HaveAnyFutureAppot": true,
    "RetDocs": "sample string 8",
    "FirstApptYesterday": true,
    "FirstApptInLast30": true,
    "FirstApptInLast90": true,
    "RecDocs": "sample string 9",
    "RecCaseType": "sample string 10",
    "RecallDays": "sample string 11",
    "apptFilterID": 1,
    "Purpose": "sample string 12",
    "AppointmentDays": 1,
    "ApprCaseType": "sample string 13",
    "IsFirstAppointment": true,
    "ApptDocs": "sample string 14",
    "MinutesBeforeAppointment": 1,
    "TimeZone": "sample string 15"
  },
  {
    "CampaignId": 1,
    "ClientIntId": 1,
    "Clientguid": "5a0da513-b37b-44b1-bf04-ca1f49889f74",
    "CampaignType": 1,
    "TemplateID": 1,
    "CampName": "sample string 2",
    "CampCreatedOn": "2025-04-03T18:18:30.1435139-07:00",
    "CampLastProcessed": "2025-04-03T18:18:30.1435139-07:00",
    "SendEmail": true,
    "SendSMS": true,
    "SendInApp": true,
    "CampNextRuntime": "2025-04-03T18:18:30.1445158-07:00",
    "CampActive": true,
    "LastUpdated": "2025-04-03T18:18:30.1445158-07:00",
    "IsMonthly": true,
    "IsDaily": true,
    "IsOnceWeekly": true,
    "IsOneTime": true,
    "Sunday": true,
    "Monday": true,
    "Tuesday": true,
    "Wednesday": true,
    "Thursday": true,
    "Friday": true,
    "Saturday": true,
    "DailyTime": "sample string 3",
    "DayofMonth": 1,
    "Monthlytime": "sample string 4",
    "OneTimeDateTime": "2025-04-03T18:18:30.1445158-07:00",
    "Recurring": true,
    "Expires": true,
    "StartDate": "2025-04-03T18:18:30.1445158-07:00",
    "ExpireDate": "2025-04-03T18:18:30.1445158-07:00",
    "CreatedOn": "2025-04-03T18:18:30.1445158-07:00",
    "demogFilterID": 1,
    "demofilterfk": 1,
    "male": true,
    "female": true,
    "BirthdayDays": 1,
    "casetype": "sample string 5",
    "RetPurp": "sample string 6",
    "RetCaseType": "sample string 7",
    "MissedApptDays": 1,
    "HaveAnyFutureAppot": true,
    "RetDocs": "sample string 8",
    "FirstApptYesterday": true,
    "FirstApptInLast30": true,
    "FirstApptInLast90": true,
    "RecDocs": "sample string 9",
    "RecCaseType": "sample string 10",
    "RecallDays": "sample string 11",
    "apptFilterID": 1,
    "Purpose": "sample string 12",
    "AppointmentDays": 1,
    "ApprCaseType": "sample string 13",
    "IsFirstAppointment": true,
    "ApptDocs": "sample string 14",
    "MinutesBeforeAppointment": 1,
    "TimeZone": "sample string 15"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGetCampaignsForMigration_Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InTouchEF">
  <GetCampaignsForMigration_Result>
    <AppointmentDays>1</AppointmentDays>
    <ApprCaseType>sample string 13</ApprCaseType>
    <ApptDocs>sample string 14</ApptDocs>
    <BirthdayDays>1</BirthdayDays>
    <CampActive>true</CampActive>
    <CampCreatedOn>2025-04-03T18:18:30.1435139-07:00</CampCreatedOn>
    <CampLastProcessed>2025-04-03T18:18:30.1435139-07:00</CampLastProcessed>
    <CampName>sample string 2</CampName>
    <CampNextRuntime>2025-04-03T18:18:30.1445158-07:00</CampNextRuntime>
    <CampaignId>1</CampaignId>
    <CampaignType>1</CampaignType>
    <ClientIntId>1</ClientIntId>
    <Clientguid>5a0da513-b37b-44b1-bf04-ca1f49889f74</Clientguid>
    <CreatedOn>2025-04-03T18:18:30.1445158-07:00</CreatedOn>
    <DailyTime>sample string 3</DailyTime>
    <DayofMonth>1</DayofMonth>
    <ExpireDate>2025-04-03T18:18:30.1445158-07:00</ExpireDate>
    <Expires>true</Expires>
    <FirstApptInLast30>true</FirstApptInLast30>
    <FirstApptInLast90>true</FirstApptInLast90>
    <FirstApptYesterday>true</FirstApptYesterday>
    <Friday>true</Friday>
    <HaveAnyFutureAppot>true</HaveAnyFutureAppot>
    <IsDaily>true</IsDaily>
    <IsFirstAppointment>true</IsFirstAppointment>
    <IsMonthly>true</IsMonthly>
    <IsOnceWeekly>true</IsOnceWeekly>
    <IsOneTime>true</IsOneTime>
    <LastUpdated>2025-04-03T18:18:30.1445158-07:00</LastUpdated>
    <MinutesBeforeAppointment>1</MinutesBeforeAppointment>
    <MissedApptDays>1</MissedApptDays>
    <Monday>true</Monday>
    <Monthlytime>sample string 4</Monthlytime>
    <OneTimeDateTime>2025-04-03T18:18:30.1445158-07:00</OneTimeDateTime>
    <Purpose>sample string 12</Purpose>
    <RecCaseType>sample string 10</RecCaseType>
    <RecDocs>sample string 9</RecDocs>
    <RecallDays>sample string 11</RecallDays>
    <Recurring>true</Recurring>
    <RetCaseType>sample string 7</RetCaseType>
    <RetDocs>sample string 8</RetDocs>
    <RetPurp>sample string 6</RetPurp>
    <Saturday>true</Saturday>
    <SendEmail>true</SendEmail>
    <SendInApp>true</SendInApp>
    <SendSMS>true</SendSMS>
    <StartDate>2025-04-03T18:18:30.1445158-07:00</StartDate>
    <Sunday>true</Sunday>
    <TemplateID>1</TemplateID>
    <Thursday>true</Thursday>
    <TimeZone>sample string 15</TimeZone>
    <Tuesday>true</Tuesday>
    <Wednesday>true</Wednesday>
    <apptFilterID>1</apptFilterID>
    <casetype>sample string 5</casetype>
    <demofilterfk>1</demofilterfk>
    <demogFilterID>1</demogFilterID>
    <female>true</female>
    <male>true</male>
  </GetCampaignsForMigration_Result>
  <GetCampaignsForMigration_Result>
    <AppointmentDays>1</AppointmentDays>
    <ApprCaseType>sample string 13</ApprCaseType>
    <ApptDocs>sample string 14</ApptDocs>
    <BirthdayDays>1</BirthdayDays>
    <CampActive>true</CampActive>
    <CampCreatedOn>2025-04-03T18:18:30.1435139-07:00</CampCreatedOn>
    <CampLastProcessed>2025-04-03T18:18:30.1435139-07:00</CampLastProcessed>
    <CampName>sample string 2</CampName>
    <CampNextRuntime>2025-04-03T18:18:30.1445158-07:00</CampNextRuntime>
    <CampaignId>1</CampaignId>
    <CampaignType>1</CampaignType>
    <ClientIntId>1</ClientIntId>
    <Clientguid>5a0da513-b37b-44b1-bf04-ca1f49889f74</Clientguid>
    <CreatedOn>2025-04-03T18:18:30.1445158-07:00</CreatedOn>
    <DailyTime>sample string 3</DailyTime>
    <DayofMonth>1</DayofMonth>
    <ExpireDate>2025-04-03T18:18:30.1445158-07:00</ExpireDate>
    <Expires>true</Expires>
    <FirstApptInLast30>true</FirstApptInLast30>
    <FirstApptInLast90>true</FirstApptInLast90>
    <FirstApptYesterday>true</FirstApptYesterday>
    <Friday>true</Friday>
    <HaveAnyFutureAppot>true</HaveAnyFutureAppot>
    <IsDaily>true</IsDaily>
    <IsFirstAppointment>true</IsFirstAppointment>
    <IsMonthly>true</IsMonthly>
    <IsOnceWeekly>true</IsOnceWeekly>
    <IsOneTime>true</IsOneTime>
    <LastUpdated>2025-04-03T18:18:30.1445158-07:00</LastUpdated>
    <MinutesBeforeAppointment>1</MinutesBeforeAppointment>
    <MissedApptDays>1</MissedApptDays>
    <Monday>true</Monday>
    <Monthlytime>sample string 4</Monthlytime>
    <OneTimeDateTime>2025-04-03T18:18:30.1445158-07:00</OneTimeDateTime>
    <Purpose>sample string 12</Purpose>
    <RecCaseType>sample string 10</RecCaseType>
    <RecDocs>sample string 9</RecDocs>
    <RecallDays>sample string 11</RecallDays>
    <Recurring>true</Recurring>
    <RetCaseType>sample string 7</RetCaseType>
    <RetDocs>sample string 8</RetDocs>
    <RetPurp>sample string 6</RetPurp>
    <Saturday>true</Saturday>
    <SendEmail>true</SendEmail>
    <SendInApp>true</SendInApp>
    <SendSMS>true</SendSMS>
    <StartDate>2025-04-03T18:18:30.1445158-07:00</StartDate>
    <Sunday>true</Sunday>
    <TemplateID>1</TemplateID>
    <Thursday>true</Thursday>
    <TimeZone>sample string 15</TimeZone>
    <Tuesday>true</Tuesday>
    <Wednesday>true</Wednesday>
    <apptFilterID>1</apptFilterID>
    <casetype>sample string 5</casetype>
    <demofilterfk>1</demofilterfk>
    <demogFilterID>1</demogFilterID>
    <female>true</female>
    <male>true</male>
  </GetCampaignsForMigration_Result>
</ArrayOfGetCampaignsForMigration_Result>