Users Web Service

Users

Click here for a complete list of operations.

GetUsers

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
username:
password:
index:
count:

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 /post/Users.asmx HTTP/1.1
Host: api.smsdev.ir
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetUsers"

<?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>
    <GetUsers xmlns="http://tempuri.org/">
      <username>string</username>
      <password>string</password>
      <index>int</index>
      <count>int</count>
    </GetUsers>
  </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>
    <GetUsersResponse xmlns="http://tempuri.org/">
      <GetUsersResult>
        <UserGridList>
          <UserId>int</UserId>
          <UserName>string</UserName>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Corporation>string</Corporation>
          <Email>string</Email>
          <MobileNumbers>string</MobileNumbers>
          <PhoneNumbers>string</PhoneNumbers>
          <FaxNumbers>string</FaxNumbers>
          <Address>string</Address>
          <Desctiptions>string</Desctiptions>
          <UserStatus>unsignedByte</UserStatus>
          <FixTariff>boolean</FixTariff>
          <MaxTicket>int</MaxTicket>
          <MaxOrderNumber>int</MaxOrderNumber>
          <NationalCode>string</NationalCode>
          <AccessToBranchs>boolean</AccessToBranchs>
          <BulkReport>boolean</BulkReport>
          <EnableDelivery>boolean</EnableDelivery>
          <PostalCode>string</PostalCode>
          <CertificateNumber>string</CertificateNumber>
          <ProvinceName>string</ProvinceName>
          <CityName>string</CityName>
          <ProductId>int</ProductId>
          <CommercialCode>string</CommercialCode>
          <UserOwner>int</UserOwner>
          <IsLegal>boolean</IsLegal>
          <userType>int</userType>
          <TariffID>int</TariffID>
          <ExpDate>dateTime</ExpDate>
        </UserGridList>
        <UserGridList>
          <UserId>int</UserId>
          <UserName>string</UserName>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Corporation>string</Corporation>
          <Email>string</Email>
          <MobileNumbers>string</MobileNumbers>
          <PhoneNumbers>string</PhoneNumbers>
          <FaxNumbers>string</FaxNumbers>
          <Address>string</Address>
          <Desctiptions>string</Desctiptions>
          <UserStatus>unsignedByte</UserStatus>
          <FixTariff>boolean</FixTariff>
          <MaxTicket>int</MaxTicket>
          <MaxOrderNumber>int</MaxOrderNumber>
          <NationalCode>string</NationalCode>
          <AccessToBranchs>boolean</AccessToBranchs>
          <BulkReport>boolean</BulkReport>
          <EnableDelivery>boolean</EnableDelivery>
          <PostalCode>string</PostalCode>
          <CertificateNumber>string</CertificateNumber>
          <ProvinceName>string</ProvinceName>
          <CityName>string</CityName>
          <ProductId>int</ProductId>
          <CommercialCode>string</CommercialCode>
          <UserOwner>int</UserOwner>
          <IsLegal>boolean</IsLegal>
          <userType>int</userType>
          <TariffID>int</TariffID>
          <ExpDate>dateTime</ExpDate>
        </UserGridList>
      </GetUsersResult>
    </GetUsersResponse>
  </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 /post/Users.asmx HTTP/1.1
