Needio.Services

<back to all web services

GetChatListRequest

Requires Authentication
The following routes are available for this service:
All Verbs/Chat/GetChatList/
GetChatListRequest Parameters:
NameParameterData TypeRequiredDescription
includeSaleChatsqueryboolNo
includeP2PChatsqueryboolNo
SelectedSessionIdquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
GetChatListResponse Parameters:
NameParameterData TypeRequiredDescription
ChatsformList<ChatSession>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
ChatSession Parameters:
NameParameterData TypeRequiredDescription
IdformObjectIdNo
StoreIdformint?No
StoreMediaIdformint?No
MediaFileNameformstringNo
SalerIdformint?No
BuyerIdformint?No
SalerDescformstringNo
BuyerDescformstringNo
StartDateformDateTimeNo
LastMessageDateformDateTimeNo
LastSeqIdformintNo
CpSeqIdformintNo
MessageCountformintNo
StatusformChatStatusesNo
ChatTypeformChatTypesNo
UsersformList<ChatUser>No
LastMessageformstringNo
BGColorformstringNo
BasketIdformintNo
ChatStatuses Enum:
NameValue
Active1
WaitForSalerAction2
WaitForBuyerAction3
WaitForAdminAction4
WaitForRateAction5
WaitForShipAction6
Completed10
Archived11
Deleted99
ChatTypes Enum:
NameValue
Sale1
P2P2
ChatUser Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UserNameformstringNo
AvatarformstringNo
LastReadSeqIdformintNo
ActiveYnformintNo
GetChatListResponse Parameters:
NameParameterData TypeRequiredDescription
ChatsformList<ChatSession>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Chat/GetChatList/ HTTP/1.1 
Host: baseservices2.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetChatListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <SelectedSessionId>String</SelectedSessionId>
  <includeP2PChats>false</includeP2PChats>
  <includeSaleChats>false</includeSaleChats>
</GetChatListRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetChatListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <Chats xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.Models">
    <d2p1:ChatSession>
      <d2p1:BGColor>String</d2p1:BGColor>
      <d2p1:BasketId>0</d2p1:BasketId>
      <d2p1:BuyerDesc>String</d2p1:BuyerDesc>
      <d2p1:BuyerId>0</d2p1:BuyerId>
      <d2p1:ChatType>Sale</d2p1:ChatType>
      <d2p1:CpSeqId>0</d2p1:CpSeqId>
      <d2p1:Id xmlns:d4p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson">
        <d4p1:_a>0</d4p1:_a>
        <d4p1:_b>0</d4p1:_b>
        <d4p1:_c>0</d4p1:_c>
      </d2p1:Id>
      <d2p1:LastMessage>String</d2p1:LastMessage>
      <d2p1:LastMessageDate>0001-01-01T00:00:00</d2p1:LastMessageDate>
      <d2p1:LastSeqId>0</d2p1:LastSeqId>
      <d2p1:MediaFileName>String</d2p1:MediaFileName>
      <d2p1:MessageCount>0</d2p1:MessageCount>
      <d2p1:SalerDesc>String</d2p1:SalerDesc>
      <d2p1:SalerId>0</d2p1:SalerId>
      <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
      <d2p1:Status>Active</d2p1:Status>
      <d2p1:StoreId>0</d2p1:StoreId>
      <d2p1:StoreMediaId>0</d2p1:StoreMediaId>
      <d2p1:Users>
        <d2p1:ChatUser>
          <d2p1:ActiveYn>0</d2p1:ActiveYn>
          <d2p1:Avatar>String</d2p1:Avatar>
          <d2p1:LastReadSeqId>0</d2p1:LastReadSeqId>
          <d2p1:UserId>0</d2p1:UserId>
          <d2p1:UserName>String</d2p1:UserName>
        </d2p1:ChatUser>
      </d2p1:Users>
    </d2p1:ChatSession>
  </Chats>
</GetChatListResponse>