Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idbimShareResource
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: share

URLhttps://api-stage.bimplus.net/v2/<team_slug>/share

Examplehttps://api-stage.bimplus.net/v2/bimplus/share

JSON Structure

Name

Mandatory / Optional

Type

Description

emailemails

mandatory

JSON Array

List of email address to whom the Bimplus user would like to share

type

mandatory

string(enum)

Type of resource. Currently only supported type is Attachment.

id

mandatory

string (guid)

Id of the resource which will be shared

Card
labelHTTP Method
 POST
Card
labelDescription
This service is used for sharing any resources with a user (Bimplus or non-Bimplus user). Resources could be any (eg: attachments, model/slide etc) The recipient will get an email with a link using which the user can download or view the shared resource.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaderslangxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSONlangxml
{
  "emails": [
    "jayaraj.purushothaman@bimplus.net"
  ],
  "type": "Attachment",
  "id": "b4fac6bb-bb00-4a41-9479-fdd229a6201f"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSONlangxml
{
  "emails": [
    "jayaraj.purushothaman@bimplus.net"
  ],
  "type": "Attachment",
  "id": "b4fac6bb-bb00-4a41-9479-fdd229a6201f"
}