API:Product: Difference between revisions

From MCM Combat Operations
Jump to: navigation, search
(Created page with " <nowiki> GET /products/20 Accept: application/hal+json -- response -- 200 OK Content-Type: application/hal+json { "_links": { "self": { "href": "\...")
 
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
Returns product info suitable for use by a vendor application
'''URI:''' /products/{productID}
=== Example Request ===
  <nowiki>
  <nowiki>
GET /products/20
GET http://testsu/mcm-api/products/30
Accept: application/hal+json
Accept: application/hal+json


Line 10: Line 15:
     "_links": {
     "_links": {
         "self": {
         "self": {
             "href": "\/products\/20"
             "href": "http:\/\/testsu\/mcm-api\/products\/30"
        },
        "curies": [
            {
                "name": "mcm",
                "href": "http:\/\/wiki.mcm-systems.net\/index.php?title=api:{rel}",
                "templated": true
            }
        ],
        "mcm:productsale": {
            "href": "http:\/\/testsu\/mcm-api\/products\/30\/sales"
        },
        "mcm:userpoduct": {
            "href": "http:\/\/testus\/mcm-api\/users\/{userName}\/products/30",
            "templated": true
        }
        "mcm:staffdelivery": {
            "href": "http:\/\/testsu\/mcm-api\/users/{userName}/products/30/staffdelivery",
            "templated": true
         }
         }
     },
     },
     "prodID": "20",
     "prodID": "30",
     "prodName": "Conscript",
     "prodName": "Fox",
     "prodPrice": "1200",
     "prodPrice": "130",
     "prodImage": "b02e343e-f618-8e2b-da4e-d19bcf1e7d77"
     "prodImage": "83ffffb5-7f0e-8a39-2d27-bfba7208563a"
}
}
</nowiki>
</nowiki>

Latest revision as of 21:52, 20 June 2020

Returns product info suitable for use by a vendor application

URI: /products/{productID}

Example Request

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

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

{
    "_links": {
        "self": {
            "href": "http:\/\/testsu\/mcm-api\/products\/30"
        },
        "curies": [
            {
                "name": "mcm",
                "href": "http:\/\/wiki.mcm-systems.net\/index.php?title=api:{rel}",
                "templated": true
            }
        ],
        "mcm:productsale": {
            "href": "http:\/\/testsu\/mcm-api\/products\/30\/sales"
        },
        "mcm:userpoduct": {
            "href": "http:\/\/testus\/mcm-api\/users\/{userName}\/products/30",
            "templated": true
        }
        "mcm:staffdelivery": {
            "href": "http:\/\/testsu\/mcm-api\/users/{userName}/products/30/staffdelivery",
            "templated": true
        }
    },
    "prodID": "30",
    "prodName": "Fox",
    "prodPrice": "130",
    "prodImage": "83ffffb5-7f0e-8a39-2d27-bfba7208563a"
}