API

System APIs

POST system/exchange-rate-sources

Add a new local rate source.

HTTP method POST
URI https://api.rambase.net/system/exchange-rate-sources
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 6934, version 9

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<LocalExchangeRateSource>
2
     <Name
Name

Required/mandatory field

Name of the rate source

>{String}</Name>
3
     <Description
Description

Description of the rate source

This field is optional.

>{String}</Description>
4
     <IsUsedForUnrealizedAgio
IsUsedForUnrealizedAgio

Indicates that these rate source is used for unrealized AGIO calculations

Default value: False

This field is optional.

>{Boolean}</IsUsedForUnrealizedAgio>
5
     <BaseCurrency
BaseCurrency

Required/mandatory field

Three-letter alphabetic code of the Base Currency in the ISO 4217 standard for the local rate source

>
6
          <Code
Code

Required/mandatory field

Three character code following the ISO 4217 standard

>{String}</Code>
7
     </BaseCurrency>
8
</LocalExchangeRateSource>
1
{
2
     "localExchangeRateSource": {
3
          "name
Name

Required/mandatory field

Name of the rate source

": "{String}",
4
          "description
Description

Description of the rate source

This field is optional.

": "{String}",
5
          "isUsedForUnrealizedAgio
IsUsedForUnrealizedAgio

Indicates that these rate source is used for unrealized AGIO calculations

Default value: False

This field is optional.

": "{Boolean}",
6
          "baseCurrency
BaseCurrency

Required/mandatory field

Three-letter alphabetic code of the Base Currency in the ISO 4217 standard for the local rate source

": {
7
               "code
Code

Required/mandatory field

Three character code following the ISO 4217 standard

": "{String}"
8
          }
9
     }
10
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<LocalExchangeRateSource>
2
     <LocalExchangeRateSourceId
LocalExchangeRateSourceId

Local rate source identifier

>{Integer}</LocalExchangeRateSourceId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
4
     <Name
Name

Name of the rate source

>{String}</Name>
5
     <Description
Description

Description of the rate source

>{String}</Description>
6
     <BaseCurrency
BaseCurrency

Three-letter alphabetic code of the Base Currency in the ISO 4217 standard for the local rate source

>
7
          <Code
Code

Three character code following the ISO 4217 standard

>{String}</Code>
8
          <Name
Name

Name/description of currency

>{String}</Name>
9
     </BaseCurrency>
10
     <IsUsedForUnrealizedAgio
IsUsedForUnrealizedAgio

Indicates that these rate source is used for unrealized AGIO calculations

>{Boolean}</IsUsedForUnrealizedAgio>
11
     <Status
Status

Status of the local rate source

Possible domain values can be found here

>{Integer}</Status>
12
     <CreatedBy
CreatedBy

The person who has created the rate source

>
13
          <UserId
UserId

User identifier

>{Integer}</UserId>
14
          <Name
Name

Name of the user

>{String}</Name>
15
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
16
          <UserLink
UserLink

User reference

>{String}</UserLink>
17
     </CreatedBy>
18
</LocalExchangeRateSource>
1
{
2
     "localExchangeRateSource": {
3
          "localExchangeRateSourceId
LocalExchangeRateSourceId

Local rate source identifier

": "{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
5
          "name
Name

Name of the rate source

": "{String}",
6
          "description
Description

Description of the rate source

": "{String}",
7
          "baseCurrency
BaseCurrency

Three-letter alphabetic code of the Base Currency in the ISO 4217 standard for the local rate source

": {
8
               "code
Code

Three character code following the ISO 4217 standard

": "{String}",
9
               "name
Name

Name/description of currency

": "{String}"
10
          },
11
          "isUsedForUnrealizedAgio
IsUsedForUnrealizedAgio

Indicates that these rate source is used for unrealized AGIO calculations

": "{Boolean}",
12
          "status
Status

Status of the local rate source

Possible domain values can be found here

": "{Integer}",
13
          "createdBy
CreatedBy

The person who has created the rate source

": {
14
               "userId
UserId

User identifier

": "{Integer}",
15
               "name
Name

Name of the user

": "{String}",
16
               "firstName
FirstName

First name of the user

": "{String}",
17
               "userLink
UserLink

User reference

": "{String}"
18
          }
19
     }
20
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: