GET api/OmsOrderRoutingSummary/order-folder-text?siteId={siteId}&localeId={localeId}

Request Information

URI Parameters

Name	Description	Type	Additional Information
siteId		integer	Required
localeId		integer	Required

Body Parameters

None.

Response Information

Resource Description

OrderFolderRoutingModelResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.
Model	OrderFolderRoutingModel	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Model": {
    "OrderItemStatusRules": {
      "sample string 1": [
        {
          "NextTitle": "sample string 1",
          "CurrentTitle": "sample string 2",
          "CurrentStatusCode": "sample string 3",
          "NextStatusCode": "sample string 4",
          "HasNextStatus": true,
          "HasFolderRoute": true,
          "UiVisible": true
        },
        {
          "NextTitle": "sample string 1",
          "CurrentTitle": "sample string 2",
          "CurrentStatusCode": "sample string 3",
          "NextStatusCode": "sample string 4",
          "HasNextStatus": true,
          "HasFolderRoute": true,
          "UiVisible": true
        }
      ],
      "sample string 2": [
        {
          "NextTitle": "sample string 1",
          "CurrentTitle": "sample string 2",
          "CurrentStatusCode": "sample string 3",
          "NextStatusCode": "sample string 4",
          "HasNextStatus": true,
          "HasFolderRoute": true,
          "UiVisible": true
        },
        {
          "NextTitle": "sample string 1",
          "CurrentTitle": "sample string 2",
          "CurrentStatusCode": "sample string 3",
          "NextStatusCode": "sample string 4",
          "HasNextStatus": true,
          "HasFolderRoute": true,
          "UiVisible": true
        }
      ]
    },
    "OrderItemStatusFolders": {
      "sample string 1": [
        {
          "FolderID": 1,
          "Priority": 2,
          "FolderName": "sample string 3",
          "OrderItemStatusName": "sample string 4",
          "OrderItemStatusCode": "sample string 5",
          "HasOrderItemStatusRule": true,
          "IsDefault": true
        },
        {
          "FolderID": 1,
          "Priority": 2,
          "FolderName": "sample string 3",
          "OrderItemStatusName": "sample string 4",
          "OrderItemStatusCode": "sample string 5",
          "HasOrderItemStatusRule": true,
          "IsDefault": true
        }
      ],
      "sample string 2": [
        {
          "FolderID": 1,
          "Priority": 2,
          "FolderName": "sample string 3",
          "OrderItemStatusName": "sample string 4",
          "OrderItemStatusCode": "sample string 5",
          "HasOrderItemStatusRule": true,
          "IsDefault": true
        },
        {
          "FolderID": 1,
          "Priority": 2,
          "FolderName": "sample string 3",
          "OrderItemStatusName": "sample string 4",
          "OrderItemStatusCode": "sample string 5",
          "HasOrderItemStatusRule": true,
          "IsDefault": true
        }
      ]
    },
    "OrderStatusFolders": {
      "sample string 1": [
        {
          "FolderID": 1,
          "Priority": 2,
          "FolderName": "sample string 3",
          "OrderStatusName": "sample string 4",
          "OrderStatusCode": "sample string 5"
        },
        {
          "FolderID": 1,
          "Priority": 2,
          "FolderName": "sample string 3",
          "OrderStatusName": "sample string 4",
          "OrderStatusCode": "sample string 5"
        }
      ],
      "sample string 2": [
        {
          "FolderID": 1,
          "Priority": 2,
          "FolderName": "sample string 3",
          "OrderStatusName": "sample string 4",
          "OrderStatusCode": "sample string 5"
        },
        {
          "FolderID": 1,
          "Priority": 2,
          "FolderName": "sample string 3",
          "OrderStatusName": "sample string 4",
          "OrderStatusCode": "sample string 5"
        }
      ]
    },
    "DefaultFolderName": "sample string 1",
    "CurrentSiteId": 1,
    "Sites": null
  }
}

application/xml, text/xml

Sample:

<OrderFolderRoutingModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <Model xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
    <d2p1:CurrentSiteId>1</d2p1:CurrentSiteId>
    <d2p1:DefaultFolderName>sample string 1</d2p1:DefaultFolderName>
    <d2p1:OrderItemStatusFolders xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfOrderItemFolderModelu8r8mg3u>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>
          <d2p1:OrderItemFolderModel>
            <d2p1:FolderID>1</d2p1:FolderID>
            <d2p1:FolderName>sample string 3</d2p1:FolderName>
            <d2p1:HasOrderItemStatusRule>true</d2p1:HasOrderItemStatusRule>
            <d2p1:IsDefault>true</d2p1:IsDefault>
            <d2p1:OrderItemStatusCode>sample string 5</d2p1:OrderItemStatusCode>
            <d2p1:OrderItemStatusName>sample string 4</d2p1:OrderItemStatusName>
            <d2p1:Priority>2</d2p1:Priority>
          </d2p1:OrderItemFolderModel>
          <d2p1:OrderItemFolderModel>
            <d2p1:FolderID>1</d2p1:FolderID>
            <d2p1:FolderName>sample string 3</d2p1:FolderName>
            <d2p1:HasOrderItemStatusRule>true</d2p1:HasOrderItemStatusRule>
            <d2p1:IsDefault>true</d2p1:IsDefault>
            <d2p1:OrderItemStatusCode>sample string 5</d2p1:OrderItemStatusCode>
            <d2p1:OrderItemStatusName>sample string 4</d2p1:OrderItemStatusName>
            <d2p1:Priority>2</d2p1:Priority>
          </d2p1:OrderItemFolderModel>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfOrderItemFolderModelu8r8mg3u>
      <d3p1:KeyValueOfstringArrayOfOrderItemFolderModelu8r8mg3u>
        <d3p1:Key>sample string 2</d3p1:Key>
        <d3p1:Value>
          <d2p1:OrderItemFolderModel>
            <d2p1:FolderID>1</d2p1:FolderID>
            <d2p1:FolderName>sample string 3</d2p1:FolderName>
            <d2p1:HasOrderItemStatusRule>true</d2p1:HasOrderItemStatusRule>
            <d2p1:IsDefault>true</d2p1:IsDefault>
            <d2p1:OrderItemStatusCode>sample string 5</d2p1:OrderItemStatusCode>
            <d2p1:OrderItemStatusName>sample string 4</d2p1:OrderItemStatusName>
            <d2p1:Priority>2</d2p1:Priority>
          </d2p1:OrderItemFolderModel>
          <d2p1:OrderItemFolderModel>
            <d2p1:FolderID>1</d2p1:FolderID>
            <d2p1:FolderName>sample string 3</d2p1:FolderName>
            <d2p1:HasOrderItemStatusRule>true</d2p1:HasOrderItemStatusRule>
            <d2p1:IsDefault>true</d2p1:IsDefault>
            <d2p1:OrderItemStatusCode>sample string 5</d2p1:OrderItemStatusCode>
            <d2p1:OrderItemStatusName>sample string 4</d2p1:OrderItemStatusName>
            <d2p1:Priority>2</d2p1:Priority>
          </d2p1:OrderItemFolderModel>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfOrderItemFolderModelu8r8mg3u>
    </d2p1:OrderItemStatusFolders>
    <d2p1:OrderItemStatusRules xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfOrderItemStatusRuleModelu8r8mg3u>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>
          <d2p1:OrderItemStatusRuleModel>
            <d2p1:CurrentStatusCode>sample string 3</d2p1:CurrentStatusCode>
            <d2p1:CurrentTitle>sample string 2</d2p1:CurrentTitle>
            <d2p1:HasFolderRoute>true</d2p1:HasFolderRoute>
            <d2p1:HasNextStatus>true</d2p1:HasNextStatus>
            <d2p1:NextStatusCode>sample string 4</d2p1:NextStatusCode>
            <d2p1:NextTitle>sample string 1</d2p1:NextTitle>
            <d2p1:UiVisible>true</d2p1:UiVisible>
          </d2p1:OrderItemStatusRuleModel>
          <d2p1:OrderItemStatusRuleModel>
            <d2p1:CurrentStatusCode>sample string 3</d2p1:CurrentStatusCode>
            <d2p1:CurrentTitle>sample string 2</d2p1:CurrentTitle>
            <d2p1:HasFolderRoute>true</d2p1:HasFolderRoute>
            <d2p1:HasNextStatus>true</d2p1:HasNextStatus>
            <d2p1:NextStatusCode>sample string 4</d2p1:NextStatusCode>
            <d2p1:NextTitle>sample string 1</d2p1:NextTitle>
            <d2p1:UiVisible>true</d2p1:UiVisible>
          </d2p1:OrderItemStatusRuleModel>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfOrderItemStatusRuleModelu8r8mg3u>
      <d3p1:KeyValueOfstringArrayOfOrderItemStatusRuleModelu8r8mg3u>
        <d3p1:Key>sample string 2</d3p1:Key>
        <d3p1:Value>
          <d2p1:OrderItemStatusRuleModel>
            <d2p1:CurrentStatusCode>sample string 3</d2p1:CurrentStatusCode>
            <d2p1:CurrentTitle>sample string 2</d2p1:CurrentTitle>
            <d2p1:HasFolderRoute>true</d2p1:HasFolderRoute>
            <d2p1:HasNextStatus>true</d2p1:HasNextStatus>
            <d2p1:NextStatusCode>sample string 4</d2p1:NextStatusCode>
            <d2p1:NextTitle>sample string 1</d2p1:NextTitle>
            <d2p1:UiVisible>true</d2p1:UiVisible>
          </d2p1:OrderItemStatusRuleModel>
          <d2p1:OrderItemStatusRuleModel>
            <d2p1:CurrentStatusCode>sample string 3</d2p1:CurrentStatusCode>
            <d2p1:CurrentTitle>sample string 2</d2p1:CurrentTitle>
            <d2p1:HasFolderRoute>true</d2p1:HasFolderRoute>
            <d2p1:HasNextStatus>true</d2p1:HasNextStatus>
            <d2p1:NextStatusCode>sample string 4</d2p1:NextStatusCode>
            <d2p1:NextTitle>sample string 1</d2p1:NextTitle>
            <d2p1:UiVisible>true</d2p1:UiVisible>
          </d2p1:OrderItemStatusRuleModel>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfOrderItemStatusRuleModelu8r8mg3u>
    </d2p1:OrderItemStatusRules>
    <d2p1:OrderStatusFolders xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfOrderFolderModelu8r8mg3u>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>
          <d2p1:OrderFolderModel>
            <d2p1:FolderID>1</d2p1:FolderID>
            <d2p1:FolderName>sample string 3</d2p1:FolderName>
            <d2p1:OrderStatusCode>sample string 5</d2p1:OrderStatusCode>
            <d2p1:OrderStatusName>sample string 4</d2p1:OrderStatusName>
            <d2p1:Priority>2</d2p1:Priority>
          </d2p1:OrderFolderModel>
          <d2p1:OrderFolderModel>
            <d2p1:FolderID>1</d2p1:FolderID>
            <d2p1:FolderName>sample string 3</d2p1:FolderName>
            <d2p1:OrderStatusCode>sample string 5</d2p1:OrderStatusCode>
            <d2p1:OrderStatusName>sample string 4</d2p1:OrderStatusName>
            <d2p1:Priority>2</d2p1:Priority>
          </d2p1:OrderFolderModel>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfOrderFolderModelu8r8mg3u>
      <d3p1:KeyValueOfstringArrayOfOrderFolderModelu8r8mg3u>
        <d3p1:Key>sample string 2</d3p1:Key>
        <d3p1:Value>
          <d2p1:OrderFolderModel>
            <d2p1:FolderID>1</d2p1:FolderID>
            <d2p1:FolderName>sample string 3</d2p1:FolderName>
            <d2p1:OrderStatusCode>sample string 5</d2p1:OrderStatusCode>
            <d2p1:OrderStatusName>sample string 4</d2p1:OrderStatusName>
            <d2p1:Priority>2</d2p1:Priority>
          </d2p1:OrderFolderModel>
          <d2p1:OrderFolderModel>
            <d2p1:FolderID>1</d2p1:FolderID>
            <d2p1:FolderName>sample string 3</d2p1:FolderName>
            <d2p1:OrderStatusCode>sample string 5</d2p1:OrderStatusCode>
            <d2p1:OrderStatusName>sample string 4</d2p1:OrderStatusName>
            <d2p1:Priority>2</d2p1:Priority>
          </d2p1:OrderFolderModel>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfOrderFolderModelu8r8mg3u>
    </d2p1:OrderStatusFolders>
    <d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  </Model>
  <ResponseCode>Success</ResponseCode>
</OrderFolderRoutingModelResponse>