pixiGetCurrency
API Call to return pixi.Currency codetable that is ISO 4217 compliant. Returns records for only specified code or all records if code not specified.
Since pixi version: AVA Official - Update 7 (8.4.7.23158) Additional notes:
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| CurrencyId | string | false | If Id not specified, all records are returned, or only details for specified id otherwise. Type: smallint Default value: 0 Example: Available from: AVA Official - Update 7 (8.4.7.23158) |
| CurrencyCode | string | false | If code not specified, all records are returned, or only details for specified code otherwise. Type: varchar(3) Default value: NULL Example: Available from: AVA Official - Update 7 (8.4.7.23158) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetCurrency>
<CurrencyCode>string</CurrencyCode>
<CurrencyId>string</CurrencyId>
</pixiGetCurrency>
</Body>
</Envelope>Response
1. Result set
| Name | Type | Description |
|---|---|---|
| Id | integer | pixi* Identification of currency Type: int Available from: 25.06 (25.6.0.58802) |
| Code | string | Currency code, ISO 4217 Type: varchar Available from: 25.06 (25.6.0.58802) |
| Active | boolean | True if it when currency if frequently used Type: bit Available from: 25.06 (25.6.0.58802) |
| LocaleId | integer | Location Id Type: int Available from: 25.06 (25.6.0.58802) |
| CodeNumber | string | Currency number, ISO 4217 Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetCurrencyPost200TextXmlResponse>
<Id>0</Id>
<Code>string</Code>
<CodeNumber>string</CodeNumber>
<Active>true</Active>
<LocaleId>0</LocaleId>
</PixiGetCurrencyPost200TextXmlResponse>HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://apigateway.descartes.com/tms/pixi/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiGetCurrency>
<CurrencyId xsi:type="xsd:string"></CurrencyId>
<CurrencyCode xsi:type="xsd:string"></CurrencyCode>
</ns1:pixiGetCurrency>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiGetCurrency', [
'CurrencyId' => '', // string
'CurrencyCode' => '', // string
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}