POST api/Lookup/GetOrderTypesForActivity

Gets the available order types for the provided activity. Uses the activity contract / line to find available order types

Request Information

URI Parameters

None.

Body Parameters

GetByActivityModel
NameDescriptionTypeAdditional information
CombinedActivityId

Gets or sets combined activity id

string

None.

TicketId

Gets or sets the ticket id

string

None.

Culture

Gets or sets culture, if not specified we will use culture set on user.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CombinedActivityId": "sample string 1",
  "TicketId": "sample string 2",
  "Culture": "sample string 3"
}

application/xml, text/xml

Sample:
<LookupController.GetByActivityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Controllers">
  <Culture xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 3</Culture>
  <TicketId xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 2</TicketId>
  <CombinedActivityId>sample string 1</CombinedActivityId>
</LookupController.GetByActivityModel>

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 'GetByActivityModel'.

Response Information

Resource Description

OrderTypeReturnModel
NameDescriptionTypeAdditional information
OrderTypes

List or order types

Collection of OrderTypeModel

None.

CombinedPerformanceId

Gets or sets the performance id. If performance monitoring is not turned on this property will not be present or set to null

string

Json null value handling: Ignore

Response Formats

application/json, text/json

Sample:
{
  "OrderTypes": [
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "TypeOfOrder": "sample string 3",
      "AllowOrderLocal": true,
      "AllowOrderSupplier": true,
      "CentralOrderPickStock": "sample string 6",
      "CentralOrderPickStockName": "sample string 7",
      "DefaultLocalStock": "sample string 8",
      "SpecifySerialNumberInCreate": true,
      "AllowOrderOutsideContract": true,
      "ReturnReworkable": true,
      "ReturnNonReworkable": true,
      "DefaultOrderValues": {
        "LocalStockId": "sample string 1",
        "LocalStockName": "sample string 2",
        "InvoiceCustomer": 1,
        "DeliveryCustomer": 1,
        "DeliveryName": "sample string 3",
        "DeliveryAddress": "sample string 4",
        "DeliveryPostalCode": "sample string 5",
        "DeliveryPostalCity": "sample string 6"
      }
    },
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "TypeOfOrder": "sample string 3",
      "AllowOrderLocal": true,
      "AllowOrderSupplier": true,
      "CentralOrderPickStock": "sample string 6",
      "CentralOrderPickStockName": "sample string 7",
      "DefaultLocalStock": "sample string 8",
      "SpecifySerialNumberInCreate": true,
      "AllowOrderOutsideContract": true,
      "ReturnReworkable": true,
      "ReturnNonReworkable": true,
      "DefaultOrderValues": {
        "LocalStockId": "sample string 1",
        "LocalStockName": "sample string 2",
        "InvoiceCustomer": 1,
        "DeliveryCustomer": 1,
        "DeliveryName": "sample string 3",
        "DeliveryAddress": "sample string 4",
        "DeliveryPostalCode": "sample string 5",
        "DeliveryPostalCity": "sample string 6"
      }
    }
  ],
  "CombinedPerformanceId": "sample string 1"
}

application/xml, text/xml

Sample:
<OrderTypeReturnModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">
  <CombinedPerformanceId>sample string 1</CombinedPerformanceId>
  <OrderTypes>
    <OrderTypeModel>
      <AllowOrderLocal>true</AllowOrderLocal>
      <AllowOrderOutsideContract>true</AllowOrderOutsideContract>
      <AllowOrderSupplier>true</AllowOrderSupplier>
      <CentralOrderPickStock>sample string 6</CentralOrderPickStock>
      <CentralOrderPickStockName>sample string 7</CentralOrderPickStockName>
      <DefaultLocalStock>sample string 8</DefaultLocalStock>
      <DefaultOrderValues xmlns:d4p1="http://schemas.datacontract.org/2004/07/Sunflower.Business.Order">
        <d4p1:DeliveryAddress>sample string 4</d4p1:DeliveryAddress>
        <d4p1:DeliveryCustomer>1</d4p1:DeliveryCustomer>
        <d4p1:DeliveryName>sample string 3</d4p1:DeliveryName>
        <d4p1:DeliveryPostalCity>sample string 6</d4p1:DeliveryPostalCity>
        <d4p1:DeliveryPostalCode>sample string 5</d4p1:DeliveryPostalCode>
        <d4p1:InvoiceCustomer>1</d4p1:InvoiceCustomer>
        <d4p1:LocalStockId>sample string 1</d4p1:LocalStockId>
        <d4p1:LocalStockName>sample string 2</d4p1:LocalStockName>
      </DefaultOrderValues>
      <Description>sample string 2</Description>
      <Name>sample string 1</Name>
      <ReturnNonReworkable>true</ReturnNonReworkable>
      <ReturnReworkable>true</ReturnReworkable>
      <SpecifySerialNumberInCreate>true</SpecifySerialNumberInCreate>
      <TypeOfOrder>sample string 3</TypeOfOrder>
    </OrderTypeModel>
    <OrderTypeModel>
      <AllowOrderLocal>true</AllowOrderLocal>
      <AllowOrderOutsideContract>true</AllowOrderOutsideContract>
      <AllowOrderSupplier>true</AllowOrderSupplier>
      <CentralOrderPickStock>sample string 6</CentralOrderPickStock>
      <CentralOrderPickStockName>sample string 7</CentralOrderPickStockName>
      <DefaultLocalStock>sample string 8</DefaultLocalStock>
      <DefaultOrderValues xmlns:d4p1="http://schemas.datacontract.org/2004/07/Sunflower.Business.Order">
        <d4p1:DeliveryAddress>sample string 4</d4p1:DeliveryAddress>
        <d4p1:DeliveryCustomer>1</d4p1:DeliveryCustomer>
        <d4p1:DeliveryName>sample string 3</d4p1:DeliveryName>
        <d4p1:DeliveryPostalCity>sample string 6</d4p1:DeliveryPostalCity>
        <d4p1:DeliveryPostalCode>sample string 5</d4p1:DeliveryPostalCode>
        <d4p1:InvoiceCustomer>1</d4p1:InvoiceCustomer>
        <d4p1:LocalStockId>sample string 1</d4p1:LocalStockId>
        <d4p1:LocalStockName>sample string 2</d4p1:LocalStockName>
      </DefaultOrderValues>
      <Description>sample string 2</Description>
      <Name>sample string 1</Name>
      <ReturnNonReworkable>true</ReturnNonReworkable>
      <ReturnReworkable>true</ReturnReworkable>
      <SpecifySerialNumberInCreate>true</SpecifySerialNumberInCreate>
      <TypeOfOrder>sample string 3</TypeOfOrder>
    </OrderTypeModel>
  </OrderTypes>
</OrderTypeReturnModel>