POST api/Centers/GetOmniFoldersForUser

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
LocaleId	integer	None.
SiteId	integer	None.
WarehouseId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "LocaleId": 1,
  "SiteId": 1,
  "WarehouseId": 1
}

application/xml, text/xml

Sample:

<GetFoldersForUserRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API.Centers">
  <LocaleId>1</LocaleId>
  <SiteId>1</SiteId>
  <WarehouseId>1</WarehouseId>
</GetFoldersForUserRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetFoldersForUserResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
Folders	Collection of IFolder	None.
PreBackorderFolder	boolean	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "Folders": null,
  "PreBackorderFolder": true,
  "CorrelationId": "sample string 3"
}

application/xml, text/xml

Sample:

<GetFoldersForUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API.Centers">
  <CorrelationId>sample string 3</CorrelationId>
  <Folders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <Message>sample string 1</Message>
  <PreBackorderFolder>true</PreBackorderFolder>
  <ResponseCode>Success</ResponseCode>
</GetFoldersForUserResponse>