GET api/Settings/Client

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
Title	string	None.
Contract	ContractLevel	None.
Note	string	None.
Active	boolean	None.
Suspended	boolean	None.
ContractExpires	date	None.
Settings	ClientSettings	None.
Deleted	boolean	None.
Master	boolean	None.
MasterSettings	Object	None.
Uuid	string	None.
OrganizationUuid	string	None.
CreatedBy	string	None.
ModifiedBy	string	None.
Hidden	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Title": "sample string 1",
  "Contract": 1,
  "Note": "sample string 2",
  "Active": true,
  "Suspended": true,
  "ContractExpires": "2024-11-20T15:33:42.6181902-05:00",
  "Settings": {
    "DataStores": [
      {
        "StoreId": 1,
        "Name": "sample string 2",
        "TypeStr": "AzureBlob",
        "Type": 1,
        "ConnectionString": "sample string 3",
        "Shared": true,
        "UsedSpace": 5.0,
        "Limit": 6,
        "TotalSize": 7.0,
        "Recalculating": true
      },
      {
        "StoreId": 1,
        "Name": "sample string 2",
        "TypeStr": "AzureBlob",
        "Type": 1,
        "ConnectionString": "sample string 3",
        "Shared": true,
        "UsedSpace": 5.0,
        "Limit": 6,
        "TotalSize": 7.0,
        "Recalculating": true
      }
    ],
    "DataProviderName": "Default",
    "DataProvider": 1,
    "DbConnectionString": "sample string 1",
    "FormatsDataProviderName": "Default",
    "FormatsDataProvider": 1,
    "FormatsDbConnectionString": "sample string 2",
    "SynchInterval": 1,
    "FormatsLastSync": "2024-11-20T15:33:42.6191919-05:00",
    "FormatsLastSyncInfo": "sample string 3",
    "Logo": "sample string 4",
    "RedisDatabase": 5,
    "UsePackageName": true,
    "AutoFinalize": true,
    "AutoStartNext": true,
    "UseOwnFormats": true,
    "StatsObsolete": 10,
    "TimeLineRange": 11,
    "SoftDelete": true,
    "DeleteRetentionDays": 13,
    "Preservation": true,
    "Access": true,
    "Thumbnail": true,
    "Other": true
  },
  "Deleted": true,
  "Master": true,
  "MasterSettings": {},
  "Uuid": "sample string 7",
  "OrganizationUuid": "sample string 8",
  "CreatedOn": "2024-11-20T15:33:42.6191919-05:00",
  "CreatedBy": "sample string 11",
  "ModifiedOn": "2024-11-20T15:33:42.6191919-05:00",
  "ModifiedBy": "sample string 14",
  "Hidden": true
}

application/xml, text/xml

Sample:

<Client xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities.Db">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 11</CreatedBy>
  <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-20T15:33:42.6191919-05:00</CreatedOn>
  <CreatedOnString xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-20T15:33:42.6191919-05:00</CreatedOnString>
  <Hidden xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">true</Hidden>
  <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 14</ModifiedBy>
  <ModifiedOn xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-20T15:33:42.6191919-05:00</ModifiedOn>
  <ModifiedOnString xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-20T15:33:42.6191919-05:00</ModifiedOnString>
  <OrganizationUuid xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 8</OrganizationUuid>
  <Uuid xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 7</Uuid>
  <_id xmlns:d2p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson" xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">
    <d2p1:_a>0</d2p1:_a>
    <d2p1:_b>0</d2p1:_b>
    <d2p1:_c>0</d2p1:_c>
  </_id>
  <Contract>Bronze</Contract>
  <ContractExpires>2024-11-20T15:33:42.6181902-05:00</ContractExpires>
  <Deleted>true</Deleted>
  <Master>true</Master>
  <MasterSettings />
  <Note>sample string 2</Note>
  <Settings>
    <Access>true</Access>
    <AutoFinalize>true</AutoFinalize>
    <AutoStartNext>true</AutoStartNext>
    <DataProvider>Default</DataProvider>
    <DataStores>
      <DataStorage>
        <ConnectionString>sample string 3</ConnectionString>
        <Limit>6</Limit>
        <Name>sample string 2</Name>
        <Recalculating>true</Recalculating>
        <Shared>true</Shared>
        <StoreId>1</StoreId>
        <TotalSize>7</TotalSize>
        <Type>AzureBlob</Type>
        <UsedSpace>5</UsedSpace>
      </DataStorage>
      <DataStorage>
        <ConnectionString>sample string 3</ConnectionString>
        <Limit>6</Limit>
        <Name>sample string 2</Name>
        <Recalculating>true</Recalculating>
        <Shared>true</Shared>
        <StoreId>1</StoreId>
        <TotalSize>7</TotalSize>
        <Type>AzureBlob</Type>
        <UsedSpace>5</UsedSpace>
      </DataStorage>
    </DataStores>
    <DbConnectionString>sample string 1</DbConnectionString>
    <DeleteRetentionDays>13</DeleteRetentionDays>
    <FormatsDataProvider>Default</FormatsDataProvider>
    <FormatsDbConnectionString>sample string 2</FormatsDbConnectionString>
    <FormatsLastSync>2024-11-20T15:33:42.6191919-05:00</FormatsLastSync>
    <FormatsLastSyncInfo>sample string 3</FormatsLastSyncInfo>
    <Logo>sample string 4</Logo>
    <Other>true</Other>
    <Preservation>true</Preservation>
    <RedisDatabase>5</RedisDatabase>
    <SoftDelete>true</SoftDelete>
    <StatsObsolete>10</StatsObsolete>
    <SynchInterval>Manual</SynchInterval>
    <Thumbnail>true</Thumbnail>
    <TimeLineRange>11</TimeLineRange>
    <UseOwnFormats>true</UseOwnFormats>
    <UsePackageName>true</UsePackageName>
  </Settings>
  <Title>sample string 1</Title>
</Client>