SOAP API - GetResourceItemByName

GetResourceItemByName( username, resourceItemName ) : Object

Since: EngageIP v25.2

Returns the Resource Item from the supplied name.

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

ID (Integer) - The ID of the resource item
Name (String) - The name or value of the resource item
ResourceTypeCategoryID (Integer) - The ID of the resource category
ResourceRequestID (Integer) - The ID of the request
ResourceItemStatusTypeID (Integer) - The ID of the resource status, would correspond with: allocated, hold, available etc..
ResourceTypeID (Integer) - The ID of the resource type

Returns:

This method returns an object representing a resource item.

Parameters:

username (String) - The username to for which this resource belongs. An exception will be thrown if the username does not exist.
resourceItemName (String) - the identifier for the resource, for example a DID number

Possible Exceptions:

INVALID USERNAME
INVALID RESOURCE ITEM 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>
    <GetResourceItemByName xmlns="Logisense_EngageIP">
      <username>string</username>
      <resourceItemName>string</resourceItemName>
    </GetResourceItemByName>
  </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>
    <GetResourceItemByNameResponse xmlns="Logisense_EngageIP">
      <GetResourceItemByNameResult>
        <Validate />
        <ID>int</ID>
        <Name>string</Name>
        <ResourceTypeCategoryID>int</ResourceTypeCategoryID>
        <ResourceRequestID>int</ResourceRequestID>
        <ResourceItemStatusTypeID>int</ResourceItemStatusTypeID>
        <ResourceTypeID>int</ResourceTypeID>
      </GetResourceItemByNameResult>
    </GetResourceItemByNameResponse>
  </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/GetResourceItemByName"

<?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>
    <GetResourceItemByName xmlns="Logisense_EngageIP">
      <username>string</username>
      <resourceItemName>string</resourceItemName>
    </GetResourceItemByName>
  </soap:Body>
</soap:Envelope>