Back to API List

POST api/cupFetchDirectory/Directory

CLUB User portal: Fetch Member Details, parameters: property, userid, user_type member id (optional).

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
property	string	None.
user	string	None.
user_type	string	None.
member_id	string	None.
caller	string	None.
name	string	None.
location	string	None.
contact_no	string	None.
occupation	string	None.
nationality	string	None.
age_group	string	None.
uses_facility	string	None.
sort_by	string	None.
next_row_start	string	None.
membership_types	string	None.

Request Formats

application/json, text/json

Sample:

{
  "property": "sample string 1",
  "user": "sample string 2",
  "user_type": "sample string 3",
  "member_id": "sample string 4",
  "caller": "sample string 5",
  "name": "sample string 6",
  "location": "sample string 7",
  "contact_no": "sample string 8",
  "occupation": "sample string 9",
  "nationality": "sample string 10",
  "age_group": "sample string 11",
  "uses_facility": "sample string 12",
  "sort_by": "sample string 13",
  "next_row_start": "sample string 14",
  "membership_types": "sample string 15"
}

application/xml, text/xml

Sample:

<cupFetchDirectoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubWebApi.cupRequest">
  <age_group>sample string 11</age_group>
  <caller>sample string 5</caller>
  <contact_no>sample string 8</contact_no>
  <location>sample string 7</location>
  <member_id>sample string 4</member_id>
  <membership_types>sample string 15</membership_types>
  <name>sample string 6</name>
  <nationality>sample string 10</nationality>
  <next_row_start>sample string 14</next_row_start>
  <occupation>sample string 9</occupation>
  <property>sample string 1</property>
  <sort_by>sample string 13</sort_by>
  <user>sample string 2</user>
  <user_type>sample string 3</user_type>
  <uses_facility>sample string 12</uses_facility>
</cupFetchDirectoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

cupFetchDirectoryResponse

Name	Type	Additional information
members	Collection of cupMember	None.
countries	Collection of cupCountries	None.
facility	Collection of cupFacility	None.
AgeGroup	Collection of cupAgeGroup	None.
MemberRelation	Collection of cupMemberRelation	None.
header	cupHeader	None.
occupations	Collection of cupOccupation	None.
total_rows	integer	None.
response_message	string	None.
response_code	string	None.
response_status	string	None.

Response Formats

application/json, text/json

Sample:

{
  "members": [
    {
      "member_id": "sample string 1",
      "name": "sample string 2",
      "occupation": "sample string 3",
      "contact_no": "sample string 4",
      "email": "sample string 5",
      "image_file_name": "sample string 6",
      "profile_id": "sample string 7",
      "designation": "sample string 8",
      "organization": "sample string 9",
      "rel_desc": "sample string 10",
      "parent_name": "sample string 11",
      "regular_in": "sample string 12",
      "nationality": "sample string 13",
      "gender": "sample string 14",
      "address": "sample string 15",
      "dob": "sample string 16",
      "age": "sample string 17",
      "rel_id": "sample string 18"
    },
    {
      "member_id": "sample string 1",
      "name": "sample string 2",
      "occupation": "sample string 3",
      "contact_no": "sample string 4",
      "email": "sample string 5",
      "image_file_name": "sample string 6",
      "profile_id": "sample string 7",
      "designation": "sample string 8",
      "organization": "sample string 9",
      "rel_desc": "sample string 10",
      "parent_name": "sample string 11",
      "regular_in": "sample string 12",
      "nationality": "sample string 13",
      "gender": "sample string 14",
      "address": "sample string 15",
      "dob": "sample string 16",
      "age": "sample string 17",
      "rel_id": "sample string 18"
    }
  ],
  "countries": [
    {
      "country_code": "sample string 1",
      "country_name": "sample string 2",
      "nationality": "sample string 3"
    },
    {
      "country_code": "sample string 1",
      "country_name": "sample string 2",
      "nationality": "sample string 3"
    }
  ],
  "facility": [
    {
      "property_id": "sample string 1",
      "facility_id": "sample string 2",
      "facility_name": "sample string 3"
    },
    {
      "property_id": "sample string 1",
      "facility_id": "sample string 2",
      "facility_name": "sample string 3"
    }
  ],
  "ageGroup": [
    {
      "number": "sample string 1",
      "value": "sample string 2",
      "attribute": "sample string 3"
    },
    {
      "number": "sample string 1",
      "value": "sample string 2",
      "attribute": "sample string 3"
    }
  ],
  "memberRelation": [
    {
      "number": "sample string 1",
      "value": "sample string 2",
      "attribute": "sample string 3"
    },
    {
      "number": "sample string 1",
      "value": "sample string 2",
      "attribute": "sample string 3"
    }
  ],
  "header": {
    "membership_id": "sample string 1",
    "membership_desc": "sample string 2",
    "member_end_date": "sample string 3"
  },
  "occupations": [
    {
      "occupation_id": "sample string 1",
      "occupation_desc": "sample string 2"
    },
    {
      "occupation_id": "sample string 1",
      "occupation_desc": "sample string 2"
    }
  ],
  "total_rows": 1,
  "response_message": "sample string 2",
  "response_code": "sample string 3",
  "response_status": "sample string 4"
}

