POST api/cupFetchDirectory/LoadDirectory
Request Information
URI Parameters
None.
Body Parameters
cupFetchDirectoryRequest| Name | Description | 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
cupFetchDirectoryLoadResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| members | Collection of cupMember |
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"
}
],
"total_rows": 1,
"response_message": "sample string 2",
"response_code": "sample string 3",
"response_status": "sample string 4"
}
application/xml, text/xml
Sample:
<cupFetchDirectoryLoadResponse 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>
<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>
<total_rows>1</total_rows>
</cupFetchDirectoryLoadResponse>