Needio.Services

<back to all web services

CreateXmlJobsRequest

The following routes are available for this service:
All Verbs/XmlJob/CreateXmlJobs/
CreateXmlJobsRequest Parameters:
NameParameterData TypeRequiredDescription
XmlJobqueryXmlJobsDtoNo
FileNamequerystringNo
MimeTypequerystringNo
Filequerybyte[]No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
CreateXmlJobsResponse Parameters:
NameParameterData TypeRequiredDescription
XmlJobformXmlJobsDtoNo
XmlImportResultformXmlImportResultNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
XmlJobsDto Parameters:
NameParameterData TypeRequiredDescription
XmlJobIdformintNo
UserIdformintNo
StoreIdformintNo
FileUrlformstringNo
FileTypeformFileTypesNo
XmlPostTemplateIdformintNo
ParametersformXMLStoreParametersModelNo
UpdateParametersformstringNo
CronExpressionformstringNo
JobTypeformJobTypesNo
LastRunDateformDateTime?No
ActiveYnformboolNo
StoreformStoreInfoNo
FileTypes Enum:
NameValue
None0
Xml1
Url2
XMLStoreParametersModel Parameters:
NameParameterData TypeRequiredDescription
XMLPostFieldMatchesJsonformstringNo
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
JobTypes Enum:
NameValue
None0
ForOnce1
Schedule2
StoreInfo Parameters:
NameParameterData TypeRequiredDescription
StoreIdformintNo
StoreNameformstringNo
StoreHeaderformstringNo
DescriptionformstringNo
PostTypeIdformshortNo
FriendlyURLformstringNo
StoreCategory1Idformshort?No
StoreSubCategory1Idformshort?No
XmlImportResult Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ErrorformErrorNo
SuccessCountformintNo
FailCountformintNo
XmlPostErrorResultListformList<XmlPostErrorResult>No
XmlPostErrorResult Parameters:
NameParameterData TypeRequiredDescription
SourceIdformstringNo
PostNameformstringNo
ErrorTextformstringNo
CreateXmlJobsResponse Parameters:
NameParameterData TypeRequiredDescription
XmlJobformXmlJobsDtoNo
XmlImportResultformXmlImportResultNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /XmlJob/CreateXmlJobs/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"XmlJob":{"XmlJobId":0,"UserId":0,"StoreId":0,"FileUrl":"String","FileType":0,"XmlPostTemplateId":0,"Parameters":{"XMLPostFieldMatchesJson":"{\"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\"}","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","CronExpression":"String","JobType":0,"LastRunDate":"\/Date(-62135596800000-0000)\/","ActiveYn":false,"Store":{"StoreId":0,"StoreName":"String","StoreHeader":"String","Description":"String","PostTypeId":0,"FriendlyURL":"String","StoreCategory1Id":0,"StoreSubCategory1Id":0}},"FileName":"String","MimeType":"String","File":"AA==","start":"\/Date(1635043260503+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"XmlJob":{"XmlJobId":0,"UserId":0,"StoreId":0,"FileUrl":"String","FileType":0,"XmlPostTemplateId":0,"Parameters":{"XMLPostFieldMatchesJson":"{\"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\"}","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","CronExpression":"String","JobType":0,"LastRunDate":"\/Date(-62135596800000-0000)\/","ActiveYn":false,"Store":{"StoreId":0,"StoreName":"String","StoreHeader":"String","Description":"String","PostTypeId":0,"FriendlyURL":"String","StoreCategory1Id":0,"StoreSubCategory1Id":0}},"XmlImportResult":{"Result":false,"Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"SuccessCount":0,"FailCount":0,"XmlPostErrorResultList":[{"SourceId":"String","PostName":"String","ErrorText":"String"}]},"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}