Halobject

BeneficiariesLinks

links that can be used for further navigation when browsing Account Information at one account level

LinkDescription
selflink to the list of trusted beneficiaries
accountslink to the list of all available accounts
consentslink to the consents forwarding
endUserIdentitylink to the end-user identity
firstlink to the first page of the beneficiaries result
lastlink to the last page of the beneficiaries result
nextlink to the next page of the beneficiaries result
prevlink to the previous page of the beneficiaries result

Fields (8)

  • selfGenericLinkrequired

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

  • accountsGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

  • consentsGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

  • endUserIdentityGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

  • firstGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

  • lastGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

  • nextGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

  • prevGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

      This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false