GET Currencies/Find?CurrencyId={CurrencyId}&GlobalCurrencyId={GlobalCurrencyId}&Archived={Archived}&Label={Label}&Symbol={Symbol}&SearchOperator={SearchOperator}

Finds all Currencies matching specified criteria. Available querystring parameters : SearchOperator,AlphaCode,Name,NumericCode,CurrencyId,GlobalCurrencyId,Symbol,Archived. Use SearchOperator=0 to specify an AND query or SearchOperator=1 for an OR query


Parameters

NameDescriptionAdditional information
CurrencyId 
CurrencyId

Define this parameter in the request URI.
GlobalCurrencyId 
GlobalCurrencyId

Define this parameter in the request URI.
Archived 
Archived

Define this parameter in the request URI.
Label 
Label

Define this parameter in the request URI.
Symbol 
Symbol

Define this parameter in the request URI.
SearchOperator 
SearchOperator

Define this parameter in the request URI.

Response body formats

A FindCurrenciesResponse containing matching Currencies.

application/json, text/json

Sample: 
{
  "List": [
    {
      "CurrencyId": 1,
      "CurrencyName": "sample string 2",
      "GlobalCurrencyId": 3,
      "AlphaCode": "sample string 4",
      "Archived": true
    },
    {
      "CurrencyId": 1,
      "CurrencyName": "sample string 2",
      "GlobalCurrencyId": 3,
      "AlphaCode": "sample string 4",
      "Archived": true
    },
    {
      "CurrencyId": 1,
      "CurrencyName": "sample string 2",
      "GlobalCurrencyId": 3,
      "AlphaCode": "sample string 4",
      "Archived": true
    }
  ],
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<GetCurrenciesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:Currency>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:AlphaCode>sample string 4</d2p1:AlphaCode>
      <d2p1:CurrencyId>1</d2p1:CurrencyId>
      <d2p1:CurrencyName>sample string 2</d2p1:CurrencyName>
      <d2p1:GlobalCurrencyId>3</d2p1:GlobalCurrencyId>
    </d2p1:Currency>
    <d2p1:Currency>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:AlphaCode>sample string 4</d2p1:AlphaCode>
      <d2p1:CurrencyId>1</d2p1:CurrencyId>
      <d2p1:CurrencyName>sample string 2</d2p1:CurrencyName>
      <d2p1:GlobalCurrencyId>3</d2p1:GlobalCurrencyId>
    </d2p1:Currency>
    <d2p1:Currency>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:AlphaCode>sample string 4</d2p1:AlphaCode>
      <d2p1:CurrencyId>1</d2p1:CurrencyId>
      <d2p1:CurrencyName>sample string 2</d2p1:CurrencyName>
      <d2p1:GlobalCurrencyId>3</d2p1:GlobalCurrencyId>
    </d2p1:Currency>
  </List>
</GetCurrenciesResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body