GET v1/form/get?UserId={UserId}&ProviderId={ProviderId}&OperatorId={OperatorId}&IsOperator={IsOperator}&IsProvider={IsProvider}&FormCode={FormCode}

Request Information

URI Parameters

Name	Type	Additional information
UserId	string	None.
ProviderId	string	None.
OperatorId	string	None.
IsOperator	boolean	None.
IsProvider	boolean	None.
FormCode	string	None.

Body Parameters

None.

Response Information

Resource Description

ApiResponseNewOfFormResponseDto

Name	Type	Additional information
status	integer	None.
message	string	None.
data	FormResponseDto	None.

Response Formats

application/json, text/json

Sample:

{
  "status": 1,
  "message": "sample string 2",
  "data": {
    "formId": "7b5ce85e-1167-49df-8629-b7c589bd67ed",
    "formTitle": "sample string 1",
    "formCode": "sample string 2",
    "formVersion": 3,
    "formStatus": "sample string 4",
    "formFields": [
      {
        "fieldID": "eb5d9093-bb7f-477d-89cd-8ada85c63070",
        "fieldLabel": "sample string 1",
        "fieldTitle": "sample string 2",
        "fieldType": "sample string 3",
        "fieldTypeFixedCode": "sample string 4",
        "displayOrder": 5,
        "placeholder": "sample string 6",
        "isRequired": true,
        "isHidden": true,
        "isSLA": true,
        "options": [
          {
            "optionID": "93fb316c-694b-4580-88d2-0dee7a8e391b",
            "optionText": "sample string 1",
            "fieldID": "f431d59c-f48a-49fa-94c7-17e7ce143021",
            "workflowID": "8583c2fe-43f1-4f1a-b5e8-844d7efe20fa"
          },
          {
            "optionID": "93fb316c-694b-4580-88d2-0dee7a8e391b",
            "optionText": "sample string 1",
            "fieldID": "f431d59c-f48a-49fa-94c7-17e7ce143021",
            "workflowID": "8583c2fe-43f1-4f1a-b5e8-844d7efe20fa"
          }
        ],
        "referenceTable": "sample string 10",
        "isAddress": true
      },
      {
        "fieldID": "eb5d9093-bb7f-477d-89cd-8ada85c63070",
        "fieldLabel": "sample string 1",
        "fieldTitle": "sample string 2",
        "fieldType": "sample string 3",
        "fieldTypeFixedCode": "sample string 4",
        "displayOrder": 5,
        "placeholder": "sample string 6",
        "isRequired": true,
        "isHidden": true,
        "isSLA": true,
        "options": [
          {
            "optionID": "93fb316c-694b-4580-88d2-0dee7a8e391b",
            "optionText": "sample string 1",
            "fieldID": "f431d59c-f48a-49fa-94c7-17e7ce143021",
            "workflowID": "8583c2fe-43f1-4f1a-b5e8-844d7efe20fa"
          },
          {
            "optionID": "93fb316c-694b-4580-88d2-0dee7a8e391b",
            "optionText": "sample string 1",
            "fieldID": "f431d59c-f48a-49fa-94c7-17e7ce143021",
            "workflowID": "8583c2fe-43f1-4f1a-b5e8-844d7efe20fa"
          }
        ],
        "referenceTable": "sample string 10",
        "isAddress": true
      }
    ],
    "formConditions": [
      {
        "conditionID": "902a9b67-297c-4620-b974-80b639dcb114",
        "sourceFieldID": "ba46b2be-7354-4039-9cde-70a483d53934",
        "sourceFieldTitle": "sample string 1",
        "sourceFieldTypeTitle": "sample string 2",
        "conditionValueId": "sample string 3",
        "conditionValue": "sample string 4",
        "conditionType": "sample string 5",
        "actionType": "sample string 6",
        "targetFieldID": "5b663316-3c23-4c42-9b7c-188f8a86f4fc",
        "targetFieldTitle": "sample string 7"
      },
      {
        "conditionID": "902a9b67-297c-4620-b974-80b639dcb114",
        "sourceFieldID": "ba46b2be-7354-4039-9cde-70a483d53934",
        "sourceFieldTitle": "sample string 1",
        "sourceFieldTypeTitle": "sample string 2",
        "conditionValueId": "sample string 3",
        "conditionValue": "sample string 4",
        "conditionType": "sample string 5",
        "actionType": "sample string 6",
        "targetFieldID": "5b663316-3c23-4c42-9b7c-188f8a86f4fc",
        "targetFieldTitle": "sample string 7"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ApiResponseNewOfFormResponseDtoX7UxrhxG xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OrionDAL.ApiModels.Version1">
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/OrionDAL.ApiModels.Contracts.Version1">
    <d2p1:FormCode>sample string 2</d2p1:FormCode>
    <d2p1:FormConditions>
      <d2p1:FormConditionDto>
        <d2p1:ActionType>sample string 6</d2p1:ActionType>
        <d2p1:ConditionID>902a9b67-297c-4620-b974-80b639dcb114</d2p1:ConditionID>
        <d2p1:ConditionType>sample string 5</d2p1:ConditionType>
        <d2p1:ConditionValue>sample string 4</d2p1:ConditionValue>
        <d2p1:ConditionValueId>sample string 3</d2p1:ConditionValueId>
        <d2p1:SourceFieldID>ba46b2be-7354-4039-9cde-70a483d53934</d2p1:SourceFieldID>
        <d2p1:SourceFieldTitle>sample string 1</d2p1:SourceFieldTitle>
        <d2p1:SourceFieldTypeTitle>sample string 2</d2p1:SourceFieldTypeTitle>
        <d2p1:TargetFieldID>5b663316-3c23-4c42-9b7c-188f8a86f4fc</d2p1:TargetFieldID>
        <d2p1:TargetFieldTitle>sample string 7</d2p1:TargetFieldTitle>
      </d2p1:FormConditionDto>
      <d2p1:FormConditionDto>
        <d2p1:ActionType>sample string 6</d2p1:ActionType>
        <d2p1:ConditionID>902a9b67-297c-4620-b974-80b639dcb114</d2p1:ConditionID>
        <d2p1:ConditionType>sample string 5</d2p1:ConditionType>
        <d2p1:ConditionValue>sample string 4</d2p1:ConditionValue>
        <d2p1:ConditionValueId>sample string 3</d2p1:ConditionValueId>
        <d2p1:SourceFieldID>ba46b2be-7354-4039-9cde-70a483d53934</d2p1:SourceFieldID>
        <d2p1:SourceFieldTitle>sample string 1</d2p1:SourceFieldTitle>
        <d2p1:SourceFieldTypeTitle>sample string 2</d2p1:SourceFieldTypeTitle>
        <d2p1:TargetFieldID>5b663316-3c23-4c42-9b7c-188f8a86f4fc</d2p1:TargetFieldID>
        <d2p1:TargetFieldTitle>sample string 7</d2p1:TargetFieldTitle>
      </d2p1:FormConditionDto>
    </d2p1:FormConditions>
    <d2p1:FormFields>
      <d2p1:FormFieldDto>
        <d2p1:DisplayOrder>5</d2p1:DisplayOrder>
        <d2p1:FieldID>eb5d9093-bb7f-477d-89cd-8ada85c63070</d2p1:FieldID>
        <d2p1:FieldLabel>sample string 1</d2p1:FieldLabel>
        <d2p1:FieldTitle>sample string 2</d2p1:FieldTitle>
        <d2p1:FieldType>sample string 3</d2p1:FieldType>
        <d2p1:FieldTypeFixedCode>sample string 4</d2p1:FieldTypeFixedCode>
        <d2p1:IsAddress>true</d2p1:IsAddress>
        <d2p1:IsHidden>true</d2p1:IsHidden>
        <d2p1:IsRequired>true</d2p1:IsRequired>
        <d2p1:IsSLA>true</d2p1:IsSLA>
        <d2p1:Options>
          <d2p1:FormFieldOptionDto>
            <d2p1:FieldID>f431d59c-f48a-49fa-94c7-17e7ce143021</d2p1:FieldID>
            <d2p1:OptionID>93fb316c-694b-4580-88d2-0dee7a8e391b</d2p1:OptionID>
            <d2p1:OptionText>sample string 1</d2p1:OptionText>
            <d2p1:WorkflowID>8583c2fe-43f1-4f1a-b5e8-844d7efe20fa</d2p1:WorkflowID>
          </d2p1:FormFieldOptionDto>
          <d2p1:FormFieldOptionDto>
            <d2p1:FieldID>f431d59c-f48a-49fa-94c7-17e7ce143021</d2p1:FieldID>
            <d2p1:OptionID>93fb316c-694b-4580-88d2-0dee7a8e391b</d2p1:OptionID>
            <d2p1:OptionText>sample string 1</d2p1:OptionText>
            <d2p1:WorkflowID>8583c2fe-43f1-4f1a-b5e8-844d7efe20fa</d2p1:WorkflowID>
          </d2p1:FormFieldOptionDto>
        </d2p1:Options>
        <d2p1:Placeholder>sample string 6</d2p1:Placeholder>
        <d2p1:ReferenceTable>sample string 10</d2p1:ReferenceTable>
      </d2p1:FormFieldDto>
      <d2p1:FormFieldDto>
        <d2p1:DisplayOrder>5</d2p1:DisplayOrder>
        <d2p1:FieldID>eb5d9093-bb7f-477d-89cd-8ada85c63070</d2p1:FieldID>
        <d2p1:FieldLabel>sample string 1</d2p1:FieldLabel>
        <d2p1:FieldTitle>sample string 2</d2p1:FieldTitle>
        <d2p1:FieldType>sample string 3</d2p1:FieldType>
        <d2p1:FieldTypeFixedCode>sample string 4</d2p1:FieldTypeFixedCode>
        <d2p1:IsAddress>true</d2p1:IsAddress>
        <d2p1:IsHidden>true</d2p1:IsHidden>
        <d2p1:IsRequired>true</d2p1:IsRequired>
        <d2p1:IsSLA>true</d2p1:IsSLA>
        <d2p1:Options>
          <d2p1:FormFieldOptionDto>
            <d2p1:FieldID>f431d59c-f48a-49fa-94c7-17e7ce143021</d2p1:FieldID>
            <d2p1:OptionID>93fb316c-694b-4580-88d2-0dee7a8e391b</d2p1:OptionID>
            <d2p1:OptionText>sample string 1</d2p1:OptionText>
            <d2p1:WorkflowID>8583c2fe-43f1-4f1a-b5e8-844d7efe20fa</d2p1:WorkflowID>
          </d2p1:FormFieldOptionDto>
          <d2p1:FormFieldOptionDto>
            <d2p1:FieldID>f431d59c-f48a-49fa-94c7-17e7ce143021</d2p1:FieldID>
            <d2p1:OptionID>93fb316c-694b-4580-88d2-0dee7a8e391b</d2p1:OptionID>
            <d2p1:OptionText>sample string 1</d2p1:OptionText>
            <d2p1:WorkflowID>8583c2fe-43f1-4f1a-b5e8-844d7efe20fa</d2p1:WorkflowID>
          </d2p1:FormFieldOptionDto>
        </d2p1:Options>
        <d2p1:Placeholder>sample string 6</d2p1:Placeholder>
        <d2p1:ReferenceTable>sample string 10</d2p1:ReferenceTable>
      </d2p1:FormFieldDto>
    </d2p1:FormFields>
    <d2p1:FormId>7b5ce85e-1167-49df-8629-b7c589bd67ed</d2p1:FormId>
    <d2p1:FormStatus>sample string 4</d2p1:FormStatus>
    <d2p1:FormTitle>sample string 1</d2p1:FormTitle>
    <d2p1:FormVersion>3</d2p1:FormVersion>
    <d2p1:Result>
      <Message>sample string 1</Message>
      <Status>2</Status>
    </d2p1:Result>
  </data>
  <message>sample string 2</message>
  <status>1</status>
</ApiResponseNewOfFormResponseDtoX7UxrhxG>