GET product/main?branchId={branchId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
branchId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Product
NameDescriptionTypeAdditional information
id

globally unique identifier

None.

masterId

globally unique identifier

None.

branchId

globally unique identifier

None.

branchName

string

None.

code

string

None.

name

string

None.

imageBase64

string

None.

imageId

globally unique identifier

None.

imageUrl

string

None.

subTitle

string

None.

type

integer

None.

allBranch

boolean

None.

groupId

globally unique identifier

None.

groupName

string

None.

price

decimal number

None.

order

integer

None.

note

string

None.

prices

Collection of ProductPrice

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "b8276761-4317-4f62-a18d-a1fdd4322c0a",
  "masterId": "f4f6ca7e-c8f6-4a02-a530-57f7cf234651",
  "branchId": "f27e6b1a-b0c2-40d1-acf5-d206cb7fddbc",
  "branchName": "sample string 1",
  "code": "sample string 2",
  "name": "sample string 3",
  "imageBase64": "sample string 4",
  "imageId": "fb4ef01d-2bf5-4a07-96c9-c619eca591b4",
  "imageUrl": "sample string 5",
  "subTitle": "sample string 6",
  "type": 7,
  "allBranch": true,
  "groupId": "09f341f3-6a92-46ff-8c08-34d12908e643",
  "groupName": "sample string 9",
  "price": 10.1,
  "order": 11,
  "note": "sample string 12",
  "prices": [
    {
      "id": "18bf6562-03a8-4ba2-86a9-454cbcea3a12",
      "productId": "35c1e103-a768-44ab-8433-3e33749f3a80",
      "isStudent": true,
      "name": "sample string 2",
      "type": 3,
      "month": 4,
      "day": 5,
      "price": 6.1,
      "limitPrice": 7.1,
      "note": "sample string 8",
      "appVisible": true
    },
    {
      "id": "18bf6562-03a8-4ba2-86a9-454cbcea3a12",
      "productId": "35c1e103-a768-44ab-8433-3e33749f3a80",
      "isStudent": true,
      "name": "sample string 2",
      "type": 3,
      "month": 4,
      "day": 5,
      "price": 6.1,
      "limitPrice": 7.1,
      "note": "sample string 8",
      "appVisible": true
    }
  ]
}

application/xml, text/xml

Sample:
<Product xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Careby.Api.Models">
  <allBranch>true</allBranch>
  <branchId>f27e6b1a-b0c2-40d1-acf5-d206cb7fddbc</branchId>
  <branchName>sample string 1</branchName>
  <code>sample string 2</code>
  <groupId>09f341f3-6a92-46ff-8c08-34d12908e643</groupId>
  <groupName>sample string 9</groupName>
  <id>b8276761-4317-4f62-a18d-a1fdd4322c0a</id>
  <imageBase64>sample string 4</imageBase64>
  <imageId>fb4ef01d-2bf5-4a07-96c9-c619eca591b4</imageId>
  <imageUrl>sample string 5</imageUrl>
  <masterId>f4f6ca7e-c8f6-4a02-a530-57f7cf234651</masterId>
  <name>sample string 3</name>
  <note>sample string 12</note>
  <order>11</order>
  <price>10.1</price>
  <prices>
    <ProductPrice>
      <appVisible>true</appVisible>
      <day>5</day>
      <id>18bf6562-03a8-4ba2-86a9-454cbcea3a12</id>
      <isStudent>true</isStudent>
      <limitPrice>7.1</limitPrice>
      <month>4</month>
      <name>sample string 2</name>
      <note>sample string 8</note>
      <price>6.1</price>
      <productId>35c1e103-a768-44ab-8433-3e33749f3a80</productId>
      <type>3</type>
    </ProductPrice>
    <ProductPrice>
      <appVisible>true</appVisible>
      <day>5</day>
      <id>18bf6562-03a8-4ba2-86a9-454cbcea3a12</id>
      <isStudent>true</isStudent>
      <limitPrice>7.1</limitPrice>
      <month>4</month>
      <name>sample string 2</name>
      <note>sample string 8</note>
      <price>6.1</price>
      <productId>35c1e103-a768-44ab-8433-3e33749f3a80</productId>
      <type>3</type>
    </ProductPrice>
  </prices>
  <subTitle>sample string 6</subTitle>
  <type>7</type>
</Product>