...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | ||
SessionTicket | String | Yes | Click here for more information. | ARNkL4C1bp7KLtsSXQW6/g== | |
DisbursedCurrencyIdentity | Either DisbursedCurrencyIdentity or ExpenseDocumentIdentity must be provided | The disbursed currency for mileage rate. If both DisbursedCurrencyIdentity and ExpenseDocumentIdentity are provided, the currencies in both data types must match. Otherwise, an error is returned in the response. If both DisbursedCurrencyIdentity and ResourceIdentity are provided and there is a mismatch, a null mileage rate is returned in the response. Click here for more information. | |||
EffectiveDate | DateTime | No | The effective date of the mileage rate. | 2018-03-01z | |
ExpenseDocumentIdentity | See DisbursedCurrencyIdentity above | The identify of the expense document whose resource's location is what the mileage rate is based on. The document's disbursed currency must match the one in DisbursedCurrencyIdentity if provided, and the document's resource must match the one in ResourceIdentity if provided. Otherwise, an error is returned in both cases. Click here for more information. | |||
ResourceIdentity | No | The resource whose mileage rate is requested. If both ExpenseDocumentIdentity and ResourceIdentity are both provided, this resource must match the resource on the expense document. If neither is provided in the request, requesting user/resource is used to locate the mileage rate. If this user is not a resource, an error is returned in the response. Click here for more information. |
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:PwsGetMileageRate>
<pws:serviceRequest>
<req:SessionTicket>ARNkL4C1bp7KLtsSXQW6/g==</req:SessionTicket>
<tim:DisbursedCurrencyIdentity>
<com:CurrencyCode>USD</com:CurrencyCode>
</tim:DisbursedCurrencyIdentity>
<tim:EffectiveDate>2018-03-08z</tim:EffectiveDate>
<tim:ExpenseDocumentIdentity>
<com:DocumentNumber>ER00163</com:DocumentNumber>
</tim:ExpenseDocumentIdentity>
<tim:ResourceIdentity>
<com:ResourceDisplayName>David Katz</com:ResourceDisplayName>
</tim:ResourceIdentity>
</pws:serviceRequest>
</pws:PwsGetMileageRate>
</soapenv:Body>
</soapenv:Envelope>
|
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click herefor more information | ||
ResponseId | Int32 | Click here for more information. | 0 |
Status | RequestStatus | Click here for more information | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-08T15:50:59.35176Z |
EffectiveEndDate | DateTime | The mileage rate's effective end date | 9999-12-31T00:00:00Z |
EffectiveStartDate | DateTime | The mileage rate's effective start date | 2013-01-01T00:00:00Z |
MileageRate | Double | The mileage rate for this resource based on resource's location | 0.565 |
MileageUom | String | The unit of the Mileage. 'M' is for miles and 'K' for kilometers. | M |
...
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 57545 | ResourceNotFound | The specified resource does not exist. |
| 65629 | ResourceNotOwnerOfExpenseReport | The specified resource does not match the expense report resource. |
| 65630 | GivenCurrencyNotSameAsReportCurrency | The specified currency does not match the expense document's disbursed currency. |
| 65678 | ResourceCannotBeDeterminedForMileageRate | Resource cannot be determined in order to look up mileage rate. (ex. when authenticated user is not a resource ...) |