Overview
This web service retrieves a list of resource title 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).
- PwsGetTitleList
- serviceRequest: PwsGetTitleListRq
Request Elements
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)
<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>
<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>
- PwsGetTitleListResponse
- PwsGetTitleListResult: PwsGetTitleListRs
Response Elements
Response Usage Example(s)
<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>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-06T19:40:37.0798514Z</ServerTimestampUtc>
<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>
<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>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-06T19:28:30.4805011Z</ServerTimestampUtc>
<a:Titles xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:PwsTitleSummary>
<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>
<b:DepartmentId i:nil="true"/>
<b:DepartmentName>Technology</b:DepartmentName>
<b:DepartmentUid>1152921504606851320</b:DepartmentUid>
</b:DepartmentIdentity>
<b:TitleId i:nil="true"/>
<b:TitleName>Principal Technical Consultant</b:TitleName>
<b:TitleUid>1152921504606862841</b:TitleUid>
<b:InactiveFlag>false</b:InactiveFlag>
</b:PwsTitleSummary>
<b:PwsTitleSummary>
<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>Senior Technical Consultant</b:TitleName>
<b:TitleUid>1152921504606862842</b:TitleUid>
<b:InactiveFlag>false</b:InactiveFlag>
</b:PwsTitleSummary>
<b:PwsTitleSummary>
<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>Technical Consultant</b:TitleName>
<b:TitleUid>1152921504606862843</b:TitleUid>
<b:InactiveFlag>false</b:InactiveFlag>
</b:PwsTitleSummary>
</a:Titles>
</PwsGetTitleListResult>
</PwsGetTitleListResponse>
</s:Body>
</s:Envelope>
PwsGetTitleList - Common Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|
| 57535 | TitleNotFound | The specified title does not exist. |
| 57559 | IncompleteTitleReference | A specified title identity was incomplete. Each title identity must specify either a title id, title uid or department identity and title name. |