Back | Webservices | Home

GetUserRole

Description

Returns a UserRole object limited by the ID.

Request Parameters

Name Description

soap:header

Username and password

Type: UserCredentials

Children: Userid, Password
userRoleID User Role ID
Type: int

Response Elements

Name Description

GetUserRoleResult

User Role element.

Type: UserRole

Example using SOAP

Example Request

The following is a sample SOAP 1.2 request and response.

<?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:Header>
    <UserCredentials xmlns="http://vidzapper.net/Webservice/">
      <Userid>string</Userid>
      <Password>string</Password>
    </UserCredentials>
  </soap12:Header>
  <soap12:Body>
    <GetUserRole xmlns="http://vidzapper.net/Webservice/">
      <userRoleID>int</userRoleID>
    </GetUserRole>
  </soap12:Body>
</soap12:Envelope>

Example Response

<?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>
    <GetUserRoleResponse xmlns="http://vidzapper.net/Webservice/">
      <GetUserRoleResult>
        <ID>int</ID>
        <Title>string</Title>
        <Description>string</Description>
        <UserType>string</UserType>
        <Error>
          <Status>string</Status>
          <Message>string</Message>
        </Error>
      </GetUserRoleResult>
    </GetUserRoleResponse>
  </soap12:Body>
</soap12:Envelope>