Skip Navigation Links.
展开 最小化

SpreadWebServcie.GetUploadRequestStatus Method

Get contact list upload status .

Parameters

Parameter

Type

Description

loginEmail

String

The login email of your Spread account.

APIKey

String

The password of your Spread account or API Key which you can retrieve from your Spread account (My account=> Settings).

RequestID

String

The request id of SpreadWebServcie.UploadContactListFile return .

Return Value

Dataset or Exception. If it success, it will return Dataset, otherwise it will return Exception.

Please find the details for the return message in the following table.

Status/Situation

Retrun Type

Retrun Message

Get the status successfully.

Dataset

A Dataset with a datatable. Please find the details about the datatable in the following table.

Call API with error account or API Key.

Exception

Return a exception with message 'Spread Email and Password not match!'.

The type of Request ID is not Guid.

Exception

Return a exception with message 'Request ID AAAABBBB-CCCC-DDDD-EEEE-FFFFGGGGHHHH is invalid!'.

Call API with error Request ID.

Exception

Return a exception with message 'You don't have permission to implement the operation!'.

Other Exception

Exception

Return a exception.

Please find the details for the datatable in the following table.

Columns

Type

Content

RequestID

Guid

AAAABBBB-CCCC-DDDD-EEEE-FFFFGGGGHHHH

UploadStatus

String

Uploading or Complete or Error

category_name

String

Remarks: The name of the contact list to upload.

UploadTime

DateTime

Remarks: The time of start to upload the contacts.

TotalCount

Integer

0

NewCount

Integer

0

DuplicateCount

Integer

0

DeletedCount

Integer

0

ExistingCount

Integer

0

SpamCount

Integer

0

UnsubscribedCount

Integer

0

DoNotMailCount

Integer

0

UndeliverableCount

Integer

0

asUnconfirmedCount

Integer

0

InvalidCount

Integer

0

HasUploadNo

Integer

1000

Remarks: The count of the contacts have been uploaded.

Example

string loginEmail = "Spread@reasonables.com";

string APIKey = "TEST0000-TEST-0000-TEST-0000TEST0000";

string RequestID = "38806E59-AAAA-BBBB-CCCC-15A7BFC0D226";

SpreadAPI.SpreadWebService MySpread = new SpreadAPI.SpreadWebService();

DataSet result = MySpread.GetUploadRequestStatus(loginEmail, APIKey , RequestID);

Dim loginEmail As String = "Spread@reasonables.com"

Dim APIKey As String = "TEST0000-TEST-0000-TEST-0000TEST0000"

Dim RequestID As String = "38806E59-AAAA-BBBB-CCCC-15A7BFC0D226"

Dim MySpread As New SpreadAPI.SpreadWebService

Dim result As DataSet = MySpread.GetUploadRequestStatus(loginEmail, APIKey, RequestID)

    /**
    * @name     GetUploadRequestStatus
    * @function get contact list upload status
    * @param
    *  RequestID The request id of SpreadWebServcie.UploadContactListFile return .
    * @return
    *          dataset.
    */
    public function GetUploadRequestStatus($loginEmail,$APIKey,$RequestID){
        $array = array(
	        'loginEmail'        => $loginEmail,
	        'APIKey'	    => $APIKey,
	        'RequestID'  => $RequestID

        );
        $Client=new SoapClient("http://service.rspread.com/Service.asmx?WSDL");
        return $Client -> GetUploadRequestStatus( $array );
    }

         
No sample.

See Also