Needio.Services

<back to all web services

GetMyStoreInfosRequest

Requires Authentication
Required role:Approved
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
APIKeyformstringNo
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 .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 /Store/GetMyStoreInfos/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"SearchText":"String","ListType":0,"IncludeNotOpenYn":false,"IncludeOpenYn":false,"start":"\/Date(1634660021823+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Stores":[{"StoreId":0,"StoreName":"String","StoreHeader":"String","Description":"String","PostTypeId":0,"FriendlyURL":"String","StoreCategory1Id":0,"StoreSubCategory1Id":0}],"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}