UsersService


Click here for a complete list of operations.

GetUsers

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 /restful_v5_2_8/ws_users_module.asmx HTTP/1.1
Host: kbcsony.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://users.tvinci.com/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://users.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <sSiteGUIDs>
        <string>string</string>
        <string>string</string>
      </sSiteGUIDs>
      <userIP>string</userIP>
    </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://users.tvinci.com/">
      <GetUsersResult>
        <resp>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </resp>
        <users>
          <UserResponseObject>
            <m_user xsi:nil="true" />
            <m_RespStatus>OK or UserExists or UserDoesNotExist or WrongPasswordOrUserName or InsideLockTime or NotImplementedYet or UserNotActivated or UserAllreadyLoggedIn or UserDoubleLogIn or SessionLoggedOut or DeviceNotRegistered or ErrorOnSendingMail or UserEmailAlreadyExists or ErrorOnUpdatingUserType or UserTypeNotExist or UserNotMasterApproved or ErrorOnInitUser or ErrorOnSaveUser or UserNotIndDomain or TokenNotFound or UserAlreadyMasterApproved or UserWithNoDomain or InternalError or LoginServerDown or UserSuspended or UserCreatedWithNoRole or ExternalIdAlreadyExists or ExternalError or PasswordPolicyViolation or PasswordExpired</m_RespStatus>
            <m_userInstanceID>string</m_userInstanceID>
            <ExternalCode>int</ExternalCode>
            <ExternalMessage>string</ExternalMessage>
          </UserResponseObject>
          <UserResponseObject>
            <m_user xsi:nil="true" />
            <m_RespStatus>OK or UserExists or UserDoesNotExist or WrongPasswordOrUserName or InsideLockTime or NotImplementedYet or UserNotActivated or UserAllreadyLoggedIn or UserDoubleLogIn or SessionLoggedOut or DeviceNotRegistered or ErrorOnSendingMail or UserEmailAlreadyExists or ErrorOnUpdatingUserType or UserTypeNotExist or UserNotMasterApproved or ErrorOnInitUser or ErrorOnSaveUser or UserNotIndDomain or TokenNotFound or UserAlreadyMasterApproved or UserWithNoDomain or InternalError or LoginServerDown or UserSuspended or UserCreatedWithNoRole or ExternalIdAlreadyExists or ExternalError or PasswordPolicyViolation or PasswordExpired</m_RespStatus>
            <m_userInstanceID>string</m_userInstanceID>
            <ExternalCode>int</ExternalCode>
            <ExternalMessage>string</ExternalMessage>
          </UserResponseObject>
        </users>
      </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 /restful_v5_2_8/ws_users_module.asmx HTTP/1.1
Host: kbcsony.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>
    <GetUsers xmlns="http://users.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <sSiteGUIDs>
        <string>string</string>
        <string>string</string>
      </sSiteGUIDs>
      <userIP>string</userIP>
    </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://users.tvinci.com/">
      <GetUsersResult>
        <resp>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </resp>
        <users>
          <UserResponseObject>
            <m_user xsi:nil="true" />
            <m_RespStatus>OK or UserExists or UserDoesNotExist or WrongPasswordOrUserName or InsideLockTime or NotImplementedYet or UserNotActivated or UserAllreadyLoggedIn or UserDoubleLogIn or SessionLoggedOut or DeviceNotRegistered or ErrorOnSendingMail or UserEmailAlreadyExists or ErrorOnUpdatingUserType or UserTypeNotExist or UserNotMasterApproved or ErrorOnInitUser or ErrorOnSaveUser or UserNotIndDomain or TokenNotFound or UserAlreadyMasterApproved or UserWithNoDomain or InternalError or LoginServerDown or UserSuspended or UserCreatedWithNoRole or ExternalIdAlreadyExists or ExternalError or PasswordPolicyViolation or PasswordExpired</m_RespStatus>
            <m_userInstanceID>string</m_userInstanceID>
            <ExternalCode>int</ExternalCode>
            <ExternalMessage>string</ExternalMessage>
          </UserResponseObject>
          <UserResponseObject>
            <m_user xsi:nil="true" />
            <m_RespStatus>OK or UserExists or UserDoesNotExist or WrongPasswordOrUserName or InsideLockTime or NotImplementedYet or UserNotActivated or UserAllreadyLoggedIn or UserDoubleLogIn or SessionLoggedOut or DeviceNotRegistered or ErrorOnSendingMail or UserEmailAlreadyExists or ErrorOnUpdatingUserType or UserTypeNotExist or UserNotMasterApproved or ErrorOnInitUser or ErrorOnSaveUser or UserNotIndDomain or TokenNotFound or UserAlreadyMasterApproved or UserWithNoDomain or InternalError or LoginServerDown or UserSuspended or UserCreatedWithNoRole or ExternalIdAlreadyExists or ExternalError or PasswordPolicyViolation or PasswordExpired</m_RespStatus>
            <m_userInstanceID>string</m_userInstanceID>
            <ExternalCode>int</ExternalCode>
            <ExternalMessage>string</ExternalMessage>
          </UserResponseObject>
        </users>
      </GetUsersResult>
    </GetUsersResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP POST

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

