Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Table of Contents
maxLevel2

WS_MailUpSend.GetCredits 

Returns the number of credits left in the administration console

Method parameters 

  • string GetCredits(string accessKey)
    • accessKey: access key obtained using the LoginFromId method

SOAP Examples

Code Block
languagehtml/xml
titleSOAP Response
linenumberstrue
<GetCreditsResult>
  <errorCode>0</errorCode>
  <errorDescription></errorDescription>
  <credits>12500</credits> 
</GetCreditsResult> 

WS_MailUpSend.GetCreditsList 

Returns the number of credits left in the administration console, for a specific list or for all lists

Method parameters 

  • string GetCreditsList(string accessKey, int idList)
    • accessKey: access key obtained using the LoginFromId method
    • idList: list identifier

If idList <=0, returned data refer to all the lists

If idList >0, returned data refer to the list indicated by the identifier


If error code=0, returned message will contain all the requested lists with the corresponding credits left
If error code<>0, returned message will contain a description of the error and the detail of the lists will be empty

SOAP Examples

Code Block
languagehtml/xml
titleSOAP Response
linenumberstrue
<GetCreditsListsResult>
       <ErrorCode>0</ErrorCode>
       <ErrorDescription></ErrorDescription>
       <Lists>
             <List>
                    <ID>1</ID>
                    <Name>List N. 1</Name>
                    <Credit>0</Credit>
             </List>
             <List>
                    <ID>3</ID>
                    <Name>List N. 2</Name>
                    <Credit>0</Credit>
             </List>
             <List>
                    <ID>3</ID>
                    <Name>List N. 3</Name>
                    <Credit>4327</Credit>
             </List>
             <List>
                    <ID>4</ID>
                    <Name>List N. 4</Name>
                    <Credit>7095.677</Credit>
             </List>
</Lists>
</GetCreditsListsResult>