Overview

This service is used to retrieve expense entry alerts associated with rejected and/or draft (unsubmitted) cost cards.

Request Format

PwsGetCostAlerts Request

PwsGetCostAlerts
- serviceRequest: PwsGetCostAlertsRq
  - RequestId: Int32
  - SessionTicket: String
  - CountOnlyFlag: Boolean
  - IncludeRejectedFlag: Boolean
  - IncludeUnsubmittedFlag: Boolean
  - ResourceIdentity: PwsResourceRef

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.	AbHODMrb8ng+PCV+B7BzmQ==
CountOnlyFlag	Boolean	No	false	If set to 'true', the web service will return only the count of cost alerts; if set to 'false' the web service will return full information about each alert	false
IncludeRejectedFlag	Boolean	No	false	If set to 'true', rejected expense alerts will be returned	true
IncludeUnsubmittedFlag	Boolean	No	false	If set to 'true', draft/unsubmitted expense alerts will be returned	true
ResourceIdentity	PwsResourceRef	No		The resource identity to retrieve alerts for. If not specified, the resource associated with the authenticated user will be used. If this is not specified, and the authenticated user is not a associated with a resource, this will return no alerts (no error will be generated).

Request Usage Example(s)

Example 01

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetCostAlerts>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AbHODMrb8ng+PCV+B7BzmQ==</req:SessionTicket>
            <tim:CountOnlyFlag>false</tim:CountOnlyFlag>
            <tim:IncludeRejectedFlag>true</tim:IncludeRejectedFlag>
            <tim:IncludeUnsubmittedFlag>true</tim:IncludeUnsumittedFlag>
         </pws:serviceRequest>
      </pws:PwsGetCostAlerts>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetCostAlerts Response

PwsGetCostAlertsResponse
- PwsGetCostAlertsResult: PwsGetCostAlertsRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - CostAlerts: PwsCostAlerts[]

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
CostAlerts	PwsCostAlerts[]	The full detail of the cost alerts

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetCostAlertsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetCostAlertsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" 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-03-15T18:29:54.4894141Z</ServerTimestampUtc>
            <a:CostAlerts>
               <a:AlertCount i:nil="true"/>
               <a:Alerts>
                  <a:PwsCostAlert>
                     <a:AlertType>R</a:AlertType>
                     <a:CurrencyDecimalDigits>2</a:CurrencyDecimalDigits>
                     <a:DisbursedCurrencyCode>USD</a:DisbursedCurrencyCode>
                     <a:DisbursementTotal>213</a:DisbursementTotal>
                     <a:DocumentName>Expense report created 27 Feb 2018 - B</a:DocumentName>
                     <a:ExpenseDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:DocumentNumber>ER00722</b:DocumentNumber>
                        <b:ExpenseDocumentId i:nil="true"/>
                        <b:ExpenseDocumentUid>1152921504607683576</b:ExpenseDocumentUid>
                     </a:ExpenseDocumentIdentity>
                     <a:ReimbursementTotal>213</a:ReimbursementTotal>
                  </a:PwsCostAlert>
                  <a:PwsCostAlert>
                     <a:AlertType>D</a:AlertType>
                     <a:CurrencyDecimalDigits>2</a:CurrencyDecimalDigits>
                     <a:DisbursedCurrencyCode>USD</a:DisbursedCurrencyCode>
                     <a:DisbursementTotal>100</a:DisbursementTotal>
                     <a:DocumentName>Expense report created 15 Mar 2018</a:DocumentName>
                     <a:ExpenseDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:DocumentNumber>ER00726</b:DocumentNumber>
                        <b:ExpenseDocumentId i:nil="true"/>
                        <b:ExpenseDocumentUid>1152921504607683580</b:ExpenseDocumentUid>
                     </a:ExpenseDocumentIdentity>
                     <a:ReimbursementTotal>100</a:ReimbursementTotal>
                  </a:PwsCostAlert>
               </a:Alerts>
            </a:CostAlerts>
         </PwsGetCostAlertsResult>
      </PwsGetCostAlertsResponse>
   </s:Body>
</s:Envelope>

PwsGetCostAlerts - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
57545	ResourceNotFound	The specified resource does not exist.