GET api/NTCosCompany/GetCOSFormDocument?q={q}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
q

string

Required

Body Parameters

None.

Response Information

Resource Description

AsapResponseOfListOfCOSFormDocumentDTO
NameDescriptionTypeAdditional information
isSuccess

boolean

None.

message

string

None.

jsonObj

Collection of 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-03T19:19:42.0527485-07:00",
          "DateUpdated": "2025-04-03T19:19:42.0527485-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-03T19:19:42.0527485-07:00",
          "DateUpdated": "2025-04-03T19:19:42.0527485-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-03T19:19:42.0685612-07:00",
      "DateUpdated": "2025-04-03T19:19:42.0685612-07:00",
      "UserIDCreated": 13,
      "UserIDUpdated": 14,
      "CompanyCode": "sample string 15",
      "IsExcludeDiscount": true
    },
    {
      "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-03T19:19:42.0527485-07:00",
          "DateUpdated": "2025-04-03T19:19:42.0527485-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-03T19:19:42.0527485-07:00",
          "DateUpdated": "2025-04-03T19:19:42.0527485-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-03T19:19:42.0685612-07:00",
      "DateUpdated": "2025-04-03T19:19:42.0685612-07:00",
      "UserIDCreated": 13,
      "UserIDUpdated": 14,
      "CompanyCode": "sample string 15",
      "IsExcludeDiscount": true
    }
  ],
  "totalCount": 3
}

application/xml, text/xml

Sample:
<AsapResponseOfArrayOfCOSFormDocumentDTO3NYuOdgi 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:COSFormDocumentDTO>
      <d2p1:CompanyCode>sample string 15</d2p1:CompanyCode>
      <d2p1:DateCreated>2025-04-03T19:19:42.0685612-07:00</d2p1:DateCreated>
      <d2p1:DateUpdated>2025-04-03T19:19:42.0685612-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-03T19:19:42.0527485-07:00</d2p1:DateCreated>
          <d2p1:DateUpdated>2025-04-03T19:19:42.0527485-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-03T19:19:42.0527485-07:00</d2p1:DateCreated>
          <d2p1:DateUpdated>2025-04-03T19:19:42.0527485-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>
    </d2p1:COSFormDocumentDTO>
    <d2p1:COSFormDocumentDTO>
      <d2p1:CompanyCode>sample string 15</d2p1:CompanyCode>
      <d2p1:DateCreated>2025-04-03T19:19:42.0685612-07:00</d2p1:DateCreated>
      <d2p1:DateUpdated>2025-04-03T19:19:42.0685612-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-03T19:19:42.0527485-07:00</d2p1:DateCreated>
          <d2p1:DateUpdated>2025-04-03T19:19:42.0527485-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-03T19:19:42.0527485-07:00</d2p1:DateCreated>
          <d2p1:DateUpdated>2025-04-03T19:19:42.0527485-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>
    </d2p1:COSFormDocumentDTO>
  </jsonObj>
  <message>sample string 2</message>
  <totalCount>3</totalCount>
</AsapResponseOfArrayOfCOSFormDocumentDTO3NYuOdgi>