Pera ServiceStack

<back to all web services

ContactCampaignRequest

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

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/ContactCampaignRequest HTTP/1.1 
Host: api2.publicemployeeretirementassistance.com 
Content-Type: application/json
Content-Length: length

{"CampaignListId":"00000000000000000000000000000000","LandingSiteId":"00000000000000000000000000000000","Contact":{"ContactId":0,"ContactType":"String","FirstName":"String","MiddleName":"String","LastName":"String","Title":"String","EmailWork":"String","EmailPersonal":"String","OrganizationType":"String","Organization":"String","UnitType":"String","Unit":"String","State":"String","Phone":"String","Department":"String","LastContact":"0001-01-01T00:00:00.0000000","DoNotContact":false,"PensionPlan":"String","ContactCount":0}}

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"Contact":{"ContactId":0,"ContactType":"String","FirstName":"String","MiddleName":"String","LastName":"String","Title":"String","EmailWork":"String","EmailPersonal":"String","OrganizationType":"String","Organization":"String","UnitType":"String","Unit":"String","State":"String","Phone":"String","Department":"String","LastContact":"0001-01-01T00:00:00.0000000","DoNotContact":false,"PensionPlan":"String","ContactCount":0},"ContactAppointment":{"ContactAppointmentRequestId":0,"CalendarEventId":0,"CampaignId":0,"ContactId":0,"ContactNumber":"String","ReceiveText":false,"MeetingLocation":"String","MeetingLocationOther":"String","Address":"String","City":"String","State":"String","Zip":"String","Latitude":0,"Longitude":0,"PreferredAppointment":"String","AlternativeAppointment":"String","TimeZone":"String","Notes":"String","DateCreated":"0001-01-01T00:00:00.0000000","DateUpdated":"0001-01-01T00:00:00.0000000","DateAssigned":"0001-01-01T00:00:00.0000000","AgentId":0,"Deleted":false,"TextVerificationSentDate":"0001-01-01T00:00:00.0000000","ReferringAgentNumber":"String","ClientAgentId":0,"CompanyId":0,"CancellationNote":"String","ProductType":"String","IsLocked":false,"MeetingType":"String","IsReplicatedApptRequest":false},"CampaignId":0,"ApptTimeMinutes":0,"TravelTimeMinutes":0,"Campaign":{"CampaignId":0,"CampaignName":"String","CampaignTypeId":0,"ProductTypeId":0,"ListId":0,"TemplateId":0,"FromEmail":"String","EmailCount":0,"DomainId":0,"SleepAfter":0,"Paused":false,"DateStarted":"0001-01-01T00:00:00.0000000","DateCompleted":"0001-01-01T00:00:00.0000000","DateCreated":"0001-01-01T00:00:00.0000000","LandingSiteId":"00000000000000000000000000000000","AllowOnsiteAppt":false,"TimeZone":"String","AssignmentType":0,"Stopped":false,"RoundRobinAgents":[{"AgentId":0,"UserId":"00000000000000000000000000000000","FirstName":"String","LastName":"String","Email":"String","EmailSignature":"String","CalendarId":"00000000000000000000000000000000","GoogleCalendar":"String","Latitude":0,"Longitude":0,"AgentLevel":0,"AsapOptOut":false,"CompanyId":0,"SplitAgentId":0,"AsapLockOut":false,"AsapOptIn":false,"AcceptAllAppts":false,"TimeZone":"String","AgreementDate":"0001-01-01T00:00:00.0000000","AgreementValue":"String","OptOutDate":"0001-01-01T00:00:00.0000000","PaymentPlan":"String","AsapWeeklyAppts":0,"CompanyAssociation":"String","ReferredBy":"String","SaturdayAppts":false,"SundayAppts":false,"StatusId":0,"CanMoveAppts":false,"StatusFollowUpDate":"0001-01-01T00:00:00.0000000","StatusNote":"String","Districts":[{"Id":0,"AgentId":0,"DistrictId":0,"Name":"String","CampaignTypeId":0,"OrganizationTypeId":0,"OrganizationTypeName":"String","CountyName":"String","StateName":"String","ProductTypeId":0,"AcceptInPersonMeetings":false,"AcceptVirtualMeetings":false}],"DistrictsWaitingList":[{"Id":0,"AgentId":0,"DistrictId":0,"Name":"String","CampaignTypeId":0,"DateCreated":"0001-01-01T00:00:00.0000000","OrganizationTypeId":0,"OrganizationTypeName":"String","CountyName":"String","StateName":"String","ProductTypeId":0,"AcceptInPersonMeetings":false,"AcceptVirtualMeetings":false}],"RequestedDistricts":[{"Id":0,"AgentId":0,"DistrictId":0,"Name":"String","CampaignTypeId":0,"OrganizationTypeId":0,"OrganizationTypeName":"String","CountyName":"String","StateName":"String","ProductTypeId":0,"AcceptInPersonMeetings":false,"AcceptVirtualMeetings":false}],"AgentProductTypes":[{"AgentId":0,"ProductType":"String","ProductTypeId":0,"DateCreated":"0001-01-01T00:00:00.0000000"}],"SSN":"String","DOB":"String","Customer":false,"VendorType":"String","AsapLockOutDate":"0001-01-01T00:00:00.0000000","ProfileImage":"AA==","RegistrantNumber":"String","Subscription":"String","ApiKey":"00000000000000000000000000000000","SubscriptionFee":0,"AgreementContent":"String","HasNewAgreement":false,"VCAppts":false,"FaceToFaceAppts":false,"IsAsapRestricted":false,"AsapOptOutReasonId":"0","AsapOptOutReturnDate":"0001-01-01T00:00:00.0000000+00:00","AsapOptOutNote":"String","AsapOptOutStatewide":false,"ApptDetailVisibilityMinutes":0,"ModifiedBy":"String","SlotsOpen":0}],"AppointmentConfirmationId":0,"AppointmentConfirmationUpdateId":0,"AppointmentConfirmationCancelId":0,"AppointmentConfirmationCancelSurveyId":0,"AgentAppointmentConfirmationId":0,"AgentAppointmentConfirmationUpdateId":0,"AgentAppointmentConfirmationCancelId":0,"SatisfactionSurveyId":0,"OtherOfferId":0,"ReferringAgentAppointmentConfirmationId":0,"ReferringAgentAppointmentConfirmationUpdateId":0,"ReferringAgentAppointmentConfirmationCancelId":0,"Note":"String","PauseRestartDate":"0001-01-01T00:00:00.0000000","PauseCount":0,"PauseRuleId":0,"ExcludeFromRuleService":false},"CampaignTimeRanges":[{"CampaignTimeRangeId":0,"CampaignId":0,"StartTime":"String","EndTime":"String"}],"AllowOnsiteAppt":false,"AllowVirtualAppt":false,"AllowInPersonAppt":false,"ShowColoradoDisclaimer":false,"ShowCERA":false,"ShowPERA":false}