SubscriptionBridge: recurring billing and subscription management system - Documentation

User Tools

Site Tools

You are here: SubscriptionBridge Documentation » API Documentation: Getting Started » API Call Reference » GetPackagesRequest
Trace: • PayOutstandingBalanceRequest • GetPackagesRequest
developer_guide:call_reference:getpackagesrequest

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
developer_guide:call_reference:getpackagesrequest [2009/08/08 02:30] – mattdeveloper_guide:call_reference:getpackagesrequest [2012/02/25 23:39] (current) – [GetPackagesRequest] matt
Line 1: Line 1:
-====== GetPackagesRequest Call Reference ======+====== GetPackagesRequest ======
  
-GetPackagesRequest will return a list of all packages for any given store or language.+==== Overview ====
  
 +**GetPackagesRequest** will return a list of all packages for any given store or language.
  
-**View:** 
-  * [[:developer_guide:developer_guide#executing-your-first-xml-api-call|Executing Your First XML API Call]]   
-  * .... 
-** 
-Related Calls:** 
-  * [[:developer_guide:call_reference:GetTimeRequest|GetTimeRequest]] 
  
 +**Learn More:**
 +
 +  * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
 +  * [[:developer_guide:developer_guide#http-status-code|HTTP Status Codes]]  
 +  * [[:developer_guide:developer_guide#error-codes|Error Codes]] 
 +  * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]] 
  
 ===== GetPackagesRequest ===== ===== GetPackagesRequest =====
- 
-==== Overview ==== 
- 
-The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, scroll down to find it in the table below the box. 
  
 ==== XML ==== ==== XML ====
 +
 <code> <code>
 +
 <?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
-    <GetPackagesRequest>  + 
-        <Token>string</Token> +    <GetPackagesRequest> 
- <Username>string</Username>  +        <Username>string</Username>  
-    </GetPackagesRequest>"+        <Token>string</Token>  
 + <LanguageCode>integer</LanguageCode>  
 +    </GetPackagesRequest> 
 </code> </code>
 +
 +
  
 ==== Elements ==== ==== Elements ====
 +
 +
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| GetPackagesRequest | container | required | Parent Element | +| **GetPackagesRequest** | container | required | Parent Element | 
-| Token| string | required | Your application's security token. view also: How to create a token | +| Username | string | required | Merchant API Username (Not your Merchant Center login) | 
-| Username| string | required | Merchant API username (this is not your SubscriptionBridge login id) |+| Token| string | required | Hash of API Username and Password. [[:developer_guide:developer_guide:LinkID|Creating a Token]] | 
 +| LanguageCode | string | required | ISO Language Code (e.g. en-US). [[:developer_guide:developer_guide:Language_Code|Learn More]] |
  
  
Line 38: Line 45:
 ===== GetPackagesResponse ===== ===== GetPackagesResponse =====
  
-==== Overview ==== 
- 
-The box below lists all fields that could be included in the call response. To learn more about an individual field or its type, scroll down to find it in the table below the box. 
  
 ==== XML ==== ==== XML ====
 +
 <code> <code>
 +
 <?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
     <GetPackagesResponse>      <GetPackagesResponse>
-        <Status>string</Status> +        <Ack>string</Ack> 
- <Timestamp>timestamp</Timestamp>  + <Timestamp>timestamp</Timestamp> 
-    </GetPackagesResponse>"+        <Packages> 
 +            <Package> 
 +                <LinkID>string</LinkID> 
 +                <PackageName>string</PackageName> 
 +                <Description>string</Description> 
 +                <Price>currency</Price> 
 +                <TrialPrice>currency</TrialPrice> 
 +                <TrialName>string</TrialName> 
 +                <Disclaimer>string</Disclaimer> 
 +                <TrialDescription>string</TrialDescription> 
 +            </Package> 
 +        </Packages> 
 +    </GetPackagesResponse> 
 </code> </code>
 +
  
 ==== Elements ==== ==== Elements ====
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| ActivationResponse | container | required | Parent Element | +| **GetPackagesResponse** | container | required | Parent Element | 
-| Status | string | always | Success, Error, or Warning |+| Ack | string | always | Success, Error, or Warning |
 | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT | | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT |
-| Message | string | conditionally | A message with helpful information for the end user |+| **Packages** | container | always | A container element that contains a list of repeating package elements | 
 +| **Package** | container | always | A container element that contains the package elements | 
 +| Package/LinkID | string | always | The package LinkID | 
 +| Package/PackageName | string | always | The name of the package (e.g. XYZ Annual Magazine Subscription) | 
 +| Package/Price | currency | always | The price of the package | 
 +| Package/TrialPrice | currency | always | The trial price of the package | 
 +| Package/TrialName | string | always | The name of the trial (e.g. Try XYZ Magazine Free for 2 weeks) | 
 +| Package/Disclaimer | string | always | A custom message that accompanies the pricing terms (e.g. Plus shipping, tax, and handling) | 
 +| Package/TrialDescription | string | always | A description of the trial. (e.g. You will receive 2 issues of XYZ Magazine completely free of charge. If you don't wish to continue, you can simply cancel your subscription before the end of the trial.) |
developer_guide/call_reference/getpackagesrequest.1249713046.txt.gz · Last modified: 2009/08/16 00:00 (external edit)