Needio.Services

<back to all web services

GetXmlJobListRequest

Requires Authentication
The following routes are available for this service:
All Verbs/XmlJob/GetXmlJobList/
GetXmlJobListRequest Parameters:
NameParameterData TypeRequiredDescription
StoreIdqueryintNo
XmlJobIdqueryint?No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetXmlJobListResponse Parameters:
NameParameterData TypeRequiredDescription
XmlJobListformList<XmlJobsDto>No
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
XMLFiltersformList<XMLFilter>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
PostVariantsAttributeNodeformstringNo
PostVariantsAttributeNodeNameformstringNo
PostVariantsAttributeNodeValueformstringNo
PostVariantsVariantSourceIdformstringNo
PostVariantsVariantKey1formstringNo
PostVariantsVariantValue1formstringNo
PostVariantsVariantKey2formstringNo
PostVariantsVariantValue2formstringNo
PostVariantsVariantKey3formstringNo
PostVariantsVariantValue3formstringNo
PostVariantsVariantKey4formstringNo
PostVariantsVariantValue4formstringNo
PostVariantsVariantStockCodeformstringNo
PostVariantsVariantImageUrlformstringNo
PostVariantsVariantListPriceformstringNo
PostVariantsVariantSalePriceformstringNo
PostVariantsVariantOverridenPriceformstringNo
PostVariantsVariantEanCodeformstringNo
PostVariantsVariantQuantityformstringNo
PostMediasNodeNameformstringNo
PostMediasMediaUrlformstringNo
PostMediasMediaTypeformstringNo
ListPriceformstringNo
SalePriceformstringNo
TaxformstringNo
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
XMLFilter Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ConditionformXMLFilterConditionsNo
ValueformstringNo
XMLFilterConditions Enum:
NameValue
Equals1
NotEquals2
JobTypes Enum:
NameValue
None0
ForOnce1
Schedule2
StoreInfo Parameters:
NameParameterData TypeRequiredDescription
StoreIdformintNo
StoreNameformstringNo
StoreHeaderformstringNo
DescriptionformstringNo
PostTypeIdformshortNo
FriendlyURLformstringNo
StoreCategory1Idformshort?No
StoreSubCategory1Idformshort?No
GetXmlJobListResponse Parameters:
NameParameterData TypeRequiredDescription
XmlJobListformList<XmlJobsDto>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 /XmlJob/GetXmlJobList/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetXmlJobListRequest 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>
  <StoreId>0</StoreId>
  <XmlJobId>0</XmlJobId>
</GetXmlJobListRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetXmlJobListResponse 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>
  <XmlJobList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:XmlJobsDto>
      <d2p1:ActiveYn>false</d2p1:ActiveYn>
      <d2p1:CronExpression>String</d2p1:CronExpression>
      <d2p1:FileType>None</d2p1:FileType>
      <d2p1:FileUrl>String</d2p1:FileUrl>
      <d2p1:JobType>None</d2p1:JobType>
      <d2p1:LastRunDate>0001-01-01T00:00:00</d2p1:LastRunDate>
      <d2p1:Parameters>
        <d2p1:XMLAttributeMatches>
          <d2p1:XMLAttributeMatchModel>
            <d2p1:LabelText>String</d2p1:LabelText>
            <d2p1:NeedionKey>0</d2p1:NeedionKey>
            <d2p1:SourceName>String</d2p1:SourceName>
          </d2p1:XMLAttributeMatchModel>
        </d2p1:XMLAttributeMatches>
        <d2p1:XMLCategoryMatches>
          <d2p1:XMLCategoryMatchModel>
            <d2p1:CategoryId>0</d2p1:CategoryId>
            <d2p1:CategoryKey>String</d2p1:CategoryKey>
            <d2p1:CategoryName>String</d2p1:CategoryName>
            <d2p1:SourceCategoryName>String</d2p1:SourceCategoryName>
          </d2p1:XMLCategoryMatchModel>
        </d2p1:XMLCategoryMatches>
        <d2p1:XMLDefaultValues>
          <d2p1:XMLDefaultValues>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:Value>String</d2p1:Value>
          </d2p1:XMLDefaultValues>
        </d2p1:XMLDefaultValues>
        <d2p1:XMLFilters>
          <d2p1:XMLFilter>
            <d2p1:Condition>Equals</d2p1:Condition>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:Value>String</d2p1:Value>
          </d2p1:XMLFilter>
        </d2p1:XMLFilters>
        <d2p1:XMLPostFieldMatches>
          <d2p1:BrandKey>String</d2p1:BrandKey>
          <d2p1:BrandName>String</d2p1:BrandName>
          <d2p1:CategoreyKey>String</d2p1:CategoreyKey>
          <d2p1:CategoreyName>String</d2p1:CategoreyName>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:DiscountBeginDate>String</d2p1:DiscountBeginDate>
          <d2p1:DiscountEndDate>String</d2p1:DiscountEndDate>
          <d2p1:DiscountType>String</d2p1:DiscountType>
          <d2p1:EanCode>String</d2p1:EanCode>
          <d2p1:InStock>String</d2p1:InStock>
          <d2p1:JQueryCategoryNode>String</d2p1:JQueryCategoryNode>
          <d2p1:ListPrice>String</d2p1:ListPrice>
          <d2p1:MaxDeliveryDay>String</d2p1:MaxDeliveryDay>
          <d2p1:PostAttributesNodeAttributeName>String</d2p1:PostAttributesNodeAttributeName>
          <d2p1:PostAttributesNodeAttributeValue>String</d2p1:PostAttributesNodeAttributeValue>
          <d2p1:PostAttributesNodeName>String</d2p1:PostAttributesNodeName>
          <d2p1:PostHeader>String</d2p1:PostHeader>
          <d2p1:PostMediasMediaType>String</d2p1:PostMediasMediaType>
          <d2p1:PostMediasMediaUrl>String</d2p1:PostMediasMediaUrl>
          <d2p1:PostMediasNodeName>String</d2p1:PostMediasNodeName>
          <d2p1:PostName>String</d2p1:PostName>
          <d2p1:PostNodeName>String</d2p1:PostNodeName>
          <d2p1:PostSourceId>String</d2p1:PostSourceId>
          <d2p1:PostVariantsAttributeNode>String</d2p1:PostVariantsAttributeNode>
          <d2p1:PostVariantsAttributeNodeName>String</d2p1:PostVariantsAttributeNodeName>
          <d2p1:PostVariantsAttributeNodeValue>String</d2p1:PostVariantsAttributeNodeValue>
          <d2p1:PostVariantsNodeName>String</d2p1:PostVariantsNodeName>
          <d2p1:PostVariantsVariantEanCode>String</d2p1:PostVariantsVariantEanCode>
          <d2p1:PostVariantsVariantImageUrl>String</d2p1:PostVariantsVariantImageUrl>
          <d2p1:PostVariantsVariantKey1>String</d2p1:PostVariantsVariantKey1>
          <d2p1:PostVariantsVariantKey2>String</d2p1:PostVariantsVariantKey2>
          <d2p1:PostVariantsVariantKey3>String</d2p1:PostVariantsVariantKey3>
          <d2p1:PostVariantsVariantKey4>String</d2p1:PostVariantsVariantKey4>
          <d2p1:PostVariantsVariantListPrice>String</d2p1:PostVariantsVariantListPrice>
          <d2p1:PostVariantsVariantOverridenPrice>String</d2p1:PostVariantsVariantOverridenPrice>
          <d2p1:PostVariantsVariantQuantity>String</d2p1:PostVariantsVariantQuantity>
          <d2p1:PostVariantsVariantSalePrice>String</d2p1:PostVariantsVariantSalePrice>
          <d2p1:PostVariantsVariantSourceId>String</d2p1:PostVariantsVariantSourceId>
          <d2p1:PostVariantsVariantStockCode>String</d2p1:PostVariantsVariantStockCode>
          <d2p1:PostVariantsVariantValue1>String</d2p1:PostVariantsVariantValue1>
          <d2p1:PostVariantsVariantValue2>String</d2p1:PostVariantsVariantValue2>
          <d2p1:PostVariantsVariantValue3>String</d2p1:PostVariantsVariantValue3>
          <d2p1:PostVariantsVariantValue4>String</d2p1:PostVariantsVariantValue4>
          <d2p1:PriceType>String</d2p1:PriceType>
          <d2p1:RootProductId>String</d2p1:RootProductId>
          <d2p1:SalePrice>String</d2p1:SalePrice>
          <d2p1:StockCode>String</d2p1:StockCode>
          <d2p1:Summary>String</d2p1:Summary>
          <d2p1:Tax>String</d2p1:Tax>
        </d2p1:XMLPostFieldMatches>
      </d2p1:Parameters>
      <d2p1:Store>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:FriendlyURL>String</d2p1:FriendlyURL>
        <d2p1:PostTypeId>0</d2p1:PostTypeId>
        <d2p1:StoreCategory1Id>0</d2p1:StoreCategory1Id>
        <d2p1:StoreHeader>String</d2p1:StoreHeader>
        <d2p1:StoreId>0</d2p1:StoreId>
        <d2p1:StoreName>String</d2p1:StoreName>
        <d2p1:StoreSubCategory1Id>0</d2p1:StoreSubCategory1Id>
      </d2p1:Store>
      <d2p1:StoreId>0</d2p1:StoreId>
      <d2p1:UpdateParameters>String</d2p1:UpdateParameters>
      <d2p1:UserId>0</d2p1:UserId>
      <d2p1:XmlJobId>0</d2p1:XmlJobId>
      <d2p1:XmlPostTemplateId>0</d2p1:XmlPostTemplateId>
    </d2p1:XmlJobsDto>
  </XmlJobList>
</GetXmlJobListResponse>