Overview

This web service retrieves a list of engagement type summary records (PwsEngagementTypeSummary), based on specified search criteria. The following parameters affect the list of engagement types retrieved:

QueryString. Find all engagement types matching specified string in engagement type name or engagement type short name
IncludeInactiveFlag. If true, engagement types that are marked as inactive will be returned. Otherwise, only engagement types that are not considered inactive will be returned.
EcCostCenterIdentity. If you specify a cost center in this parameter, then the enterprise configuration settings for this cost center will have a bearing on whether each engagement type is considered inactive or not. If an engagement type is not allowed for the specified cost center, it will be treated as inactive. If no cost center is specified, only the engagement type's inactive setting is used to determine if the engagement type is considered inactive. Note that this only has a bearing on the results when IncludeInactiveFlag is 'false'.
EngagementTypeIdentity. If an engagement type is explicitly specified, only the identified engagement type will be returned (QueryString, IncludeActiveFlag and EcCostCenterIdentity will be ignored).

Request Format

PwsGetEngagementTypeList Request

PwsGetEngagementTypeList
- serviceRequest: PwsGetEngagementTypeListRq
  - RequestId: Int32
  - SessionTicket: String
  - EcCostCenterIdentity: PwsCostCenterRef
  - EngagementTypeIdentity: PwsEngagementTypeRef
  - IncludeInactiveFlag: Boolean
  - MaxRowsToReturn: Int32
  - QueryString: String (255)

Request Element

rElement	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.	1
SessionTicket	String	Yes		Click here for more information.	Aa/HJL2aAIqnCD1DEazq8Q==
EcCostCenterIdentity	PwsCostCenterRef	No		If a cost center is specified, only engagement types that are valid for the cost center (and are themselves marked active) will be considered active for filtering purposes. Applicable to installations in which Enterprise Configuration is enabled. This only has an effect on the results if IncludeInactiveFlag is 'false'.
EngagementTypeIdentity	PwsEngagementTypeRef	No		For this service, the caller may specify up to 1 engagement type identity. If an engagement type identity is not specified all engagement types fitting the criteria will be returned.
IncludeInactiveFlag	Boolean	No	true	If set to 'true', all engagement types including those that have been marked as inactive will be returned. This flag is disregarded if an engagement type is specified.	true
MaxRowsToReturn	Int32	No		The maximum number of engagement types to be returned. This value is disregarded if an engagement type is specified in EngagementTypeIdentity.	3
QueryString	String (255)	No		A search string to narrow down the results. An engagement type will be included in the results if the search string matches the EngagementTypeName or EngagementTypeShortName. This value is disregarded if an engagement type is specified in EngagementTypeIdentity.

Request Usage Example(s)

Example 01 - EngagementTypeIdentity is not specified

<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:PwsGetEngagementTypeList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>Aa/HJL2aAIqnCD1DEazq8Q==</req:SessionTicket>
            <req:IncludeInactiveFlag>true</req:IncludeInactiveFlag>
            <req:MaxRowsToReturn>3</req:MaxRowsToReturn>
         </pws:serviceRequest>
      </pws:PwsGetEngagementTypeList>
   </soapenv:Body>
</soapenv:Envelope>

Example 02 - EngagementTypeIdentity is specified

<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:PwsGetEngagementTypeList>
         <pws:serviceRequest>
            <req:RequestId>2</req:RequestId>
            <req:SessionTicket>Aa/HJL2aAIqnCD1DEazq8Q==</req:SessionTicket>
            <req:EngagementTypeIdentity>
               <com:EngagementTypeName>Billable - Time and Materials</com:EngagementTypeName>
               <com:EngagementTypeShortName>TandM</com:EngagementTypeShortName>
            </req:EngagementTypeIdentity>
         </pws:serviceRequest>
      </pws:PwsGetEngagementTypeList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetEngagementTypeList Response

PwsGetEngagementTypeListResponse
- PwsGetEngagementTypeListResult: PwsGetEngagementTypeListRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - EngagementTypes: PwsEngagementTypeSummary[]

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage[]	The web service response status and message. Click here for more information.
ResponseId	Int32	Click here for more information.	1
Status	RequestStatus	Click here for more information.	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-02-28T20:58:20.9857123Z
EngagementTypes	PwsEngagementTypeSummary[]	The engagement type summary record(s) retrieved by the service

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetEngagementTypeListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetEngagementTypeListResult xmlns:a="http://projectorpsa.com/DataContracts/Requests/" 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/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-28T20:58:20.9857123Z</ServerTimestampUtc>
            <a:EngagementTypes xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsEngagementTypeSummary>
                  <b:EngagementTypeId i:nil="true"/>
                  <b:EngagementTypeName>Billable - Fixed Price</b:EngagementTypeName>
                  <b:EngagementTypeShortName>BFP</b:EngagementTypeShortName>
                  <b:EngagementTypeUid>1152921504606863885</b:EngagementTypeUid>
                  <b:BillableFlag>true</b:BillableFlag>
                  <b:BusyFlag>true</b:BusyFlag>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsEngagementTypeSummary>
               <b:PwsEngagementTypeSummary>
                  <b:EngagementTypeId i:nil="true"/>
                  <b:EngagementTypeName>Billable - Fixed Price (RDC)</b:EngagementTypeName>
                  <b:EngagementTypeShortName>BFP-RDC</b:EngagementTypeShortName>
                  <b:EngagementTypeUid>1152921504606869339</b:EngagementTypeUid>
                  <b:BillableFlag>true</b:BillableFlag>
                  <b:BusyFlag>true</b:BusyFlag>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsEngagementTypeSummary>
               <b:PwsEngagementTypeSummary>
                  <b:EngagementTypeId i:nil="true"/>
                  <b:EngagementTypeName>Billable - Not to Exceed</b:EngagementTypeName>
                  <b:EngagementTypeShortName>NTE</b:EngagementTypeShortName>
                  <b:EngagementTypeUid>1152921504606863891</b:EngagementTypeUid>
                  <b:BillableFlag>true</b:BillableFlag>
                  <b:BusyFlag>true</b:BusyFlag>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsEngagementTypeSummary>
            </a:EngagementTypes>
         </PwsGetEngagementTypeListResult>
      </PwsGetEngagementTypeListResponse>
   </s:Body>
</s:Envelope>

PwsGetEngagementTypeList - Common Errors and Warnings

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

ErrorNumber	ErrorCode	Description
54612	EngagementTypeNotFound	The specified engagement type does not exist.