GET api/GetFormsBySite?SiteIds={SiteIds}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SiteIds

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of FormModel
NameDescriptionTypeAdditional information
FormId

integer

None.
Name

string

None.
Description

string

None.
FormIncomeCollectionMethod

string

None.
FormRequiresSSN

boolean

None.
FormRequiresESignature

boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "FormId": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "FormIncomeCollectionMethod": "sample string 4",
    "FormRequiresSSN": true,
    "FormRequiresESignature": true
  },
  {
    "FormId": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "FormIncomeCollectionMethod": "sample string 4",
    "FormRequiresSSN": true,
    "FormRequiresESignature": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfFormModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.FormApplication">
  <FormModel>
    <Description>sample string 3</Description>
    <FormId>1</FormId>
    <FormIncomeCollectionMethod>sample string 4</FormIncomeCollectionMethod>
    <FormRequiresESignature>true</FormRequiresESignature>
    <FormRequiresSSN>true</FormRequiresSSN>
    <Name>sample string 2</Name>
  </FormModel>
  <FormModel>
    <Description>sample string 3</Description>
    <FormId>1</FormId>
    <FormIncomeCollectionMethod>sample string 4</FormIncomeCollectionMethod>
    <FormRequiresESignature>true</FormRequiresESignature>
    <FormRequiresSSN>true</FormRequiresSSN>
    <Name>sample string 2</Name>
  </FormModel>
</ArrayOfFormModel>