Versions Compared

Version Old Version 6 New Version Current
Changes made by

Min Zeng

Bettina Borces

Saved on

Key

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

...

This web service retrieves a list of resource title summary summaries (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). 

...

Panel
titlePwsGetTitleList Request
  • PwsGetTitleList
    • serviceRequest: PwsGetTitleListRq

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.

ARNkL4C1bp7KLtsSXQW6/g==

IncludeInactiveFlag

Boolean

No

false

If set to 'true', inactive titles will be included in the response. This flag is disregarded if a client is specified in TitleIdentity.

true

MaxRowsToReturn

Int32

No


The maximum number of titles to be returned.

10

QueryString

String (255)

No


A search string to narrow down the results. A title will be included in the results if the search string matches the title name or title department name. This value is disregarded if a title is specified in TitleIdentity.

Management

TitleIdentity

PwsTitleRef

No


For this service, the caller may specify a title identity to retrieve a specific title summary. If a title identity is not specified all titles fitting the other specified criteria will be returned.


Request Usage Example(s)


Code Block
languagexml
titleExample 01 - use title identity
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: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>

...

Code Block
languagexml
titleExample 02 - Client is specifieduse query string
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:PwsGetTitleList>
         <pws:serviceRequest>
            <req:SessionTicket>ARNkL4C1bp7KLtsSXQW6/g==</req:SessionTicket>
            <req:IncludeInactiveFlag>true</req:IncludeInactiveFlag>
            <req:MaxRowsToReturn>10</req:MaxRowsToReturn>
            <req:QueryString>technical</req:QueryString>
         </pws:serviceRequest>
      </pws:PwsGetTitleList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


Panel
titlePwsGetTitleList Response


Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

The web service response status and message. Click herefor more information.


ResponseId

Int32

Click here for more information.

0

Status

RequestStatusClick here for more information
Ok

ServerTimestampUtc

DateTime

Click here for more information.

1152921504606851319

Titles

PwsTitleSummary[]

The title summary record(s) retrieved by the service


Response Usage Example(s)

...

Code Block
languagexml
titleExample 01 - use title identity
collapsetrue
 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault><PwsGetTitleListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
          <faultcode>s:Client</faultcode><PwsGetTitleListResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
             <faultstring xml:lang="en-US">The creator of this fault did not specify a Reason.</faultstring><Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
             <detail><ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-06T19:40:37.0798514Z</ServerTimestampUtc>
            <PwsFault<a:Titles xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsTitleSummary>
                  <b:DepartmentIdentity>
                     <b:DepartmentId i:nil="true"/>
                     <b:DepartmentName>Management</b:DepartmentName>
                     <b:DepartmentUid>1152921504606851319</b:DepartmentUid>
                  </b:DepartmentIdentity>
                  <b:TitleId i:nil="true"/>
                  <b:TitleName>Administrator</b:TitleName>
                  <b:TitleUid>1152921504606862838</b:TitleUid>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsTitleSummary>
            </a:Titles>
         </PwsGetTitleListResult>
      </PwsGetTitleListResponse>
   </s:Body>
</s:Envelope>


Code Block
languagexml
titleExample 02 - use query string
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetTitleListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetTitleListResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
           <Messages> <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-06T19:28:30.4805011Z</ServerTimestampUtc>
            <a:Titles xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
  <PwsMessage>             <b:PwsTitleSummary>
              <AdditionalErrorText>Error  57535, State 2: Title not found (installation = 3018, title id/uid = (null)/1152921504606862837, title name = Administrator)</AdditionalErrorText><b:DepartmentIdentity>
                     <b:DepartmentId i:nil="true"/>
                     <b:DepartmentName>Technology</b:DepartmentName>
                     <b:DepartmentUid>1152921504606851320</b:DepartmentUid>
                  </b:DepartmentIdentity>
                  <b:TitleId i:nil="true"/>
                  <b:TitleName>Associate Technical Consultant</b:TitleName>
                  <b:TitleUid>1152921504606862840</b:TitleUid>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsTitleSummary>
               <b:PwsTitleSummary>
                  <b:DepartmentIdentity>
                      <ErrorCode>TitleNotFound</ErrorCode><b:DepartmentId i:nil="true"/>
                     <ErrorNumber>57535</ErrorNumber><b:DepartmentName>Technology</b:DepartmentName>
                     <b:DepartmentUid>1152921504606851320</b:DepartmentUid>
             <ErrorText>The specified title does not exist.</ErrorText>
  </b:DepartmentIdentity>
                  <b:TitleId i:nil="true"/>
                  <b:TitleName>Principal Technical Consultant</b:TitleName>
                  <Type>Error</Type><b:TitleUid>1152921504606862841</b:TitleUid>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </PwsMessage>/b:PwsTitleSummary>
               <b:PwsTitleSummary>
                  <b:DepartmentIdentity>
                     <b:DepartmentId i:nil="true"/>
                     <b:DepartmentName>Technology</b:DepartmentName>
                     <b:DepartmentUid>1152921504606851320</b:DepartmentUid>
                  </Messages>/b:DepartmentIdentity>
                  <b:TitleId i:nil="true"/>
                  <b:TitleName>Senior Technical Consultant</b:TitleName>
                  <b:TitleUid>1152921504606862842</b:TitleUid>
                  <ResponseId>0</ResponseId><b:InactiveFlag>false</b:InactiveFlag>
               <ServiceName>PwsGetTitleListRs</ServiceName></b:PwsTitleSummary>
               <b:PwsTitleSummary>
                  <b:DepartmentIdentity>
                     <LockHolderUserIdentity<b:DepartmentId i:nil="true"/>
                     <b:DepartmentName>Technology</b:DepartmentName>
                     <b:DepartmentUid>1152921504606851320</b:DepartmentUid>
 </PwsFault>                 </b:DepartmentIdentity>
                  <b:TitleId i:nil="true"/>
                  <b:TitleName>Technical Consultant</b:TitleName>
                  <b:TitleUid>1152921504606862843</b:TitleUid>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </detail>b:PwsTitleSummary>
            </s:Fault>a:Titles>
         </PwsGetTitleListResult>
      </PwsGetTitleListResponse>
   </s:Body>
</s:Envelope>

...

PwsGetTitleList - Common Errors and Warnings

ErrorNumberErrorCodeErrorText
57535TitleNotFoundThe specified title does not exist.
57559
TitleMissing? (see issue 36266)
IncompleteTitleReference

A specified title identity was incomplete. Each title identity must specify either a title id, title uid or department identity and title name.