GET settings?branchId={branchId}

Request Information

URI Parameters

Name	Description	Type	Additional information
branchId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Settings

Name	Type	Additional information
branchId	globally unique identifier	None.
branchCode	string	None.
branchName	string	None.
branchPhone	string	None.
masterId	globally unique identifier	None.
masterName	string	None.
mainProductId	globally unique identifier	None.
mainProductName	string	None.
lockerProductId	globally unique identifier	None.
lockerProductName	string	None.
useAppRenew	boolean	None.
useAppPause	boolean	None.
pauseMonthLimit	integer	None.
pauseMinLimit	integer	None.
pauseMaxLimit	integer	None.
useEbarimt	boolean	None.
merchantTin	string	None.
useFaceAuth	boolean	None.
skynexHost	string	None.
licenseMonthPrice	decimal number	None.
licenseEndDate	date	None.
licenseExpiresSoon	boolean	None.
licenseHasExpired	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "branchId": "f7d33ae9-b964-4839-9aae-83a7017073ab",
  "branchCode": "sample string 1",
  "branchName": "sample string 2",
  "branchPhone": "sample string 3",
  "masterId": "f94a6b5e-2805-47cf-8a85-ff8374162afe",
  "masterName": "sample string 4",
  "mainProductId": "151a2cad-09af-4d2f-a11d-ddb38621b6a9",
  "mainProductName": "sample string 5",
  "lockerProductId": "5460b91c-8e77-45f9-a02b-41224c183a60",
  "lockerProductName": "sample string 6",
  "useAppRenew": true,
  "useAppPause": true,
  "pauseMonthLimit": 9,
  "pauseMinLimit": 10,
  "pauseMaxLimit": 11,
  "useEbarimt": true,
  "merchantTin": "sample string 13",
  "useFaceAuth": true,
  "skynexHost": "sample string 15",
  "licenseMonthPrice": 16.1,
  "licenseEndDate": "2026-06-02T02:11:17.5923134+08:00",
  "licenseExpiresSoon": true,
  "licenseHasExpired": true
}

application/xml, text/xml

Sample:

<Settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Careby.Api.Models">
  <branchCode>sample string 1</branchCode>
  <branchId>f7d33ae9-b964-4839-9aae-83a7017073ab</branchId>
  <branchName>sample string 2</branchName>
  <branchPhone>sample string 3</branchPhone>
  <licenseEndDate>2026-06-02T02:11:17.5923134+08:00</licenseEndDate>
  <licenseExpiresSoon>true</licenseExpiresSoon>
  <licenseHasExpired>true</licenseHasExpired>
  <licenseMonthPrice>16.1</licenseMonthPrice>
  <lockerProductId>5460b91c-8e77-45f9-a02b-41224c183a60</lockerProductId>
  <lockerProductName>sample string 6</lockerProductName>
  <mainProductId>151a2cad-09af-4d2f-a11d-ddb38621b6a9</mainProductId>
  <mainProductName>sample string 5</mainProductName>
  <masterId>f94a6b5e-2805-47cf-8a85-ff8374162afe</masterId>
  <masterName>sample string 4</masterName>
  <merchantTin>sample string 13</merchantTin>
  <pauseMaxLimit>11</pauseMaxLimit>
  <pauseMinLimit>10</pauseMinLimit>
  <pauseMonthLimit>9</pauseMonthLimit>
  <skynexHost>sample string 15</skynexHost>
  <useAppPause>true</useAppPause>
  <useAppRenew>true</useAppRenew>
  <useEbarimt>true</useEbarimt>
  <useFaceAuth>true</useFaceAuth>
</Settings>