Host: api.smsdev.ir
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>
    <GetUsers xmlns="http://tempuri.org/">
      <username>string</username>
      <password>string</password>
      <index>int</index>
      <count>int</count>
    </GetUsers>
  </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>
    <GetUsersResponse xmlns="http://tempuri.org/">
      <GetUsersResult>
        <UserGridList>
          <UserId>int</UserId>
          <UserName>string</UserName>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Corporation>string</Corporation>
          <Email>string</Email>
          <MobileNumbers>string</MobileNumbers>
          <PhoneNumbers>string</PhoneNumbers>
          <FaxNumbers>string</FaxNumbers>
          <Address>string</Address>
          <Desctiptions>string</Desctiptions>
          <UserStatus>unsignedByte</UserStatus>
          <FixTariff>boolean</FixTariff>
          <MaxTicket>int</MaxTicket>
          <MaxOrderNumber>int</MaxOrderNumber>
          <NationalCode>string</NationalCode>
          <AccessToBranchs>boolean</AccessToBranchs>
          <BulkReport>boolean</BulkReport>
          <EnableDelivery>boolean</EnableDelivery>
          <PostalCode>string</PostalCode>
          <CertificateNumber>string</CertificateNumber>
          <ProvinceName>string</ProvinceName>
          <CityName>string</CityName>
          <ProductId>int</ProductId>
          <CommercialCode>string</CommercialCode>
          <UserOwner>int</UserOwner>
          <IsLegal>boolean</IsLegal>
          <userType>int</userType>
          <TariffID>int</TariffID>
          <ExpDate>dateTime</ExpDate>
        </UserGridList>
        <UserGridList>
          <UserId>int</UserId>
          <UserName>string</UserName>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Corporation>string</Corporation>
          <Email>string</Email>
          <MobileNumbers>string</MobileNumbers>
          <PhoneNumbers>string</PhoneNumbers>
          <FaxNumbers>string</FaxNumbers>
          <Address>string</Address>
          <Desctiptions>string</Desctiptions>
          <UserStatus>unsignedByte</UserStatus>
          <FixTariff>boolean</FixTariff>
          <MaxTicket>int</MaxTicket>
          <MaxOrderNumber>int</MaxOrderNumber>
          <NationalCode>string</NationalCode>
          <AccessToBranchs>boolean</AccessToBranchs>
          <BulkReport>boolean</BulkReport>
          <EnableDelivery>boolean</EnableDelivery>
          <PostalCode>string</PostalCode>
          <CertificateNumber>string</CertificateNumber>
          <ProvinceName>string</ProvinceName>
          <CityName>string</CityName>
          <ProductId>int</ProductId>
          <CommercialCode>string</CommercialCode>
          <UserOwner>int</UserOwner>
          <IsLegal>boolean</IsLegal>
          <userType>int</userType>
          <TariffID>int</TariffID>
          <ExpDate>dateTime</ExpDate>
        </UserGridList>
      </GetUsersResult>
    </GetUsersResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /post/Users.asmx/GetUsers?username=string&password=string&index=string&count=string HTTP/1.1
Host: api.smsdev.ir

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfUserGridList xmlns="http://tempuri.org/">
  <UserGridList>
    <UserId>int</UserId>
    <UserName>string</UserName>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <Corporation>string</Corporation>
    <Email>string</Email>
    <MobileNumbers>string</MobileNumbers>
    <PhoneNumbers>string</PhoneNumbers>
    <FaxNumbers>string</FaxNumbers>
    <Address>string</Address>
    <Desctiptions>string</Desctiptions>
    <UserStatus>unsignedByte</UserStatus>
    <FixTariff>boolean</FixTariff>
    <MaxTicket>int</MaxTicket>
    <MaxOrderNumber>int</MaxOrderNumber>
    <NationalCode>string</NationalCode>
    <AccessToBranchs>boolean</AccessToBranchs>
    <BulkReport>boolean</BulkReport>
    <EnableDelivery>boolean</EnableDelivery>
    <PostalCode>string</PostalCode>
    <CertificateNumber>string</CertificateNumber>
    <ProvinceName>string</ProvinceName>
    <CityName>string</CityName>
    <ProductId>int</ProductId>
    <CommercialCode>string</CommercialCode>
    <UserOwner>int</UserOwner>
    <IsLegal>boolean</IsLegal>
    <userType>int</userType>
    <TariffID>int</TariffID>
    <ExpDate>dateTime</ExpDate>
  </UserGridList>
  <UserGridList>
    <UserId>int</UserId>
    <UserName>string</UserName>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <Corporation>string</Corporation>
    <Email>string</Email>
    <MobileNumbers>string</MobileNumbers>
    <PhoneNumbers>string</PhoneNumbers>
    <FaxNumbers>string</FaxNumbers>
    <Address>string</Address>
    <Desctiptions>string</Desctiptions>
    <UserStatus>unsignedByte</UserStatus>
    <FixTariff>boolean</FixTariff>
    <MaxTicket>int</MaxTicket>
    <MaxOrderNumber>int</MaxOrderNumber>
    <NationalCode>string</NationalCode>
    <AccessToBranchs>boolean</AccessToBranchs>
    <BulkReport>boolean</BulkReport>
    <EnableDelivery>boolean</EnableDelivery>
    <PostalCode>string</PostalCode>
    <CertificateNumber>string</CertificateNumber>
    <ProvinceName>string</ProvinceName>
    <CityName>string</CityName>
    <ProductId>int</ProductId>
    <CommercialCode>string</CommercialCode>
    <UserOwner>int</UserOwner>
    <IsLegal>boolean</IsLegal>
    <userType>int</userType>
    <TariffID>int</TariffID>
    <ExpDate>dateTime</ExpDate>
  </UserGridList>
