GET api/touchscreen/GetFamilies

Request Information

URI Parameters

None.

Body Parameters

DataForGetFamily
NameDescriptionTypeAdditional information
PageIndex

integer

None.
RecPerPage

integer

None.
OnlyBatch

boolean

None.
MustHaveArrival

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "PageIndex": 1,
  "RecPerPage": 2,
  "OnlyBatch": true,
  "MustHaveArrival": true
}

application/xml, text/xml

Sample: 
<DataForGetFamily xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAGACore.Model.TouchScreen.Family">
  <MustHaveArrival>true</MustHaveArrival>
  <OnlyBatch>true</OnlyBatch>
  <PageIndex>1</PageIndex>
  <RecPerPage>2</RecPerPage>
</DataForGetFamily>

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

Response Information

Resource Description

JSonGenericOfNODAListReturnOfFamily
NameDescriptionTypeAdditional information
Response

NODAListReturnOfFamily

None.
Datas

NODAListReturnOfFamily

None.
ServiceName

string

None.
Parameters

string

None.
Status

ReturnErrorStatus

None.
ErrorMessage

string

None.
Error

jsonExceptionIES

None.

Response Formats

application/json, text/json

Sample: 
{
  "Response": {
    "TotalListCount": 1,
    "DataList": [
      {
        "Code": "sample string 1",
        "Name": "sample string 2",
        "Abrege": "sample string 3",
        "DisplayOrder": 4
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2",
        "Abrege": "sample string 3",
        "DisplayOrder": 4
      }
    ]
  },
  "Datas": {
    "TotalListCount": 1,
    "DataList": [
      {
        "Code": "sample string 1",
        "Name": "sample string 2",
        "Abrege": "sample string 3",
        "DisplayOrder": 4
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2",
        "Abrege": "sample string 3",
        "DisplayOrder": 4
      }
    ]
  },
  "ServiceName": "sample string 1",
  "Parameters": "sample string 2",
  "Status": 0,
  "ErrorMessage": "sample string 3",
  "Error": {
    "Code": "sample string 1",
    "Details": "sample string 2",
    "Message": "sample string 3",
    "Level": 1
  }
}

application/xml, text/xml

Sample: 
<JSonGenericOfNODAListReturnOfFamilybU8i3qLgjhoUeH8f xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ForSagaMiddleware">
  <Error>
    <Code>sample string 1</Code>
    <Details>sample string 2</Details>
    <Level>Info</Level>
    <Message>sample string 3</Message>
  </Error>
  <ErrorMessage>sample string 3</ErrorMessage>
  <Parameters>sample string 2</Parameters>
  <ServiceName>sample string 1</ServiceName>
  <Status>Error</Status>
  <Datas xmlns:d2p1="http://schemas.datacontract.org/2004/07/SAGACore.Model.TouchScreen">
    <d2p1:DataList xmlns:d3p1="http://schemas.datacontract.org/2004/07/SAGACore.Model.TouchScreen.Family">
      <d3p1:Family>
        <d3p1:Abrege>sample string 3</d3p1:Abrege>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:DisplayOrder>4</d3p1:DisplayOrder>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Family>
      <d3p1:Family>
        <d3p1:Abrege>sample string 3</d3p1:Abrege>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:DisplayOrder>4</d3p1:DisplayOrder>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Family>
    </d2p1:DataList>
    <d2p1:TotalListCount>1</d2p1:TotalListCount>
  </Datas>
  <Response xmlns:d2p1="http://schemas.datacontract.org/2004/07/SAGACore.Model.TouchScreen">
    <d2p1:DataList xmlns:d3p1="http://schemas.datacontract.org/2004/07/SAGACore.Model.TouchScreen.Family">
      <d3p1:Family>
        <d3p1:Abrege>sample string 3</d3p1:Abrege>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:DisplayOrder>4</d3p1:DisplayOrder>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Family>
      <d3p1:Family>
        <d3p1:Abrege>sample string 3</d3p1:Abrege>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:DisplayOrder>4</d3p1:DisplayOrder>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Family>
    </d2p1:DataList>
    <d2p1:TotalListCount>1</d2p1:TotalListCount>
  </Response>
</JSonGenericOfNODAListReturnOfFamilybU8i3qLgjhoUeH8f>