Needio.Services

<back to all web services

SendServiceNotificationRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/ServiceMan/SendServiceNotification
SendServiceNotificationRequest Parameters:
NameParameterData TypeRequiredDescription
ServiceIdqueryintNo
TargetsqueryNotificationTargetsNo
NotificationTypesqueryNotificationTypesNo
MessageTemplateTypequeryMessageTemplateTypesNo
MessageTemplateCodequerystringNo
MessageParametersqueryDictionary<string, string>No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
NotificationTargets Enum:
NameValue
Buyer1
StoreUser2
StoreAdmin4
Admin8
NotificationTypes Enum:
NameValue
Common1
NewMessage2
HelpDesk3
DailyReport11
TransRejectedBySaler12
TransApprovedBySaler13
NewTransaction14
TransactionIsRated15
PostIsExpried16
CampaingIsEnding17
TransApprovedByAdmin32
TransRejectedByAdmin33
NewPost51
PriceChange52
RememberTransApprove53
RememberTransRate54
TransApprovedByBuyer55
TransRejectedByBuyer56
TransCancelledByBuyer57
TransExtendShippingDate58
TransAutoRejectForNoCargo59
TransRememberForCargo60
Advertisement61
NewCampaign62
SalerStartShippment63
ReturnCreatedByBuyer71
ReturnRequestApprovedBySaler72
ReturnRequestRejectedBySaler73
ReturnRequestCancelByBuyer74
ReturnApprovedByAdmin75
ReturnRejectedByAdmin76
BuyerStartShippment77
ReturnApprovedBySaler78
ReturnRejectedBySaler79
PostSendApprove80
PostSave81
PostApprove82
PostReject83
PostIsUpdated84
PostPublish85
PostUnpublished86
StoreSendApprove90
StoreSave91
StoreApprove92
StoreReject93
StoreIsUpdated94
StorePublish95
StoreUnpublished96
FollowUser101
FollowStore102
FollowPost103
ReturnAutoRejectForNoCargo104
ReturnRequestRemember105
ReturnRequestApprovedByAdmin106
ReturnRequestAutoApproved107
ReturnRememberDelivery108
ReturnRequestRejectedByAdmin109
ReturnAutoApproved110
ReturnAutoRejectForNoInStore111
PostLowPrice120
PostLowStock121
PostRestock122
ImportFile123
BulkMessages124
DeliveryProblem125
ApproveReturnCargoBySaler126
AddInvoiceForTransaction127
AutoApproveReturnCargoBySalerNotification128
RejectReturnCargoBySaler129
BasketRemember130
BB_Test201
MessageTemplateTypes Enum:
NameValue
Email1
SMS2
FCM3
Document4
GUI11
API12
TicketDesk21

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

<SendServiceNotificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <DeviceUUID>String</DeviceUUID>
  <MessageParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </MessageParameters>
  <MessageTemplateCode>String</MessageTemplateCode>
  <MessageTemplateType>Email</MessageTemplateType>
  <NotificationTypes>Common</NotificationTypes>
  <ServiceId>0</ServiceId>
  <Targets>Buyer</Targets>
</SendServiceNotificationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendServiceNotificationResponse 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>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
</SendServiceNotificationResponse>