GET api/Plants/{companyId}?includeInactive={includeInactive}

Return all Plants for a Company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId		integer	Required
includeInactive		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

List of Plant

ServiceResultTypedOfListOfPlant

Name	Type	Additional information
Code	integer	None.
Errors	Collection of string	None.
Data	Collection of Plant	None.

Response Formats

application/json, text/json

Sample:

{
  "Code": 1,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": [
    {
      "PlantId": 1,
      "PlantName": "sample string 2",
      "PlantCode": "sample string 3",
      "CompanyId": 4,
      "IsActive": true
    },
    {
      "PlantId": 1,
      "PlantName": "sample string 2",
      "PlantCode": "sample string 3",
      "CompanyId": 4,
      "IsActive": true
    }
  ]
}

text/html

Sample:

{"Code":1,"Errors":["sample string 1","sample string 2"],"Data":[{"PlantId":1,"PlantName":"sample string 2","PlantCode":"sample string 3","CompanyId":4,"IsActive":true},{"PlantId":1,"PlantName":"sample string 2","PlantCode":"sample string 3","CompanyId":4,"IsActive":true}]}

application/xml, text/xml

Sample:

<ServiceResultTypedOfArrayOfPlantYj8O1tFc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSW.Common.Models">
  <Code>1</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TTMWM_MECLAIM_API.ViewModels">
    <d2p1:Plant>
      <d2p1:CompanyId>4</d2p1:CompanyId>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:PlantCode>sample string 3</d2p1:PlantCode>
      <d2p1:PlantId>1</d2p1:PlantId>
      <d2p1:PlantName>sample string 2</d2p1:PlantName>
    </d2p1:Plant>
    <d2p1:Plant>
      <d2p1:CompanyId>4</d2p1:CompanyId>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:PlantCode>sample string 3</d2p1:PlantCode>
      <d2p1:PlantId>1</d2p1:PlantId>
      <d2p1:PlantName>sample string 2</d2p1:PlantName>
    </d2p1:Plant>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
</ServiceResultTypedOfArrayOfPlantYj8O1tFc>