API:Vendorapi: Difference between revisions

From MCM Combat Operations
Jump to: navigation, search
(Created page with "Entry point for the vendor subsystem. Requires authentication. == Example Request == <nowiki> GET http://testsu/mcm-api/vendorapi Accept: application/hal+json -- response...")
 
mNo edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
Entry point for the vendor subsystem.
Entry point for the vendor subsystem.


Requires authentication.
'''URI''': /vendorapi


== Example Request ==
== Example Request ==
Line 13: Line 13:


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

Latest revision as of 07:59, 27 May 2023

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"
    }
  }
}