GET api/COSForm/GetForm?q={q}

Request Information

URI Parameters

Name	Description	Type	Additional information
q		string	Required

Body Parameters

None.

Response Information

Resource Description

AsapResponseOfCOSFormDetailDTO

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

Response Formats

application/json, text/json

Sample:

{
  "isSuccess": true,
  "message": "sample string 2",
  "jsonObj": {
    "COSFormEncounterObj": {
      "EncounterId": 1,
      "EntityId": 2,
      "CaseNo": 3,
      "EmployeeId": "sample string 4"
    },
    "COSFormQuestionList": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "QuestionType": 3,
        "CaseOutComeTypeId": 1,
        "CaseOutComeType": "sample string 4",
        "COSFormOptionList": [
          {
            "Id": 1,
            "Name": "sample string 2",
            "COSQuestionId": 3,
            "NeedMoreInfo": true,
            "ParentId": 1,
            "QuestionName": "sample string 5",
            "AnswerValue": 1,
            "AnswerDetail": "sample string 6",
            "ParentLevel1": 1,
            "COSFormId": 1,
            "ValidFlag": true,
            "DateCreated": "2025-04-03T19:02:33.50468-07:00",
            "DateUpdated": "2025-04-03T19:02:33.50468-07:00",
            "UserIDCreated": 10,
            "UserIDUpdated": 11,
            "CompanyCode": "sample string 12",
            "IsExcludeDiscount": true
          },
          {
            "Id": 1,
            "Name": "sample string 2",
            "COSQuestionId": 3,
            "NeedMoreInfo": true,
            "ParentId": 1,
            "QuestionName": "sample string 5",
            "AnswerValue": 1,
            "AnswerDetail": "sample string 6",
            "ParentLevel1": 1,
            "COSFormId": 1,
            "ValidFlag": true,
            "DateCreated": "2025-04-03T19:02:33.50468-07:00",
            "DateUpdated": "2025-04-03T19:02:33.50468-07:00",
            "UserIDCreated": 10,
            "UserIDUpdated": 11,
            "CompanyCode": "sample string 12",
            "IsExcludeDiscount": true
          }
        ],
        "COSFormTypeId": 5,
        "Form": "sample string 6",
        "ParentLevel1": 1,
        "OptionCount": 7,
        "ValidFlag": true,
        "DateCreated": "2025-04-03T19:02:33.50468-07:00",
        "DateUpdated": "2025-04-03T19:02:33.50468-07:00",
        "UserIDCreated": 11,
        "UserIDUpdated": 12,
        "CompanyCode": "sample string 13",
        "IsExcludeDiscount": true
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "QuestionType": 3,
        "CaseOutComeTypeId": 1,
        "CaseOutComeType": "sample string 4",
        "COSFormOptionList": [
          {
            "Id": 1,
            "Name": "sample string 2",
            "COSQuestionId": 3,
            "NeedMoreInfo": true,
            "ParentId": 1,
            "QuestionName": "sample string 5",
            "AnswerValue": 1,
            "AnswerDetail": "sample string 6",
            "ParentLevel1": 1,
            "COSFormId": 1,
            "ValidFlag": true,
            "DateCreated": "2025-04-03T19:02:33.50468-07:00",
            "DateUpdated": "2025-04-03T19:02:33.50468-07:00",
            "UserIDCreated": 10,
            "UserIDUpdated": 11,
            "CompanyCode": "sample string 12",
            "IsExcludeDiscount": true
          },
          {
            "Id": 1,
            "Name": "sample string 2",
            "COSQuestionId": 3,
            "NeedMoreInfo": true,
            "ParentId": 1,
            "QuestionName": "sample string 5",
            "AnswerValue": 1,
            "AnswerDetail": "sample string 6",
            "ParentLevel1": 1,
            "COSFormId": 1,
            "ValidFlag": true,
            "DateCreated": "2025-04-03T19:02:33.50468-07:00",
            "DateUpdated": "2025-04-03T19:02:33.50468-07:00",
            "UserIDCreated": 10,
            "UserIDUpdated": 11,
            "CompanyCode": "sample string 12",
            "IsExcludeDiscount": true
          }
        ],
        "COSFormTypeId": 5,
        "Form": "sample string 6",
        "ParentLevel1": 1,
        "OptionCount": 7,
        "ValidFlag": true,
        "DateCreated": "2025-04-03T19:02:33.50468-07:00",
        "DateUpdated": "2025-04-03T19:02:33.50468-07:00",
        "UserIDCreated": 11,
        "UserIDUpdated": 12,
        "CompanyCode": "sample string 13",
        "IsExcludeDiscount": true
      }
    ],
    "COSFormId": 1
  },
  "totalCount": 3
}

