POST api/NTSetting/PostCOSFormDocument

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
COSFormDocumentId	integer	None.
Name	string	String length: inclusive between 0 and 100
Template	string	String length: inclusive between 0 and 8000
TemplateCode	string	String length: inclusive between 0 and 5
lstCOSFormDocumentRequirement	Collection of COSFormDocumentRequirementDTO	None.
DownloadableDocumentName	string	String length: inclusive between 0 and 100
IsCustomizable	boolean	None.
IsCustom	boolean	None.
CorporationCode	string	None.
ValidFlag	boolean	None.
DateCreated	date	None.
DateUpdated	date	None.
UserIDCreated	integer	None.
UserIDUpdated	integer	None.
CompanyCode	string	String length: inclusive between 0 and 20
IsExcludeDiscount	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "COSFormDocumentId": 2,
  "Name": "sample string 3",
  "Template": "sample string 4",
  "TemplateCode": "sample string 5",
  "lstCOSFormDocumentRequirement": [
    {
      "Id": 1,
      "RequirementCodeId": 2,
      "RequirementCode": "sample string 3",
      "Value": "sample string 4",
      "RequirementDescription": "sample string 5",
      "TemplateCode": "sample string 6",
      "COSFormDocumentId": 7,
      "ValidFlag": true,
      "DateCreated": "2025-04-04T05:00:28.1426207-07:00",
      "DateUpdated": "2025-04-04T05:00:28.1426207-07:00",
      "UserIDCreated": 11,
      "UserIDUpdated": 12,
      "CompanyCode": "sample string 13",
      "IsExcludeDiscount": true
    },
    {
      "Id": 1,
      "RequirementCodeId": 2,
      "RequirementCode": "sample string 3",
      "Value": "sample string 4",
      "RequirementDescription": "sample string 5",
      "TemplateCode": "sample string 6",
      "COSFormDocumentId": 7,
      "ValidFlag": true,
      "DateCreated": "2025-04-04T05:00:28.1426207-07:00",
      "DateUpdated": "2025-04-04T05:00:28.1426207-07:00",
      "UserIDCreated": 11,
      "UserIDUpdated": 12,
      "CompanyCode": "sample string 13",
      "IsExcludeDiscount": true
    }
  ],
  "DownloadableDocumentName": "sample string 6",
  "IsCustomizable": true,
  "IsCustom": true,
  "CorporationCode": "sample string 9",
  "ValidFlag": true,
  "DateCreated": "2025-04-04T05:00:28.1426207-07:00",
  "DateUpdated": "2025-04-04T05:00:28.1426207-07:00",
  "UserIDCreated": 13,
  "UserIDUpdated": 14,
  "CompanyCode": "sample string 15",
  "IsExcludeDiscount": true
}

application/xml, text/xml

Sample:

<COSFormDocumentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASAP_BL.BL">
  <CompanyCode>sample string 15</CompanyCode>
  <DateCreated>2025-04-04T05:00:28.1426207-07:00</DateCreated>
  <DateUpdated>2025-04-04T05:00:28.1426207-07:00</DateUpdated>
  <IsExcludeDiscount>true</IsExcludeDiscount>
  <UserIDCreated>13</UserIDCreated>
  <UserIDUpdated>14</UserIDUpdated>
  <ValidFlag>true</ValidFlag>
  <COSFormDocumentId>2</COSFormDocumentId>
  <CorporationCode>sample string 9</CorporationCode>
  <DownloadableDocumentName>sample string 6</DownloadableDocumentName>
  <Id>1</Id>
  <IsCustom>true</IsCustom>
  <IsCustomizable>true</IsCustomizable>
  <Name>sample string 3</Name>
  <Template>sample string 4</Template>
  <TemplateCode>sample string 5</TemplateCode>
  <lstCOSFormDocumentRequirement>
    <COSFormDocumentRequirementDTO>
      <CompanyCode>sample string 13</CompanyCode>
      <DateCreated>2025-04-04T05:00:28.1426207-07:00</DateCreated>
      <DateUpdated>2025-04-04T05:00:28.1426207-07:00</DateUpdated>
      <IsExcludeDiscount>true</IsExcludeDiscount>
      <UserIDCreated>11</UserIDCreated>
      <UserIDUpdated>12</UserIDUpdated>
      <ValidFlag>true</ValidFlag>
      <COSFormDocumentId>7</COSFormDocumentId>
      <Id>1</Id>
      <RequirementCode>sample string 3</RequirementCode>
      <RequirementCodeId>2</RequirementCodeId>
      <RequirementDescription>sample string 5</RequirementDescription>
      <TemplateCode>sample string 6</TemplateCode>
      <Value>sample string 4</Value>
    </COSFormDocumentRequirementDTO>
    <COSFormDocumentRequirementDTO>
      <CompanyCode>sample string 13</CompanyCode>
      <DateCreated>2025-04-04T05:00:28.1426207-07:00</DateCreated>
      <DateUpdated>2025-04-04T05:00:28.1426207-07:00</DateUpdated>
      <IsExcludeDiscount>true</IsExcludeDiscount>
      <UserIDCreated>11</UserIDCreated>
      <UserIDUpdated>12</UserIDUpdated>
      <ValidFlag>true</ValidFlag>
      <COSFormDocumentId>7</COSFormDocumentId>
      <Id>1</Id>
      <RequirementCode>sample string 3</RequirementCode>
      <RequirementCodeId>2</RequirementCodeId>
      <RequirementDescription>sample string 5</RequirementDescription>
      <TemplateCode>sample string 6</TemplateCode>
      <Value>sample string 4</Value>
    </COSFormDocumentRequirementDTO>
  </lstCOSFormDocumentRequirement>
</COSFormDocumentDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AsapResponseOfCOSFormDocumentDTO

Name	Type	Additional information
isSuccess	boolean	None.
message	string	None.
jsonObj	COSFormDocumentDTO	None.
totalCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "isSuccess": true,
  "message": "sample string 2",
  "jsonObj": {
    "Id": 1,
    "COSFormDocumentId": 2,
    "Name": "sample string 3",
    "Template": "sample string 4",
    "TemplateCode": "sample string 5",
    "lstCOSFormDocumentRequirement": [
      {
        "Id": 1,
        "RequirementCodeId": 2,
        "RequirementCode": "sample string 3",
        "Value": "sample string 4",
        "RequirementDescription": "sample string 5",
        "TemplateCode": "sample string 6",
        "COSFormDocumentId": 7,
        "ValidFlag": true,
        "DateCreated": "2025-04-04T05:00:28.1582582-07:00",
        "DateUpdated": "2025-04-04T05:00:28.1582582-07:00",
        "UserIDCreated": 11,
        "UserIDUpdated": 12,
        "CompanyCode": "sample string 13",
        "IsExcludeDiscount": true
      },
      {
        "Id": 1,
        "RequirementCodeId": 2,
        "RequirementCode": "sample string 3",
        "Value": "sample string 4",
        "RequirementDescription": "sample string 5",
        "TemplateCode": "sample string 6",
        "COSFormDocumentId": 7,
        "ValidFlag": true,
        "DateCreated": "2025-04-04T05:00:28.1582582-07:00",
        "DateUpdated": "2025-04-04T05:00:28.1582582-07:00",
        "UserIDCreated": 11,
        "UserIDUpdated": 12,
        "CompanyCode": "sample string 13",
        "IsExcludeDiscount": true
      }
    ],
    "DownloadableDocumentName": "sample string 6",
    "IsCustomizable": true,
    "IsCustom": true,
    "CorporationCode": "sample string 9",
    "ValidFlag": true,
    "DateCreated": "2025-04-04T05:00:28.1582582-07:00",
    "DateUpdated": "2025-04-04T05:00:28.1582582-07:00",
    "UserIDCreated": 13,
    "UserIDUpdated": 14,
    "CompanyCode": "sample string 15",
    "IsExcludeDiscount": true
  },
  "totalCount": 3
}

