Needio.Services

<back to all web services

GetXmlTemplateRequest

The following routes are available for this service:
All Verbs/XmlJob/GetXmlTemplate/
GetXmlTemplateRequest Parameters:
NameParameterData TypeRequiredDescription
XmlTemplateIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetXmlTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
XmlPostTemplateformXmlPostTemplateDtoNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
XmlPostTemplateDto Parameters:
NameParameterData TypeRequiredDescription
XmlPostTemplateIdformintNo
NameformstringNo
PostTemplateformXMLPostTemplateParametersModelNo
UpdateParametersformstringNo
XMLPostTemplateParametersModel Parameters:
NameParameterData TypeRequiredDescription
XMLPostFieldMatchesformXMLPostFieldMatchesModelNo
XMLCategoryMatchesformList<XMLCategoryMatchModel>No
XMLAttributeMatchesformList<XMLAttributeMatchModel>No
XMLDefaultValuesformList<XMLDefaultValues>No
XMLPostFieldMatchesModel Parameters:
NameParameterData TypeRequiredDescription
RootProductIdformstringNo
JQueryCategoryNodeformstringNo
PostNodeNameformstringNo
PostSourceIdformstringNo
PostNameformstringNo
PostHeaderformstringNo
SummaryformstringNo
DescriptionformstringNo
MaxDeliveryDayformstringNo
BrandKeyformstringNo
BrandNameformstringNo
CategoreyKeyformstringNo
CategoreyNameformstringNo
InStockformstringNo
StockCodeformstringNo
EanCodeformstringNo
PostAttributesNodeNameformstringNo
PostAttributesNodeAttributeNameformstringNo
PostAttributesNodeAttributeValueformstringNo
PostVariantsNodeNameformstringNo
PostVariantsVariantSourceIdformstringNo
PostVariantsVariantKey1formstringNo
PostVariantsVariantValue1formstringNo
PostVariantsVariantKey2formstringNo
PostVariantsVariantValue2formstringNo
PostVariantsVariantKey3formstringNo
PostVariantsVariantValue3formstringNo
PostVariantsVariantKey4formstringNo
PostVariantsVariantValue4formstringNo
PostVariantsVariantStockCodeformstringNo
PostVariantsVariantImageUrlformstringNo
PostVariantsVariantListPriceformstringNo
PostVariantsVariantSalePriceformstringNo
PostVariantsVariantEanCodeformstringNo
PostVariantsVariantQuantityformstringNo
PostMediasNodeNameformstringNo
PostMediasMediaUrlformstringNo
PostMediasMediaTypeformstringNo
ListPriceformstringNo
SalePriceformstringNo
PriceTypeformstringNo
DiscountTypeformstringNo
DiscountBeginDateformstringNo
DiscountEndDateformstringNo
XMLCategoryMatchModel Parameters:
NameParameterData TypeRequiredDescription
SourceCategoryNameformstringNo
CategoryKeyformstringNo
CategoryIdformint?No
CategoryNameformstringNo
XMLAttributeMatchModel Parameters:
NameParameterData TypeRequiredDescription
SourceNameformstringNo
NeedionKeyformintNo
LabelTextformstringNo
XMLDefaultValues Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
GetXmlTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
XmlPostTemplateformXmlPostTemplateDtoNo

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

HTTP + CSV

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

POST /XmlJob/GetXmlTemplate/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"XmlTemplateId":0,"start":"\/Date(1635310272467+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"XmlPostTemplate":{"XmlPostTemplateId":0,"Name":"String","PostTemplate":{"XMLPostFieldMatches":{"RootProductId":"String","JQueryCategoryNode":"String","PostNodeName":"String","PostSourceId":"String","PostName":"String","PostHeader":"String","Summary":"String","Description":"String","MaxDeliveryDay":"String","BrandKey":"String","BrandName":"String","CategoreyKey":"String","CategoreyName":"String","InStock":"String","StockCode":"String","EanCode":"String","PostAttributesNodeName":"String","PostAttributesNodeAttributeName":"String","PostAttributesNodeAttributeValue":"String","PostVariantsNodeName":"String","PostVariantsVariantSourceId":"String","PostVariantsVariantKey1":"String","PostVariantsVariantValue1":"String","PostVariantsVariantKey2":"String","PostVariantsVariantValue2":"String","PostVariantsVariantKey3":"String","PostVariantsVariantValue3":"String","PostVariantsVariantKey4":"String","PostVariantsVariantValue4":"String","PostVariantsVariantStockCode":"String","PostVariantsVariantImageUrl":"String","PostVariantsVariantListPrice":"String","PostVariantsVariantSalePrice":"String","PostVariantsVariantEanCode":"String","PostVariantsVariantQuantity":"String","PostMediasNodeName":"String","PostMediasMediaUrl":"String","PostMediasMediaType":"String","ListPrice":"String","SalePrice":"String","PriceType":"String","DiscountType":"String","DiscountBeginDate":"String","DiscountEndDate":"String"},"XMLCategoryMatches":[{"SourceCategoryName":"String","CategoryKey":"String","CategoryId":0,"CategoryName":"String"}],"XMLAttributeMatches":[{"SourceName":"String","NeedionKey":0,"LabelText":"String"}],"XMLDefaultValues":[{"Name":"String","Value":"String"}]},"UpdateParameters":"String"},"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}