{"info":{"_postman_id":"5a31a46a-0841-4b2c-9243-97214ae5b8f7","name":"P2PMessagingSync - aseXML:r38","description":"

The B2BMessagingAsync API is a B2B SMP APIs used to exchange the following Peer-to-Peer information via the e-Hub:

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10032049","collectionId":"5a31a46a-0841-4b2c-9243-97214ae5b8f7","publishedId":"2s93CNNDCH","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-02-24T03:29:14.000Z"},"item":[{"name":"postMessages - Free-form data","id":"a2874af4-ffe5-43d7-a241-3dce3f16aeb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"

Message ID defined by the Participant. \nThe messageContextID is used in the following ways:

\n
    \n
  1. To provide a contextID for the message exchange. The participant/e-Hub uses the contextID of the original request when delivering its corresponding MACK(s).
    2. \n
  2. If the Recipient is on FTP, the filename is set to .zip.
    3. \n
  3. The name of the archive files is set to .zip.
    4. \n
  4. To provide context to the failure messages to be returned where the incoming payload is unreadable such as, the payload is schema invalid.
    5. \n
\n

Format of is: [TransactionGroup 0-9_a-z]{1,4} + [Priority h|m|l] + \"\" + [FromParticipantID]{1,10} + \"\" + [0-9_a-z]{1,18}

\n

NOTE: Transaction Group ‘PTPE’ will be used to exchange free form information and/or attachments between the participants

\n","key":"messageContextID.","value":"ptpem__abcd1234"},{"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

\n","key":"x-eHub-APIKey","value":""},{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\r\n\t
\r\n\t\tinitiatingParticipantID\r\n\t\ttoParticipantID\r\n\t\tMsg_07042020232022650\r\n\t\t2005-10-15T01:02:40+10:00\r\n\t\tPTPE\r\n\t\tMedium\r\n\t\tNEM\r\n\t
\r\n\t\r\n\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\tMsg_07042020232022650_Txn_07042020232022650\r\n\t\t\t\r\n\t\t\r\n\t\r\n"},"url":"https://apis.preprod.aemo.com.au:9319/ws/P2PMessagingSync/1.0/messages","description":"

Used to exchange free-form data and/or attachments

\n","urlObject":{"path":["messages"],"host":["https://apis.preprod.aemo.com.au:9319/ws/P2PMessagingSync/1.0"],"query":[],"variable":[]}},"response":[{"id":"7e2cea06-f8f9-4eed-a51f-49e63d550c13","name":"Response_500","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"description":"Message ID defined by the Participant. \nThe messageContextID is used in the following ways:\n1. To provide a contextID for the message exchange. The participant/e-Hub uses the contextID of the original request when delivering its corresponding MACK(s).\n2. If the Recipient is on FTP, the filename is set to .zip.\n3. The name of the archive files is set to .zip.\n4. To provide context to the failure messages to be returned where the incoming payload is unreadable such as, the payload is schema invalid.\n\nFormat of is: [TransactionGroup 0-9_a-z]{1,4} + [Priority h|m|l] + \"_\" + [FromParticipantID]{1,10} + \"_\" + [0-9_a-z]{1,18} \n\nNOTE: Transaction Group ‘PTPE’ will be used to exchange free form information and/or attachments between the participants","key":"messageContextID.","value":"ptpem__abcd1234"},{"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":"x-eHub-APIKey","value":""},{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\r\n\t
\r\n\t\tinitiatingParticipantID\r\n\t\ttoParticipantID\r\n\t\tMsg_07042020232022650\r\n\t\t2005-10-15T01:02:40+10:00\r\n\t\tPTPE\r\n\t\tMedium\r\n\t\tNEM\r\n\t
\r\n\t\r\n\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\tMsg_07042020232022650_Txn_07042020232022650\r\n\t\t\t\r\n\t\t\r\n\t\r\n"},"url":"https://apis.preprod.aemo.com.au:9319/ws/P2PMessagingSync/1.0/messages","description":"Used to exchange free-form data and/or attachments"},"status":"This response is provided when any unforeseen error is encountered, such as; Certificate/key do not match or incorrect or e-Hub/API/downstream service is not available or Malformed payload.","code":500,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"13ff0b52-96e0-4cb9-87a4-020880c351b4","name":"Response_405","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"description":"Message ID defined by the Participant. \nThe messageContextID is used in the following ways:\n1. To provide a contextID for the message exchange. The participant/e-Hub uses the contextID of the original request when delivering its corresponding MACK(s).\n2. If the Recipient is on FTP, the filename is set to .zip.\n3. The name of the archive files is set to .zip.\n4. To provide context to the failure messages to be returned where the incoming payload is unreadable such as, the payload is schema invalid.\n\nFormat of is: [TransactionGroup 0-9_a-z]{1,4} + [Priority h|m|l] + \"_\" + [FromParticipantID]{1,10} + \"_\" + [0-9_a-z]{1,18} \n\nNOTE: Transaction Group ‘PTPE’ will be used to exchange free form information and/or attachments between the participants","key":"messageContextID.","value":"ptpem__abcd1234"},{"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":"x-eHub-APIKey","value":""},{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\r\n\t
\r\n\t\tinitiatingParticipantID\r\n\t\ttoParticipantID\r\n\t\tMsg_07042020232022650\r\n\t\t2005-10-15T01:02:40+10:00\r\n\t\tPTPE\r\n\t\tMedium\r\n\t\tNEM\r\n\t
\r\n\t\r\n\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\tMsg_07042020232022650_Txn_07042020232022650\r\n\t\t\t\r\n\t\t\r\n\t\r\n"},"url":"https://apis.preprod.aemo.com.au:9319/ws/P2PMessagingSync/1.0/messages","description":"Used to exchange free-form data and/or attachments"},"status":"This response is provided when the method is not POST","code":405,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1d407fa5-8743-4dc8-94f9-1f57a8b30a4a","name":"Response_200","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"description":"Message ID defined by the Participant. \nThe messageContextID is used in the following ways:\n1. To provide a contextID for the message exchange. The participant/e-Hub uses the contextID of the original request when delivering its corresponding MACK(s).\n2. If the Recipient is on FTP, the filename is set to .zip.\n3. The name of the archive files is set to .zip.\n4. To provide context to the failure messages to be returned where the incoming payload is unreadable such as, the payload is schema invalid.\n\nFormat of is: [TransactionGroup 0-9_a-z]{1,4} + [Priority h|m|l] + \"_\" + [FromParticipantID]{1,10} + \"_\" + [0-9_a-z]{1,18} \n\nNOTE: Transaction Group ‘PTPE’ will be used to exchange free form information and/or attachments between the participants","key":"messageContextID.","value":"ptpem__abcd1234"},{"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":"x-eHub-APIKey","value":""},{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\r\n\t
\r\n\t\tinitiatingParticipantID\r\n\t\ttoParticipantID\r\n\t\tMsg_07042020232022650\r\n\t\t2005-10-15T01:02:40+10:00\r\n\t\tPTPE\r\n\t\tMedium\r\n\t\tNEM\r\n\t
\r\n\t\r\n\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\tMsg_07042020232022650_Txn_07042020232022650\r\n\t\t\t\r\n\t\t\r\n\t\r\n"},"url":"https://apis.preprod.aemo.com.au:9319/ws/P2PMessagingSync/1.0/messages","description":"Used to exchange free-form data and/or attachments"},"status":"aseXML hub Acknowledgement (status = ‘Accept’) will be sent","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":""},{"id":"3e595121-c7e8-4ec7-b4f0-7999ec9a42c9","name":"Response_404","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"description":"Message ID defined by the Participant. \nThe messageContextID is used in the following ways:\n1. To provide a contextID for the message exchange. The participant/e-Hub uses the contextID of the original request when delivering its corresponding MACK(s).\n2. If the Recipient is on FTP, the filename is set to .zip.\n3. The name of the archive files is set to .zip.\n4. To provide context to the failure messages to be returned where the incoming payload is unreadable such as, the payload is schema invalid.\n\nFormat of is: [TransactionGroup 0-9_a-z]{1,4} + [Priority h|m|l] + \"_\" + [FromParticipantID]{1,10} + \"_\" + [0-9_a-z]{1,18} \n\nNOTE: Transaction Group ‘PTPE’ will be used to exchange free form information and/or attachments between the participants","key":"messageContextID.","value":"ptpem__abcd1234"},{"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":"x-eHub-APIKey","value":""},{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\r\n\t
\r\n\t\tinitiatingParticipantID\r\n\t\ttoParticipantID\r\n\t\tMsg_07042020232022650\r\n\t\t2005-10-15T01:02:40+10:00\r\n\t\tPTPE\r\n\t\tMedium\r\n\t\tNEM\r\n\t
\r\n\t\r\n\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\tMsg_07042020232022650_Txn_07042020232022650\r\n\t\t\t\r\n\t\t\r\n\t\r\n"},"url":"https://apis.preprod.aemo.com.au:9319/ws/P2PMessagingSync/1.0/messages","description":"Used to exchange free-form data and/or attachments"},"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":"08800dbf-0ced-447f-bb14-cc506c154b44","name":"Response_429","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"description":"Message ID defined by the Participant. \nThe messageContextID is used in the following ways:\n1. To provide a contextID for the message exchange. The participant/e-Hub uses the contextID of the original request when delivering its corresponding MACK(s).\n2. If the Recipient is on FTP, the filename is set to .zip.\n3. The name of the archive files is set to .zip.\n4. To provide context to the failure messages to be returned where the incoming payload is unreadable such as, the payload is schema invalid.\n\nFormat of is: [TransactionGroup 0-9_a-z]{1,4} + [Priority h|m|l] + \"_\" + [FromParticipantID]{1,10} + \"_\" + [0-9_a-z]{1,18} \n\nNOTE: Transaction Group ‘PTPE’ will be used to exchange free form information and/or attachments between the participants","key":"messageContextID.","value":"ptpem__abcd1234"},{"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":"x-eHub-APIKey","value":""},{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\r\n\t
\r\n\t\tinitiatingParticipantID\r\n\t\ttoParticipantID\r\n\t\tMsg_07042020232022650\r\n\t\t2005-10-15T01:02:40+10:00\r\n\t\tPTPE\r\n\t\tMedium\r\n\t\tNEM\r\n\t
\r\n\t\r\n\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\tMsg_07042020232022650_Txn_07042020232022650\r\n\t\t\t\r\n\t\t\r\n\t\r\n"},"url":"https://apis.preprod.aemo.com.au:9319/ws/P2PMessagingSync/1.0/messages","description":"Used to exchange free-form data and/or attachments"},"status":"This response is provided when the throttling limits are reached.","code":429,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0940047f-318e-4294-a6a1-78560ba8bb85","name":"Response_400","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"description":"Message ID defined by the Participant. \nThe messageContextID is used in the following ways:\n1. To provide a contextID for the message exchange. The participant/e-Hub uses the contextID of the original request when delivering its corresponding MACK(s).\n2. If the Recipient is on FTP, the filename is set to .zip.\n3. The name of the archive files is set to .zip.\n4. To provide context to the failure messages to be returned where the incoming payload is unreadable such as, the payload is schema invalid.\n\nFormat of is: [TransactionGroup 0-9_a-z]{1,4} + [Priority h|m|l] + \"_\" + [FromParticipantID]{1,10} + \"_\" + [0-9_a-z]{1,18} \n\nNOTE: Transaction Group ‘PTPE’ will be used to exchange free form information and/or attachments between the participants","key":"messageContextID.","value":"ptpem__abcd1234"},{"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":"x-eHub-APIKey","value":""},{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\r\n\t
\r\n\t\tinitiatingParticipantID\r\n\t\ttoParticipantID\r\n\t\tMsg_07042020232022650\r\n\t\t2005-10-15T01:02:40+10:00\r\n\t\tPTPE\r\n\t\tMedium\r\n\t\tNEM\r\n\t
\r\n\t\r\n\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\tMsg_07042020232022650_Txn_07042020232022650\r\n\t\t\t\r\n\t\t\r\n\t\r\n"},"url":"https://apis.preprod.aemo.com.au:9319/ws/P2PMessagingSync/1.0/messages","description":"Used to exchange free-form data and/or attachments"},"status":"This response is provided when the submitted payload cannot be passed successfully.","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a2874af4-ffe5-43d7-a241-3dce3f16aeb4"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"69359b86-96c4-4e3f-a44a-98df50a7ef05"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8fd601ad-f96d-47ce-8503-f446af4d9128"}}],"variable":[{"key":"default","value":"https://apis.preprod.aemo.com.au:9319/ws/P2PMessagingSync/1.0"},{"key":"default1","value":"https://apis.prod.aemo.com.au:9319/ws/P2PMessagingSync/1.0"},{"key":"default2","value":"https://apis.preprod.marketnet.net.au:9319/ws/P2PMessagingSync/1.0"},{"key":"default3","value":"https://apis.prod.marketnet.net.au:9319/ws/P2PMessagingSync/1.0"},{"key":"APIKey","value":""},{"key":"participantId","value":""}]}