Home Resource

There is a home document available. The resource is a HAL-JSON document with various links to key resources.

Orders

Order Placement

Orders may be placed at a resource discovered by navigating the order-placement link from the home document.

An order-search link will be provided. Again, the results will be constrained by authentication information of the client.

Orders may be enumerated by simply providing no parameters to the search resource. If the client is authenticated as a retailer then the resources returned are implicitly constrained to those that were submitted by the retailer. By contrast, a user or client authenticated as the Operator will be able to see all orders whereas an individual Retailer will only be able to see those orders submitted and ‘owned’ by that organisation and no others.

Search return a list of links to orders, as described in the lotteries-io-order application profile.

Available Gaming Products

The Gaming Products on offer are discovered by following available-gaming-product links.

Draw Information

If the service offers information about Draw Series then these can be discovered by following available-draw-series links.

{
   "_links":{
      "curies":[
         {
            "name":"lo",
            "href":"http://www.lotteries.io/link-relationships/{link-relationship}",
            "templated":true
         }
      ],
      "lo:available-gaming-product":[
         {
            "href":"/gaming-products/product1"
         },
         {
            "href":"/gaming-products/product2"
         }
      ]
   },
   "lo:order-placement":{
      "href":"/orders/placement"
   },
   "lo:orders": {
      "href":"/orders"
   },
   "lo:order-search": {
      "href":"/orders/search{?retailer/href,retail-customer/href,retailer-order-reference/href,fromDate,toDate,processing-state}",
      "templated":true
   },
   "lo:available-draw-series":[
      {
         "href":"/draw-series/series1"
      },
      {
         "href":"/draw-series/series2"
      }
   ]
}