Sessions

Impersonation_Authorize

Grant another User access to your Rev.io account.

Input

• ToUserID As Integer – Rev.io ID of the User that you wish to grant Impersonation access to. Cannot be used with ToUserName.
• ToUserName As String – Rev.io login/username User that you wish to grant Impersonation access to. Cannot be used with ToUserID.
• ExpirationDate As Date – Optional – if specified, this Authorization will expire on the specified date. If not included, the Authorization will not expire unless it is explicitly expired.

Output

• ToUserID As Integer – returns the User ID of the Rev.io User that the Authorization was granted to.
• ImpersonationKey As String – 64-character key to be used in the Credentials/login structure for this User to Impersonate your account.

Sessions_Create

Create a Session to be used for multiple API calls for better performance.

Required Input

• Credentials
  • Username As String – A valid Rev.io login username.
  • Password As String – Rev.io's password for Username.
  • Client As String – Client_Code of the Rev.io system you are seeking to access.
  • ImpersonationKey As String – Optional – used for impersonating another Rev.io user.

Output

• SessionKey As String
• SessionKey_Encoded As Sting

Sessions_Validate

Test an existing Session to verify it is still active and return information about the User and Agent associated with it.

Required Input

• Session
  • SessionKey As Sting

Output

• UserID As Integer – Rev.io ID of the User that created the session.
• AgentID As Integer – Rev.io ID of the Agent that created the session.
• AgentNumber As String – Rev.io Account Number from the Agent that created the session.

Sessions_Destroy

End an existing session. This will invalidate the given session key, making it unusable for future authentication.

Input Fields

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <Sessions_Destroy xmlns="http://api.myh2o.com/v20">
            <Request>
                <Session>
                    <SessionKey>ABC123939AkD9kD9303odfABC123939AkD9kD9303odf</SessionKey>
                </Session>
            </Request>
        </Sessions_Destroy>
    </soap:Body>
</soap:Envelope>

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <Sessions_DestroyResponse xmlns="http://api.myh2o.com/v20">
      <Sessions_DestroyResult>
        <Header>
          <Success>true</Success>
          <SessionKey>ABC123939AkD9kD9303odfABC123939AkD9kD9303odf</SessionKey>
          <Impersonated>false</Impersonated>
        </Header>
      </Sessions_DestroyResult>
    </Sessions_DestroyResponse>
  </soap:Body>
</soap:Envelope>