application/xml, text/xml

Sample:

<AsapResponseOfCOSFormDocumentDTO3NYuOdgi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASAP_BL.Common">
  <isSuccess>true</isSuccess>
  <jsonObj xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASAP_BL.BL">
    <d2p1:CompanyCode>sample string 15</d2p1:CompanyCode>
    <d2p1:DateCreated>2025-04-04T05:00:28.1582582-07:00</d2p1:DateCreated>
    <d2p1:DateUpdated>2025-04-04T05:00:28.1582582-07:00</d2p1:DateUpdated>
    <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
    <d2p1:UserIDCreated>13</d2p1:UserIDCreated>
    <d2p1:UserIDUpdated>14</d2p1:UserIDUpdated>
    <d2p1:ValidFlag>true</d2p1:ValidFlag>
    <d2p1:COSFormDocumentId>2</d2p1:COSFormDocumentId>
    <d2p1:CorporationCode>sample string 9</d2p1:CorporationCode>
    <d2p1:DownloadableDocumentName>sample string 6</d2p1:DownloadableDocumentName>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsCustom>true</d2p1:IsCustom>
    <d2p1:IsCustomizable>true</d2p1:IsCustomizable>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Template>sample string 4</d2p1:Template>
    <d2p1:TemplateCode>sample string 5</d2p1:TemplateCode>
    <d2p1:lstCOSFormDocumentRequirement>
      <d2p1:COSFormDocumentRequirementDTO>
        <d2p1:CompanyCode>sample string 13</d2p1:CompanyCode>
        <d2p1:DateCreated>2025-04-04T05:00:28.1582582-07:00</d2p1:DateCreated>
        <d2p1:DateUpdated>2025-04-04T05:00:28.1582582-07:00</d2p1:DateUpdated>
        <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
        <d2p1:UserIDCreated>11</d2p1:UserIDCreated>
        <d2p1:UserIDUpdated>12</d2p1:UserIDUpdated>
        <d2p1:ValidFlag>true</d2p1:ValidFlag>
        <d2p1:COSFormDocumentId>7</d2p1:COSFormDocumentId>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:RequirementCode>sample string 3</d2p1:RequirementCode>
        <d2p1:RequirementCodeId>2</d2p1:RequirementCodeId>
        <d2p1:RequirementDescription>sample string 5</d2p1:RequirementDescription>
        <d2p1:TemplateCode>sample string 6</d2p1:TemplateCode>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:COSFormDocumentRequirementDTO>
      <d2p1:COSFormDocumentRequirementDTO>
        <d2p1:CompanyCode>sample string 13</d2p1:CompanyCode>
        <d2p1:DateCreated>2025-04-04T05:00:28.1582582-07:00</d2p1:DateCreated>
        <d2p1:DateUpdated>2025-04-04T05:00:28.1582582-07:00</d2p1:DateUpdated>
        <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
        <d2p1:UserIDCreated>11</d2p1:UserIDCreated>
        <d2p1:UserIDUpdated>12</d2p1:UserIDUpdated>
        <d2p1:ValidFlag>true</d2p1:ValidFlag>
        <d2p1:COSFormDocumentId>7</d2p1:COSFormDocumentId>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:RequirementCode>sample string 3</d2p1:RequirementCode>
        <d2p1:RequirementCodeId>2</d2p1:RequirementCodeId>
        <d2p1:RequirementDescription>sample string 5</d2p1:RequirementDescription>
        <d2p1:TemplateCode>sample string 6</d2p1:TemplateCode>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:COSFormDocumentRequirementDTO>
    </d2p1:lstCOSFormDocumentRequirement>
  </jsonObj>
  <message>sample string 2</message>
  <totalCount>3</totalCount>
</AsapResponseOfCOSFormDocumentDTO3NYuOdgi>