Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This web service retrieves a list of client resource summary records (PwsResourceSummary), based on specified search criteria. You can specify which client or clients resources to retrieved retrieve either by specifying a set of search criteria, or by specifying a specific client resource to retrieve (PwsResourceRef).

...

Panel
titlePwsGetResourceList Request

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information

1

SessionTicket

String

Yes 


Click here for more information

AVC/x56/KIpgZvF71H4TwA==

IncludeInactiveFlag

Boolean

Yes 

 false

If set to 'true', inactive resources will be included in the results. Otherwise, only active resources will be returned. This flag is disregarded if a resource is specified in ResourceIdentity

false

MaxRowsToReturn

Int32

No


The maximum number of resources to be retrieved. This value is disregarded if a resource is specified in ResourceIdentity

5

QueryString

String (255)

No 


A search string to narrow down the results. A resource will be included in the results if the search string matches the resource display name or resource reference system id / employee id as well as the other specified criteria. This value is disregarded if a cost center is specified in ResourceIdentity.


ResourceIdentity

PwsResourceRef

No 


The unique keys used to identify a resource to be retrieved


LastUpdatedSinceTimestampStringNo
The timestamp from when the resource is last updated.

Request Usage Example(s)


Code Block
languagexml
titleExample 01 - resource is not identified
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetResourceList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AVC/x56/KIpgZvF71H4TwA==</req:SessionTicket>
            <req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
            <req:MaxRowsToReturn>5</req:MaxRowsToReturn>
         </pws:serviceRequest>
      </pws:PwsGetResourceList>
   </soapenv:Body>
</soapenv:Envelope>
Code Block
languagexml
titleExample 02 - resource is specified
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetResourceList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AVC/x56/KIpgZvF71H4TwA==</req:SessionTicket>
            <req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
            <!--req:MaxRowsToReturn>5</req:MaxRowsToReturn-->
            <!--req:QueryString>?</req:QueryString-->
            <req:ResourceIdentity>
               <com:ResourceReferenceSystemId>IT (USA) - 01</com:ResourceReferenceSystemId>
            </req:ResourceIdentity>
         </pws:serviceRequest>
      </pws:PwsGetResourceList>
   </soapenv:Body>
</soapenv:Envelope>

...