{
  "openapi" : "3.1.0",
  "info" : {
    "title" : "Brand Information",
    "version" : "1.0.0",
    "description" : "Provides services for requesting brand information."
  },
  "paths" : {
    "/portals/api/v1/brand/info" : {
      "get" : {
        "operationId" : "get-portals-api-v1-brand-info",
        "summary" : "Fetch Brand Information",
        "description" : "Provides information regarding a brand (found through a given ID, name or supplier number),\nif the brand is available in the portal.\n",
        "parameters" : [ {
          "name" : "accessToken",
          "in" : "query",
          "required" : true,
          "description" : "Access token for non-public portals. When submitting a <i>user</i> or <i>roles,</i> the respective values need to be considered during the computation of the token. See kba:INT63 for details.",
          "schema" : {
            "type" : "string"
          },
          "example" : "d0765f518ff0cab426dbbd6d467c9967"
        }, {
          "name" : "brand",
          "in" : "query",
          "required" : true,
          "description" : "Brand identifier: can be the brand ID, name, or supplier number.",
          "schema" : {
            "type" : "string"
          },
          "example" : "ST"
        }, {
          "name" : "portal",
          "in" : "query",
          "required" : true,
          "description" : "Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the <a href=\"/portals\">Portals</a> page.",
          "schema" : {
            "type" : "string"
          },
          "example" : "9999999"
        }, {
          "name" : "user",
          "in" : "query",
          "required" : true,
          "description" : "User name",
          "schema" : {
            "type" : "string"
          },
          "example" : "john.doe"
        }, {
          "name" : "language",
          "in" : "query",
          "required" : false,
          "description" : "Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code.",
          "schema" : {
            "type" : "string"
          },
          "example" : "de"
        }, {
          "name" : "roles",
          "in" : "query",
          "required" : false,
          "description" : "Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public.",
          "schema" : {
            "type" : "string"
          },
          "example" : "Heating,Electronics,Top-Customer"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successful response. Returns an empty object if no matching brand is found in the portal.",
            "content" : {
              "application/json" : {
                "examples" : {
                  "example1" : {
                    "value" : {
                      "id" : "ABC123",
                      "name" : "ST Sanitär",
                      "supplierNumber" : "ST",
                      "supplierNumbers" : "ST",
                      "mediumImageUrl" : "https://oxomi.com/dasd/p/tenants/.../.../....jpg",
                      "manufacturerName" : "ST Sanitary Inc",
                      "manufacturerPostalAddress" : "ST Sanitary, 69 W 14th St, 10011 New York, US",
                      "manufacturerElectronicAddress" : "st-sanitary@oxomi.local",
                      "distributorName" : "ST Sanitär Europa GmbH",
                      "distributorPostalAddress" : "ST Sanitär, Sanitärstrasse 1, 73630 Remshalden, GERMANY",
                      "distributorElectronicAddress" : "st-sanitaer-eu@oxomi.local"
                    }
                  }
                }
              }
            }
          },
          "400" : {
            "description" : "Missing parameter or malformed request",
            "content" : {
              "application/json" : {
                "examples" : {
                  "example1" : {
                    "value" : {
                      "success" : false,
                      "error" : true,
                      "message" : "The parameter {missingParameter} must be filled."
                    }
                  }
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication required but none provided",
            "content" : {
              "application/json" : { }
            }
          },
          "403" : {
            "description" : "Invalid authentication or missing permission",
            "content" : {
              "application/json" : { }
            }
          },
          "404" : {
            "description" : "Resource not found",
            "content" : {
              "application/json" : { }
            }
          },
          "405" : {
            "description" : "Incorrect request method, e.g. GET instead of POST",
            "content" : {
              "application/json" : { }
            }
          },
          "500" : {
            "description" : "Unexpected server-side error",
            "content" : {
              "application/json" : { }
            }
          }
        }
      }
    }
  }
}