GetProgramStatusMessages

This method retrieves the program status messages from the publisher's inbox.

To access live data, please use this WSDL file:
https://api.affili.net/V2.0/PublisherInbox.svc?wsdl
To access demo data, please use this WSDL file:
https://developer-api.affili.net/V2.0/PublisherInbox.svc?wsdl

Web service description

Test data document

Operation test

With this form, you can try out this web service. We already filled it out with a sample request which will return data. Feel free to fill in different parameter values - our test data reference gives you an overview of our sample data.

Field	Type	Values
PublisherId *	int
TimeSpan	enum
Query	string
MessagePartnershipStatus	enum

XML response

Short paramter definitions

PublisherId (int):: Id of the publisher whose account is being used.
TimeSpan (enum):: This parameter defines the timespan of the messages that ought to be retrieved. Possible values are: LastLogin, Last7days, Last14days, LastMonth, Last3months
Query (string):: This parameter defines the search query for which records ought to be returned.
MessagePartnershipStatus (enum):: This parameter restricts the returned messages to a certain partnership status. Possible values are: AllPartnerships, AllAcceptedPartnerships, AllTemporarilyAcceptedPartnerships, AllDeclinedPartnerships

Complete code examples

<?php

/* <LIVE DATA>
define ("WSDL_LOGON", "https://api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_SERVICE",  "https://api.affili.net/V2.0/PublisherInbox.svc?wsdl");

$Username   = ''; // the publisher ID
$Password   = ''; // the publisher web services password

$SOAP_LOGON = new SoapClient(WSDL_LOGON);
$Token      = $SOAP_LOGON->Logon(array(
             'Username'  => $Username,
             'Password'  => $Password,
             'WebServiceType' => 'Publisher'
             ));
</LIVE DATA> */

/* <DEMO DATA> */
define ("WSDL_LOGON", "https://developer-api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_SERVICE",  "https://developer-api.affili.net/V2.0/PublisherInbox.svc?wsdl");

$Username   = '';     // your developer ID
$Password   = '';     // your developer portal password
$DemoPublisherId   = 403235;  // one of the publisher IDs of our demo database
$DeveloperSettings = array('SandboxPublisherID' => $DemoPublisherId);

$SOAP_LOGON = new SoapClient(WSDL_LOGON);
$Token      = $SOAP_LOGON->Logon(array(
                     'Username'  => $Username,
                     'Password'  => $Password,
                     'WebServiceType' => 'Publisher',
                     'DeveloperSettings' => $DeveloperSettings
                     ));
/* </DEMO DATA> */

$params = array(
          'TimeSpan' => 'Last3months',
          'Query' => '',
          'MessagePartnershipStatus' => 'AllPartnerships'
          );

$SOAP_REQUEST = new SoapClient(WSDL_SERVICE);
$req = $SOAP_REQUEST->GetProgramStatusMessages(array(
            'CredentialToken' => $Token,
            'GetProgramStatusMessagesRequestMessage' => $params
            ));

print_r($req);

?>

protected void LoadWebService()
{            
    // first create the Web References
    // LIVE DATA
    // using Affilinet.LogonWebservice; ("https://api.affili.net/V2.0/Logon.svc?wsdl")
    // using Affilinet.InboxWebservice; ("https://api.affili.net/V2.0/PublisherInbox.svc?wsdl")    

    // or DEMO DATA
    // using Affilinet.LogonWebservice; ("https://developer-api.affili.net/V2.0/Logon.svc?wsdl")
    // using Affilinet.InboxWebservice; ("https://developer-api.affili.net/V2.0/PublisherInbox.svc?wsdl")


    #region Parameters for the authentification token
    // Insert the publisher ID for access the live data or insert your DeveloperId for access the demo data 
    string Username   = "";
    // Insert the publisher web services password for access the live data or insert your developer portal password for access the demo data 
    string Password   = "";
    // only required for access the demo data. Insert one of the publisher IDs of our demo database. e.g.: 403233
    int SandboxPublisherID = 0;
    #endregion

    string myToken = GetAuthentificationToken(Username, Password, SandboxPublisherID, WebServiceTypes.Publisher);
    
    // insert the parameters to get the products    
    string query = "";
    PartnershipStatusMessages myResult = GetProgramStatusMessages(myToken, MessagePartnershipStatus.AllPartnerships, query, Affilinet.InboxWebservice.TimeSpan.Last3months);
}

public static string GetAuthentificationToken(string username, string password, int sandboxPublisherID, WebServiceTypes WSType)
{
    Logon logonRequest = new Logon();
    logonRequest.Username = username;
    logonRequest.Password = password;
    logonRequest.WebServiceType = WSType;
    
    // *** only required for sandbox requests *** 
    // logonRequest.DeveloperSettings = new TokenDeveloperDetails();
    // logonRequest.DeveloperSettings.SandboxPublisherID = sandboxPublisherID;
    // logonRequest.DeveloperSettings.SandboxPublisherIDSpecified = true;             

    Authentication logonService = new Authentication();
    return logonService.Logon(logonRequest);
}

public static PartnershipStatusMessages GetProgramStatusMessages(string token, MessagePartnershipStatus MessagePartnershipStatus, string query, Affilinet.InboxWebservice.TimeSpan timespan)
{
    PublisherInbox pubinbox = new PublisherInbox();
    GetProgramStatusMessagesRequestMessage gpsmRqMess = new GetProgramStatusMessagesRequestMessage();
    gpsmRqMess.MessagePartnershipStatus = MessagePartnershipStatus;
    gpsmRqMess.Query = query;
    gpsmRqMess.TimeSpan = timespan;
    return pubinbox.GetProgramStatusMessages(token, gpsmRqMess);
}

GetProgramStatusMessages

GetProgramStatusMessages

Web service description

Test data document

More questions?

Operation test

XML response

Complete code examples

PHP

.NET