Home › API › Update the issuer

Update the issuer

Updated on 09 Dec 2020

Description

A User or External Entity on behalf of a User with role permission ISSUER_MANAGER will go through all steps of “Obtain issuers” Use Case, and then send a request to Endpoint “Update the issuer”.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User with permissions: ISSUER_MANAGER.
  2. System Operator running “SDK.Finance” software and exposing portfolio of financial APIs.

Preconditions

  1. The user must have a System Operator profile with sufficient access privileges.

 

Basic Flow

By default, this flow assumes that External Entity sends Requests to System Operator Endpoints and System Operator sends back Responses to External Entity.

  1. Perform all steps of Use Case “Obtain issuers”.
  2. External Entity sends a request to Endpoint “Update the issuer”.

Endpoint URL: https://sdkfinance.app/api/ui/#!/Issuers/Update_issuer

Parameters:

Authorization – authorization token

id – identifier of the Issuer

Request body example:

{ 

   "name":"string",

   "description":"string",

   "active":false,

   "orderNumber":0,

   "orderQuote":0

}
  1. System Operator returns updated Issuer information to External Entity. (See Result example below)

 

Optional Flow with Web Browser UI

  1. Perform all steps of Use Case “Obtain issuers”.
  2. A user sends a request to Endpoint “Update the issuer”.

Endpoint URL: https://sdkfinance.app/api/ui/#!/Issuers/Update_issuer

Parameters:

Authorization – authorization token

id – identifier of the Issuer

Request body example:

{ 

   "name":"string",

   "description":"string",

   "active":false,

   "orderNumber":0,

   "orderQuote":0

}

 

  1. System Operator returns updated Issuer information to User (See Result example below).

 

Post Conditions

Updated Issuer information is available.

Result example

{ 

   "issuer":{ 

      "id":"string",

      "sn":"string",

      "name":"string",

      "description":"string",

      "orderNumber":0,

      "orderQuote":0,

      "active":false,

      "currency":{ 

         "code":"string",

         "digitalCode":"string",

         "symbol":"string",

         "name":"string",

         "description":"string"

      }

   },

   "status":"ok",

   "message":"string"

}