Pera Administrators Service

ContactRequest

The following routes are available for this service:
GET,DELETE,POST,PUT,OPTIONS	/v1/Contact/{ContactId}
GET,DELETE,POST,PUT,OPTIONS	/v1/Contact/{ContactId}/{AgentId}
GET,POST,PUT,OPTIONS	/v1/Contact

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

HTTP + XML

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

POST /xml/reply/ContactRequest HTTP/1.1 
Host: testapi.peraadministrators.com 
Content-Type: application/xml
Content-Length: length

<ContactRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PeraAdministrators.API.Internal">
  <AgentId>0</AgentId>
  <Contact>
    <Contact>
      <AdditionalInformation>String</AdditionalInformation>
      <AgentId>0</AgentId>
      <AltPhoneLabel>String</AltPhoneLabel>
      <CRMImage>String</CRMImage>
      <Carriers>String</Carriers>
      <ContactGUID>00000000-0000-0000-0000-000000000000</ContactGUID>
      <ContactId>0</ContactId>
      <ContactImage>String</ContactImage>
      <ContactStatusDesc>String</ContactStatusDesc>
      <ContactStatusId>0</ContactStatusId>
      <ContactType>0</ContactType>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
      <Deleted>false</Deleted>
      <DeletedBy>String</DeletedBy>
      <DeletedDateTimeUtc>0001-01-01T00:00:00</DeletedDateTimeUtc>
      <DoNotContact>false</DoNotContact>
      <EmailPersonal>String</EmailPersonal>
      <EmailWork>String</EmailWork>
      <Employee>
        <Compensation>0</Compensation>
        <ContactId>0</ContactId>
        <DateOfHire>0001-01-01T00:00:00</DateOfHire>
        <DateOfRehire>0001-01-01T00:00:00</DateOfRehire>
        <DateOfTermination>0001-01-01T00:00:00</DateOfTermination>
        <EmployeeId>String</EmployeeId>
        <EmployeeStatus>String</EmployeeStatus>
        <EmployerId>0</EmployerId>
        <EmployerName>String</EmployerName>
        <FullSSN>String</FullSSN>
        <Gender>String</Gender>
        <HoursWorked>0</HoursWorked>
        <IPXSponsorUserId>String</IPXSponsorUserId>
        <Id>0</Id>
        <InternetAgreementSignedDate>0001-01-01T00:00:00</InternetAgreementSignedDate>
        <IsMarried>false</IsMarried>
        <LastSentToIPXDate>0001-01-01T00:00:00</LastSentToIPXDate>
        <LocationId>String</LocationId>
        <PeraConnectAgentId>0</PeraConnectAgentId>
        <RoleId>0</RoleId>
        <SchoolId>0</SchoolId>
        <SchoolName>String</SchoolName>
        <UserId>00000000-0000-0000-0000-000000000000</UserId>
      </Employee>
      <Employer>
        <AccountNumber>String</AccountNumber>
        <AccountType>String</AccountType>
        <BankAddress>String</BankAddress>
        <BankCity>String</BankCity>
        <BankName>String</BankName>
        <BankState>String</BankState>
        <BankZip>String</BankZip>
        <City>String</City>
        <ContactId>0</ContactId>
        <EIN>String</EIN>
        <EmployeeCount>0</EmployeeCount>
        <Id>0</Id>
        <NCESId>String</NCESId>
        <Name>String</Name>
        <PartnerFirstName>String</PartnerFirstName>
        <PartnerId>0</PartnerId>
        <PartnerLastName>String</PartnerLastName>
        <PayrollTriggerDate>0001-01-01T00:00:00</PayrollTriggerDate>
        <RoutingNumber>String</RoutingNumber>
        <SchoolSiteCount>0</SchoolSiteCount>
        <StateId>0</StateId>
        <Street>String</Street>
        <Zip>String</Zip>
      </Employer>
      <FirstName>String</FirstName>
      <HasFactFinderSheet>false</HasFactFinderSheet>
      <HasGiftCard>false</HasGiftCard>
      <HasNBC>false</HasNBC>
      <IsShared>false</IsShared>
      <LastContact>0001-01-01T00:00:00</LastContact>
      <LastName>String</LastName>
      <Licenses>
        <AgentLicense>
          <AgentId>0</AgentId>
          <AgentRegistrationTempId>0</AgentRegistrationTempId>
          <ContactId>0</ContactId>
          <DateAcquired>0001-01-01T00:00:00</DateAcquired>
          <DateCreated>0001-01-01T00:00:00</DateCreated>
          <DateModified>0001-01-01T00:00:00</DateModified>
          <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
          <Id>0</Id>
          <LicenseNumber>String</LicenseNumber>
          <LicenseState>String</LicenseState>
          <LicenseTypeId>0</LicenseTypeId>
          <LicenseTypeName>String</LicenseTypeName>
          <SecuritiesLicenseTypeName>String</SecuritiesLicenseTypeName>
          <SecurityLicenseTypeId>0</SecurityLicenseTypeId>
          <Temporary>false</Temporary>
        </AgentLicense>
      </Licenses>
      <MaritalStatus>String</MaritalStatus>
      <MiddleInitial>String</MiddleInitial>
      <Partner>
        <ContactId>0</ContactId>
        <EIN>String</EIN>
        <EmployerCount>0</EmployerCount>
        <FullSSN>String</FullSSN>
        <Id>0</Id>
        <PartnerAssociatedEmployer i:nil="true" />
      </Partner>
      <PeraContactId>0</PeraContactId>
      <Phone>String</Phone>
      <PhoneAlt>String</PhoneAlt>
      <PhoneLabel>String</PhoneLabel>
      <SSN>String</SSN>
      <School>
        <AccountNumber>String</AccountNumber>
        <BankAddress>String</BankAddress>
        <BankCity>String</BankCity>
        <BankName>String</BankName>
        <BankState>String</BankState>
        <BankZip>String</BankZip>
        <City>String</City>
        <ContactId>0</ContactId>
        <County>String</County>
        <EmployeeCount>0</EmployeeCount>
        <Employer>
          <AccountNumber>String</AccountNumber>
          <AccountType>String</AccountType>
          <BankAddress>String</BankAddress>
          <BankCity>String</BankCity>
          <BankName>String</BankName>
          <BankState>String</BankState>
          <BankZip>String</BankZip>
          <City>String</City>
          <ContactId>0</ContactId>
          <EIN>String</EIN>
          <EmployeeCount>0</EmployeeCount>
          <Id>0</Id>
          <NCESId>String</NCESId>
          <Name>String</Name>
          <PartnerFirstName>String</PartnerFirstName>
          <PartnerId>0</PartnerId>
          <PartnerLastName>String</PartnerLastName>
          <PayrollTriggerDate>0001-01-01T00:00:00</PayrollTriggerDate>
          <RoutingNumber>String</RoutingNumber>
          <SchoolSiteCount>0</SchoolSiteCount>
          <StateId>0</StateId>
          <Street>String</Street>
          <Zip>String</Zip>
        </Employer>
        <EmployerId>0</EmployerId>
        <Id>0</Id>
        <LocationId>String</LocationId>
        <Name>String</Name>
        <PayrollFrequency>String</PayrollFrequency>
        <PayrollTrigger>String</PayrollTrigger>
        <PayrollTriggerDate>0001-01-01T00:00:00</PayrollTriggerDate>
        <Phone>String</Phone>
        <RoutingNumber>String</RoutingNumber>
        <SchoolContacts i:nil="true" />
        <SchoolLevelId>0</SchoolLevelId>
        <SchoolSiteCount>0</SchoolSiteCount>
        <Street1>String</Street1>
        <Street2>String</Street2>
        <Website>String</Website>
        <Zip>String</Zip>
        <Zip4>String</Zip4>
      </School>
      <SourceNote>String</SourceNote>
      <SourceTypeDesc>String</SourceTypeDesc>
      <SourceTypeId>0</SourceTypeId>
      <State>String</State>
      <Tags>String</Tags>
      <Title>String</Title>
      <Vendor>
        <AccountNumber>String</AccountNumber>
        <AuthorizedSigners i:nil="true" />
        <BankAddress>String</BankAddress>
        <BankCity>String</BankCity>
        <BankName>String</BankName>
        <BankState>String</BankState>
        <BankZip>String</BankZip>
        <ContactId>0</ContactId>
        <DataTransmissionMethod>String</DataTransmissionMethod>
        <Fax>String</Fax>
        <IPXVendorId>String</IPXVendorId>
        <Id>0</Id>
        <Name>String</Name>
        <ProductTypeIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <RoutingNumber>String</RoutingNumber>
        <SPARKContactEmail>String</SPARKContactEmail>
        <SPARKContactName>String</SPARKContactName>
        <SPARKContactPhone>String</SPARKContactPhone>
        <SPARKFileSharingFrequency>String</SPARKFileSharingFrequency>
        <SPARKFileSharingFrequencyOther>String</SPARKFileSharingFrequencyOther>
        <TransactionTypeIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <Website>String</Website>
      </Vendor>
      <address_city>String</address_city>
      <address_line1>String</address_line1>
      <address_state>String</address_state>
      <address_zip>String</address_zip>
    </Contact>
  </Contact>
  <ContactId>0</ContactId>
</ContactRequest>

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

<ContactResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PeraAdministrators.API.Internal">
  <Contact>
    <Contact>
      <AdditionalInformation>String</AdditionalInformation>
      <AgentId>0</AgentId>
      <AltPhoneLabel>String</AltPhoneLabel>
      <CRMImage>String</CRMImage>
      <Carriers>String</Carriers>
      <ContactGUID>00000000-0000-0000-0000-000000000000</ContactGUID>
      <ContactId>0</ContactId>
      <ContactImage>String</ContactImage>
      <ContactStatusDesc>String</ContactStatusDesc>
      <ContactStatusId>0</ContactStatusId>
      <ContactType>0</ContactType>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
      <Deleted>false</Deleted>
      <DeletedBy>String</DeletedBy>
      <DeletedDateTimeUtc>0001-01-01T00:00:00</DeletedDateTimeUtc>
      <DoNotContact>false</DoNotContact>
      <EmailPersonal>String</EmailPersonal>
      <EmailWork>String</EmailWork>
      <Employee>
        <Compensation>0</Compensation>
        <ContactId>0</ContactId>
        <DateOfHire>0001-01-01T00:00:00</DateOfHire>
        <DateOfRehire>0001-01-01T00:00:00</DateOfRehire>
        <DateOfTermination>0001-01-01T00:00:00</DateOfTermination>
        <EmployeeId>String</EmployeeId>
        <EmployeeStatus>String</EmployeeStatus>
        <EmployerId>0</EmployerId>
        <EmployerName>String</EmployerName>
        <FullSSN>String</FullSSN>
        <Gender>String</Gender>
        <HoursWorked>0</HoursWorked>
        <IPXSponsorUserId>String</IPXSponsorUserId>
        <Id>0</Id>
        <InternetAgreementSignedDate>0001-01-01T00:00:00</InternetAgreementSignedDate>
        <IsMarried>false</IsMarried>
        <LastSentToIPXDate>0001-01-01T00:00:00</LastSentToIPXDate>
        <LocationId>String</LocationId>
        <PeraConnectAgentId>0</PeraConnectAgentId>
        <RoleId>0</RoleId>
        <SchoolId>0</SchoolId>
        <SchoolName>String</SchoolName>
        <UserId>00000000-0000-0000-0000-000000000000</UserId>
      </Employee>
      <Employer>
        <AccountNumber>String</AccountNumber>
        <AccountType>String</AccountType>
        <BankAddress>String</BankAddress>
        <BankCity>String</BankCity>
        <BankName>String</BankName>
        <BankState>String</BankState>
        <BankZip>String</BankZip>
        <City>String</City>
        <ContactId>0</ContactId>
        <EIN>String</EIN>
        <EmployeeCount>0</EmployeeCount>
        <Id>0</Id>
        <NCESId>String</NCESId>
        <Name>String</Name>
        <PartnerFirstName>String</PartnerFirstName>
        <PartnerId>0</PartnerId>
        <PartnerLastName>String</PartnerLastName>
        <PayrollTriggerDate>0001-01-01T00:00:00</PayrollTriggerDate>
        <RoutingNumber>String</RoutingNumber>
        <SchoolSiteCount>0</SchoolSiteCount>
        <StateId>0</StateId>
        <Street>String</Street>
        <Zip>String</Zip>
      </Employer>
      <FirstName>String</FirstName>
      <HasFactFinderSheet>false</HasFactFinderSheet>
      <HasGiftCard>false</HasGiftCard>
      <HasNBC>false</HasNBC>
      <IsShared>false</IsShared>
      <LastContact>0001-01-01T00:00:00</LastContact>
      <LastName>String</LastName>
      <Licenses>
        <AgentLicense>
          <AgentId>0</AgentId>
          <AgentRegistrationTempId>0</AgentRegistrationTempId>
          <ContactId>0</ContactId>
          <DateAcquired>0001-01-01T00:00:00</DateAcquired>
          <DateCreated>0001-01-01T00:00:00</DateCreated>
          <DateModified>0001-01-01T00:00:00</DateModified>
          <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
          <Id>0</Id>
          <LicenseNumber>String</LicenseNumber>
          <LicenseState>String</LicenseState>
          <LicenseTypeId>0</LicenseTypeId>
          <LicenseTypeName>String</LicenseTypeName>
          <SecuritiesLicenseTypeName>String</SecuritiesLicenseTypeName>
          <SecurityLicenseTypeId>0</SecurityLicenseTypeId>
          <Temporary>false</Temporary>
        </AgentLicense>
      </Licenses>
      <MaritalStatus>String</MaritalStatus>
      <MiddleInitial>String</MiddleInitial>
      <Partner>
        <ContactId>0</ContactId>
        <EIN>String</EIN>
        <EmployerCount>0</EmployerCount>
        <FullSSN>String</FullSSN>
        <Id>0</Id>
        <PartnerAssociatedEmployer i:nil="true" />
      </Partner>
      <PeraContactId>0</PeraContactId>
      <Phone>String</Phone>
      <PhoneAlt>String</PhoneAlt>
      <PhoneLabel>String</PhoneLabel>
      <SSN>String</SSN>
      <School>
        <AccountNumber>String</AccountNumber>
        <BankAddress>String</BankAddress>
        <BankCity>String</BankCity>
        <BankName>String</BankName>
        <BankState>String</BankState>
        <BankZip>String</BankZip>
        <City>String</City>
        <ContactId>0</ContactId>
        <County>String</County>
        <EmployeeCount>0</EmployeeCount>
        <Employer>
          <AccountNumber>String</AccountNumber>
          <AccountType>String</AccountType>
          <BankAddress>String</BankAddress>
          <BankCity>String</BankCity>
          <BankName>String</BankName>
          <BankState>String</BankState>
          <BankZip>String</BankZip>
          <City>String</City>
          <ContactId>0</ContactId>
          <EIN>String</EIN>
          <EmployeeCount>0</EmployeeCount>
          <Id>0</Id>
          <NCESId>String</NCESId>
          <Name>String</Name>
          <PartnerFirstName>String</PartnerFirstName>
          <PartnerId>0</PartnerId>
          <PartnerLastName>String</PartnerLastName>
          <PayrollTriggerDate>0001-01-01T00:00:00</PayrollTriggerDate>
          <RoutingNumber>String</RoutingNumber>
          <SchoolSiteCount>0</SchoolSiteCount>
          <StateId>0</StateId>
          <Street>String</Street>
          <Zip>String</Zip>
        </Employer>
        <EmployerId>0</EmployerId>
        <Id>0</Id>
        <LocationId>String</LocationId>
        <Name>String</Name>
        <PayrollFrequency>String</PayrollFrequency>
        <PayrollTrigger>String</PayrollTrigger>
        <PayrollTriggerDate>0001-01-01T00:00:00</PayrollTriggerDate>
        <Phone>String</Phone>
        <RoutingNumber>String</RoutingNumber>
        <SchoolContacts i:nil="true" />
        <SchoolLevelId>0</SchoolLevelId>
        <SchoolSiteCount>0</SchoolSiteCount>
        <Street1>String</Street1>
        <Street2>String</Street2>
        <Website>String</Website>
        <Zip>String</Zip>
        <Zip4>String</Zip4>
      </School>
      <SourceNote>String</SourceNote>
      <SourceTypeDesc>String</SourceTypeDesc>
      <SourceTypeId>0</SourceTypeId>
      <State>String</State>
      <Tags>String</Tags>
      <Title>String</Title>
      <Vendor>
        <AccountNumber>String</AccountNumber>
        <AuthorizedSigners i:nil="true" />
        <BankAddress>String</BankAddress>
        <BankCity>String</BankCity>
        <BankName>String</BankName>
        <BankState>String</BankState>
        <BankZip>String</BankZip>
        <ContactId>0</ContactId>
        <DataTransmissionMethod>String</DataTransmissionMethod>
        <Fax>String</Fax>
        <IPXVendorId>String</IPXVendorId>
        <Id>0</Id>
        <Name>String</Name>
        <ProductTypeIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <RoutingNumber>String</RoutingNumber>
        <SPARKContactEmail>String</SPARKContactEmail>
        <SPARKContactName>String</SPARKContactName>
        <SPARKContactPhone>String</SPARKContactPhone>
        <SPARKFileSharingFrequency>String</SPARKFileSharingFrequency>
        <SPARKFileSharingFrequencyOther>String</SPARKFileSharingFrequencyOther>
        <TransactionTypeIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <Website>String</Website>
      </Vendor>
      <address_city>String</address_city>
      <address_line1>String</address_line1>
      <address_state>String</address_state>
      <address_zip>String</address_zip>
    </Contact>
  </Contact>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</ContactResponse>