taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-private-tokenfamilies.rst (1458B)

      1 .. http:get:: [/instances/$INSTANCES]/private/tokenfamilies
      2 
      3   This is used to list all configured token families for an instance.
      4 
      5   **Required permission:** ``tokenfamilies-read``
      6 
      7   **Response:**
      8 
      9   :http:statuscode:`200 OK`:
     10     The merchant backend has successfully returned all token families.
     11     Returns a `TokenFamiliesList`.
     12 
     13   :http:statuscode:`404 Not found`:
     14     The merchant backend is unaware of the instance.
     15 
     16   **Details:**
     17 
     18   .. ts:def:: TokenFamiliesList
     19 
     20     // TODO: Add pagination
     21 
     22     interface TokenFamiliesList {
     23 
     24       // All configured token families of this instance.
     25       token_families: TokenFamilySummary[];
     26 
     27    }
     28 
     29   .. ts:def:: TokenFamilySummary
     30 
     31     interface TokenFamilySummary {
     32       // Identifier for the token family consisting of unreserved characters
     33       // according to RFC 3986.
     34       slug: string;
     35 
     36       // Human-readable name for the token family.
     37       name: string;
     38 
     39       // Human-readable description for the token family.
     40       // @since protocol **v23**.
     41       description: string;
     42 
     43       // Optional map from IETF BCP 47 language tags to localized descriptions.
     44       // @since protocol **v23**.
     45       description_i18n?: { [lang_tag: string]: string };
     46 
     47       // Start time of the token family's validity period.
     48       valid_after: Timestamp;
     49 
     50       // End time of the token family's validity period.
     51       valid_before: Timestamp;
     52 
     53       // Kind of the token family.
     54       kind: TokenFamilyKind;
     55    }