Pera Administrators Service

ContactReferralRequest

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

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/ContactReferralRequest HTTP/1.1 
Host: api.peraadministrators.com 
Content-Type: text/jsv
Content-Length: length

{
	APIKey: 00000000000000000000000000000000,
	AgentId: 0,
	Contact: 
	[
		{
			ContactId: 0,
			ContactType: 0,
			FirstName: String,
			LastName: String,
			Title: String,
			EmailWork: String,
			EmailPersonal: String,
			State: String,
			Phone: String,
			LastContact: 0001-01-01,
			DoNotContact: False,
			AgentId: 0,
			PhoneAlt: String,
			PeraContactId: 0,
			SourceTypeId: 0,
			SourceTypeDesc: String,
			SourceNote: String,
			ContactStatusId: 0,
			ContactStatusDesc: String,
			SSN: String,
			DateOfBirth: 0001-01-01,
			Deleted: False,
			IsShared: False,
			address_line1: String,
			address_city: String,
			address_state: String,
			address_zip: String,
			DeletedBy: String,
			DeletedDateTimeUtc: 0001-01-01,
			HasNBC: False,
			HasFactFinderSheet: False,
			MiddleInitial: String,
			Tags: String,
			DateCreated: 0001-01-01,
			PhoneLabel: String,
			AltPhoneLabel: String,
			Carriers: String,
			ContactImage: String,
			AdditionalInformation: String,
			HasGiftCard: False,
			MaritalStatus: String,
			ContactGUID: 00000000000000000000000000000000,
			Licenses: 
			[
				{
					Id: 0,
					AgentId: 0,
					ContactId: 0,
					AgentRegistrationTempId: 0,
					LicenseTypeId: 0,
					SecurityLicenseTypeId: 0,
					LicenseTypeName: String,
					SecuritiesLicenseTypeName: String,
					LicenseState: String,
					LicenseNumber: String,
					Temporary: False,
					DateCreated: 0001-01-01,
					DateModified: 0001-01-01,
					DateAcquired: 0001-01-01,
					ExpirationDate: 0001-01-01
				}
			],
			Employee: 
			{
				Id: 0,
				ContactId: 0,
				EmployerId: 0,
				SchoolId: 0,
				EmployerName: String,
				SchoolName: String,
				FullSSN: String,
				Gender: String,
				EmployeeId: String,
				DateOfHire: 0001-01-01,
				DateOfTermination: 0001-01-01,
				Compensation: 0,
				HoursWorked: 0,
				LocationId: String,
				RoleId: 0,
				IsMarried: False,
				LastSentToIPXDate: 0001-01-01,
				UserId: 00000000000000000000000000000000,
				DateOfRehire: 0001-01-01,
				EmployeeStatus: String,
				InternetAgreementSignedDate: 0001-01-01,
				IPXSponsorUserId: String,
				PeraConnectAgentId: 0
			},
			Employer: 
			{
				Id: 0,
				ContactId: 0,
				NCESId: String,
				Name: String,
				StateId: 0,
				Street: String,
				City: String,
				Zip: String,
				EmployeeCount: 0,
				SchoolSiteCount: 0,
				BankName: String,
				BankAddress: String,
				BankCity: String,
				BankState: String,
				BankZip: String,
				RoutingNumber: String,
				AccountNumber: String,
				PayrollTriggerDate: 0001-01-01,
				AccountType: String,
				EIN: String
			},
			School: 
			{
				Id: 0,
				ContactId: 0,
				EmployerId: 0,
				Name: String,
				SchoolLevelId: 0,
				City: String,
				County: String,
				Zip: String,
				Zip4: String,
				Phone: String,
				Website: String,
				Street1: String,
				Street2: String,
				EmployeeCount: 0,
				SchoolSiteCount: 0,
				BankName: String,
				BankAddress: String,
				BankCity: String,
				BankState: String,
				BankZip: String,
				RoutingNumber: String,
				AccountNumber: String,
				PayrollTriggerDate: 0001-01-01,
				PayrollFrequency: String,
				PayrollTrigger: String,
				LocationId: String,
				Employer: 
				{
					Id: 0,
					ContactId: 0,
					NCESId: String,
					Name: String,
					StateId: 0,
					Street: String,
					City: String,
					Zip: String,
					EmployeeCount: 0,
					SchoolSiteCount: 0,
					BankName: String,
					BankAddress: String,
					BankCity: String,
					BankState: String,
					BankZip: String,
					RoutingNumber: String,
					AccountNumber: String,
					PayrollTriggerDate: 0001-01-01,
					AccountType: String,
					EIN: String
				}
			},
			Vendor: 
			{
				Id: 0,
				ContactId: 0,
				Name: String,
				Website: String,
				Fax: String,
				IPXVendorId: String,
				SPARKFileSharingFrequency: String,
				SPARKFileSharingFrequencyOther: String,
				SPARKContactName: String,
				SPARKContactPhone: String,
				SPARKContactEmail: String,
				BankName: String,
				BankAddress: String,
				BankCity: String,
				BankState: String,
				BankZip: String,
				RoutingNumber: String,
				AccountNumber: String,
				DataTransmissionMethod: String
			},
			CRMImage: 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
			}
		]
	},
	ContactsAdded: 0
}