POST /restful_v5_2_8/ws_users_module.asmx/GetUsers HTTP/1.1
Host: kbcsony.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sWSUserName=string&sWSPassword=string&sSiteGUIDs=string&sSiteGUIDs=string&userIP=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<UsersResponse xmlns="http://users.tvinci.com/">
  <resp>
    <Code>int</Code>
    <Message>string</Message>
    <Args>
      <KeyValuePair>
        <key>string</key>
        <value>string</value>
      </KeyValuePair>
      <KeyValuePair>
        <key>string</key>
        <value>string</value>
      </KeyValuePair>
    </Args>
  </resp>
  <users>
    <UserResponseObject>
      <m_user>
        <m_oBasicData d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <m_domianID>int</m_domianID>
        <m_sSiteGUID>string</m_sSiteGUID>
        <m_isDomainMaster>boolean</m_isDomainMaster>
        <m_oDynamicData d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <m_eUserState>Unknown or Activated or SingleSignIn or DoubleSignIn or LoggedOut</m_eUserState>
        <m_eSuspendState>OK or Suspended</m_eSuspendState>
        <m_nSSOOperatorID>int</m_nSSOOperatorID>
        <IsActivationGracePeriod>boolean</IsActivationGracePeriod>
      </m_user>
      <m_RespStatus>OK or UserExists or UserDoesNotExist or WrongPasswordOrUserName or InsideLockTime or NotImplementedYet or UserNotActivated or UserAllreadyLoggedIn or UserDoubleLogIn or SessionLoggedOut or DeviceNotRegistered or ErrorOnSendingMail or UserEmailAlreadyExists or ErrorOnUpdatingUserType or UserTypeNotExist or UserNotMasterApproved or ErrorOnInitUser or ErrorOnSaveUser or UserNotIndDomain or TokenNotFound or UserAlreadyMasterApproved or UserWithNoDomain or InternalError or LoginServerDown or UserSuspended or UserCreatedWithNoRole or ExternalIdAlreadyExists or ExternalError or PasswordPolicyViolation or PasswordExpired</m_RespStatus>
      <m_userInstanceID>string</m_userInstanceID>
      <ExternalCode>int</ExternalCode>
      <ExternalMessage>string</ExternalMessage>
    </UserResponseObject>
    <UserResponseObject>
      <m_user>
        <m_oBasicData d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <m_domianID>int</m_domianID>
        <m_sSiteGUID>string</m_sSiteGUID>
        <m_isDomainMaster>boolean</m_isDomainMaster>
        <m_oDynamicData d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <m_eUserState>Unknown or Activated or SingleSignIn or DoubleSignIn or LoggedOut</m_eUserState>
        <m_eSuspendState>OK or Suspended</m_eSuspendState>
        <m_nSSOOperatorID>int</m_nSSOOperatorID>
        <IsActivationGracePeriod>boolean</IsActivationGracePeriod>
      </m_user>
      <m_RespStatus>OK or UserExists or UserDoesNotExist or WrongPasswordOrUserName or InsideLockTime or NotImplementedYet or UserNotActivated or UserAllreadyLoggedIn or UserDoubleLogIn or SessionLoggedOut or DeviceNotRegistered or ErrorOnSendingMail or UserEmailAlreadyExists or ErrorOnUpdatingUserType or UserTypeNotExist or UserNotMasterApproved or ErrorOnInitUser or ErrorOnSaveUser or UserNotIndDomain or TokenNotFound or UserAlreadyMasterApproved or UserWithNoDomain or InternalError or LoginServerDown or UserSuspended or UserCreatedWithNoRole or ExternalIdAlreadyExists or ExternalError or PasswordPolicyViolation or PasswordExpired</m_RespStatus>
      <m_userInstanceID>string</m_userInstanceID>
      <ExternalCode>int</ExternalCode>
      <ExternalMessage>string</ExternalMessage>
    </UserResponseObject>
  </users>
</UsersResponse>