POST api/v1/store/{storeID}/users?page={page}&take={take}

Request Information

URI Parameters

Name	Type	Additional information
storeID	string	Required
page	integer	Default value is 1
take	integer	Default value is 25

Body Parameters

UserSearchRequest

Name	Type	Additional information
IsReverseSort	boolean	None.
SortByField	SortByUserField	None.
SearchTerm	string	None.

Request Formats

application/json, text/json

Sample:

{
  "IsReverseSort": true,
  "SortByField": "Name",
  "SearchTerm": "sample string 2"
}

application/xml, text/xml

Sample:

<UserSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Request">
  <IsReverseSort>true</IsReverseSort>
  <SearchTerm>sample string 2</SearchTerm>
  <SortByField>Name</SortByField>
</UserSearchRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UserSearchRequest'.

multipart/form-data

Sample:

An exception has occurred while using the formatter 'MultiPartMediaFormat' to generate sample for media type 'multipart/form-data'. Exception message: The media type formatter of type 'MultiPartMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/png

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/png'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpeg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpeg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/bmp

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/bmp'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, multipart/form-data, image/png, image/jpg, image/jpeg, image/bmp

Sample:

Sample not available.