developer_guide:call_reference:activationrequest

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:activationrequest [2009/08/16 08:39] – external edit 127.0.0.1developer_guide:call_reference:activationrequest [2012/02/25 23:38] (current) – [ActivationRequest] matt
Line 1: Line 1:
-====== ActivationRequest Call Reference ======+~~NOTOC~~
  
-ActivationRequest is the first call you will make to the API.  This call authorizes your application to communicate with the API.  No other calls will work until you successfully call ActivationRequest.+====== ActivationRequest ======
  
 +<note>
  
-**View:** +This method is depreciatedDevelopers are no longer required to activate their IP address However, you can add IP restrictions via the control panel.
-  * [[:developer_guide:developer_guide#executing-your-first-xml-api-call|Executing Your First XML API Call]]   +
-  * ...+
-** +
-Related Calls:** +
-  * [[:developer_guide:call_reference:GetTimeRequest|GetTimeRequest]]+
  
- +</note>
-===== ActivationRequest =====+
  
 ==== Overview ==== ==== Overview ====
  
-The box below lists all fields that could be included in the call requestTo learn more about an individual field or its type, scroll down to find it in the table below the box.+**ActivationRequest** is the first call you will make to the API This call authorizes your application to communicate with the API No other calls will work until you successfully call ActivationRequest. 
 + 
 + 
 +**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]]  
 + 
 +===== ActivationRequest =====
  
 ==== XML ==== ==== XML ====
 +
 <code> <code>
 +
 <?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
     <ActivationRequest>      <ActivationRequest>
         <Username>string</Username>         <Username>string</Username>
-        <Token>string</Token>  +        <Token>string</Token>  
-    </ActivationRequest>"+    </ActivationRequest> 
 </code> </code>
  
-==== Elements ==== 
  
-^ Name ^ Type ^ Occurrence  ^ Meaning ^ 
-| ActivationRequest | container | required | Parent Element | 
-| Username| string | required | Merchant API username (this is not your SubscriptionBridge login id) | 
-| Token| string | required | Your application's security token. view also: How to create a token | 
  
 +==== Elements ====
  
 +
 +^ Name ^ Type ^ Occurrence  ^ Meaning ^
 +| **ActivationRequest** | container | required | Parent Element |
 +| Username | string | required | Merchant API Username (Not your Merchant Center login) |
 +| Token| string | required | Hash of API Username and Password. [[:developer_guide:developer_guide:LinkID|Creating a Token]] |
  
  
 ===== ActivationResponse ===== ===== ActivationResponse =====
- 
-==== 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"?>
     <ActivationResponse>      <ActivationResponse>
-        <Status>string</Status+        <Ack>string</Ack
- <Timestamp>timestamp</Timestamp>  + <Timestamp>timestamp</Timestamp>  
-    </ActivationResponse>"+    </ActivationResponse> 
 </code> </code>
 +
 +
  
 ==== Elements ==== ==== Elements ====
 +
 +
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| ActivationResponse | container | required | Parent Element | +**ActivationResponse** | 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 | 
developer_guide/call_reference/activationrequest.1250426399.txt.gz · Last modified: 2010/01/04 23:00 (external edit)