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/07/30 17:49] mattdeveloper_guide:call_reference:activationrequest [2012/02/25 23:38] (current) – [ActivationRequest] matt
Line 1: Line 1:
 +~~NOTOC~~
 +
 ====== ActivationRequest ====== ====== ActivationRequest ======
  
-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.+<note>
  
 +This method is depreciated. Developers are no longer required to activate their IP address.  However, you can add IP restrictions via the control panel.
  
-**View:** +</note>
-  * [[:developer_guide:developer_guide#executing-your-first-xml-api-call|Executing Your First XML API Call]]   +
-  * .... +
-** +
-Related Calls:** +
-  * [[:developer_guide:call_reference:GetTimeRequest|GetTimeRequest]]+
  
 +==== Overview ====
  
-===== ActivationRequest Input =====+**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.
  
-==== 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.+**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>
-        <Token>string</Token+        <Username>string</Username
- <Username>string</Username>  +        <Token>string</Token>  
-    </ActivationRequest>"+    </ActivationRequest> 
 </code> </code>
 +
 +
  
 ==== Elements ==== ==== Elements ====
 +
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| ActivationRequest | container | required | Parent Element | +**ActivationRequest** | 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]] |
  
-===== ActivationRequest Output ===== 
  
-The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).+===== ActivationResponse ===== 
 + 
 +==== XML ==== 
 <code> <code>
 +
 <?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
-    <ActivationRequest>  +    <ActivationResponse>  
-        <Token>string</Token+        <Ack>string</Ack
- <Username>string</Username>  + <Timestamp>timestamp</Timestamp>  
-    </ActivationRequest>"+    </ActivationResponse> 
 </code> </code>
 +
 +
 +
 +==== Elements ====
 +
 +
 +
 +^ Name ^ Type ^ Occurrence  ^ Meaning ^
 +| **ActivationResponse** | container | required | Parent Element |
 +| Ack | string | always | Success, Error, or Warning |
 +| Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT |
developer_guide/call_reference/activationrequest.1248990578.txt.gz · Last modified: 2009/08/16 00:00 (external edit)