Account


Click here for a complete list of operations.

SubAccountGiveCredit

Transfers credits to a sub-account.

 
Parameter
Notes
Username: 
Password: 
SubAccount:Provide the user name of the sub-account you wish to transfer credits to.
AnyTimeBalance:Provide a decimal value that represents the number of any time credits you wish to transfer to the sub-account. e.g. 10, -10. A negative balance indicates the transfer of credits back to the parent account from the sub-account.
OffPeakBalance:Provide a decimal value that represents the number of off peak credits you wish to transfer to the sub-account. e.g. 10, -10. A negative balance indicates the transfer of credits back to the parent account from the sub-account.
ParentAnyTimeBalance:Provide a decimal output parameter. This will be populated with the current any time balance on the parent account.
ParentOffPeakBalance:Provide a decimal output parameter. This will be populated with the current off peak balance on the parent account.
SubAnyTimeBalance:Provide a decimal output parameter. This will be populated with the number of any time credits on the selected sub-account.
SubOffPeakBalance:Provide a decimal output parameter. This will be populated with the number of off peak credits on the selected sub-account.
ResultText:E.g. Credits successfully exchanged between your.address@your.company (master account) and sub.account@company.com (sub account).
Code: 

Test

The test form is only available for methods with primitive types as parameters.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /WebServices/2.2/Simple/Account.asmx HTTP/1.1
Host: www.2sms.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.2sms.com/WebServices/2.2/Simple/SubAccountGiveCredit"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SubAccountGiveCredit xmlns="http://www.2sms.com/WebServices/2.2/Simple/">
      <Username>string</Username>
      <Password>string</Password>
      <SubAccount>string</SubAccount>
      <AnyTimeBalance>decimal</AnyTimeBalance>
      <OffPeakBalance>decimal</OffPeakBalance>
      <ParentAnyTimeBalance>decimal</ParentAnyTimeBalance>
      <ParentOffPeakBalance>decimal</ParentOffPeakBalance>
      <SubAnyTimeBalance>decimal</SubAnyTimeBalance>
      <SubOffPeakBalance>decimal</SubOffPeakBalance>
      <ResultText>string</ResultText>
      <Code>string</Code>
    </SubAccountGiveCredit>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SubAccountGiveCreditResponse xmlns="http://www.2sms.com/WebServices/2.2/Simple/">
      <SubAccountGiveCreditResult>string</SubAccountGiveCreditResult>
      <ParentAnyTimeBalance>decimal</ParentAnyTimeBalance>
      <ParentOffPeakBalance>decimal</ParentOffPeakBalance>
      <SubAnyTimeBalance>decimal</SubAnyTimeBalance>
      <SubOffPeakBalance>decimal</SubOffPeakBalance>
      <ResultText>string</ResultText>
      <Code>string</Code>
    </SubAccountGiveCreditResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /WebServices/2.2/Simple/Account.asmx HTTP/1.1
Host: www.2sms.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SubAccountGiveCredit xmlns="http://www.2sms.com/WebServices/2.2/Simple/">
      <Username>string</Username>
      <Password>string</Password>
      <SubAccount>string</SubAccount>
      <AnyTimeBalance>decimal</AnyTimeBalance>
      <OffPeakBalance>decimal</OffPeakBalance>
      <ParentAnyTimeBalance>decimal</ParentAnyTimeBalance>
      <ParentOffPeakBalance>decimal</ParentOffPeakBalance>
      <SubAnyTimeBalance>decimal</SubAnyTimeBalance>
      <SubOffPeakBalance>decimal</SubOffPeakBalance>
      <ResultText>string</ResultText>
      <Code>string</Code>
    </SubAccountGiveCredit>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SubAccountGiveCreditResponse xmlns="http://www.2sms.com/WebServices/2.2/Simple/">
      <SubAccountGiveCreditResult>string</SubAccountGiveCreditResult>
      <ParentAnyTimeBalance>decimal</ParentAnyTimeBalance>
      <ParentOffPeakBalance>decimal</ParentOffPeakBalance>
      <SubAnyTimeBalance>decimal</SubAnyTimeBalance>
      <SubOffPeakBalance>decimal</SubOffPeakBalance>
      <ResultText>string</ResultText>
      <Code>string</Code>
    </SubAccountGiveCreditResponse>
  </soap12:Body>
</soap12:Envelope>