API:Vendorapi

From MCM Combat Operations
Revision as of 07:59, 27 May 2023 by Nash Fraenkel (development | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Entry point for the vendor subsystem.

URI: /vendorapi

Example Request

GET http://testsu/mcm-api/vendorapi
Accept: application/hal+json

 -- response --
200 OK
Content-Type:  application/hal+json

{
  "_links": {
    "self": {
      "href": "http:\/\/testsu\/mcm-api\/vendorapi"
    },
    "curies": [
      {
        "name": "mcm",
        "href": "http:\/\/wiki.mcm-systems.net\/index.php?title=api:{rel}",
        "templated": true
      }
    ],
    "mcm:user;vendor": {
      "href": "http:\/\/testsu\/mcm-api\/users\/{user}?view=vendor&productID={productID}",
      "templated": true
    },
    "mcm:products": {
      "href": "http:\/\/testsu\/mcm-api\/products?page={page}&perpage{perpage}"
    },
    "mcm:product": {
      "href": "http:\/\/testsu\/mcm-api\/products\/{productID}",
      "templated": true
    },
    "mcm:sales": {
      "href": "http:\/\/testsu\/mcm-api\/sales"
    }
  }
}