Users Web Service

Users

Click here for a complete list of operations.

SearchUsers

Test

The test form is only available for requests from the local machine.

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

<?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>
    <SearchUsers xmlns="http://tempuri.org/">
      <userName>string</userName>
      <password>string</password>
      <userNameFilter>string</userNameFilter>
      <firstNameFilter>string</firstNameFilter>
      <lastNameFilter>string</lastNameFilter>
      <mobileNoFilter>string</mobileNoFilter>
      <rowsPerPage>int</rowsPerPage>
      <requestedPageNumber>int</requestedPageNumber>
      <usersScope>AllMyDirectSubUsers or ExpiredUsers or ExpiringUsers or AllSystemUsers</usersScope>
      <message>string</message>
    </SearchUsers>
  </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>
    <SearchUsersResponse xmlns="http://tempuri.org/">
      <SearchUsersResult>
        <UserDetails>
          <ID>int</ID>
          <UserName>string</UserName>
          <ParentID>int</ParentID>
          <CategoryID>int</CategoryID>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <BirthDate>dateTime</BirthDate>
          <MobileNo>string</MobileNo>
          <Phone>string</Phone>
          <Fax>string</Fax>
          <Address>string</Address>
          <PostalCode>string</PostalCode>
          <NationalCode>string</NationalCode>
          <BCN>string</BCN>
          <EMail>string</EMail>
          <Company>string</Company>
          <FamiliarityMethodID>int</FamiliarityMethodID>
          <CityID>int</CityID>
          <Description>string</Description>
          <ExpirationDateTime>dateTime</ExpirationDateTime>
          <IsActive>boolean</IsActive>
          <IsMale>boolean</IsMale>
          <IsMobileVerified>boolean</IsMobileVerified>
          <MobileVerificationPhrase>string</MobileVerificationPhrase>
        </UserDetails>
        <UserDetails>
          <ID>int</ID>
          <UserName>string</UserName>
          <ParentID>int</ParentID>
          <CategoryID>int</CategoryID>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <BirthDate>dateTime</BirthDate>
          <MobileNo>string</MobileNo>
          <Phone>string</Phone>
          <Fax>string</Fax>
          <Address>string</Address>
          <PostalCode>string</PostalCode>
          <NationalCode>string</NationalCode>
          <BCN>string</BCN>
          <EMail>string</EMail>
          <Company>string</Company>
          <FamiliarityMethodID>int</FamiliarityMethodID>
          <CityID>int</CityID>
          <Description>string</Description>
          <ExpirationDateTime>dateTime</ExpirationDateTime>
          <IsActive>boolean</IsActive>
          <IsMale>boolean</IsMale>
          <IsMobileVerified>boolean</IsMobileVerified>
          <MobileVerificationPhrase>string</MobileVerificationPhrase>
        </UserDetails>
      </SearchUsersResult>
      <message>string</message>
    </SearchUsersResponse>
  </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 /ws/Users.asmx HTTP/1.1
Host: ip.sms.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>
    <SearchUsers xmlns="http://tempuri.org/">
      <userName>string</userName>
      <password>string</password>
      <userNameFilter>string</userNameFilter>
      <firstNameFilter>string</firstNameFilter>
      <lastNameFilter>string</lastNameFilter>
      <mobileNoFilter>string</mobileNoFilter>
      <rowsPerPage>int</rowsPerPage>
      <requestedPageNumber>int</requestedPageNumber>
      <usersScope>AllMyDirectSubUsers or ExpiredUsers or ExpiringUsers or AllSystemUsers</usersScope>
      <message>string</message>
    </SearchUsers>
  </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>
    <SearchUsersResponse xmlns="http://tempuri.org/">
      <SearchUsersResult>
        <UserDetails>
          <ID>int</ID>
          <UserName>string</UserName>
          <ParentID>int</ParentID>
          <CategoryID>int</CategoryID>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <BirthDate>dateTime</BirthDate>
          <MobileNo>string</MobileNo>
          <Phone>string</Phone>
          <Fax>string</Fax>
          <Address>string</Address>
          <PostalCode>string</PostalCode>
          <NationalCode>string</NationalCode>
          <BCN>string</BCN>
          <EMail>string</EMail>
          <Company>string</Company>
          <FamiliarityMethodID>int</FamiliarityMethodID>
          <CityID>int</CityID>
          <Description>string</Description>
          <ExpirationDateTime>dateTime</ExpirationDateTime>
          <IsActive>boolean</IsActive>
          <IsMale>boolean</IsMale>
          <IsMobileVerified>boolean</IsMobileVerified>
          <MobileVerificationPhrase>string</MobileVerificationPhrase>
        </UserDetails>
        <UserDetails>
          <ID>int</ID>
          <UserName>string</UserName>
          <ParentID>int</ParentID>
          <CategoryID>int</CategoryID>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <BirthDate>dateTime</BirthDate>
          <MobileNo>string</MobileNo>
          <Phone>string</Phone>
          <Fax>string</Fax>
          <Address>string</Address>
          <PostalCode>string</PostalCode>
          <NationalCode>string</NationalCode>
          <BCN>string</BCN>
          <EMail>string</EMail>
          <Company>string</Company>
          <FamiliarityMethodID>int</FamiliarityMethodID>
          <CityID>int</CityID>
          <Description>string</Description>
          <ExpirationDateTime>dateTime</ExpirationDateTime>
          <IsActive>boolean</IsActive>
          <IsMale>boolean</IsMale>
          <IsMobileVerified>boolean</IsMobileVerified>
          <MobileVerificationPhrase>string</MobileVerificationPhrase>
        </UserDetails>
      </SearchUsersResult>
      <message>string</message>
    </SearchUsersResponse>
  </soap12:Body>
</soap12:Envelope>