Overview
This service is used to retrieve time entry and/or expense entry alerts
...
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. | Aa1FHhs2UCa+UGUJJq/hpg== | |
CountOnlyFlag | Boolean | No | false | If set to 'true', the web service will return only the count of time and cost alerts; if set to 'false' the web service will return full information about each alert | false |
IncludeDraftTimeFlag | Boolean | One of IncludeDraftTimeFlag, IncludeMissingTimeFlag, IncludeRejectedExpenseFlag, IncludeRejectedOrIncompleteTimeFlag or IncludeUnsubmittedExpenseFlag is required | false | If set to 'true', draft time card alerts will be returned | true |
IncludeMissingTimeFlag | Boolean | See IncludeDraftTimeFlag | false | If set to 'true', missing time alerts will be returned | false |
IncludeRejectedExpenseFlag | Boolean | See IncludeDraftTimeFlag | false | If set to 'true', rejected expense alerts will be returned | false |
IncludeRejectedOrIncompleteTimeFlag | Boolean | See IncludeDraftTimeFlag | false | If set to 'true, | true |
IncludeUnsubmittedExpenseFlag | Boolean | See IncludeDraftTimeFlag | false | false | |
MinAlertsDate *** deprecated *** | DateTime | *** deprecated *** | *** deprecated *** | *** deprecated *** |
|
ResourceIdentity | No | The resource identity when acting on behalf of | |||
AlertsPeriodType | String | No | 'W' for weekly | The alerts period type: "D" for day, "W" for week "M" for month "A" for accounting period | M |
MissingTimeCalculateDailyFlag | Boolean | No | false | If set to 'true', the web service will calculate the daily missing time | true |
IncludeRejectedOrIncompleteTimeoffFlag | Boolean | No | false | If set to 'true', rejected or incomplete time off alerts will be returned | true |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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:PwsGetAlerts>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>Aa1FHhs2UCa+UGUJJq/hpg==</req:SessionTicket>
<tim:CountOnlyFlag>false</tim:CountOnlyFlag>
<tim:IncludeDraftTimeFlag>true</tim:IncludeDraftTimeFlag>
<tim:IncludeMissingTimeFlag>false</tim:IncludeMissingTimeFlag>
<tim:IncludeRejectedExpenseFlag>false</tim:IncludeRejectedExpenseFlag>
<tim:IncludeRejectedOrIncompleteTimeFlag>false</tim:IncludeRejectedOrIncompleteTimeFlag>
<tim:IncludeUnsubmittedExpenseFlag>true</tim:IncludeUnsubmittedExpenseFlag>
<tim:AlertsPeriodType>M</tim:AlertsPeriodType>
<tim:MissingTimeCalculateDailyFlag>true</tim:MissingTimeCalculateDailyFlag>
<tim:IncludeRejectedOrIncompleteTimeoffFlag>true</tim:IncludeRejectedOrIncompleteTimeoffFlag>
</pws:serviceRequest>
</pws:PwsGetAlerts>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. |
| |
ResponseId | Int32 | Click here for more information | 1 |
Status | Click here for more information |
| |
ServerTimestampUtc | DateTime | Click here for more information | 2018-03-15T13:42:44.2920992Z |
CostAlerts | The complete information associated with cost alerts |
| |
TimeAlerts | The complete information associated with time alerts |
| |
TimeoffAlerts | The complete information associated with time off alerts |
|
Response Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsGetAlertsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsGetAlertsResult 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-15T13:42:44.2920992Z</ServerTimestampUtc>
<a:CostAlerts>
<a:AlertCount i:nil="true"/>
<a:Alerts>
<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>
<a:TimeAlerts>
<a:AlertCount i:nil="true"/>
<a:Alerts>
<a:PwsTimeAlert>
<a:AlertType>D</a:AlertType>
<a:Minutes>120</a:Minutes>
<a:PeriodStartDate>2018-03-01T00:00:00Z</a:PeriodStartDate>
<a:CardCount>1</a:CardCount>
</a:PwsTimeAlert>
</a:Alerts>
</a:TimeAlerts>
<a:TimeoffAlerts>
<a:AlertCount i:nil="true"/>
<a:Alerts/>
</a:TimeoffAlerts>
</PwsGetAlertsResult>
</PwsGetAlertsResponse>
</s:Body>
</s:Envelope> |