GET Setup/ServiceBusMessage/Initialize

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
MessageType	ServiceBusMessageType	None.
ChannelType	ServiceBusChannelType	None.
MessageSource	string	None.
MessageTarget	string	None.
MessageHeader	string	None.
MessageDateUtc	date	None.
MessageSourceReferenceID	string	None.
MessagePayload	string	None.
MessagePayloadProps	Collection of Object	None.
MessageResults	string	None.
SubscriberDetails	Collection of ServiceBusMessageSubscriberDetailDTO	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
EventStatus	string	None.
MessageID	integer	None.
MessageState	ServiceBusMessageState	None.

Response Formats

application/json, text/json

Sample:

{
  "messageType": 1,
  "channelType": 1,
  "messageSource": "sample string 1",
  "messageTarget": "sample string 2",
  "messageHeader": "sample string 3",
  "messageDateUtc": "2024-12-04T08:00:30.8230916+00:00",
  "messageSourceReferenceID": "sample string 5",
  "messagePayload": "sample string 6",
  "messageResults": "sample string 7",
  "subscriberDetails": [
    {
      "subscriberDetailID": 1,
      "messageID": 2,
      "messageTarget": "sample string 3",
      "messageState": 1,
      "results": "sample string 4",
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T08:00:30.8230916+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:00:30 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:00:30.8230916+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:00:30 AM"
      }
    },
    {
      "subscriberDetailID": 1,
      "messageID": 2,
      "messageTarget": "sample string 3",
      "messageState": 1,
      "results": "sample string 4",
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T08:00:30.8230916+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:00:30 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:00:30.8230916+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:00:30 AM"
      }
    }
  ],
  "recordState": 1,
  "created": {
    "dateUtc": "2024-12-04T08:00:30.8230916+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:00:30 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T08:00:30.8230916+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:00:30 AM"
  },
  "eventStatus": "sample string 8",
  "messageID": 9,
  "messageState": 1
}

application/xml, text/xml

Sample:

<ServiceBusMessageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <MessageID>9</MessageID>
  <MessageState>New</MessageState>
  <ChannelType>PointToPoint</ChannelType>
  <Created>
    <DateUtc>2024-12-04T08:00:30.8230916+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <EventStatus>sample string 8</EventStatus>
  <LastUpdated>
    <DateUtc>2024-12-04T08:00:30.8230916+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <MessageDateUtc>2024-12-04T08:00:30.8230916+00:00</MessageDateUtc>
  <MessageHeader>sample string 3</MessageHeader>
  <MessagePayload>sample string 6</MessagePayload>
  <MessagePayloadProps xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
  <MessageResults>sample string 7</MessageResults>
  <MessageSource>sample string 1</MessageSource>
  <MessageSourceReferenceID>sample string 5</MessageSourceReferenceID>
  <MessageTarget>sample string 2</MessageTarget>
  <MessageType>Event</MessageType>
  <RecordState>Active</RecordState>
  <SubscriberDetails>
    <ServiceBusMessageSubscriberDetailDTO>
      <Created>
        <DateUtc>2024-12-04T08:00:30.8230916+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T08:00:30.8230916+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <MessageID>2</MessageID>
      <MessageState>New</MessageState>
      <MessageTarget>sample string 3</MessageTarget>
      <RecordState>Active</RecordState>
      <Results>sample string 4</Results>
      <SubscriberDetailID>1</SubscriberDetailID>
    </ServiceBusMessageSubscriberDetailDTO>
    <ServiceBusMessageSubscriberDetailDTO>
      <Created>
        <DateUtc>2024-12-04T08:00:30.8230916+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T08:00:30.8230916+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <MessageID>2</MessageID>
      <MessageState>New</MessageState>
      <MessageTarget>sample string 3</MessageTarget>
      <RecordState>Active</RecordState>
      <Results>sample string 4</Results>
      <SubscriberDetailID>1</SubscriberDetailID>
    </ServiceBusMessageSubscriberDetailDTO>
  </SubscriberDetails>
</ServiceBusMessageDTO>

application/x-compressed-json

Sample:

�풱N�0�_��JJ'�4R@�M'��:G��8�� EQ���G�p��,l��|������_�\�֬��o�a��3��!���M�����խ���d�B| r�J0Aq
���#2f`c�E(��,�3�$I	I#r�Ј,�ř��ߤ��	H7�������
+<d��N�!���VsUmAe`X%,�0x��g���l�d��Xv�Jb<�x�
�r�ip�/;
���n�n޺f��s��(��x>�@�����L�M[��18����x���r�������K�^z;~�*d