Overview

This web service retrieves a list of resource title summary (PwsTitleSummary), based on specified search criteria. You can specify which title or titles to retrieve either by specifying a set of search criteria, or by specifying a specific title (PwsTitleRef).

Request Format

PwsGetTitleList Request

PwsGetTitleList
- serviceRequest: PwsGetTitleListRq
  - RequestId: Int32
  - SessionTicket: String
  - IncludeInactiveFlag: Boolean
  - MaxRowsToReturn: Int32
  - QueryString: String
  - TitleIdentity: PwsTitleRef

Request Elements

Element	Data Type	Description
RequestId	Int32	Click here for more information.
SessionTicket	String	Click here for more information.
IncludeInactiveFlag	Boolean
MaxRowsToReturn	Int32
QueryString	String
TitleIdentity	PwsTitleRef

Request Usage Example(s)

Example 01 - use title identity

<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:PwsGetTitleList>
         <pws:serviceRequest>
            <req:SessionTicket>ARNkL4C1bp7KLtsSXQW6/g==</req:SessionTicket>
            <req:IncludeInactiveFlag>true</req:IncludeInactiveFlag>
            <req:MaxRowsToReturn>10</req:MaxRowsToReturn>
            <req:QueryString></req:QueryString>
            <req:TitleIdentity>
               <com:DepartmentIdentity>
                  <com:DepartmentName>Management</com:DepartmentName>
               </com:DepartmentIdentity>
               <com:TitleName>Administrator</com:TitleName>
               <com:TitleUid>1152921504606862837</com:TitleUid>
            </req:TitleIdentity>
         </pws:serviceRequest>
      </pws:PwsGetTitleList>
   </soapenv:Body>
</soapenv:Envelope>

Example 02 - Client is specified

</soapenv:Envelope>

Response Format

PwsGetTitleList Response

PwsGetTitleListResponse
- PwsGetTitleListResult: PwsGetTitleListRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Titles: PwsTitleSummary

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage
ResponseId	Int32	Click here for more information.
Status	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more information.
Titles	PwsTitleSummary

Response Usage Example(s)

Example 01 - use title identity

 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:Client</faultcode>
         <faultstring xml:lang="en-US">The creator of this fault did not specify a Reason.</faultstring>
         <detail>
            <PwsFault xmlns="http://projectorpsa.com/DataContracts/Shared/Common/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
               <Messages>
                  <PwsMessage>
                     <AdditionalErrorText>Error 57535, State 2: Title not found (installation = 3018, title id/uid = (null)/1152921504606862837, title name = Administrator)</AdditionalErrorText>
                     <ErrorCode>TitleNotFound</ErrorCode>
                     <ErrorNumber>57535</ErrorNumber>
                     <ErrorText>The specified title does not exist.</ErrorText>
                     <Type>Error</Type>
                  </PwsMessage>
               </Messages>
               <ResponseId>0</ResponseId>
               <ServiceName>PwsGetTitleListRs</ServiceName>
               <LockHolderUserIdentity i:nil="true"/>
            </PwsFault>
         </detail>
      </s:Fault>
   </s:Body>
</s:Envelope>

PwsGetClientList - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
57535	TitleNotFound	The specified title does not exist.
57559	TitleMissing? (see issue 36266)