Versions Compared

Key

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

...

Panel
titlePwsGetExpenseTypeGroupList Request
  • PwsGetExpenseTypeGroupList

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

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)


Code Block
languagexml
titleExample 01 - Expense Type Group Identity not specified
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: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>

...

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

 


Response Usage Example(s)

...


ErrorNumber

ErrorCode

Description

59947

SpecifiedExpenseTypeGroupNotFound

The specified expense type group was not found.