POST Agents/List/SaveCurrencyEntity

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/List/SaveCurrencyEntity

Updates the existing CurrencyEntity or creates a new CurrencyEntity if the id parameter is empty

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: entity

The CurrencyEntity to be saved.

Property Name Type Description
CurrencyId Integer Primary key
Name String The list item
Tooltip String Tooltip or other description
Rank Integer Rank order
Rate Number Exchange rate
Units Number Exchange unit scale (0.01, 0.1, 1, 10, 100 etc)
Deleted Boolean 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists

Response:

OK

Response Description
200 OK

Response body: CurrencyEntity

Property Name Type Description
CurrencyId int32 Primary key
Name string The list item
Tooltip string Tooltip or other description
Rank int32 Rank order
Rate double Exchange rate
Units double Exchange unit scale (0.01, 0.1, 1, 10, 100 etc)
Deleted bool 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/List/SaveCurrencyEntity
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *
Content-Type: application/json; charset=utf-8

{
  "CurrencyId": 151,
  "Name": "Schuster, Sawayn and Monahan",
  "Tooltip": "fugit",
  "Rank": 672,
  "Rate": 12369.898,
  "Units": 20339.66,
  "Deleted": true
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "CurrencyId": 972,
  "Name": "Nader LLC",
  "Tooltip": "cupiditate",
  "Rank": 854,
  "Rate": 990.34399999999994,
  "Units": 16713.622,
  "Deleted": false,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 949
    }
  }
}