Bombshell Agency Platform Service

<back to all web services

AgentAgreementDocNotStartedRequest

The following routes are available for this service:
POST,OPTIONS/v1/AgentAgreementDoc/SubmitAgreements
GET,OPTIONS/v1/AgentAgreementDoc/NonStarted/{AgentId}

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/AgentAgreementDocNotStartedRequest HTTP/1.1 
Host: api.consumertaxadvocate.com 
Content-Type: application/xml
Content-Length: length

<AgentAgreementDocNotStartedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <AgentAgreementsSigned>
    <AgentAgreementDoc>
      <Active>false</Active>
      <ApplicationId>String</ApplicationId>
      <DisplayName>String</DisplayName>
      <FileExtension>String</FileExtension>
      <FileName>String</FileName>
      <Id>0</Id>
      <LegalRegion>String</LegalRegion>
      <Name>String</Name>
      <Order>0</Order>
      <Section>String</Section>
      <Version>0</Version>
    </AgentAgreementDoc>
  </AgentAgreementsSigned>
  <AgentId>0</AgentId>
  <AgentW9>
    <AgentId>0</AgentId>
    <AgentW9Id>0</AgentW9Id>
    <w9_1>String</w9_1>
    <w9_2>String</w9_2>
    <w9_3_1>String</w9_3_1>
    <w9_3_2>String</w9_3_2>
    <w9_3_3>String</w9_3_3>
    <w9_3_4>String</w9_3_4>
    <w9_3_5>String</w9_3_5>
    <w9_3_6>String</w9_3_6>
    <w9_3_7>String</w9_3_7>
    <w9_3_8>String</w9_3_8>
    <w9_4_1>String</w9_4_1>
    <w9_4_2>String</w9_4_2>
    <w9_5>String</w9_5>
    <w9_6>String</w9_6>
    <w9_7>String</w9_7>
  </AgentW9>
  <AgreementsSignatureImage>String</AgreementsSignatureImage>
  <AreasWorkedOrCustomersLocated>String</AreasWorkedOrCustomersLocated>
  <EIN>String</EIN>
  <IPAddress>String</IPAddress>
  <SSN>String</SSN>
</AgentAgreementDocNotStartedRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentAgreementDocNotStartedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <NotStartedAgentAgreementDocs>
    <AgentAgreementDoc>
      <Active>false</Active>
      <ApplicationId>String</ApplicationId>
      <DisplayName>String</DisplayName>
      <FileExtension>String</FileExtension>
      <FileName>String</FileName>
      <Id>0</Id>
      <LegalRegion>String</LegalRegion>
      <Name>String</Name>
      <Order>0</Order>
      <Section>String</Section>
      <Version>0</Version>
    </AgentAgreementDoc>
  </NotStartedAgentAgreementDocs>
  <RequireSSNorEIN>false</RequireSSNorEIN>
  <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>
</AgentAgreementDocNotStartedResponse>