Needio.Services

<back to all web services

ExtSendChatMessageListRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Ext/SendChatMessages/
ExtSendChatMessageListRequest Parameters:
NameParameterData TypeRequiredDescription
StoreIdqueryintNo
MessagesqueryList<ExternalInMessage>No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
isAdminformboolNo
CmdformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ExYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
ExternalInMessage Parameters:
NameParameterData TypeRequiredDescription
ChatIdformstringNo
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
ThreeD10
Custom99
GeoLocation Parameters:
NameParameterData TypeRequiredDescription
LonformstringNo
LatformstringNo
GeoAddressformstringNo
IsDeletedformboolNo

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 /Ext/SendChatMessages/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ExtSendChatMessageListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <Cmd>String</Cmd>
  <DeviceUUID>String</DeviceUUID>
  <isAdmin>false</isAdmin>
  <start>0001-01-01T00:00:00</start>
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:ExternalInMessage>
      <d2p1:ChatId>String</d2p1:ChatId>
      <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:d5p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson">
          <d5p1:_a>0</d5p1:_a>
          <d5p1:_b>0</d5p1:_b>
          <d5p1:_c>0</d5p1:_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:RefNo>String</d2p1:RefNo>
      <d2p1:Text>String</d2p1:Text>
      <d2p1:Type>Text</d2p1:Type>
    </d2p1:ExternalInMessage>
  </Messages>
  <StoreId>0</StoreId>
</ExtSendChatMessageListRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ExtSendChatMessageListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
    <ExYn>false</ExYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
</ExtSendChatMessageListResponse>