SubscriptionBridge: recurring billing and subscription management system - Documentation

User Tools

Site Tools

You are here: SubscriptionBridge Documentation » API Documentation: Getting Started » API Call Reference » NotificationRequest
Trace:
developer_guide:call_reference:notificationrequest

Differences

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

Link to this comparison view

Next revision		Previous revision
developer_guide:call_reference:notificationrequest [2009/08/08 02:42] – created mattdeveloper_guide:call_reference:notificationrequest [2012/02/25 23:38] (current) – [NotificationRequest] matt
Line 1: Line 1:
-====== NotificationRequest Call Reference ======+====== NotificationRequest ======
  
-NotificationRequest allows an application to problematically send any notification.+==== Overview ==== 
 + 
 +**NotificationRequest** allows an application to programmatically send any notification.
  
  
-**View:** +**Learn More:**
-  * [[:developer_guide:developer_guide#executing-your-first-xml-api-call|Executing Your First XML API Call]]   +
-  * .... +
-** +
-Related Calls:** +
-  * [[:developer_guide:call_reference:GetTimeRequest|GetTimeRequest]]+
  
 +  * [[: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]] 
  
 ===== NotificationRequest ===== ===== NotificationRequest =====
  
-==== 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"?>
-    <NotificationRequest> +    <NotificationRequest> 
 + <Username>string</Username>
         <Token>string</Token>         <Token>string</Token>
- <Username>string</Username> 
         <GUID>string</GUID>         <GUID>string</GUID>
-        <Action>string</Action>  +        <Action>string</Action>  
-    </NotificationRequest>"+    </NotificationRequest> 
 </code> </code>
 +
 +
  
 ==== Elements ==== ==== Elements ====
 +
 +
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| NotificationRequest | container | required | Parent Element | +| **NotificationRequest** | 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]] | 
-| GUID | string | required | The global unique identifier for a Subscription, returned in SubscriptionResponse |+| Guid | string | always | This is the identifier for the subscription and should be referenced in future management requests |
 | Action | string | required | The notification name you wish to send. | | Action | string | required | The notification name you wish to send. |
  
Line 41: Line 47:
 ===== NotificationResponse ===== ===== NotificationResponse =====
  
-==== 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"?>
     <NotificationResponse>      <NotificationResponse>
-        <Status>string</Status> +        <Ack>string</Ack> 
- <Timestamp>timestamp</Timestamp>  + <Timestamp>timestamp</Timestamp>  
-    </NotificationResponse>"+    </NotificationResponse> 
 </code> </code>
 +
 +
  
 ==== Elements ==== ==== Elements ====
 +
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| NotificationResponse | container | required | Parent Element | +| **NotificationResponse** | 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 | | Message | string | conditionally | A message with helpful information for the end user |
developer_guide/call_reference/notificationrequest.1249713727.txt.gz · Last modified: 2009/08/16 00:00 (external edit)