GET api-v1/commerce/orderschema?id={id}

Returns detailed information about the order schema with the specified Id

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The Id of the order schema to return information about	integer	Required

Body Parameters

None.

Response Information

Resource Description

Detailed information about the order schema with the specified Id

OrderSchemaResponse

Name	Description	Type	Additional information
GlobalProperties	The global properties on this order schema	Collection of Property	None.
OrderProperties	The order properties on this order schema	Collection of Property	None.
SampleProperties	The sample properties on this order schema	Collection of Property	None.
Id	The Id of this order schema	integer	None.
Name	The name of this order schema	string	None.

Response Formats

application/json,text/json

Sample:

{
  "GlobalProperties": [
    {
      "Name": "sample string 1",
      "Caption": "sample string 2",
      "Type": "sample string 3",
      "Required": true
    },
    {
      "Name": "sample string 1",
      "Caption": "sample string 2",
      "Type": "sample string 3",
      "Required": true
    }
  ],
  "OrderProperties": [
    {
      "Name": "sample string 1",
      "Caption": "sample string 2",
      "Type": "sample string 3",
      "Required": true
    },
    {
      "Name": "sample string 1",
      "Caption": "sample string 2",
      "Type": "sample string 3",
      "Required": true
    }
  ],
  "SampleProperties": [
    {
      "Name": "sample string 1",
      "Caption": "sample string 2",
      "Type": "sample string 3",
      "Required": true
    },
    {
      "Name": "sample string 1",
      "Caption": "sample string 2",
      "Type": "sample string 3",
      "Required": true
    }
  ],
  "Id": 1,
  "Name": "sample string 2"
}

application/xml,text/xml

Sample:

<OrderSchemaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/labPortal2.Web.Api.v1.Commerce.Messages">
  <Id>1</Id>
  <Name>sample string 2</Name>
  <GlobalProperties>
    <Property>
      <Caption>sample string 2</Caption>
      <Name>sample string 1</Name>
      <Required>true</Required>
      <Type>sample string 3</Type>
    </Property>
    <Property>
      <Caption>sample string 2</Caption>
      <Name>sample string 1</Name>
      <Required>true</Required>
      <Type>sample string 3</Type>
    </Property>
  </GlobalProperties>
  <OrderProperties>
    <Property>
      <Caption>sample string 2</Caption>
      <Name>sample string 1</Name>
      <Required>true</Required>
      <Type>sample string 3</Type>
    </Property>
    <Property>
      <Caption>sample string 2</Caption>
      <Name>sample string 1</Name>
      <Required>true</Required>
      <Type>sample string 3</Type>
    </Property>
  </OrderProperties>
  <SampleProperties>
    <Property>
      <Caption>sample string 2</Caption>
      <Name>sample string 1</Name>
      <Required>true</Required>
      <Type>sample string 3</Type>
    </Property>
    <Property>
      <Caption>sample string 2</Caption>
      <Name>sample string 1</Name>
      <Required>true</Required>
      <Type>sample string 3</Type>
    </Property>
  </SampleProperties>
</OrderSchemaResponse>