API:Vendorapi

From MCM Combat Operations
Revision as of 10:56, 10 February 2015 by Nash Fraenkel (development | contribs) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Entry point for the vendor subsystem.

Requires authentication.

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",
            "templated": true
        },
        "mcm:product": {
            "href": "http:\/\/testsu\/mcm-api\/products\/{productID}",
            "templated": true
        },
        "mcm:sales": {
            "href": "http:\/\/testsu\/mcm-api\/sales"
        }
    }
}