application/xml, text/xml

Sample:

<cupFetchDirectoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubWebApi.cupResponse">
  <response_code>sample string 3</response_code>
  <response_message>sample string 2</response_message>
  <response_status>sample string 4</response_status>
  <AgeGroup>
    <cupAgeGroup>
      <attribute>sample string 3</attribute>
      <number>sample string 1</number>
      <value>sample string 2</value>
    </cupAgeGroup>
    <cupAgeGroup>
      <attribute>sample string 3</attribute>
      <number>sample string 1</number>
      <value>sample string 2</value>
    </cupAgeGroup>
  </AgeGroup>
  <MemberRelation>
    <cupMemberRelation>
      <attribute>sample string 3</attribute>
      <number>sample string 1</number>
      <value>sample string 2</value>
    </cupMemberRelation>
    <cupMemberRelation>
      <attribute>sample string 3</attribute>
      <number>sample string 1</number>
      <value>sample string 2</value>
    </cupMemberRelation>
  </MemberRelation>
  <countries>
    <cupCountries>
      <country_code>sample string 1</country_code>
      <country_name>sample string 2</country_name>
      <nationality>sample string 3</nationality>
    </cupCountries>
    <cupCountries>
      <country_code>sample string 1</country_code>
      <country_name>sample string 2</country_name>
      <nationality>sample string 3</nationality>
    </cupCountries>
  </countries>
  <facility>
    <cupFacility>
      <facility_id>sample string 2</facility_id>
      <facility_name>sample string 3</facility_name>
      <property_id>sample string 1</property_id>
    </cupFacility>
    <cupFacility>
      <facility_id>sample string 2</facility_id>
      <facility_name>sample string 3</facility_name>
      <property_id>sample string 1</property_id>
    </cupFacility>
  </facility>
  <header>
    <member_end_date>sample string 3</member_end_date>
    <membership_desc>sample string 2</membership_desc>
    <membership_id>sample string 1</membership_id>
  </header>
  <members>
    <cupMember>
      <address>sample string 15</address>
      <age>sample string 17</age>
      <contact_no>sample string 4</contact_no>
      <designation>sample string 8</designation>
      <dob>sample string 16</dob>
      <email>sample string 5</email>
      <gender>sample string 14</gender>
      <image_file_name>sample string 6</image_file_name>
      <member_id>sample string 1</member_id>
      <name>sample string 2</name>
      <nationality>sample string 13</nationality>
      <occupation>sample string 3</occupation>
      <organization>sample string 9</organization>
      <parent_name>sample string 11</parent_name>
      <profile_id>sample string 7</profile_id>
      <regular_in>sample string 12</regular_in>
      <rel_desc>sample string 10</rel_desc>
      <rel_id>sample string 18</rel_id>
    </cupMember>
    <cupMember>
      <address>sample string 15</address>
      <age>sample string 17</age>
      <contact_no>sample string 4</contact_no>
      <designation>sample string 8</designation>
      <dob>sample string 16</dob>
      <email>sample string 5</email>
      <gender>sample string 14</gender>
      <image_file_name>sample string 6</image_file_name>
      <member_id>sample string 1</member_id>
      <name>sample string 2</name>
      <nationality>sample string 13</nationality>
      <occupation>sample string 3</occupation>
      <organization>sample string 9</organization>
      <parent_name>sample string 11</parent_name>
      <profile_id>sample string 7</profile_id>
      <regular_in>sample string 12</regular_in>
      <rel_desc>sample string 10</rel_desc>
      <rel_id>sample string 18</rel_id>
    </cupMember>
  </members>
  <occupations>
    <cupOccupation>
      <occupation_desc>sample string 2</occupation_desc>
      <occupation_id>sample string 1</occupation_id>
    </cupOccupation>
    <cupOccupation>
      <occupation_desc>sample string 2</occupation_desc>
      <occupation_id>sample string 1</occupation_id>
    </cupOccupation>
  </occupations>
  <total_rows>1</total_rows>
</cupFetchDirectoryResponse>