Needio.Services

<back to all web services

GetMyStoreInfosRequest

Requires Authentication
The following routes are available for this service:
All Verbs/Store/GetMyStoreInfos/
GetMyStoreInfosRequest Parameters:
NameParameterData TypeRequiredDescription
SearchTextquerystringNo
ListTypequeryItemListTypes?No
IncludeNotOpenYnqueryboolNo
IncludeOpenYnqueryboolNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
GetMyStoreInfosResponse Parameters:
NameParameterData TypeRequiredDescription
StoresformList<StoreInfo>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
StoreInfo Parameters:
NameParameterData TypeRequiredDescription
StoreIdformintNo
StoreNameformstringNo
StoreHeaderformstringNo
DescriptionformstringNo
PostTypeIdformshortNo
FriendlyURLformstringNo
StoreCategory1Idformshort?No
StoreSubCategory1Idformshort?No
ItemListTypes Enum:
NameValue
Drafts0
ActiveAndDrafts9
Actives10
Archived11
ActiveAndAchive12
All101
GetMyStoreInfosResponse Parameters:
NameParameterData TypeRequiredDescription
StoresformList<StoreInfo>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 /Store/GetMyStoreInfos/ HTTP/1.1 
Host: baseservices2.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetMyStoreInfosRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <DeviceUUID>String</DeviceUUID>
  <IncludeNotOpenYn>false</IncludeNotOpenYn>
  <IncludeOpenYn>false</IncludeOpenYn>
  <ListType>Drafts</ListType>
  <SearchText>String</SearchText>
</GetMyStoreInfosRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetMyStoreInfosResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <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>
  <Stores xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.Models">
    <d2p1:StoreInfo>
      <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:StoreInfo>
  </Stores>
</GetMyStoreInfosResponse>