PARAMETRI RICHIESTA

Parametro Tipo di dato Richiesto Definizione
SessionID string Session ID which is needed to authenticate the access. It's optional and required for desktop applications only
Command string The API Command sended to the console
ResponseFormat JSON | XML Response format
JSONPCallBack bool Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP
OrderField string Field name of subscriber list used for return array sorting
OrderType string {ASC} {DESC} Type of return array ordering
RecordsFrom integer Return records starting from this index (starts from zero)
RecordsPerRequest integer Records number per page
SearchField string Subscriber list field to make the search. In order to disable search/filtering assign an empty string
SearchKeyword string Keyword used in search/filtering process. In order to disable search/filtering assign an empty string
SubscriberListID integer List ID of the subscribers
SubscriberSegment string Target segment ID or one of the following values: Suppressed, Unsubscribed, Soft bounced, Hard bounced, Opt-in pending, Active
TotalSubscribers integer Returns the total number of subscribers if selected subscription list that match filter/searching parameters

PARAMETRI DI RISPOSTA

Parametro Tipo di dato Definizione
Success bool States if an error has been generated during last command execution or not
ErrorCode integer The ErrorCode number, if an error has occurred. ErrorCode = 0 means no error has occurred.
ErrorText string Returns the error description (if exception is trown)
Subscribers array Returns the list of all subscribers of selected subscription list that satisfy filter/searching conditions

CODICI DI ERRORE

Codice Definizione
1 Missing subscriber list ID
2 Target segment ID is missing
99998 Authentication failure or session expired
99999 Not enough privileges