Zones_Get.yaml 1.95 KB
Newer Older
description: Used to get a list of identifiers for zones authorized for use by the application.
produces:
- application/json

responses:
  200:
    description: Successful response to a query regarding the status of a zone
    schema:
      properties:
        zoneList:
          $ref: '#/definitions/ZoneList'
      
    examples:
      application/json:
        $ref: '../examples/ZoneList.json'

# works, but what does it add?!
#      application/json:
#        $ref: '../examples/index.yaml#/ZonesGetResponse'

# works
#      application/json:
#        $ref: '../examples/ZonesGetResponse.json'

# works
#      application/json:
#        {
#        	"zoneList": {
#        		"zone": 
#        		[
#        		  {
#        				"zoneId": "zone01",
#        				"numberOfAccessPoints": "3",
#        				"numberOfUnserviceableAccessPoints": "1",
#        				"numberOfUsers": "10",
#        				"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01"
#        			}, 
#        			{
#        				"zoneId": "zone02",
#        				"numberOfAccessPoints": "12",
#        				"numberOfUnserviceableAccessPoints": "0",
#        				"numberOfUsers": "36",
#        				"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone02"
#        			}
#        		],
#        		"resourceURL": "http://example.com/exampleAPI/location/v1/zones"
#        	}            
#        } 

# works
#      application/json:
#        zoneList:
#          zone:
#          - zoneId: zone01
#            numberOfAccessPoints: '3'
#            numberOfUnserviceableAccessPoints: '1'
#            numberOfUsers: '10'
#            resourceURL: http://example.com/exampleAPI/location/v1/zones/zone01
#          - zoneId: zone02
#            numberOfAccessPoints: '12'
#            numberOfUnserviceableAccessPoints: '0'
#            numberOfUsers: '36'
#            resourceURL: http://example.com/exampleAPI/location/v1/zones/zone02
#          resourceURL: http://example.com/exampleAPI/location/v1/zones