Pera ServiceStack

<back to all web services

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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/CampaignAddAgentRequest HTTP/1.1 
Host: api.publicemployeeretirementassistance.com 
Content-Type: text/csv
Content-Length: length

Agent,CampaignId
"[{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-01,AgreementValue:String,OptOutDate:0001-01-01,PaymentPlan:String,AsapWeeklyAppts:0,CompanyAssociation:String,ReferredBy:String,SaturdayAppts:False,SundayAppts:False,StatusId:0,StatusFollowUpDate:0001-01-01,StatusNote:String,Districts:[{Id:0,AgentId:0,DistrictId:0,Name:String,CampaignTypeId:0,OrganizationTypeId:0,OrganizationTypeName:String,CountyName:String,StateName:String,ProductTypeId:0}],DistrictsWaitingList:[{Id:0,AgentId:0,DistrictId:0,Name:String,CampaignTypeId:0,DateCreated:0001-01-01,OrganizationTypeId:0,OrganizationTypeName:String,CountyName:String,StateName:String,ProductTypeId:0}],RequestedDistricts:[{Id:0,AgentId:0,DistrictId:0,Name:String,CampaignTypeId:0,OrganizationTypeId:0,OrganizationTypeName:String,CountyName:String,StateName:String,ProductTypeId:0}],AgentProductTypes:[{AgentId:0,ProductType:String,ProductTypeId:0,DateCreated:0001-01-01}],SSN:String,DOB:String,Customer:False,VendorType:String,AsapLockOutDate:0001-01-01,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}]",0

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

ResponseStatus,Campaign
"{ErrorCode:String,Message:String,StackTrace:String,Errors:[{ErrorCode:String,FieldName:String,Message:String}]}","[{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-01,DateCompleted:0001-01-01,DateCreated:0001-01-01,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-01,AgreementValue:String,OptOutDate:0001-01-01,PaymentPlan:String,AsapWeeklyAppts:0,CompanyAssociation:String,ReferredBy:String,SaturdayAppts:False,SundayAppts:False,StatusId:0,StatusFollowUpDate:0001-01-01,StatusNote:String,Districts:[{Id:0,AgentId:0,DistrictId:0,Name:String,CampaignTypeId:0,OrganizationTypeId:0,OrganizationTypeName:String,CountyName:String,StateName:String,ProductTypeId:0}],DistrictsWaitingList:[{Id:0,AgentId:0,DistrictId:0,Name:String,CampaignTypeId:0,DateCreated:0001-01-01,OrganizationTypeId:0,OrganizationTypeName:String,CountyName:String,StateName:String,ProductTypeId:0}],RequestedDistricts:[{Id:0,AgentId:0,DistrictId:0,Name:String,CampaignTypeId:0,OrganizationTypeId:0,OrganizationTypeName:String,CountyName:String,StateName:String,ProductTypeId:0}],AgentProductTypes:[{AgentId:0,ProductType:String,ProductTypeId:0,DateCreated:0001-01-01}],SSN:String,DOB:String,Customer:False,VendorType:String,AsapLockOutDate:0001-01-01,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}],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-01,PauseCount:0,PauseRuleId:0,ExcludeFromRuleService:False}]"