ReturnValue (SOAP)

RSS

ReturnValue is one of the types in the PSWinCom SMS Gateway SOAP API.

Table of Contents [Hide/Show]

Properties
Code
XML
Return code values
See also

Properties¶

Attribute	Description
Code	Integer. Statuscode indicating whether the operation was successful or failed. A statuscode of 200 represents a successful operation. Otherwise the Code will indicate an failure, and the Description attribute will contain further information.
Description	String. Textual descriptions of the statuscode given by the Code attribute.
Reference	Optional String. Certain operations may render an unique reference ID that the client may store and later use to track or correlate messages. Typically submit message operations will return a Reference value that the client later will use to correlate with a delivery report. This value must be treated as a string with a length of at least 36 characters.

C# notation of the ReturnValue object:

public class ReturnValue
{
  public int Code;
  public string Description;
  public string Reference;
  
  public ReturnValue()
  {
  }
}

Sample XML:

<ReturnValue>
  <Code>200</Code>
  <Description>OK</Description>
  <Reference>6542424363623</Reference>
</ReturnValue>

The following table shows the possible values of the Code element on the ReturnValue object:

Code	Description
100	Gateway rejected message. Detailed description can be found in the Description element of the ReturnValue object. Reference value will be empty.
200	Message successfully submitted. Reference (if requested and enabled on account) will be set to a unique value.
500	General SOAP Interface error. Message was not submitted.