Versions Compared

Old Version 8

changes.mady.by.user Stanislav Slacky

Saved on

compared with

New Version 9

changes.mady.by.user Stanislav Slacky

Saved on

Key

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

...

Deck of Cards
idbimUpdateSlide
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/slideshowsslides/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
indexoptionalintegerOrder of the slide (Starts with 1)
Card
labelHTTP Method
 PUT
Card
labelDescription
 Update a specific slideshow using its id.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
    "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
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
{
    "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"
}

...

Deck of Cards
idbimDeleteSlide
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
labelHTTP Method
 DELETE
Card
labelDescription
 Delete a particular slide using its id.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

...