Back to API List

POST api/cupDocument/fetchDocCategories

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
property_id	string	None.
user_id	string	None.
seq_no	integer	None.
search_on	string	None.
doc_category_id	string	None.

Request Formats

application/json, text/json

Sample:

{
  "property_id": "sample string 1",
  "user_id": "sample string 2",
  "seq_no": 3,
  "search_on": "sample string 4",
  "doc_category_id": "sample string 5"
}

application/xml, text/xml

Sample:

<cupDocsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubWebApi.cupRequest">
  <doc_category_id>sample string 5</doc_category_id>
  <property_id>sample string 1</property_id>
  <search_on>sample string 4</search_on>
  <seq_no>3</seq_no>
  <user_id>sample string 2</user_id>
</cupDocsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

cupDocLoadResp

Name	Type	Additional information
docType	Collection of cupFetchDocumentCategory	None.
docs	Collection of cupDocs	None.
response_message	string	None.
response_code	string	None.
response_status	string	None.

Response Formats

application/json, text/json

Sample:

{
  "docType": [
    {
      "doc_category_id": "sample string 1",
      "doc_category_desc": "sample string 2"
    },
    {
      "doc_category_id": "sample string 1",
      "doc_category_desc": "sample string 2"
    }
  ],
  "docs": [
    {
      "doc_seq_no": 1,
      "doc_category_id": "sample string 2",
      "doc_desc": "sample string 3",
      "doc_file_path": "sample string 4",
      "doc_name": "sample string 5",
      "portal_flag": "sample string 6",
      "display_seq_no": 7,
      "valid_from": "sample string 8",
      "valid_to": "sample string 9",
      "is_freezed": true,
      "doc_category_desc": "sample string 11"
    },
    {
      "doc_seq_no": 1,
      "doc_category_id": "sample string 2",
      "doc_desc": "sample string 3",
      "doc_file_path": "sample string 4",
      "doc_name": "sample string 5",
      "portal_flag": "sample string 6",
      "display_seq_no": 7,
      "valid_from": "sample string 8",
      "valid_to": "sample string 9",
      "is_freezed": true,
      "doc_category_desc": "sample string 11"
    }
  ],
  "response_message": "sample string 1",
  "response_code": "sample string 2",
  "response_status": "sample string 3"
}

application/xml, text/xml

Sample:

<cupDocLoadResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubWebApi.cupResponse">
  <response_code>sample string 2</response_code>
  <response_message>sample string 1</response_message>
  <response_status>sample string 3</response_status>
  <docType>
    <cupFetchDocumentCategory>
      <doc_category_desc>sample string 2</doc_category_desc>
      <doc_category_id>sample string 1</doc_category_id>
    </cupFetchDocumentCategory>
    <cupFetchDocumentCategory>
      <doc_category_desc>sample string 2</doc_category_desc>
      <doc_category_id>sample string 1</doc_category_id>
    </cupFetchDocumentCategory>
  </docType>
  <docs>
    <cupDocs>
      <display_seq_no>7</display_seq_no>
      <doc_category_desc>sample string 11</doc_category_desc>
      <doc_category_id>sample string 2</doc_category_id>
      <doc_desc>sample string 3</doc_desc>
      <doc_file_path>sample string 4</doc_file_path>
      <doc_name>sample string 5</doc_name>
      <doc_seq_no>1</doc_seq_no>
      <is_freezed>true</is_freezed>
      <portal_flag>sample string 6</portal_flag>
      <valid_from>sample string 8</valid_from>
      <valid_to>sample string 9</valid_to>
    </cupDocs>
    <cupDocs>
      <display_seq_no>7</display_seq_no>
      <doc_category_desc>sample string 11</doc_category_desc>
      <doc_category_id>sample string 2</doc_category_id>
      <doc_desc>sample string 3</doc_desc>
      <doc_file_path>sample string 4</doc_file_path>
      <doc_name>sample string 5</doc_name>
      <doc_seq_no>1</doc_seq_no>
      <is_freezed>true</is_freezed>
      <portal_flag>sample string 6</portal_flag>
      <valid_from>sample string 8</valid_from>
      <valid_to>sample string 9</valid_to>
    </cupDocs>
  </docs>
</cupDocLoadResp>