POST api/TablesManagement/ADUDocumentDescription?pType={pType}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pType

string

Required

Body Parameters

DocumentDescription
NameDescriptionTypeAdditional information
code

integer

None.

description

string

Required

String length: inclusive between 0 and 40

active

string

Matching regular expression pattern: ^[yn]{1}$

String length: inclusive between 0 and 1

agree_email

string

Matching regular expression pattern: ^[yn]{1}$

String length: inclusive between 0 and 1

for_ascii

string

Matching regular expression pattern: ^[yn]{1}$

String length: inclusive between 0 and 1

doc_type_code

string

String length: inclusive between 0 and 2

interface_code

string

String length: inclusive between 0 and 10

old_code

integer

None.

DocumentsStores

Collection of DocumentsStore

None.

DocumentRecord

Collection of DocumentRecord

None.

Request Formats

application/json, text/json

Sample:
{
  "code": 1,
  "description": "sample string 2",
  "active": "sample string 3",
  "agree_email": "sample string 4",
  "for_ascii": "sample string 5",
  "doc_type_code": "sample string 6",
  "interface_code": "sample string 7",
  "old_code": 1,
  "DocumentsStores": [
    {
      "document_code": 1,
      "cust_num": 2,
      "visit_code": 1,
      "service_code": 1,
      "debit_line": 1,
      "doc_desc": 3,
      "free_definition": "sample string 4",
      "remark": "sample string 5",
      "file_extension": "sample string 6",
      "externalAccessionNumber": "sample string 7",
      "agree_email": "sample string 8",
      "active": "sample string 9",
      "addate": "2024-11-21T11:39:56.6924466+02:00",
      "repacedocdate": "2024-11-21T11:39:56.6924466+02:00",
      "display_to_cust": "sample string 10",
      "prolongation_days": 1,
      "firstseen": "2024-11-21T11:39:56.6924466+02:00",
      "interface_code": "sample string 11",
      "old_code": 1,
      "cust_view_date": "2024-11-21T11:39:56.6924466+02:00"
    },
    {
      "document_code": 1,
      "cust_num": 2,
      "visit_code": 1,
      "service_code": 1,
      "debit_line": 1,
      "doc_desc": 3,
      "free_definition": "sample string 4",
      "remark": "sample string 5",
      "file_extension": "sample string 6",
      "externalAccessionNumber": "sample string 7",
      "agree_email": "sample string 8",
      "active": "sample string 9",
      "addate": "2024-11-21T11:39:56.6924466+02:00",
      "repacedocdate": "2024-11-21T11:39:56.6924466+02:00",
      "display_to_cust": "sample string 10",
      "prolongation_days": 1,
      "firstseen": "2024-11-21T11:39:56.6924466+02:00",
      "interface_code": "sample string 11",
      "old_code": 1,
      "cust_view_date": "2024-11-21T11:39:56.6924466+02:00"
    }
  ],
  "DocumentRecord": [
    {
      "document_code": 1,
      "document_name": "sample string 2",
      "doc_desc": 1,
      "insur_code": 1,
      "employee_code": 1,
      "branch_code": 1,
      "create_date": "2024-11-21T11:39:56.6924466+02:00",
      "agreement_start_date": "2024-11-21T11:39:56.6924466+02:00",
      "agreement_end_date": "2024-11-21T11:39:56.6924466+02:00",
      "active": "sample string 4"
    },
    {
      "document_code": 1,
      "document_name": "sample string 2",
      "doc_desc": 1,
      "insur_code": 1,
      "employee_code": 1,
      "branch_code": 1,
      "create_date": "2024-11-21T11:39:56.6924466+02:00",
      "agreement_start_date": "2024-11-21T11:39:56.6924466+02:00",
      "agreement_end_date": "2024-11-21T11:39:56.6924466+02:00",
      "active": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<DocumentDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CustDemog">
  <DocumentRecord>
    <DocumentRecord>
      <active>sample string 4</active>
      <agreement_end_date>2024-11-21T11:39:56.6924466+02:00</agreement_end_date>
      <agreement_start_date>2024-11-21T11:39:56.6924466+02:00</agreement_start_date>
      <branch_code>1</branch_code>
      <create_date>2024-11-21T11:39:56.6924466+02:00</create_date>
      <doc_desc>1</doc_desc>
      <document_code>1</document_code>
      <document_name>sample string 2</document_name>
      <employee_code>1</employee_code>
      <insur_code>1</insur_code>
    </DocumentRecord>
    <DocumentRecord>
      <active>sample string 4</active>
      <agreement_end_date>2024-11-21T11:39:56.6924466+02:00</agreement_end_date>
      <agreement_start_date>2024-11-21T11:39:56.6924466+02:00</agreement_start_date>
      <branch_code>1</branch_code>
      <create_date>2024-11-21T11:39:56.6924466+02:00</create_date>
      <doc_desc>1</doc_desc>
      <document_code>1</document_code>
      <document_name>sample string 2</document_name>
      <employee_code>1</employee_code>
      <insur_code>1</insur_code>
    </DocumentRecord>
  </DocumentRecord>
  <DocumentsStores>
    <DocumentsStore>
      <active>sample string 9</active>
      <addate>2024-11-21T11:39:56.6924466+02:00</addate>
      <agree_email>sample string 8</agree_email>
      <cust_num>2</cust_num>
      <cust_view_date>2024-11-21T11:39:56.6924466+02:00</cust_view_date>
      <debit_line>1</debit_line>
      <display_to_cust>sample string 10</display_to_cust>
      <doc_desc>3</doc_desc>
      <document_code>1</document_code>
      <externalAccessionNumber>sample string 7</externalAccessionNumber>
      <file_extension>sample string 6</file_extension>
      <firstseen>2024-11-21T11:39:56.6924466+02:00</firstseen>
      <free_definition>sample string 4</free_definition>
      <interface_code>sample string 11</interface_code>
      <old_code>1</old_code>
      <prolongation_days>1</prolongation_days>
      <remark>sample string 5</remark>
      <repacedocdate>2024-11-21T11:39:56.6924466+02:00</repacedocdate>
      <service_code>1</service_code>
      <visit_code>1</visit_code>
    </DocumentsStore>
    <DocumentsStore>
      <active>sample string 9</active>
      <addate>2024-11-21T11:39:56.6924466+02:00</addate>
      <agree_email>sample string 8</agree_email>
      <cust_num>2</cust_num>
      <cust_view_date>2024-11-21T11:39:56.6924466+02:00</cust_view_date>
      <debit_line>1</debit_line>
      <display_to_cust>sample string 10</display_to_cust>
      <doc_desc>3</doc_desc>
      <document_code>1</document_code>
      <externalAccessionNumber>sample string 7</externalAccessionNumber>
      <file_extension>sample string 6</file_extension>
      <firstseen>2024-11-21T11:39:56.6924466+02:00</firstseen>
      <free_definition>sample string 4</free_definition>
      <interface_code>sample string 11</interface_code>
      <old_code>1</old_code>
      <prolongation_days>1</prolongation_days>
      <remark>sample string 5</remark>
      <repacedocdate>2024-11-21T11:39:56.6924466+02:00</repacedocdate>
      <service_code>1</service_code>
      <visit_code>1</visit_code>
    </DocumentsStore>
  </DocumentsStores>
  <active>sample string 3</active>
  <agree_email>sample string 4</agree_email>
  <code>1</code>
  <description>sample string 2</description>
  <doc_type_code>sample string 6</doc_type_code>
  <for_ascii>sample string 5</for_ascii>
  <interface_code>sample string 7</interface_code>
  <old_code>1</old_code>
</DocumentDescription>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DocumentDescription'.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

DocumentDescription
NameDescriptionTypeAdditional information
code

integer

None.

description

string

Required

String length: inclusive between 0 and 40

active

string

Matching regular expression pattern: ^[yn]{1}$

String length: inclusive between 0 and 1

agree_email

string

Matching regular expression pattern: ^[yn]{1}$

String length: inclusive between 0 and 1

for_ascii

string

Matching regular expression pattern: ^[yn]{1}$

String length: inclusive between 0 and 1

doc_type_code

string

String length: inclusive between 0 and 2

interface_code

string

String length: inclusive between 0 and 10

old_code

integer

None.

DocumentsStores

Collection of DocumentsStore

None.

DocumentRecord

Collection of DocumentRecord

None.

Response Formats

application/json, text/json

Sample:
{
  "code": 1,
  "description": "sample string 2",
  "active": "sample string 3",
  "agree_email": "sample string 4",
  "for_ascii": "sample string 5",
  "doc_type_code": "sample string 6",
  "interface_code": "sample string 7",
  "old_code": 1,
  "DocumentsStores": [
    {
      "document_code": 1,
      "cust_num": 2,
      "visit_code": 1,
      "service_code": 1,
      "debit_line": 1,
      "doc_desc": 3,
      "free_definition": "sample string 4",
      "remark": "sample string 5",
      "file_extension": "sample string 6",
      "externalAccessionNumber": "sample string 7",
      "agree_email": "sample string 8",
      "active": "sample string 9",
      "addate": "2024-11-21T11:39:56.7236971+02:00",
      "repacedocdate": "2024-11-21T11:39:56.7236971+02:00",
      "display_to_cust": "sample string 10",
      "prolongation_days": 1,
      "firstseen": "2024-11-21T11:39:56.7236971+02:00",
      "interface_code": "sample string 11",
      "old_code": 1,
      "cust_view_date": "2024-11-21T11:39:56.7236971+02:00"
    },
    {
      "document_code": 1,
      "cust_num": 2,
      "visit_code": 1,
      "service_code": 1,
      "debit_line": 1,
      "doc_desc": 3,
      "free_definition": "sample string 4",
      "remark": "sample string 5",
      "file_extension": "sample string 6",
      "externalAccessionNumber": "sample string 7",
      "agree_email": "sample string 8",
      "active": "sample string 9",
      "addate": "2024-11-21T11:39:56.7236971+02:00",
      "repacedocdate": "2024-11-21T11:39:56.7236971+02:00",
      "display_to_cust": "sample string 10",
      "prolongation_days": 1,
      "firstseen": "2024-11-21T11:39:56.7236971+02:00",
      "interface_code": "sample string 11",
      "old_code": 1,
      "cust_view_date": "2024-11-21T11:39:56.7236971+02:00"
    }
  ],
  "DocumentRecord": [
    {
      "document_code": 1,
      "document_name": "sample string 2",
      "doc_desc": 1,
      "insur_code": 1,
      "employee_code": 1,
      "branch_code": 1,
      "create_date": "2024-11-21T11:39:56.7236971+02:00",
      "agreement_start_date": "2024-11-21T11:39:56.7236971+02:00",
      "agreement_end_date": "2024-11-21T11:39:56.7236971+02:00",
      "active": "sample string 4"
    },
    {
      "document_code": 1,
      "document_name": "sample string 2",
      "doc_desc": 1,
      "insur_code": 1,
      "employee_code": 1,
      "branch_code": 1,
      "create_date": "2024-11-21T11:39:56.7236971+02:00",
      "agreement_start_date": "2024-11-21T11:39:56.7236971+02:00",
      "agreement_end_date": "2024-11-21T11:39:56.7236971+02:00",
      "active": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<DocumentDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CustDemog">
  <DocumentRecord>
    <DocumentRecord>
      <active>sample string 4</active>
      <agreement_end_date>2024-11-21T11:39:56.7236971+02:00</agreement_end_date>
      <agreement_start_date>2024-11-21T11:39:56.7236971+02:00</agreement_start_date>
      <branch_code>1</branch_code>
      <create_date>2024-11-21T11:39:56.7236971+02:00</create_date>
      <doc_desc>1</doc_desc>
      <document_code>1</document_code>
      <document_name>sample string 2</document_name>
      <employee_code>1</employee_code>
      <insur_code>1</insur_code>
    </DocumentRecord>
    <DocumentRecord>
      <active>sample string 4</active>
      <agreement_end_date>2024-11-21T11:39:56.7236971+02:00</agreement_end_date>
      <agreement_start_date>2024-11-21T11:39:56.7236971+02:00</agreement_start_date>
      <branch_code>1</branch_code>
      <create_date>2024-11-21T11:39:56.7236971+02:00</create_date>
      <doc_desc>1</doc_desc>
      <document_code>1</document_code>
      <document_name>sample string 2</document_name>
      <employee_code>1</employee_code>
      <insur_code>1</insur_code>
    </DocumentRecord>
  </DocumentRecord>
  <DocumentsStores>
    <DocumentsStore>
      <active>sample string 9</active>
      <addate>2024-11-21T11:39:56.7236971+02:00</addate>
      <agree_email>sample string 8</agree_email>
      <cust_num>2</cust_num>
      <cust_view_date>2024-11-21T11:39:56.7236971+02:00</cust_view_date>
      <debit_line>1</debit_line>
      <display_to_cust>sample string 10</display_to_cust>
      <doc_desc>3</doc_desc>
      <document_code>1</document_code>
      <externalAccessionNumber>sample string 7</externalAccessionNumber>
      <file_extension>sample string 6</file_extension>
      <firstseen>2024-11-21T11:39:56.7236971+02:00</firstseen>
      <free_definition>sample string 4</free_definition>
      <interface_code>sample string 11</interface_code>
      <old_code>1</old_code>
      <prolongation_days>1</prolongation_days>
      <remark>sample string 5</remark>
      <repacedocdate>2024-11-21T11:39:56.7236971+02:00</repacedocdate>
      <service_code>1</service_code>
      <visit_code>1</visit_code>
    </DocumentsStore>
    <DocumentsStore>
      <active>sample string 9</active>
      <addate>2024-11-21T11:39:56.7236971+02:00</addate>
      <agree_email>sample string 8</agree_email>
      <cust_num>2</cust_num>
      <cust_view_date>2024-11-21T11:39:56.7236971+02:00</cust_view_date>
      <debit_line>1</debit_line>
      <display_to_cust>sample string 10</display_to_cust>
      <doc_desc>3</doc_desc>
      <document_code>1</document_code>
      <externalAccessionNumber>sample string 7</externalAccessionNumber>
      <file_extension>sample string 6</file_extension>
      <firstseen>2024-11-21T11:39:56.7236971+02:00</firstseen>
      <free_definition>sample string 4</free_definition>
      <interface_code>sample string 11</interface_code>
      <old_code>1</old_code>
      <prolongation_days>1</prolongation_days>
      <remark>sample string 5</remark>
      <repacedocdate>2024-11-21T11:39:56.7236971+02:00</repacedocdate>
      <service_code>1</service_code>
      <visit_code>1</visit_code>
    </DocumentsStore>
  </DocumentsStores>
  <active>sample string 3</active>
  <agree_email>sample string 4</agree_email>
  <code>1</code>
  <description>sample string 2</description>
  <doc_type_code>sample string 6</doc_type_code>
  <for_ascii>sample string 5</for_ascii>
  <interface_code>sample string 7</interface_code>
  <old_code>1</old_code>
</DocumentDescription>

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.