Needio.Services

<back to all web services

GetChatMessageRequest

Requires Authentication
The following routes are available for this service:
All Verbs/Chat/GetChatMessage/{MessageId}
GetChatMessageRequest Parameters:
NameParameterData TypeRequiredDescription
MessageIdpathstringNo
ReadYnqueryboolNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
GetChatMessageResponse Parameters:
NameParameterData TypeRequiredDescription
MessageformChatMessageNo
ChatformChatSessionNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
ChatMessage Parameters:
NameParameterData TypeRequiredDescription
IdformObjectIdNo
ChatIdformObjectIdNo
SeqIdformintNo
SenderIdformintNo
StoreIdformint?No
BuyerIdformint?No
BuyerNameformstringNo
ReceiverIdformint?No
DateformDateTimeNo
TypeformMessageTypesNo
TextformstringNo
MediaformChatMediaNo
LocationformGeoLocationNo
Location2formGeoLocationNo
RefNoformstringNo
MessageTypes Enum:
NameValue
Text1
Media2
Location3
Basket4
PaymentRequest11
Payment12
Approve21
Review22
Auto101
Cargo102
ChatMedia Parameters:
NameParameterData TypeRequiredDescription
IdformObjectIdNo
MediaTypeformMediaTypesNo
FileNameformstringNo
SourceformstringNo
MediaMimeformstringNo
UrlformstringNo
MediaTypes Enum:
NameValue
icon0
Image1
Video2
Youtube3
Pdf8
File9
Custom10
GeoLocation Parameters:
NameParameterData TypeRequiredDescription
LonformstringNo
LatformstringNo
GeoAddressformstringNo
IsDeletedformboolNo
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
GetChatMessageResponse Parameters:
NameParameterData TypeRequiredDescription
MessageformChatMessageNo
ChatformChatSessionNo

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/GetChatMessage/{MessageId} HTTP/1.1 
Host: baseservices2.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<GetChatMessageResponse 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>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <Chat xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.Models">
    <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:d3p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson">
      <d3p1:_a>0</d3p1:_a>
      <d3p1:_b>0</d3p1:_b>
      <d3p1:_c>0</d3p1:_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>
  </Chat>
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.Models">
    <d2p1:BuyerId>0</d2p1:BuyerId>
    <d2p1:BuyerName>String</d2p1:BuyerName>
    <d2p1:ChatId xmlns:d3p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson">
      <d3p1:_a>0</d3p1:_a>
      <d3p1:_b>0</d3p1:_b>
      <d3p1:_c>0</d3p1:_c>
    </d2p1:ChatId>
    <d2p1:Date>0001-01-01T00:00:00</d2p1:Date>
    <d2p1:Id xmlns:d3p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson">
      <d3p1:_a>0</d3p1:_a>
      <d3p1:_b>0</d3p1:_b>
      <d3p1:_c>0</d3p1:_c>
    </d2p1:Id>
    <d2p1:Location>
      <d2p1:GeoAddress>String</d2p1:GeoAddress>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:Lat>String</d2p1:Lat>
      <d2p1:Lon>String</d2p1:Lon>
    </d2p1:Location>
    <d2p1:Location2>
      <d2p1:GeoAddress>String</d2p1:GeoAddress>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:Lat>String</d2p1:Lat>
      <d2p1:Lon>String</d2p1:Lon>
    </d2p1:Location2>
    <d2p1:Media>
      <d2p1:FileName>String</d2p1:FileName>
      <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:MediaMime>String</d2p1:MediaMime>
      <d2p1:MediaType>icon</d2p1:MediaType>
      <d2p1:Source>String</d2p1:Source>
      <d2p1:Url>String</d2p1:Url>
    </d2p1:Media>
    <d2p1:ReceiverId>0</d2p1:ReceiverId>
    <d2p1:RefNo>String</d2p1:RefNo>
    <d2p1:SenderId>0</d2p1:SenderId>
    <d2p1:SeqId>0</d2p1:SeqId>
    <d2p1:StoreId>0</d2p1:StoreId>
    <d2p1:Text>String</d2p1:Text>
    <d2p1:Type>Text</d2p1:Type>
  </Message>
</GetChatMessageResponse>