au.org.consumerdatastandards.api.v1_1_1.common

Interface CommonDiscoveryAPI

@Section(name="CommonDiscovery",
         tags={"Common","Discovery"})
public interface CommonDiscoveryAPI

Method Summary

Modifier and Type	Method and Description
ResponseDiscoveryOutagesList	getOutages(String xV, String xMinV)
ResponseCommonDiscoveryStatus	getStatus(String xV, String xMinV)

Method Detail

getOutages

@Endpoint(path="/discovery/outages",
          summary="Get Outages",
          description="Obtain a list of scheduled outages for the implementation",
          requestMethod=GET,
          operationId="getOutages",
          responses=@EndpointResponse(responseCode=OK,description="Success",headers=@ResponseHeader(name="x-v",type="string",description="The [version](#response-headers) of the API end point that the data holder has responded with."),content=ResponseDiscoveryOutagesList.class))
 @CustomAttributes(value=@CustomAttribute(name="x-version",value="1"))
ResponseDiscoveryOutagesList getOutages(@Param(name="x-v",description="Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)",in=HEADER,reference="RequestHeader_x-v")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 String xV,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 @Param(name="x-min-v",description="Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.",in=HEADER,reference="RequestHeader_x-min-v")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 String xMinV)

getStatus

@Endpoint(path="/discovery/status",
          summary="Get Status",
          description="Obtain a health check status for the implementation",
          requestMethod=GET,
          operationId="getStatus",
          responses=@EndpointResponse(responseCode=OK,description="Success",headers=@ResponseHeader(name="x-v",type="string",description="The [version](#response-headers) of the API end point that the data holder has responded with."),content=ResponseCommonDiscoveryStatus.class))
 @CustomAttributes(value=@CustomAttribute(name="x-version",value="1"))
ResponseCommonDiscoveryStatus getStatus(@Param(name="x-v",description="Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)",in=HEADER,reference="RequestHeader_x-v")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         String xV,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         @Param(name="x-min-v",description="Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.",in=HEADER,reference="RequestHeader_x-min-v")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         String xMinV)