GET api/NTSummary/GetAllCOSFormDocument?q={q}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| q | string |
Required |
Body Parameters
None.
Response Information
Resource Description
AsapResponseOfListOfSummaryCOSFormDocumentListDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| isSuccess | boolean |
None. |
|
| message | string |
None. |
|
| jsonObj | Collection of SummaryCOSFormDocumentListDTO |
None. |
|
| totalCount | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"isSuccess": true,
"message": "sample string 2",
"jsonObj": [
{
"COSFormDocumentName": "sample string 1",
"COSFormName": "sample string 2",
"COSFormDocumentId": 3,
"CaseNo": 4,
"EncounterId": 5,
"Status": 6,
"State": "sample string 7",
"PhysicianId": 1,
"AddendumId": 1,
"OrderId": 1,
"OrderImagingTypeName": "sample string 8",
"OrderMedicationId": 1,
"OrderMedicationName": "sample string 9",
"BeforeChangePhyisicianId": 10,
"OrderRequestedBy": 1,
"OrderDateCreated": "2025-10-30T07:43:44.4378901-07:00",
"OrderMedicationRequestedBy": 1,
"OrderMedicationDateCreated": "2025-10-30T07:43:44.4378901-07:00",
"IsVisibleOnSummary": true,
"AvailableAfterEncounterClose": true,
"Sequence": 1,
"DispositionTypeId": 13,
"DispositionId": 14,
"Id": 15,
"Code": "sample string 16",
"OrderCategoryId": 17,
"DocumentCode": "sample string 18",
"EntityTypeId": 19
},
{
"COSFormDocumentName": "sample string 1",
"COSFormName": "sample string 2",
"COSFormDocumentId": 3,
"CaseNo": 4,
"EncounterId": 5,
"Status": 6,
"State": "sample string 7",
"PhysicianId": 1,
"AddendumId": 1,
"OrderId": 1,
"OrderImagingTypeName": "sample string 8",
"OrderMedicationId": 1,
"OrderMedicationName": "sample string 9",
"BeforeChangePhyisicianId": 10,
"OrderRequestedBy": 1,
"OrderDateCreated": "2025-10-30T07:43:44.4378901-07:00",
"OrderMedicationRequestedBy": 1,
"OrderMedicationDateCreated": "2025-10-30T07:43:44.4378901-07:00",
"IsVisibleOnSummary": true,
"AvailableAfterEncounterClose": true,
"Sequence": 1,
"DispositionTypeId": 13,
"DispositionId": 14,
"Id": 15,
"Code": "sample string 16",
"OrderCategoryId": 17,
"DocumentCode": "sample string 18",
"EntityTypeId": 19
}
],
"totalCount": 3
}
application/xml, text/xml
Sample:
<AsapResponseOfArrayOfSummaryCOSFormDocumentListDTO3NYuOdgi 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:SummaryCOSFormDocumentListDTO>
<d2p1:AddendumId>1</d2p1:AddendumId>
<d2p1:AvailableAfterEncounterClose>true</d2p1:AvailableAfterEncounterClose>
<d2p1:BeforeChangePhyisicianId>10</d2p1:BeforeChangePhyisicianId>
<d2p1:COSFormDocumentId>3</d2p1:COSFormDocumentId>
<d2p1:COSFormDocumentName>sample string 1</d2p1:COSFormDocumentName>
<d2p1:COSFormName>sample string 2</d2p1:COSFormName>
<d2p1:CaseNo>4</d2p1:CaseNo>
<d2p1:Code>sample string 16</d2p1:Code>
<d2p1:DispositionId>14</d2p1:DispositionId>
<d2p1:DispositionTypeId>13</d2p1:DispositionTypeId>
<d2p1:DocumentCode>sample string 18</d2p1:DocumentCode>
<d2p1:EncounterId>5</d2p1:EncounterId>
<d2p1:EntityTypeId>19</d2p1:EntityTypeId>
<d2p1:Id>15</d2p1:Id>
<d2p1:IsVisibleOnSummary>true</d2p1:IsVisibleOnSummary>
<d2p1:OrderCategoryId>17</d2p1:OrderCategoryId>
<d2p1:OrderDateCreated>2025-10-30T07:43:44.4378901-07:00</d2p1:OrderDateCreated>
<d2p1:OrderId>1</d2p1:OrderId>
<d2p1:OrderImagingTypeName>sample string 8</d2p1:OrderImagingTypeName>
<d2p1:OrderMedicationDateCreated>2025-10-30T07:43:44.4378901-07:00</d2p1:OrderMedicationDateCreated>
<d2p1:OrderMedicationId>1</d2p1:OrderMedicationId>
<d2p1:OrderMedicationName>sample string 9</d2p1:OrderMedicationName>
<d2p1:OrderMedicationRequestedBy>1</d2p1:OrderMedicationRequestedBy>
<d2p1:OrderRequestedBy>1</d2p1:OrderRequestedBy>
<d2p1:PhysicianId>1</d2p1:PhysicianId>
<d2p1:Sequence>1</d2p1:Sequence>
<d2p1:State>sample string 7</d2p1:State>
<d2p1:Status>6</d2p1:Status>
</d2p1:SummaryCOSFormDocumentListDTO>
<d2p1:SummaryCOSFormDocumentListDTO>
<d2p1:AddendumId>1</d2p1:AddendumId>
<d2p1:AvailableAfterEncounterClose>true</d2p1:AvailableAfterEncounterClose>
<d2p1:BeforeChangePhyisicianId>10</d2p1:BeforeChangePhyisicianId>
<d2p1:COSFormDocumentId>3</d2p1:COSFormDocumentId>
<d2p1:COSFormDocumentName>sample string 1</d2p1:COSFormDocumentName>
<d2p1:COSFormName>sample string 2</d2p1:COSFormName>
<d2p1:CaseNo>4</d2p1:CaseNo>
<d2p1:Code>sample string 16</d2p1:Code>
<d2p1:DispositionId>14</d2p1:DispositionId>
<d2p1:DispositionTypeId>13</d2p1:DispositionTypeId>
<d2p1:DocumentCode>sample string 18</d2p1:DocumentCode>
<d2p1:EncounterId>5</d2p1:EncounterId>
<d2p1:EntityTypeId>19</d2p1:EntityTypeId>
<d2p1:Id>15</d2p1:Id>
<d2p1:IsVisibleOnSummary>true</d2p1:IsVisibleOnSummary>
<d2p1:OrderCategoryId>17</d2p1:OrderCategoryId>
<d2p1:OrderDateCreated>2025-10-30T07:43:44.4378901-07:00</d2p1:OrderDateCreated>
<d2p1:OrderId>1</d2p1:OrderId>
<d2p1:OrderImagingTypeName>sample string 8</d2p1:OrderImagingTypeName>
<d2p1:OrderMedicationDateCreated>2025-10-30T07:43:44.4378901-07:00</d2p1:OrderMedicationDateCreated>
<d2p1:OrderMedicationId>1</d2p1:OrderMedicationId>
<d2p1:OrderMedicationName>sample string 9</d2p1:OrderMedicationName>
<d2p1:OrderMedicationRequestedBy>1</d2p1:OrderMedicationRequestedBy>
<d2p1:OrderRequestedBy>1</d2p1:OrderRequestedBy>
<d2p1:PhysicianId>1</d2p1:PhysicianId>
<d2p1:Sequence>1</d2p1:Sequence>
<d2p1:State>sample string 7</d2p1:State>
<d2p1:Status>6</d2p1:Status>
</d2p1:SummaryCOSFormDocumentListDTO>
</jsonObj>
<message>sample string 2</message>
<totalCount>3</totalCount>
</AsapResponseOfArrayOfSummaryCOSFormDocumentListDTO3NYuOdgi>