Pera Administrators Service

<back to all web services

ContactPeraRequest

The following routes are available for this service:
GET/v1/ContactPera/{CompanyId}/{AgentId}/{PeraContactId}

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/ContactPeraRequest HTTP/1.1 
Host: testapi.peraadministrators.com 
Content-Type: application/json
Content-Length: length

{"CompanyId":0,"PeraContactId":0,"AgentId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Contact":[{"ContactId":0,"ContactType":0,"FirstName":"String","LastName":"String","Title":"String","EmailWork":"String","EmailPersonal":"String","State":"String","Phone":"String","LastContact":"0001-01-01T00:00:00.0000000","DoNotContact":false,"AgentId":0,"PhoneAlt":"String","PeraContactId":0,"SourceTypeId":0,"SourceTypeDesc":"String","SourceNote":"String","ContactStatusId":0,"ContactStatusDesc":"String","SSN":"String","DateOfBirth":"0001-01-01T00:00:00.0000000","Deleted":false,"IsShared":false,"address_line1":"String","address_city":"String","address_state":"String","address_zip":"String","DeletedBy":"String","DeletedDateTimeUtc":"0001-01-01T00:00:00.0000000","HasNBC":false,"HasFactFinderSheet":false,"MiddleInitial":"String","Tags":"String","DateCreated":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","DateModified":"0001-01-01T00:00:00.0000000","DateAcquired":"0001-01-01T00:00:00.0000000","ExpirationDate":"0001-01-01T00:00:00.0000000"}],"Employee":{"Id":0,"ContactId":0,"EmployerId":0,"SchoolId":0,"EmployerName":"String","SchoolName":"String","FullSSN":"String","Gender":"String","EmployeeId":"String","DateOfHire":"0001-01-01T00:00:00.0000000","DateOfTermination":"0001-01-01T00:00:00.0000000","Compensation":0,"HoursWorked":0,"LocationId":"String","RoleId":0,"IsMarried":false,"LastSentToIPXDate":"0001-01-01T00:00:00.0000000","UserId":"00000000000000000000000000000000","DateOfRehire":"0001-01-01T00:00:00.0000000","EmployeeStatus":"String","InternetAgreementSignedDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","AccountType":"String","EIN":"String","PartnerId":0,"PartnerFirstName":"String","PartnerLastName":"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-01T00:00:00.0000000","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-01T00:00:00.0000000","AccountType":"String","EIN":"String","PartnerId":0,"PartnerFirstName":"String","PartnerLastName":"String"},"SchoolContacts":null},"Vendor":{"Id":0,"ContactId":0,"Name":"String","Website":"String","Fax":"String","IPXVendorId":"String","SPARKFileSharingFrequency":"String","SPARKFileSharingFrequencyOther":"String","SPARKContactName":"String","SPARKContactPhone":"String","SPARKContactEmail":"String","AuthorizedSigners":null,"BankName":"String","BankAddress":"String","BankCity":"String","BankState":"String","BankZip":"String","RoutingNumber":"String","AccountNumber":"String","ProductTypeIds":null,"TransactionTypeIds":null,"DataTransmissionMethod":"String"},"Partner":{"Id":0,"ContactId":0,"EIN":"String","EmployerCount":0,"FullSSN":"String","PartnerAssociatedEmployer":null},"CRMImage":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]}}