Versions Compared

Key

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

...

Section
bordertrue
Column

Project relevant services

Column

Administration relevant services

Column

Other services

...

Section
Column
width25%

Import Service


Column
width25%

Slideshow Service


Column
width50%

 

...

Deck of Cards
idbimGetProjectList
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
 

Resource: slideshows

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows

Card
labelDescription
 Get the slideshow list belonging to a project.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
[
    {
        "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
        "name": "My first slideshow",
        "description": null,
        "author": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com",
            "firstname": "Jayaraj",
            "lastname": "Purushothaman",
            "company": "Jay Company",
            "fullname": "Jayaraj Purushothaman",
            "displayname": "Jayaraj Purushothaman [Jay Company]",
            "info": "",
            "gender": "MR",
            "phoneWork": "",
            "phoneHome": "",
            "fax": "",
            "mobile": "",
            "birthDate": "0000-00-00",
            "address": {
                "street": "Konrad Zuse platz",
                "streetNr": "1",
                "zip": "81829",
                "city": "Munich",
                "country": "Germany"
            },
            "preferedLanguage": "en"
        },
        "created": "2014-03-03T12:50:01",
        "id": "cdece695-530d-4b54-a413-d30877a15b08"
    }
]
Anchor

...

deleteSlideshowList

...

deleteSlideshowList
Delete all the slideshows from a project
Deck of Cards
idbimDeleteUser
Card
labelHTTP Method
 DELETE
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: slideshows

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows

Card
labelDescription
 Delete all the slideshows from a project
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
getSlideshowDetails
getSlideshowDetails

Get details of the slideshow
Deck of Cards
idbimGetProjectProp
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resourceslideshows/<slideshow_id>

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

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

Card
labelDescription
 Get the details of a particular slideshow 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
Code Block
borderColorRed
titleJSON
langxml
{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "My first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en"
    },
    "created": "2014-03-03T15:31:14",
    "id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}

 

Anchor
authorizationService
authorizationService

...