Versions Compared

Old Version 433

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 434

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

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

...

Anchor
updateSlide
updateSlide

Update the details of a slide
Deck of Cards
idbimUpdateSlide
Card
labelHTTP Method
 PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: slides/<slide_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id> 

Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/586b02be-43b8-4e27-b698-e067e85e38e2

JSON Structure: 

Name

Mandatory / Optional

Type

Description

name

optional

string

Name of the slideshow

descriptionoptionalstringDescription of the slideshow
projectIdoptionalstringThe id of the project to which the slideshow belongs
authorwill be ignoredobject (user)Information about the user who has created the slideshow
createdwill be ignoredstring (date)Creation date of the slideshow
idwill be ignoredstring (id)Id of the slideshow
Card
labelDescription
 Update a specific slideshow using its id.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slide",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"
    }
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": null,
        "firstname": null,
        "lastname": null,
        "company": null,
        "fullname": "",
        "displayname": null,
        "info": null,
        "gender": null,
        "phoneWork": null,
        "phoneHome": null,
        "fax": null,
        "mobile": null,
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "created": "0001-01-01T00:00:00",
    "id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}
Anchor
deleteSlide
deleteSlide
Delete

...

a slide from a slideshow
Deck of Cards
idbimDeleteSlide
Card
labelHTTP Method
 DELETE
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: slides/slide

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slides/<slide_id>

Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slides/ff375edf-5e8c-4b68-a4a1-fec6b943e7d8

Card
labelDescription
 Delete a particular slide using its id.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

...

Deck of Cards
idbimCreateSlideThumbnail
Card
labelHTTP Method
 POST
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: projectsslides/<project<slide_id>/thumbnail

URL: https://api-stage.bimplus.net/v2/<team_slug>/projectsslides/<project<slide_id>/thumbnail

Example: https://api-stage.bimplus.net/v2/bimplus/projectsslides/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail

Card
labelDescription
 Creates or uploads a thumbnail to a slide.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
    "fileName": "MyThumbnailSlide1.jpgpng",
    "type": "image/jpegpng",
    "size": 5262
id: "21320,
    "id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}

Anchor
downloadSlideThumbnail
downloadSlideThumbnail

Download the thumbnail from a slide
Deck of Cards
idbimDownloadSlideThumbnail
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: slide/<slide_id>/thumbnail/download

URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>/thumbnail/download

Example: https://api-stage.bimplus.net/v2/bimplus/slides/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

" }

...

/thumbnail/download

Card
labelDescription
 Downloads the thumbnail of a slide.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
authorizationService
authorizationService

...