POST Currencies

Adds a Currency for the current user. Currency type for the user can also be provided with the currency.


Parameters

NameDescriptionAdditional information
request 
The Currency to be added

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample: 
{
  "CurrencyId": 0,
  "CurrencyName": null,
  "GlobalCurrencyId": 1,
  "AlphaCode": null,
  "Archived": false
}

application/xml, text/xml

Sample: 
<Currency xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
  <Archived>false</Archived>
  <AlphaCode i:nil="true" />
  <CurrencyId>0</CurrencyId>
  <CurrencyName i:nil="true" />
  <GlobalCurrencyId>1</GlobalCurrencyId>
</Currency>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

A CurrencyResponse containing the edited Currency.

application/json, text/json

Sample: 
{
  "Item": {
    "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: 
<CurrencyResponse 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>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <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>
  </Item>
</CurrencyResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body