Versions Compared

Key

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

...

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

...

Panel
titlePwsGetExpenseTypeGroupList Request

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. This input will be disregarded if ExpenseTypeGroupIdentity is specified.

true

MaxRowsToReturn

Int32

No 


The maximum number of expense type groups this service will return. This input will be disregarded if ExpenseTypeGroupIdentity is specified.

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. This input will be disregarded if ExpenseTypeGroupIdentity is specified. 

Software

Request Usage Example(s)

...

Panel
titlePwsGetExpenseTypeGroupList Response

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.

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


...