Update sandbox organisation cover image

PUT 
/v2/config/sandbox-org/:sandboxOrgId/coverimage

Updates the cover image of one sandbox organisation. Give the sandbox organisation ID in the path and send the image as multipart form data in the coverimage form field.

The service stores the image, sets the new image ID and the new image URL on the sandbox organisation, and sends the change to the wallet of the sandbox organisation when it is deployed.

You cannot update the main wallet through this endpoint. If the given ID is the main wallet, the service gives HTTP 400.

Request

Path Parameters

sandboxOrgId stringrequired

Unique identifier of the sandbox organisation.

multipart/form-data

Body

required

The cover image to store.

coverimage binaryrequired

The cover image file.

Responses

200

The service stored the cover image.

Response Headers

application/json

Schema

Schema

sandboxOrg objectrequired

The sandbox organisation after the update. The service sets coverImageId and coverImageUrl.

id string

Unique identifier of the sandbox organisation

name string

Display name of the sandbox organisation

description string

Human readable description of the sandbox organisation

openIdDeploymentId string

Identifier of the associated OpenID deployment

status integer

Status code of the sandbox organisation

ledgerId integer

Identifier of the associated ledger

infrastructureProvider string

Name of the infrastructure provider

version string

Version of the sandbox organisation configuration

role string

Role of the sandbox organisation in the ecosystem

trustAnchor string

Trust anchor identifier or DID

isWalletProvider boolean

Indicates whether this sandbox organisation acts as a wallet provider

secureVault integer

Identifier of the primary secure vault

secureVaults integer[]nullable

Identifiers of the secure vaults that the sandbox organisation uses. The field holds null when the sandbox organisation has no secure vault.

logoImageId string

Identifier of the logo image. The field is absent when the sandbox organisation has no logo image.

coverImageId string

Identifier of the cover image. The field is absent when the sandbox organisation has no cover image.

logoImageUrl string

Public URL for the logo image

coverImageUrl string

Public URL for the cover image

createdAt integer

Timestamp when the sandbox organisation was created

updatedAt integer

Timestamp when the sandbox organisation was last updated

isMain boolean

Indicates whether this is the main organisation

Example (from schema)

{
  "sandboxOrg": {
    "id": "string",
    "name": "string",
    "description": "string",
    "openIdDeploymentId": "string",
    "status": 0,
    "ledgerId": 0,
    "infrastructureProvider": "string",
    "version": "string",
    "role": "string",
    "trustAnchor": "string",
    "isWalletProvider": true,
    "secureVault": 0,
    "secureVaults": [
      0
    ],
    "logoImageId": "string",
    "coverImageId": "string",
    "logoImageUrl": "string",
    "coverImageUrl": "string",
    "createdAt": 0,
    "updatedAt": 0,
    "isMain": true
  }
}

400

The given ID is the main wallet, the request has no coverimage form field, or the service could not send the change to the wallet of the sandbox organisation.

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

404

The organisation has no sandbox organisation with this ID.

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...