Back to API List

POST api/cupFetchDashboard/Dashboard

<CLUB User portal:> Fetch Menu depending on user and his type, parameters: property, userid.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
property		string	None.
user		string	None.

Request Formats

application/json, text/json

Sample:

{
  "property": "sample string 1",
  "user": "sample string 2"
}

application/xml, text/xml

Sample:

<cupFetchDashboardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubWebApi.cupRequest">
  <property>sample string 1</property>
  <user>sample string 2</user>
</cupFetchDashboardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

cupFetchDashboardResponse

Name	Type	Additional information
heading	string	None.
introductions	string	None.
slider_items	Collection of cupSliderItem	None.
news_items	Collection of cupNewsItem	None.
account_summary	cupAccountSummary	None.
hot_packages	Collection of cupHotPackage	None.
todayes_bookings	Collection of cupTodaysBooking	None.
response_message	string	None.
response_code	string	None.
response_status	string	None.

Response Formats

application/json, text/json

Sample:

{
  "heading": "sample string 1",
  "introductions": "sample string 2",
  "slider_items": [
    {
      "id": "sample string 1",
      "content": "sample string 2",
      "image_path": "sample string 3",
      "date": "sample string 4",
      "venue": "sample string 5",
      "paragraph1": "sample string 6",
      "paragraph2": "sample string 7",
      "organize1": "sample string 8",
      "organize2": "sample string 9"
    },
    {
      "id": "sample string 1",
      "content": "sample string 2",
      "image_path": "sample string 3",
      "date": "sample string 4",
      "venue": "sample string 5",
      "paragraph1": "sample string 6",
      "paragraph2": "sample string 7",
      "organize1": "sample string 8",
      "organize2": "sample string 9"
    }
  ],
  "news_items": [
    {
      "date": 1,
      "month": "sample string 2",
      "content": "sample string 3",
      "short_content": "sample string 4"
    },
    {
      "date": 1,
      "month": "sample string 2",
      "content": "sample string 3",
      "short_content": "sample string 4"
    }
  ],
  "account_summary": {
    "credit_days": 1,
    "last_invoice_date": "sample string 2",
    "last_statement_date": "sample string 3",
    "last_statement_amount": 4.0,
    "debits": 5.0,
    "credits": 6.0,
    "total_outstanding": 7.0,
    "last_updated": "sample string 8",
    "last_day_to_pay_due": "sample string 9",
    "credit_limit": 10.0,
    "available_limit": 11.0
  },
  "hot_packages": [
    {
      "description": "sample string 1",
      "amount": 2.0,
      "amount_umo": "sample string 3",
      "currency_symbol": "sample string 4"
    },
    {
      "description": "sample string 1",
      "amount": 2.0,
      "amount_umo": "sample string 3",
      "currency_symbol": "sample string 4"
    }
  ],
  "todayes_bookings": [
    {
      "description": "sample string 1",
      "time": "sample string 2",
      "link_value": "sample string 3",
      "facility_small_img": "sample string 4"
    },
    {
      "description": "sample string 1",
      "time": "sample string 2",
      "link_value": "sample string 3",
      "facility_small_img": "sample string 4"
    }
  ],
  "response_message": "sample string 3",
  "response_code": "sample string 4",
  "response_status": "sample string 5"
}

application/xml, text/xml

Sample:

<cupFetchDashboardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubWebApi.cupResponse">
  <response_code>sample string 4</response_code>
  <response_message>sample string 3</response_message>
  <response_status>sample string 5</response_status>
  <account_summary>
    <available_limit>11</available_limit>
    <credit_days>1</credit_days>
    <credit_limit>10</credit_limit>
    <credits>6</credits>
    <debits>5</debits>
    <last_day_to_pay_due>sample string 9</last_day_to_pay_due>
    <last_invoice_date>sample string 2</last_invoice_date>
    <last_statement_amount>4</last_statement_amount>
    <last_statement_date>sample string 3</last_statement_date>
    <last_updated>sample string 8</last_updated>
    <total_outstanding>7</total_outstanding>
  </account_summary>
  <heading>sample string 1</heading>
  <hot_packages>
    <cupHotPackage>
      <amount>2</amount>
      <amount_umo>sample string 3</amount_umo>
      <currency_symbol>sample string 4</currency_symbol>
      <description>sample string 1</description>
    </cupHotPackage>
    <cupHotPackage>
      <amount>2</amount>
      <amount_umo>sample string 3</amount_umo>
      <currency_symbol>sample string 4</currency_symbol>
      <description>sample string 1</description>
    </cupHotPackage>
  </hot_packages>
  <introductions>sample string 2</introductions>
  <news_items>
    <cupNewsItem>
      <content>sample string 3</content>
      <date>1</date>
      <month>sample string 2</month>
      <short_content>sample string 4</short_content>
    </cupNewsItem>
    <cupNewsItem>
      <content>sample string 3</content>
      <date>1</date>
      <month>sample string 2</month>
      <short_content>sample string 4</short_content>
    </cupNewsItem>
  </news_items>
  <slider_items>
    <cupSliderItem>
      <content>sample string 2</content>
      <date>sample string 4</date>
      <id>sample string 1</id>
      <image_path>sample string 3</image_path>
      <organize1>sample string 8</organize1>
      <organize2>sample string 9</organize2>
      <paragraph1>sample string 6</paragraph1>
      <paragraph2>sample string 7</paragraph2>
      <venue>sample string 5</venue>
    </cupSliderItem>
    <cupSliderItem>
      <content>sample string 2</content>
      <date>sample string 4</date>
      <id>sample string 1</id>
      <image_path>sample string 3</image_path>
      <organize1>sample string 8</organize1>
      <organize2>sample string 9</organize2>
      <paragraph1>sample string 6</paragraph1>
      <paragraph2>sample string 7</paragraph2>
      <venue>sample string 5</venue>
    </cupSliderItem>
  </slider_items>
  <todayes_bookings>
    <cupTodaysBooking>
      <description>sample string 1</description>
      <facility_small_img>sample string 4</facility_small_img>
      <link_value>sample string 3</link_value>
      <time>sample string 2</time>
    </cupTodaysBooking>
    <cupTodaysBooking>
      <description>sample string 1</description>
      <facility_small_img>sample string 4</facility_small_img>
      <link_value>sample string 3</link_value>
      <time>sample string 2</time>
    </cupTodaysBooking>
  </todayes_bookings>
</cupFetchDashboardResponse>