POST api/Hub/GetHubMessageByGroupId

Request Information

URI Parameters

None.

Body Parameters

RequestGetHubMessages
NameDescriptionTypeAdditional information
GroupId

globally unique identifier

None.

PageSize

integer

None.

PageIndex

integer

None.

KeyWord

string

None.

SortColumn

string

None.

SortType

EnumSortType

None.

ParamCollection

Dictionary of string [key] and Object [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "GroupId": "f08adebb-485a-461f-bd9e-4f28e08f3db5",
  "PageSize": 2,
  "PageIndex": 3,
  "KeyWord": "sample string 4",
  "SortColumn": "sample string 5",
  "SortType": 0,
  "ParamCollection": {
    "sample string 1": {},
    "sample string 3": {}
  }
}

application/xml, text/xml

Sample:
<RequestGetHubMessages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Isonfor.ECommerce.Common.Entity.Request.Hub">
  <KeyWord xmlns="http://schemas.datacontract.org/2004/07/ZTSoft.Core">sample string 4</KeyWord>
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/ZTSoft.Core">3</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ZTSoft.Core">2</PageSize>
  <ParamCollection xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/ZTSoft.Core">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </ParamCollection>
  <SortColumn xmlns="http://schemas.datacontract.org/2004/07/ZTSoft.Core">sample string 5</SortColumn>
  <SortType xmlns="http://schemas.datacontract.org/2004/07/ZTSoft.Core">Desc</SortType>
  <GroupId>f08adebb-485a-461f-bd9e-4f28e08f3db5</GroupId>
</RequestGetHubMessages>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RequestGetHubMessages'.

Response Information

Resource Description

PagingResultOfHubMessage
NameDescriptionTypeAdditional information
PageSize

integer

None.

PageIndex

integer

None.

Records

integer

None.

TotalPages

integer

None.

PagingInfo

PagingInfo

None.

Data

Collection of HubMessage

None.

Success

boolean

None.

IsSuccess

boolean

None.

Msg

string

None.

Code

integer

None.

StatusCode

string

None.

Errors

Dictionary of string [key] and string [value]

None.

Response Formats

application/json, text/json

Sample:
{
  "PageSize": 1,
  "PageIndex": 2,
  "Records": 3,
  "TotalPages": 3,
  "PagingInfo": {
    "PageIndex": 2,
    "PageSize": 1,
    "TotalCount": 3,
    "TotalPage": 3,
    "Dics": null
  },
  "Data": [
    {
      "Id": "8c8633cb-96a1-4cc7-a3ce-7e32d1858d73",
      "CreateDate": "2023-06-06T16:25:20.9272073+08:00",
      "SendMemberId": "8155914e-6eec-4a8d-9f2e-9d6eec2a7950",
      "SendMemberName": "sample string 4",
      "Message": "sample string 5",
      "GroupId": "c3b41d79-0293-416c-b355-9fdf0232c57e",
      "MessageType": 0,
      "IP": "sample string 7",
      "IsSend": true,
      "SendType": 0,
      "ReceiveMemberId": "dbcddcbd-997c-4820-8256-101e50d11d44"
    },
    {
      "Id": "8c8633cb-96a1-4cc7-a3ce-7e32d1858d73",
      "CreateDate": "2023-06-06T16:25:20.9272073+08:00",
      "SendMemberId": "8155914e-6eec-4a8d-9f2e-9d6eec2a7950",
      "SendMemberName": "sample string 4",
      "Message": "sample string 5",
      "GroupId": "c3b41d79-0293-416c-b355-9fdf0232c57e",
      "MessageType": 0,
      "IP": "sample string 7",
      "IsSend": true,
      "SendType": 0,
      "ReceiveMemberId": "dbcddcbd-997c-4820-8256-101e50d11d44"
    }
  ],
  "Success": true,
  "IsSuccess": true,
  "Msg": "sample string 6",
  "Code": 7,
  "StatusCode": "sample string 8",
  "Errors": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<PagingResultOfHubMessagewQj_SqIeA xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZTSoft.Core">
  <Code>7</Code>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Errors>
  <IsSuccess>true</IsSuccess>
  <Msg>sample string 6</Msg>
  <StatusCode>sample string 8</StatusCode>
  <Success>true</Success>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Isonfor.ECommerce.Common.Entity.Hub">
    <d2p1:HubMessage>
      <d2p1:CreateDate>2023-06-06T16:25:20.9272073+08:00</d2p1:CreateDate>
      <d2p1:GroupId>c3b41d79-0293-416c-b355-9fdf0232c57e</d2p1:GroupId>
      <d2p1:IP>sample string 7</d2p1:IP>
      <d2p1:Id>8c8633cb-96a1-4cc7-a3ce-7e32d1858d73</d2p1:Id>
      <d2p1:IsSend>true</d2p1:IsSend>
      <d2p1:Message>sample string 5</d2p1:Message>
      <d2p1:MessageType>Words</d2p1:MessageType>
      <d2p1:ReceiveMemberId>dbcddcbd-997c-4820-8256-101e50d11d44</d2p1:ReceiveMemberId>
      <d2p1:SendMemberId>8155914e-6eec-4a8d-9f2e-9d6eec2a7950</d2p1:SendMemberId>
      <d2p1:SendMemberName>sample string 4</d2p1:SendMemberName>
      <d2p1:SendType>Chat</d2p1:SendType>
    </d2p1:HubMessage>
    <d2p1:HubMessage>
      <d2p1:CreateDate>2023-06-06T16:25:20.9272073+08:00</d2p1:CreateDate>
      <d2p1:GroupId>c3b41d79-0293-416c-b355-9fdf0232c57e</d2p1:GroupId>
      <d2p1:IP>sample string 7</d2p1:IP>
      <d2p1:Id>8c8633cb-96a1-4cc7-a3ce-7e32d1858d73</d2p1:Id>
      <d2p1:IsSend>true</d2p1:IsSend>
      <d2p1:Message>sample string 5</d2p1:Message>
      <d2p1:MessageType>Words</d2p1:MessageType>
      <d2p1:ReceiveMemberId>dbcddcbd-997c-4820-8256-101e50d11d44</d2p1:ReceiveMemberId>
      <d2p1:SendMemberId>8155914e-6eec-4a8d-9f2e-9d6eec2a7950</d2p1:SendMemberId>
      <d2p1:SendMemberName>sample string 4</d2p1:SendMemberName>
      <d2p1:SendType>Chat</d2p1:SendType>
    </d2p1:HubMessage>
  </Data>
  <PageIndex>2</PageIndex>
  <PageSize>1</PageSize>
  <Records>3</Records>
</PagingResultOfHubMessagewQj_SqIeA>