GET api/Order/GetOrderHead/{id}
Gets the order head.
Access
Requires authentication.
Requires SSL.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| id | The identifier. |
Define this parameter in the request URI. |
Response Information
Response body formats
application/xml, text/xml
Sample:
<ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ResponseCode>1</ResponseCode>
<ResponseDescription>sample string 2</ResponseDescription>
<MethodExpirationDate>2024-05-17T19:55:20.4839858+02:00</MethodExpirationDate>
<ResponseObject>
<Id>1</Id>
<Readonly>true</Readonly>
<ProjectId>5</ProjectId>
<ExternalCode>sample string 6</ExternalCode>
<WishedDeliveryDate>2024-05-17T19:55:20.4839858+02:00</WishedDeliveryDate>
<ExternalOrderNumber>sample string 7</ExternalOrderNumber>
<HeaderText>sample string 8</HeaderText>
<CreatedAt>2024-05-17T19:55:20.4839858+02:00</CreatedAt>
<ExportedAt>2024-05-17T19:55:20.4839858+02:00</ExportedAt>
<ExportedByName>sample string 1</ExportedByName>
<SalesRepresentativeName>sample string 2</SalesRepresentativeName>
<ProductionSite>sample string 3</ProductionSite>
<OrderLines>
<OrderLineOut>
<Id>1</Id>
<Readonly>true</Readonly>
<ArticleId>1</ArticleId>
<CutAndBendDefinitionId>1</CutAndBendDefinitionId>
<MeshDefinitionId>1</MeshDefinitionId>
<WeldDefinitionId>1</WeldDefinitionId>
<ArticleDefinitionId>1</ArticleDefinitionId>
<ConfigElementDefinitionId>1</ConfigElementDefinitionId>
<Amount>1</Amount>
<GroupCount>1</GroupCount>
<IsPieceUnit>true</IsPieceUnit>
<OrderHeadId>1</OrderHeadId>
<OrderedAmount>1</OrderedAmount>
<GroupTypeSymbol>sample string 1</GroupTypeSymbol>
<OrderLineGUID>sample string 2</OrderLineGUID>
<SpecificationName>sample string 3</SpecificationName>
<ListingName>sample string 4</ListingName>
<TotalWeight>1</TotalWeight>
</OrderLineOut>
<OrderLineOut>
<Id>1</Id>
<Readonly>true</Readonly>
<ArticleId>1</ArticleId>
<CutAndBendDefinitionId>1</CutAndBendDefinitionId>
<MeshDefinitionId>1</MeshDefinitionId>
<WeldDefinitionId>1</WeldDefinitionId>
<ArticleDefinitionId>1</ArticleDefinitionId>
<ConfigElementDefinitionId>1</ConfigElementDefinitionId>
<Amount>1</Amount>
<GroupCount>1</GroupCount>
<IsPieceUnit>true</IsPieceUnit>
<OrderHeadId>1</OrderHeadId>
<OrderedAmount>1</OrderedAmount>
<GroupTypeSymbol>sample string 1</GroupTypeSymbol>
<OrderLineGUID>sample string 2</OrderLineGUID>
<SpecificationName>sample string 3</SpecificationName>
<ListingName>sample string 4</ListingName>
<TotalWeight>1</TotalWeight>
</OrderLineOut>
<OrderLineOut>
<Id>1</Id>
<Readonly>true</Readonly>
<ArticleId>1</ArticleId>
<CutAndBendDefinitionId>1</CutAndBendDefinitionId>
<MeshDefinitionId>1</MeshDefinitionId>
<WeldDefinitionId>1</WeldDefinitionId>
<ArticleDefinitionId>1</ArticleDefinitionId>
<ConfigElementDefinitionId>1</ConfigElementDefinitionId>
<Amount>1</Amount>
<GroupCount>1</GroupCount>
<IsPieceUnit>true</IsPieceUnit>
<OrderHeadId>1</OrderHeadId>
<OrderedAmount>1</OrderedAmount>
<GroupTypeSymbol>sample string 1</GroupTypeSymbol>
<OrderLineGUID>sample string 2</OrderLineGUID>
<SpecificationName>sample string 3</SpecificationName>
<ListingName>sample string 4</ListingName>
<TotalWeight>1</TotalWeight>
</OrderLineOut>
</OrderLines>
<OrderHeadStatus>1</OrderHeadStatus>
<OrderHeadStatusSymbol>sample string 4</OrderHeadStatusSymbol>
</ResponseObject>
</ApiResponse>
application/json, text/json
Sample:
{
"ResponseCode": 1,
"ResponseDescription": "sample string 2",
"MethodExpirationDate": "2024-05-17T19:55:20.4839858+02:00",
"ResponseObject": {
"CreatedAt": "2024-05-17T19:55:20.4839858+02:00",
"ExportedAt": "2024-05-17T19:55:20.4839858+02:00",
"ExportedByName": "sample string 1",
"SalesRepresentativeName": "sample string 2",
"ProductionSite": "sample string 3",
"OrderLines": [
{
"OrderHeadId": 1,
"OrderedAmount": 1.0,
"GroupTypeSymbol": "sample string 1",
"OrderLineGUID": "sample string 2",
"SpecificationName": "sample string 3",
"ListingName": "sample string 4",
"TotalWeight": 1.0,
"ArticleId": 1,
"CutAndBendDefinitionId": 1,
"MeshDefinitionId": 1,
"WeldDefinitionId": 1,
"ArticleDefinitionId": 1,
"ConfigElementDefinitionId": 1,
"Amount": 1.0,
"GroupCount": 1,
"IsPieceUnit": true,
"Id": 1,
"Readonly": true
},
{
"OrderHeadId": 1,
"OrderedAmount": 1.0,
"GroupTypeSymbol": "sample string 1",
"OrderLineGUID": "sample string 2",
"SpecificationName": "sample string 3",
"ListingName": "sample string 4",
"TotalWeight": 1.0,
"ArticleId": 1,
"CutAndBendDefinitionId": 1,
"MeshDefinitionId": 1,
"WeldDefinitionId": 1,
"ArticleDefinitionId": 1,
"ConfigElementDefinitionId": 1,
"Amount": 1.0,
"GroupCount": 1,
"IsPieceUnit": true,
"Id": 1,
"Readonly": true
},
{
"OrderHeadId": 1,
"OrderedAmount": 1.0,
"GroupTypeSymbol": "sample string 1",
"OrderLineGUID": "sample string 2",
"SpecificationName": "sample string 3",
"ListingName": "sample string 4",
"TotalWeight": 1.0,
"ArticleId": 1,
"CutAndBendDefinitionId": 1,
"MeshDefinitionId": 1,
"WeldDefinitionId": 1,
"ArticleDefinitionId": 1,
"ConfigElementDefinitionId": 1,
"Amount": 1.0,
"GroupCount": 1,
"IsPieceUnit": true,
"Id": 1,
"Readonly": true
}
],
"OrderHeadStatus": 1,
"OrderHeadStatusSymbol": "sample string 4",
"ProjectId": 5,
"ExternalCode": "sample string 6",
"WishedDeliveryDate": "2024-05-17T19:55:20.4839858+02:00",
"ExternalOrderNumber": "sample string 7",
"HeaderText": "sample string 8",
"Id": 1,
"Readonly": true
}
}