Pera ServiceStack

<back to all web services

AgentRegistrationRequest

The following routes are available for this service:
POST,OPTIONS/v1/AgentRegistration

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

HTTP + JSV

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

POST /jsv/reply/AgentRegistrationRequest HTTP/1.1 
Host: api2.publicemployeeretirementassistance.com 
Content-Type: text/jsv
Content-Length: length

{
	Agent: 
	{
		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,
		CanMoveAppts: False,
		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,
				AcceptInPersonMeetings: False,
				AcceptVirtualMeetings: False
			}
		],
		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,
				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-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,
		ModifiedBy: String,
		SlotsOpen: 0
	},
	AgentContactInfo: 
	{
		Id: 00000000000000000000000000000000,
		AgentId: 0,
		PhysicalAddress: String,
		PhysicalCity: String,
		PhysicalState: String,
		PhysicalZip: String,
		MailingAddress: String,
		MailingCity: String,
		MailingState: String,
		MailingZip: String,
		PhoneNumber: String,
		Reference1Name: String,
		Reference1Phone: String,
		Reference2Name: String,
		Reference2Phone: String,
		DateCreated: 0001-01-01
	},
	Address: 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-01,
			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
		}
	],
	AgentAppointments: 
	[
		{
			Id: 0,
			AgentId: 0,
			Company: String,
			LicenseNumber: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	Agent: 
	[
		{
			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,
			CanMoveAppts: False,
			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,
					AcceptInPersonMeetings: False,
					AcceptVirtualMeetings: False
				}
			],
			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,
					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-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,
			ModifiedBy: String,
			SlotsOpen: 0
		}
	],
	Username: String,
	Password: String
}