SOAP API - GetResourceItemPool

GetResourceItemPool( username, resourceTypeCategoryID, resourceItemPoolName ) : Object

Since: EngageIP v25.2

Returns the specified ResourceItemPool associated with the user and type category.

This function will return a resource item pool in the form of an object with the following properties:

ID (Integer) - The ID of the resource item pool
Name (String) - The name or value of the resource item pool
ResourceTypeCategoryOwnerID (Integer) - Reference to the ID of the owner of the resource

Returns:

This method returns an object representing a resource item pool

Parameters:

username (String) - The username to for which this resource belongs. An exception will be thrown if the username does not exist.
resourceTypeCategoryID (Integer) - ID of the associated resource type category
resourceItemPoolName (String) - Name of the resource pool to retrieve

Possible Exceptions:

INVALID USERNAME
INVALID RESOURCE TYPE CATEGORY
INVALID POOL NAME

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 /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.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:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <GetResourceItemPool xmlns="Logisense_EngageIP">
      <username>string</username>
      <resourceTypeCategoryID>int</resourceTypeCategoryID>
      <resourceItemPoolName>string</resourceItemPoolName>
    </GetResourceItemPool>
  </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>
    <GetResourceItemPoolResponse xmlns="Logisense_EngageIP">
      <GetResourceItemPoolResult>
        <Validate />
        <ID>int</ID>
        <Name>string</Name>
        <ResourceTypeCategoryOwnerID>int</ResourceTypeCategoryOwnerID>
      </GetResourceItemPoolResult>
    </GetResourceItemPoolResponse>
  </soap12:Body>
</soap12:Envelope>

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 /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/GetResourceItemPool"

<?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:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <GetResourceItemPool xmlns="Logisense_EngageIP">
      <username>string</username>
      <resourceTypeCategoryID>int</resourceTypeCategoryID>
      <resourceItemPoolName>string</resourceItemPoolName>
    </GetResourceItemPool>
  </soap:Body>
</soap:Envelope>