application/xml, text/xml

Sample:

<AsapResponseOfCOSFormDetailDTO3NYuOdgi 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:COSFormEncounterObj>
      <d2p1:CaseNo>3</d2p1:CaseNo>
      <d2p1:EmployeeId>sample string 4</d2p1:EmployeeId>
      <d2p1:EncounterId>1</d2p1:EncounterId>
      <d2p1:EntityId>2</d2p1:EntityId>
    </d2p1:COSFormEncounterObj>
    <d2p1:COSFormId>1</d2p1:COSFormId>
    <d2p1:COSFormQuestionList>
      <d2p1:COSFormQuestionDTO>
        <d2p1:CompanyCode>sample string 13</d2p1:CompanyCode>
        <d2p1:DateCreated>2025-04-03T19:02:33.50468-07:00</d2p1:DateCreated>
        <d2p1:DateUpdated>2025-04-03T19:02:33.50468-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:COSFormOptionList>
          <d2p1:COSFormOptionDTO>
            <d2p1:CompanyCode>sample string 12</d2p1:CompanyCode>
            <d2p1:DateCreated>2025-04-03T19:02:33.50468-07:00</d2p1:DateCreated>
            <d2p1:DateUpdated>2025-04-03T19:02:33.50468-07:00</d2p1:DateUpdated>
            <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
            <d2p1:UserIDCreated>10</d2p1:UserIDCreated>
            <d2p1:UserIDUpdated>11</d2p1:UserIDUpdated>
            <d2p1:ValidFlag>true</d2p1:ValidFlag>
            <d2p1:AnswerDetail>sample string 6</d2p1:AnswerDetail>
            <d2p1:AnswerValue>1</d2p1:AnswerValue>
            <d2p1:COSFormId>1</d2p1:COSFormId>
            <d2p1:COSQuestionId>3</d2p1:COSQuestionId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Name>sample string 2</d2p1:Name>
            <d2p1:NeedMoreInfo>true</d2p1:NeedMoreInfo>
            <d2p1:ParentId>1</d2p1:ParentId>
            <d2p1:ParentLevel1>1</d2p1:ParentLevel1>
            <d2p1:QuestionName>sample string 5</d2p1:QuestionName>
          </d2p1:COSFormOptionDTO>
          <d2p1:COSFormOptionDTO>
            <d2p1:CompanyCode>sample string 12</d2p1:CompanyCode>
            <d2p1:DateCreated>2025-04-03T19:02:33.50468-07:00</d2p1:DateCreated>
            <d2p1:DateUpdated>2025-04-03T19:02:33.50468-07:00</d2p1:DateUpdated>
            <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
            <d2p1:UserIDCreated>10</d2p1:UserIDCreated>
            <d2p1:UserIDUpdated>11</d2p1:UserIDUpdated>
            <d2p1:ValidFlag>true</d2p1:ValidFlag>
            <d2p1:AnswerDetail>sample string 6</d2p1:AnswerDetail>
            <d2p1:AnswerValue>1</d2p1:AnswerValue>
            <d2p1:COSFormId>1</d2p1:COSFormId>
            <d2p1:COSQuestionId>3</d2p1:COSQuestionId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Name>sample string 2</d2p1:Name>
            <d2p1:NeedMoreInfo>true</d2p1:NeedMoreInfo>
            <d2p1:ParentId>1</d2p1:ParentId>
            <d2p1:ParentLevel1>1</d2p1:ParentLevel1>
            <d2p1:QuestionName>sample string 5</d2p1:QuestionName>
          </d2p1:COSFormOptionDTO>
        </d2p1:COSFormOptionList>
        <d2p1:COSFormTypeId>5</d2p1:COSFormTypeId>
        <d2p1:CaseOutComeType>sample string 4</d2p1:CaseOutComeType>
        <d2p1:CaseOutComeTypeId>1</d2p1:CaseOutComeTypeId>
        <d2p1:Form>sample string 6</d2p1:Form>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:OptionCount>7</d2p1:OptionCount>
        <d2p1:ParentLevel1>1</d2p1:ParentLevel1>
        <d2p1:QuestionType>3</d2p1:QuestionType>
      </d2p1:COSFormQuestionDTO>
      <d2p1:COSFormQuestionDTO>
        <d2p1:CompanyCode>sample string 13</d2p1:CompanyCode>
        <d2p1:DateCreated>2025-04-03T19:02:33.50468-07:00</d2p1:DateCreated>
        <d2p1:DateUpdated>2025-04-03T19:02:33.50468-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:COSFormOptionList>
          <d2p1:COSFormOptionDTO>
            <d2p1:CompanyCode>sample string 12</d2p1:CompanyCode>
            <d2p1:DateCreated>2025-04-03T19:02:33.50468-07:00</d2p1:DateCreated>
            <d2p1:DateUpdated>2025-04-03T19:02:33.50468-07:00</d2p1:DateUpdated>
            <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
            <d2p1:UserIDCreated>10</d2p1:UserIDCreated>
            <d2p1:UserIDUpdated>11</d2p1:UserIDUpdated>
            <d2p1:ValidFlag>true</d2p1:ValidFlag>
            <d2p1:AnswerDetail>sample string 6</d2p1:AnswerDetail>
            <d2p1:AnswerValue>1</d2p1:AnswerValue>
            <d2p1:COSFormId>1</d2p1:COSFormId>
            <d2p1:COSQuestionId>3</d2p1:COSQuestionId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Name>sample string 2</d2p1:Name>
            <d2p1:NeedMoreInfo>true</d2p1:NeedMoreInfo>
            <d2p1:ParentId>1</d2p1:ParentId>
            <d2p1:ParentLevel1>1</d2p1:ParentLevel1>
            <d2p1:QuestionName>sample string 5</d2p1:QuestionName>
          </d2p1:COSFormOptionDTO>
          <d2p1:COSFormOptionDTO>
            <d2p1:CompanyCode>sample string 12</d2p1:CompanyCode>
            <d2p1:DateCreated>2025-04-03T19:02:33.50468-07:00</d2p1:DateCreated>
            <d2p1:DateUpdated>2025-04-03T19:02:33.50468-07:00</d2p1:DateUpdated>
            <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
            <d2p1:UserIDCreated>10</d2p1:UserIDCreated>
            <d2p1:UserIDUpdated>11</d2p1:UserIDUpdated>
            <d2p1:ValidFlag>true</d2p1:ValidFlag>
            <d2p1:AnswerDetail>sample string 6</d2p1:AnswerDetail>
            <d2p1:AnswerValue>1</d2p1:AnswerValue>
            <d2p1:COSFormId>1</d2p1:COSFormId>
            <d2p1:COSQuestionId>3</d2p1:COSQuestionId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Name>sample string 2</d2p1:Name>
            <d2p1:NeedMoreInfo>true</d2p1:NeedMoreInfo>
            <d2p1:ParentId>1</d2p1:ParentId>
            <d2p1:ParentLevel1>1</d2p1:ParentLevel1>
            <d2p1:QuestionName>sample string 5</d2p1:QuestionName>
          </d2p1:COSFormOptionDTO>
        </d2p1:COSFormOptionList>
        <d2p1:COSFormTypeId>5</d2p1:COSFormTypeId>
        <d2p1:CaseOutComeType>sample string 4</d2p1:CaseOutComeType>
        <d2p1:CaseOutComeTypeId>1</d2p1:CaseOutComeTypeId>
        <d2p1:Form>sample string 6</d2p1:Form>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:OptionCount>7</d2p1:OptionCount>
        <d2p1:ParentLevel1>1</d2p1:ParentLevel1>
        <d2p1:QuestionType>3</d2p1:QuestionType>
      </d2p1:COSFormQuestionDTO>
    </d2p1:COSFormQuestionList>
  </jsonObj>
  <message>sample string 2</message>
  <totalCount>3</totalCount>
</AsapResponseOfCOSFormDetailDTO3NYuOdgi>