Bombshell Agency Platform Service

<back to all web services

AgentSubscriptionRequest

The following routes are available for this service:
POST,OPTIONS/v1/AgentSubscription
PUT,OPTIONS/v1/AgentSubscription
GET/v1/AgentSubscription/{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/AgentSubscriptionRequest HTTP/1.1 
Host: api.responsible-advisor.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>
  <AgentSubscription>
    <AccessDenialOverride>false</AccessDenialOverride>
    <AccessPermissionOverride>false</AccessPermissionOverride>
    <ActiveUntilDate>0001-01-01T00:00:00</ActiveUntilDate>
    <AgentId>0</AgentId>
    <AgentSubscriptionId>0</AgentSubscriptionId>
    <AutoRenew>false</AutoRenew>
    <StripePaymentId>0</StripePaymentId>
    <SubscriptionId>0</SubscriptionId>
  </AgentSubscription>
  <StripeToken>String</StripeToken>
</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">
  <AgentPayment>
    <AgentId>0</AgentId>
    <AgentNumber>String</AgentNumber>
    <Amount>String</Amount>
    <Approved>false</Approved>
    <AuthCode>String</AuthCode>
    <CardNumber>String</CardNumber>
    <Message>String</Message>
    <ResponseCode>0</ResponseCode>
    <TransactionId>String</TransactionId>
  </AgentPayment>
  <AgentSubscription>
    <AgentSubscription>
      <AccessDenialOverride>false</AccessDenialOverride>
      <AccessPermissionOverride>false</AccessPermissionOverride>
      <ActiveUntilDate>0001-01-01T00:00:00</ActiveUntilDate>
      <AgentId>0</AgentId>
      <AgentSubscriptionId>0</AgentSubscriptionId>
      <AutoRenew>false</AutoRenew>
      <StripePaymentId>0</StripePaymentId>
      <SubscriptionId>0</SubscriptionId>
    </AgentSubscription>
  </AgentSubscription>
  <Message>String</Message>
  <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>