</ArrayOfUserGridList>

HTTP POST

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

POST /post/Users.asmx/GetUsers HTTP/1.1
Host: api.smsdev.ir
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string&password=string&index=string&count=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfUserGridList xmlns="http://tempuri.org/">
  <UserGridList>
    <UserId>int</UserId>
    <UserName>string</UserName>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <Corporation>string</Corporation>
    <Email>string</Email>
    <MobileNumbers>string</MobileNumbers>
    <PhoneNumbers>string</PhoneNumbers>
    <FaxNumbers>string</FaxNumbers>
    <Address>string</Address>
    <Desctiptions>string</Desctiptions>
    <UserStatus>unsignedByte</UserStatus>
    <FixTariff>boolean</FixTariff>
    <MaxTicket>int</MaxTicket>
    <MaxOrderNumber>int</MaxOrderNumber>
    <NationalCode>string</NationalCode>
    <AccessToBranchs>boolean</AccessToBranchs>
    <BulkReport>boolean</BulkReport>
    <EnableDelivery>boolean</EnableDelivery>
    <PostalCode>string</PostalCode>
    <CertificateNumber>string</CertificateNumber>
    <ProvinceName>string</ProvinceName>
    <CityName>string</CityName>
    <ProductId>int</ProductId>
    <CommercialCode>string</CommercialCode>
    <UserOwner>int</UserOwner>
    <IsLegal>boolean</IsLegal>
    <userType>int</userType>
    <TariffID>int</TariffID>
    <ExpDate>dateTime</ExpDate>
  </UserGridList>
  <UserGridList>
    <UserId>int</UserId>
    <UserName>string</UserName>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <Corporation>string</Corporation>
    <Email>string</Email>
    <MobileNumbers>string</MobileNumbers>
    <PhoneNumbers>string</PhoneNumbers>
    <FaxNumbers>string</FaxNumbers>
    <Address>string</Address>
    <Desctiptions>string</Desctiptions>
    <UserStatus>unsignedByte</UserStatus>
    <FixTariff>boolean</FixTariff>
    <MaxTicket>int</MaxTicket>
    <MaxOrderNumber>int</MaxOrderNumber>
    <NationalCode>string</NationalCode>
    <AccessToBranchs>boolean</AccessToBranchs>
    <BulkReport>boolean</BulkReport>
    <EnableDelivery>boolean</EnableDelivery>
    <PostalCode>string</PostalCode>
    <CertificateNumber>string</CertificateNumber>
    <ProvinceName>string</ProvinceName>
    <CityName>string</CityName>
    <ProductId>int</ProductId>
    <CommercialCode>string</CommercialCode>
    <UserOwner>int</UserOwner>
    <IsLegal>boolean</IsLegal>
    <userType>int</userType>
    <TariffID>int</TariffID>
    <ExpDate>dateTime</ExpDate>
  </UserGridList>
</ArrayOfUserGridList>