Needio.Services

<back to all web services

SmReasonRequest

The following routes are available for this service:
All Verbs/Trans/GetReasons/
SmReasonRequest Parameters:
NameParameterData TypeRequiredDescription
ReasonTypequerySmReasonTypeNo
PostTypeIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
SmReasonResponse Parameters:
NameParameterData TypeRequiredDescription
ReasonsformList<ReasonDTO>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
ReasonDTO Parameters:
NameParameterData TypeRequiredDescription
ReasonIdformshortNo
ReasonTypeIdformSmReasonTypeNo
PostTypeIdformshortNo
ReasonTextformstringNo
ActiveYnformboolNo
SmReasonType Enum:
NameValue
CancelByBuyer1
RejectBySaler2
ReturnByBuyer11
ReturnRejectBySaler12
ReturnRejectByDelivery13
ReturnRejectByAdmin201
PostRejectByAdmin202
StoreRejectByAdmin203
TransactionRejectByAdmin204
TransactionExtendShipping205
SmReasonResponse Parameters:
NameParameterData TypeRequiredDescription
ReasonsformList<ReasonDTO>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 /Trans/GetReasons/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SmReasonRequest 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>
  <PostTypeId>0</PostTypeId>
  <ReasonType>CancelByBuyer</ReasonType>
</SmReasonRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SmReasonResponse 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>
  <Reasons xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:ReasonDTO>
      <d2p1:ActiveYn>false</d2p1:ActiveYn>
      <d2p1:PostTypeId>0</d2p1:PostTypeId>
      <d2p1:ReasonId>0</d2p1:ReasonId>
      <d2p1:ReasonText>String</d2p1:ReasonText>
      <d2p1:ReasonTypeId>CancelByBuyer</d2p1:ReasonTypeId>
    </d2p1:ReasonDTO>
  </Reasons>
</SmReasonResponse>