Versions Compared

Key

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

...

This web service retrieves one single currency or a list of currencies (PwsCurrencyRate) based on specified search criteria.  If you only provide session ticketdo not specify the currency to retrieve, a complete list of system currencies is returned.  If a disbursed currency identity is provided, a complete list of system currencies with the available FX rate calculated against disbursed currency is returned. When data for conversion to and from the specified disbursed currency will be included in the response for each currency. If you do not specify a disbursed currency, but do specify a resource identity, the resource's disbursing currency is used. If neither a disbursed currency identity nor a resource identity are provided, the FX rate data will be null in the response. When an incurred currency is also provided, only incurred the specified currency, instead of the complete list of currencies, is returned. 

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.

ATtU220EvBSE2+GCN9U58g==

DisbursedCurrencyIdentity

PwsCurrencyRef

No


If provided, it is used to calculate FX rate against the complete list of system currencies or one incurred this response for each incurred currency will include the FX rate for conversion to or from the specified disbursed currency.


EffectiveDate

DateTime

No

Today's date

It This date is used to calculate determine the FX rate between the specified disbursed currency and the incurred currency or a list of system currencies.0.2496

2018-01-01z

IncurredOpsCurrencyIdentity

PwsOpsCurrencyRef

No


If not provided, a complete of system currencies is returned, Otherwise, this currency is returned in the response


ResourceIdentity

PwsResourceRef

No


It If specified, this resource is used to calculate determine the disbursed currency when disbursed currency identity is not provided in the request.


...

Panel
titlePwsGetCurrencies 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.

0

StatusRequestStatusClick here for more informationOk

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-13T13:42:05.2909846Z

Currencies

PwsCurrencyRate[]

The basic currency information and FX Fx rate between disbursed and incurred currencies.


...

Code Block
languagexml
titleExample 01
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetCurrenciesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetCurrenciesResult 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/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-13T14:17:28.8610811Z</ServerTimestampUtc>
            <a:Currencies>
               <a:PwsCurrencyRate>
                  <a:Currency xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:OpsCurrencyCode>USD</b:OpsCurrencyCode>
                     <b:OpsCurrencyId i:nil="true"/>
                     <b:CurrencyIdentity>
                        <b:CurrencyCode>USD</b:CurrencyCode>
                        <b:CurrencyId i:nil="true"/>
                        <b:CurrencyUid>1152921504606849879</b:CurrencyUid>
                     </b:CurrencyIdentity>
                     <b:CurrencyName>United States Dollars</b:CurrencyName>
                     <b:DecimalDigits>2</b:DecimalDigits>
                     <b:InactiveFlag>false</b:InactiveFlag>
                     <b:InstallationCurrencyInactiveFlag>false</b:InstallationCurrencyInactiveFlag>
                  </a:Currency>
                  <a:FxRate>2</a:FxRate>
               </a:PwsCurrencyRate>
            </a:Currencies>
         </PwsGetCurrenciesResult>
      </PwsGetCurrenciesResponse>
   </s:Body>
</s:Envelope>

PwsGetCurrencies - Common Errors and Warnings

...