GET v2/apps/{appId}/tenants/active/page/{page}/display?display={display}

Retrieves all active Tenants for an Application. Returns Not Found if App doesn't exist or is not a Multi-Tenant App

Request Information

URI Parameters

Name Type Description
appId integer

Application Id to fetch tenants for

Additional Info :

Required

page integer

Next page you want to get

Additional Info :

Required

display integer

Number of records to get

Body Parameters

None.

Response Information

Resource Description

TenantPageResponse
Name Type Description
TotalPage integer

Zero Base page total count.

TotalRecords integer

Total record in the database count.

List Collection of TenantResponse

List of the current request

Response Formats

{
  "totalPage": 1,
  "totalRecords": 2,
  "list": [
    {
      "id": 412,
      "appId": 1234,
      "displayName": "Bob's Plumbing",
      "iconUrl": "http://imagehosting.com/AGOEN32SDSAE392DSAJ",
      "iconUrl32x32": null,
      "splashUrl": "http://imagehosting.com/AOEUHGDEG832KGd",
      "url": "http://bobdoesplumbing.com",
      "disabled": false,
      "hidden": false,
      "displayOrder": 4,
      "createDate": "2019-04-14T19:47:25.5805223Z",
      "footerUrl": "http://app.appnotch.com/converter/footer/tenant/412",
      "shareContent": "https://a2bc.app.link/ag7GFe26dE",
      "branchUrl": "https://a2bc.app.link/ag7GFe26dE",
      "description": null,
      "facebookLink": null,
      "twitterLink": null,
      "linkedInLink": null,
      "googlePlus": null,
      "phone": null,
      "supportEmail": null,
      "supportSite": null,
      "ionicTemplateId": null,
      "source": null,
      "category": null
    },
    {
      "id": 413,
      "appId": 1234,
      "displayName": "Carol's Pipes and Things",
      "iconUrl": "http://app.appnotch.com/Converter/Websites/48/1937/d359b0d9_5aaf_408c_9ac3_79f7014da40b.png",
      "iconUrl32x32": null,
      "splashUrl": "http://qa.appnotch.com/Converter/Websites/48/1937/bb175766_f514_4f83_97bd_8bd16fab2bb3.png",
      "url": "http://pipingcarol.com",
      "disabled": false,
      "hidden": false,
      "displayOrder": 3,
      "createDate": "2019-04-14T19:47:25.5805223Z",
      "footerUrl": "http://app.appnotch.com/converter/footer/tenant/413",
      "shareContent": "https://a2bc.app.link/SrW2ofea1g",
      "branchUrl": "https://a2bc.app.link/SrW2ofea1g",
      "description": null,
      "facebookLink": null,
      "twitterLink": null,
      "linkedInLink": null,
      "googlePlus": null,
      "phone": null,
      "supportEmail": null,
      "supportSite": null,
      "ionicTemplateId": null,
      "source": null,
      "category": null
    }
  ]
}
<TenantPageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models">
  <List>
    <TenantResponse>
      <AppId>1234</AppId>
      <BranchUrl>https://a2bc.app.link/ag7GFe26dE</BranchUrl>
      <Category i:nil="true" />
      <CreateDate>2019-04-14T19:47:25.5805223+00:00</CreateDate>
      <Description i:nil="true" />
      <Disabled>false</Disabled>
      <DisplayName>Bob's Plumbing</DisplayName>
      <DisplayOrder>4</DisplayOrder>
      <FacebookLink i:nil="true" />
      <FooterUrl>http://app.appnotch.com/converter/footer/tenant/412</FooterUrl>
      <GooglePlus i:nil="true" />
      <Hidden>false</Hidden>
      <IconUrl>http://imagehosting.com/AGOEN32SDSAE392DSAJ</IconUrl>
      <IconUrl32x32 i:nil="true" />
      <Id>412</Id>
      <IonicTemplateId i:nil="true" />
      <LinkedInLink i:nil="true" />
      <Phone i:nil="true" />
      <ShareContent>https://a2bc.app.link/ag7GFe26dE</ShareContent>
      <Source i:nil="true" />
      <SplashUrl>http://imagehosting.com/AOEUHGDEG832KGd</SplashUrl>
      <SupportEmail i:nil="true" />
      <SupportSite i:nil="true" />
      <TwitterLink i:nil="true" />
      <Url>http://bobdoesplumbing.com</Url>
    </TenantResponse>
    <TenantResponse>
      <AppId>1234</AppId>
      <BranchUrl>https://a2bc.app.link/SrW2ofea1g</BranchUrl>
      <Category i:nil="true" />
      <CreateDate>2019-04-14T19:47:25.5805223+00:00</CreateDate>
      <Description i:nil="true" />
      <Disabled>false</Disabled>
      <DisplayName>Carol's Pipes and Things</DisplayName>
      <DisplayOrder>3</DisplayOrder>
      <FacebookLink i:nil="true" />
      <FooterUrl>http://app.appnotch.com/converter/footer/tenant/413</FooterUrl>
      <GooglePlus i:nil="true" />
      <Hidden>false</Hidden>
      <IconUrl>http://app.appnotch.com/Converter/Websites/48/1937/d359b0d9_5aaf_408c_9ac3_79f7014da40b.png</IconUrl>
      <IconUrl32x32 i:nil="true" />
      <Id>413</Id>
      <IonicTemplateId i:nil="true" />
      <LinkedInLink i:nil="true" />
      <Phone i:nil="true" />
      <ShareContent>https://a2bc.app.link/SrW2ofea1g</ShareContent>
      <Source i:nil="true" />
      <SplashUrl>http://qa.appnotch.com/Converter/Websites/48/1937/bb175766_f514_4f83_97bd_8bd16fab2bb3.png</SplashUrl>
      <SupportEmail i:nil="true" />
      <SupportSite i:nil="true" />
      <TwitterLink i:nil="true" />
      <Url>http://pipingcarol.com</Url>
    </TenantResponse>
  </List>
  <TotalPage>1</TotalPage>
  <TotalRecords>2</TotalRecords>
</TenantPageResponse>