Sign in

v1

latestOpenAPI 3.0.02026-07-23135518615.8 KB
Status Messages

Submit a series of status messages

Allows a Market Participant to submit a series of status messages

post/statusmessage

Headers

X-DIP-Signaturestring required
X-DIP-Signature-Datestring required
X-DIP-Content-Hashstring required
X-DIP-Signature-Certificatestring required

Request body

transactionIDstring nullable required

Transaction ID

senderUniqueReferencestring nullable required

Sender Unique Reference

correlationIDstring nullable required

Correlation Id

sentTimestampstring required

ISO 8601 Date/time

senderIDstring required

DIP Participant Id

recipientIDstring nullable required

DIP Participant Id

DIPConnectionProviderIDstring nullable required

DIP Participant Id

messagestring nullable required

Status/Error messages

helpstring nullable required

Help Text

serviceTicketURLstring nullable required

URL

Example request

[
  {
    "transactionID": "T-IF-006-0123456789-SUP-20220401-1234CC0123456789",
    "senderUniqueReference": "S-IF-005-0123456789-SUP-20222313-12345687a1234567a",
    "correlationID": "CI-20220401-1234567890123abce123092",
    "sentTimestamp": "2022-03-21T19:05:00+00:00",
    "senderID": "1009012345",
    "recipientID": "1009012345",
    "DIPConnectionProviderID": "1009012345",
    "message": "MSG0101 Application 101 error message",
    "help": "Sender Unique reference must take the format S - Interface Id - Participant Id - Role Id - Date - Sequence (hex)/Participant Ref, e.g. ‘S-IF-005-03458900823-SUP-20222313-12345687a’",
    "serviceTicketURL": "https://<baseURL>/nav_to.do?uri=<table name>.do?sys_id=-1%26sysparm_query=<field=value>"
  }
]

Response

Created

timestampstring

ISO 8601 Date/time

Example response

{
  "messageArray": [
    {
      "transactionID": "T-IF-006-0123456789-SUP-20220401-1234CC0123456789",
      "senderUniqueReference": "S-IF-005-0123456789-SUP-20222313-12345687a1234567a",
      "correlationID": "CI-20220401-1234567890123abce123092",
      "sentTimestamp": "2022-03-21T19:05:00+00:00",
      "senderID": "1009012345",
      "recipientID": "1009012345",
      "DIPConnectionProviderID": "1009012345",
      "message": "MSG0101 Application 101 error message",
      "help": "Sender Unique reference must take the format S - Interface Id - Participant Id - Role Id - Date - Sequence (hex)/Participant Ref, e.g. ‘S-IF-005-03458900823-SUP-20222313-12345687a’",
      "serviceTicketURL": "https://<baseURL>/nav_to.do?uri=<table name>.do?sys_id=-1%26sysparm_query=<field=value>"
    }
  ],
  "timestamp": "2022-03-21T19:05:00+00:00"
}