GET api/Currency/{auth}

Retrieve a list of currencies

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

Authorization token

string

Required

Body Parameters

None.

Response Information

Resource Description

CurrencyResp
NameDescriptionTypeAdditional information
IsSuccessful

Used to determine if method call was successful (true) or failure (false)

boolean

None.

ErrorMessage

The error message if method call was not successful

string

None.

Currencies

Listing of currencies

Collection of CurrencyItem

None.

Response Formats

application/json, text/json

Sample:
{
  "Currencies": [
    {
      "CurrencyID": "sample string 1",
      "Description": "sample string 4",
      "Name": "sample string 3",
      "ShortName": "sample string 2"
    },
    {
      "CurrencyID": "sample string 1",
      "Description": "sample string 4",
      "Name": "sample string 3",
      "ShortName": "sample string 2"
    }
  ],
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true
}

application/xml, text/xml

Sample:
<CurrencyResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <Currencies>
    <CurrencyItem>
      <CurrencyID>sample string 1</CurrencyID>
      <Description>sample string 4</Description>
      <Name>sample string 3</Name>
      <ShortName>sample string 2</ShortName>
    </CurrencyItem>
    <CurrencyItem>
      <CurrencyID>sample string 1</CurrencyID>
      <Description>sample string 4</Description>
      <Name>sample string 3</Name>
      <ShortName>sample string 2</ShortName>
    </CurrencyItem>
  </Currencies>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</CurrencyResp>