The HubMessageManagement API is a B2B SMP APIs used retrieve the current list of stop files for all participants or for a specific participant (using alerts) resource.
\nParticipants can use this resource to:
\nWhen invoking e-Hub API resources, this parameter is the AEMO-supplied API Key. Note that an API Key is issued for each combination of API and ParticipantID. API Keys are sourced from the AEMO API Portal. Initial API Keys are allocated as part of the registration and accreditation process
\n"},{"key":"Accept","value":"application/xml"}],"url":"https://apis.preprod.aemo.com.au:9319/ws/HubMessageManagement/1.0/alerts?initiatingParticipantID=&alertType=B2BStopFile&queryParticipantID=","description":"Return Participants that have a B2B Stop file. Returns stop file details for all participants or the requested ParticipantID. Note- This API & resource will be enhanced in future to return the list of B2M stop files
\n","urlObject":{"path":["alerts"],"host":["https://apis.preprod.aemo.com.au:9319/ws/HubMessageManagement/1.0"],"query":[{"description":{"content":"ParticipantID of the Participant invoking the API Note- If the API keys and certificates issued against the ParticipantID does not match with the ParticipantID passed in the query string, the system will send an exception
\n","type":"text/plain"},"key":"initiatingParticipantID","value":""},{"description":{"content":"If the value is set to ‘B2BStopFile’, details related to B2B stop files will be sent. In future this parameter will be extended to support the retrieval of B2M stop files. If this parameter is not passed; the e-Hub will default the alertType to ‘B2BStopFile’.
\n","type":"text/plain"},"key":"alertType","value":"B2BStopFile"},{"description":{"content":"If queryParticipantID is populated, e-Hub will retrieve the stop file for the queryParticipantID. The e-Hub will not validate if the queryParticipantID is valid. If an invalid queryParticipantID is sent, the e-Hub will send = 0; meaning no stop file exists for the requested queryParticipantID. If queryParticipantID is not passed it will return the current list of stop files in the market.
\n","type":"text/plain"},"key":"queryParticipantID","value":""}],"variable":[]}},"response":[{"id":"4ac0a9b8-fbed-48f6-a479-826e94ca10f7","name":"Response_404","originalRequest":{"method":"GET","header":[{"key":"x-eHub-APIKey","value":"","description":"When invoking e-Hub API resources, this parameter is the AEMO-supplied API Key. Note that an API Key is issued for each combination of API and ParticipantID. API Keys are sourced from the AEMO API Portal. Initial API Keys are allocated as part of the registration and accreditation process"},{"key":"Accept","value":"application/xml"}],"url":{"raw":"https://apis.preprod.aemo.com.au:9319/ws/HubMessageManagement/1.0/alerts?initiatingParticipantID=&alertType=B2BStopFile&queryParticipantID=","host":["https://apis.preprod.aemo.com.au:9319/ws/HubMessageManagement/1.0"],"path":["alerts"],"query":[{"key":"initiatingParticipantID","value":"","description":"ParticipantID of the Participant invoking the API Note- If the API keys and certificates issued against the ParticipantID does not match with the ParticipantID passed in the query string, the system will send an exception"},{"key":"alertType","value":"B2BStopFile","description":"If the value is set to ‘B2BStopFile’, details related to B2B stop files will be sent. In future this parameter will be extended to support the retrieval of B2M stop files. If this parameter is not passed; the e-Hub will default the alertType to ‘B2BStopFile’."},{"key":"queryParticipantID","value":"","description":"If queryParticipantID is populated, e-Hub will retrieve the stop file for the queryParticipantID. The e-Hub will not validate if the queryParticipantID is valid. If an invalid queryParticipantID is sent, the e-Hub will sendWhen invoking e-Hub API resources, this parameter is the AEMO-supplied API Key. Note that an API Key is issued for each combination of API and ParticipantID. API Keys are sourced from the AEMO API Portal. Initial API Keys are allocated as part of the registration and accreditation process
\n"},{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"The e-Hub will send alerts to the Participants in the following scenarios
\nWhen invoking e-Hub API resources, this parameter is the AEMO-supplied API Key. Note that an API Key is issued for each combination of API and ParticipantID. API Keys are sourced from the AEMO API Portal. Initial API Keys are allocated as part of the registration and accreditation process
\n"},{"key":"Accept","value":"application/xml"}],"url":"https://apis.preprod.aemo.com.au:9319/ws/HubMessageManagement/1.0/ping?initiatingParticipantID=","description":"Returns response code to state if the core e-Hub applications are available / operational. This API/resource will be used by the Participants to
\nParticipantID of the Participant invoking the API Note- If the API keys and certificates issued against the ParticipantID does not match with the ParticipantID passed in the query string, the system will send an exception
\n","type":"text/plain"},"key":"initiatingParticipantID","value":""}],"variable":[]}},"response":[{"id":"3bdc0034-337c-4c75-833e-a6d10de0d603","name":"Response_404","originalRequest":{"method":"GET","header":[{"key":"x-eHub-APIKey","value":"","description":"When invoking e-Hub API resources, this parameter is the AEMO-supplied API Key. Note that an API Key is issued for each combination of API and ParticipantID. API Keys are sourced from the AEMO API Portal. Initial API Keys are allocated as part of the registration and accreditation process"},{"key":"Accept","value":"application/xml"}],"url":{"raw":"https://apis.preprod.aemo.com.au:9319/ws/HubMessageManagement/1.0/ping?initiatingParticipantID=","host":["https://apis.preprod.aemo.com.au:9319/ws/HubMessageManagement/1.0"],"path":["ping"],"query":[{"key":"initiatingParticipantID","value":"","description":"ParticipantID of the Participant invoking the API Note- If the API keys and certificates issued against the ParticipantID does not match with the ParticipantID passed in the query string, the system will send an exception"}]},"description":"Returns response code to state if the core e-Hub applications are available / operational. This API/resource will be used by the Participants to\n- Test if the Participant application / gateway is able to establish connectivity with the e-Hub and/or\n- Validate if the SSL configuration / certificates are valid and/or\n- Check if the core e-Hub applications are available "},"status":"This response is provided when the resource name missing from URL or is invalid.","code":404,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e543f971-428d-4c18-b64e-e9be65c0b378","name":"Response_200","originalRequest":{"method":"GET","header":[{"key":"x-eHub-APIKey","value":"","description":"When invoking e-Hub API resources, this parameter is the AEMO-supplied API Key. Note that an API Key is issued for each combination of API and ParticipantID. API Keys are sourced from the AEMO API Portal. Initial API Keys are allocated as part of the registration and accreditation process"},{"key":"Accept","value":"application/xml"}],"url":{"raw":"https://apis.preprod.aemo.com.au:9319/ws/HubMessageManagement/1.0/ping?initiatingParticipantID=","host":["https://apis.preprod.aemo.com.au:9319/ws/HubMessageManagement/1.0"],"path":["ping"],"query":[{"key":"initiatingParticipantID","value":"","description":"ParticipantID of the Participant invoking the API Note- If the API keys and certificates issued against the ParticipantID does not match with the ParticipantID passed in the query string, the system will send an exception"}]},"description":"Returns response code to state if the core e-Hub applications are available / operational. This API/resource will be used by the Participants to\n- Test if the Participant application / gateway is able to establish connectivity with the e-Hub and/or\n- Validate if the SSL configuration / certificates are valid and/or\n- Check if the core e-Hub applications are available "},"status":"Successful Ping i.e. Participant is able to connect to e-Hub, authentication & authorisation is valid and the e-Hub is operational.","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"