Overview

This web service retrieves a list of expense type group summary records (PwsEngagementSummary), based on specified search criteria. The following parameters affect the list of expense type groups retrieved:

QueryString. Find all expense type groups matching specified string in expense type group name or expense type group code
IncludeInactiveFlag. If true, expense type groups that are set to inactive will be included in the search. Otherwise, only active expense type groups will be returned.
ExpenseTypeGroupIdentity. If specified, the identified expense type group will be returned (QueryString and IncludeClosedFlag will be ignored).

Request Format

PwsGetExpenseTypeGroupList Request

PwsGetExpenseTypeGroupList
- serviceRequest: PwsGetExpenseTypeGroupListRq
  - RequestId: Int32
  - SessionTicket: String
  - ExpenseTypeGroupIdentity: PwsExpenseTypeGroupRef
  - IncludeInactiveFlag: Boolean
  - MaxRowsToReturn: Int32
  - QueryString: String (255)

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.	Aa/HJL2aAIqnCD1DEazq8Q==
ExpenseTypeGroupIdentity	PwsExpenseTypeGroupRef	No		The unique keys used to identify the expense type group(s) to be retrieved
IncludeInactiveFlag	Boolean	No	true	If set to 'true', inactive expense type groups will be returned in the results	true
MaxRowsToReturn	Int32	No		The maximum number of expense type groups this service will return	10
QueryString	String (255)	No		A search string to narrow down the results. An expense type group will be included in the results if the search string matches the expense type group name. This value is disregarded if an expense type group name is specified in ExpenseTypeGroupIdentity.	Software

Request Usage Example(s)

Example 01 - Expense Type Group Identity 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:PwsGetExpenseTypeGroupList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>Aa/HJL2aAIqnCD1DEazq8Q==</req:SessionTicket>
            <req:IncludeInactiveFlag>true</req:IncludeInactiveFlag>
            <req:MaxRowsToReturn>10</req:MaxRowsToReturn>
            <req:QueryString>Software</req:QueryString>
         </pws:serviceRequest>
      </pws:PwsGetExpenseTypeGroupList>
   </soapenv:Body>
</soapenv:Envelope>

Example 02 - Expense Type Group Identity 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:PwsGetExpenseTypeGroupList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>Aa/HJL2aAIqnCD1DEazq8Q==</req:SessionTicket>
            <req:ExpenseTypeGroupIdentity>
               <com:ExpenseTypeGroupName>Software License Revenue</com:ExpenseTypeGroupName>
            </req:ExpenseTypeGroupIdentity>
         </pws:serviceRequest>
      </pws:PwsGetExpenseTypeGroupList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetExpenseTypeGroupList Response

PwsGetExpenseTypeGroupListResponse
- PwsGetExpenseTypeGroupListResult: PwsGetExpenseTypeGroupListRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ExpenseTypeGroups: PwsExpenseTypeGroupSummary[]

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-27T20:47:46.2964588Z
ExpenseTypeGroups	PwsExpenseTypeGroupSummary[]	The expense type group summary records that were fetched by the service

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetExpenseTypeGroupListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetExpenseTypeGroupListResult 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/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-27T20:47:46.2964588Z</ServerTimestampUtc>
            <a:ExpenseTypeGroups xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsExpenseTypeGroupSummary>
                  <b:ExpenseTypeGroupId i:nil="true"/>
                  <b:ExpenseTypeGroupName>Software License Revenue</b:ExpenseTypeGroupName>
                  <b:ExpenseTypeGroupUid>1152921504606847818</b:ExpenseTypeGroupUid>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsExpenseTypeGroupSummary>
            </a:ExpenseTypeGroups>
         </PwsGetExpenseTypeGroupListResult>
      </PwsGetExpenseTypeGroupListResponse>
   </s:Body>
</s:Envelope>

PwsGetExpenseTypeGroupList - Common Errors and Warnings

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

ErrorNumber	ErrorCode	Description
59947	SpecifiedExpenseTypeGroupNotFound	The specified expense type group was not found.