You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »




Catalog Service



Catalog Service


Create a new norm
    Resource: norms

    URLhttps://api-stage.bimplus.net/v2/ norms

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

    JSON Structure

    Name

    Mandatory / Optional

    Type

    Description

    id will be ignored string(guid) The id of the norm. Will be taken from request url.
    name mandatory string Norm name
    description optional string Norm description
     POST

    Create a new norm.

    Headers
    Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
    Content-Type: application/json
    
    JSON
    {
      "name":"DIN 1046",
      "description":"DIN 1046"
    }
    Status
    Status: 201 Created
    
    JSON
    {
      "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385",
      "name":"DIN 1046",
      "description":"DIN 1046"
    }

    Get the norm list
       GET
       Gets the norm list
      Headers
      Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
      Content-Type: application/json
      
      Status
      Status: 200 OK
      
      JSON
      [{
          "id":"6de06146-125f-c7eb-95cc-0c07d85c4d94",
          "name":"DIN 1045",
          "description":"DIN 1045"
        },
        {
          "id":"0da7bbc8-c63d-d090-c458-1431f78987e0",
          "name":"DIN 17100",
          "description":"DIN 17100"
        }
      ]

      Get the norm details
         GET
         Get information about a specified norm
        Headers
        Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
        Content-Type: application/json
        
        Status
        Status: 200 OK
        
        JSON
        {
          "id":"6de06146-125f-c7eb-95cc-0c07d85c4d94",
          "name":"DIN 1045",
          "description":"DIN 1045"
        }

        Delete the specified norm
           DELETE

          Delete the specified norm

          Headers
          Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
          Content-Type: application/json
          
          Status
          Status: 200 OK
          

          Create a new country
            Resource: countries

            URLhttps://api-stage.bimplus.net/v2/ countries

            Examplehttps://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
             POST

            Create a new country.

            Headers
            Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
            Content-Type: application/json
            
            JSON
            {
              "name":"Austria",
              "description":"Austria"
            }
            Status
            Status: 201 Created
            
            JSON
            {
              "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385",
              "name":"Austria",
              "description":"Austria"
            }

            Get the country list
               GET
               Gets the country list
              Headers
              Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
              Content-Type: application/json
              
              Status
              Status: 200 OK
              
              JSON
              [{
                  "id":"2909b0d8-c6de-425d-2303-256336ada04f",
                  "name":"Germany",
                  "description":"Germany"
                },
                {
                  "id":"b7e10710-94f8-bfdf-72a0-eaa80f3bc57e",
                  "name":"Italy",
                  "description":"Italy"
                }
              ]

              Get the country details
                 GET
                 Get information about a specified country
                Headers
                Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                Content-Type: application/json
                
                Status
                Status: 200 OK
                
                JSON
                {
                  "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385",
                  "name":"Austria",
                  "description":"Austria"
                }

                Delete the specified country
                   DELETE

                  Delete the specified country

                  Headers
                  Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                  Content-Type: application/json
                  
                  Status
                  Status: 200 OK
                  
                  Get a list of catalog types
                    Resource: catalogs/types

                    URLhttps://api-stage.bimplus.net/v2/ catalogs/types

                    Examplehttps://api-stage.bimplus.net/v2/catalogs/types

                    JSON Structure

                    Name

                    Mandatory / Optional

                    Type

                    Description

                    id will be ignored string(guid) The id of the catalog type.
                    name mandatory string Catalog type name
                    description optional string Catalog type description
                     GET
                     Get a list of catalog types
                    Headers
                    Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                    Content-Type: application/json
                    
                    Status
                    Status: 200 OK
                    
                    JSON
                    [{
                        "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
                        "name":"Material",
                        "description":"Material"
                      },
                      ...
                    ]

                    Get the catalog type details
                       GET
                       Get information about a specified norm
                      Headers
                      Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
                      Content-Type: application/json
                      
                      Status
                      Status: 200 OK
                      
                      JSON
                      {
                        "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
                        "name":"Material",
                        "description":"Material"
                      }
                      • No labels