Page History

...

Deck of Cards

id	bimGetMessage

Card

default	true
label	URL / Resource / JSON Structure

Resource: norms

URL: https://api-stage.bimplus.net/v2/ norms/<message<norm_id>

Example: https://api-stage.bimplus.net/v2/norms/6de06146-125f-c7eb-95cc-0c07d85c4d94

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified norm

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "id":"6de06146-125f-c7eb-95cc-0c07d85c4d94",
  "name":"DIN 1045",
  "description":"DIN 1045"
}

...

Deck of Cards

id	bimDeleteMessage

Card

default	true
label	URL / Resource / JSON Structure

Resource: norms

URL: https://api-stage.bimplus.net/v2/ norms/<message<norm_id>

Example: https://api-stage.bimplus.net/v2/norms/6de06146-125f-c7eb-95cc-0c07d85c4d94

Card

label	HTTP Method

DELETE

Card

label	Description

Delete the specified norm

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	createCountry
	createCountry

Create a new country

Deck of Cards

id	bimCreateCountry

Card

default	true
label	URL / Resource / JSON Structure

Resource: countries

URL: https://api-stage.bimplus.net/v2/ countries

Example: https://api-stage.bimplus.net/v2/countries

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	The id of the country. Will be taken from request url.
name	mandatory	string	Country name
description	optional	string	Country description

Card

label	HTTP Method

POST

Card

label	Description

Create a new country.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name":"Austria",
  "description":"Austria"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
  "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385",
  "name":"Austria",
  "description":"Austria"
}

Anchor

	getCountryList
	getCountryList

Get the norm list

Deck of Cards

id	bimGetCountryList

Card

default	true
label	URL / Resource / JSON Structure

Resource: countries

URL: https://api-stage.bimplus.net/v2/ countries

Example: https://api-stage.bimplus.net/v2/countries

Card

label	HTTP Method

GET

Card

label	Description

Gets the country list

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[{
    "id":"2909b0d8-c6de-425d-2303-256336ada04f",
    "name":"Germany",
    "description":"Germany"
  },
  {
    "id":"b7e10710-94f8-bfdf-72a0-eaa80f3bc57e",
    "name":"Italy",
    "description":"Italy"
  }
]

Anchor

	getCountry
	getCountry

Get the norm details

Deck of Cards

id	bimGetCountry

Card

default	true
label	URL / Resource / JSON Structure

Resource: countries

URL: https://api-stage.bimplus.net/v2/ countries/<country_id>

Example: https://api-stage.bimplus.net/v2/countries/ed9fe5ba-96c0-f24d-9779-b06b7ce69385

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified country

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385",
  "name":"Austria",
  "description":"Austria"
}

Anchor

	deleteCountry
	deleteCountry

Delete the specified norm

Deck of Cards

id	bimDeleteCountry

Card

default	true
label	URL / Resource / JSON Structure

Resource: countries

URL: https://api-stage.bimplus.net/v2/ countries/<country_id>

Example: https://api-stage.bimplus.net/v2/countries/ed9fe5ba-96c0-f24d-9779-b06b7ce69385

Card

label	HTTP Method

DELETE

Card

label	Description

Delete the specified country

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor
browserMessageRead
browserMessageRead

Mark a browser message as "read"

Deck of Cards

id	bimBrowserMessageRead

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasreadbrowser

URL: https://api-stage.bimplus.net/v2/messages/<message_id>/markasreadbrowser

Example: https://api-stage.bimplus.net/v2/messages/<message_id>/markasreadbrowser

Card

label	HTTP Method

POST

Card

label	Description

Mark a message or group of messages by given posting as read by browser.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor
browserMessageRead
browserMessageRead

Mark a browser message as "read"

Deck of Cards

id	bimBrowserMessageRead

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasreadbrowser

URL: https://api-stage.bimplus.net/v2/messages/<message_id>/markasreadbrowser

Example: https://api-stage.bimplus.net/v2/messages/<message_id>/markasreadbrowser

Card

label	HTTP Method

POST

Card

label	Description

Mark a message or group of messages by given posting as read by browser.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	browserMessageUnread
	browserMessageUnread

Mark a browser message as "unread"

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Create a new country

Get the norm list

Get the norm details

Delete the specified norm

Anchor
browserMessageRead
browserMessageRead

Mark a browser message as "read"

Anchor
browserMessageRead
browserMessageRead

Mark a browser message as "read"

Mark a browser message as "unread"

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 2

New Version 3

Key

Create a new country

Get the norm list

Get the norm details

Delete the specified norm

AnchorbrowserMessageReadbrowserMessageRead

Mark a browser message as "read"

AnchorbrowserMessageReadbrowserMessageRead

Mark a browser message as "read"

Mark a browser message as "unread"

Anchor
browserMessageRead
browserMessageRead

Anchor
browserMessageRead
browserMessageRead