Bombshell Agency Platform Service

AgentSubscriptionRequest

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

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

<AgentSubscriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <AgentId>0</AgentId>
  <SubscriptionGroupId>0</SubscriptionGroupId>
  <SubscriptionId>0</SubscriptionId>
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
</AgentSubscriptionRequest>

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

<AgentSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <AgentSubscription>
    <AgentSubscriptionExtended>
      <ActivateOnDate>0001-01-01T00:00:00</ActivateOnDate>
      <ActiveUntilDate>0001-01-01T00:00:00</ActiveUntilDate>
      <AgentId>0</AgentId>
      <AgentSubscriptionId>0</AgentSubscriptionId>
      <IsCancelled>false</IsCancelled>
      <IsSuspended>false</IsSuspended>
      <PaymentProviderSubscriptionId>String</PaymentProviderSubscriptionId>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <SubscriptionComps>
        <SubscriptionComp>
          <AddedByUserId>00000000-0000-0000-0000-000000000000</AddedByUserId>
          <AgentId>0</AgentId>
          <AgentSubscriptionId>0</AgentSubscriptionId>
          <DateAdded>0001-01-01T00:00:00</DateAdded>
          <Id>0</Id>
        </SubscriptionComp>
      </SubscriptionComps>
      <SubscriptionId>0</SubscriptionId>
      <AgentName>String</AgentName>
      <AgentNumber>String</AgentNumber>
      <CompDate>0001-01-01T00:00:00</CompDate>
      <SubscriptionGroupName>String</SubscriptionGroupName>
      <SubscriptionName>String</SubscriptionName>
    </AgentSubscriptionExtended>
  </AgentSubscription>
  <CardsOnFile>0</CardsOnFile>
  <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>
</AgentSubscriptionResponse>