GET /external/api/v3/form?Id={Id}&LanguageCode={LanguageCode}&IncludeArchived={IncludeArchived}
Get a form by id.
Request Information
URI Parameters
| Name | Description | Type | Additional information | Nullable |
|---|---|---|---|---|
| Id | globally unique identifier |
None |
False | |
| LanguageCode | string |
None |
False | |
| IncludeArchived |
Include archived pages, sections and questions in response, default false. |
boolean |
None |
False |
Body Parameters
None.
Response Information
Resource Description
Form| Name | Description | Type | Additional information | Nullable |
|---|---|---|---|---|
| Pages | Collection of FormPage |
None |
False | |
| Id | globally unique identifier |
None |
False | |
| Name | string |
None |
False | |
| IsConcept | boolean |
None |
False |
Response Formats
application/json, text/json
Sample:
{
"Pages": [
{
"Id": "179e9a9b-0458-43a6-8d01-1f154f878a53",
"Name": "sample string 2",
"Sequence": 3,
"IsRepeatable": true,
"Title": "sample string 5",
"IsArchived": true,
"Sections": [
{
"Id": "8df7f87d-c4b2-440b-b1fd-d3013dc29433",
"Name": "sample string 2",
"Sequence": 3,
"IsRepeatable": true,
"Title": "sample string 5",
"IsArchived": true,
"Questions": [
{
"Id": "a84ff830-131d-4fb3-9b72-ee3d6fe96b97",
"BaseQuestionId": 2,
"Type": "sample string 3",
"Content": "sample string 4",
"Description": "sample string 5",
"Scale": {
"Positions": [
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
},
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
}
]
},
"Sequence": 6,
"Text": "sample string 7",
"ScaleBehavior": "sample string 8",
"CustomerDataColumnId": 1,
"IsArchived": true
},
{
"Id": "a84ff830-131d-4fb3-9b72-ee3d6fe96b97",
"BaseQuestionId": 2,
"Type": "sample string 3",
"Content": "sample string 4",
"Description": "sample string 5",
"Scale": {
"Positions": [
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
},
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
}
]
},
"Sequence": 6,
"Text": "sample string 7",
"ScaleBehavior": "sample string 8",
"CustomerDataColumnId": 1,
"IsArchived": true
}
]
},
{
"Id": "8df7f87d-c4b2-440b-b1fd-d3013dc29433",
"Name": "sample string 2",
"Sequence": 3,
"IsRepeatable": true,
"Title": "sample string 5",
"IsArchived": true,
"Questions": [
{
"Id": "a84ff830-131d-4fb3-9b72-ee3d6fe96b97",
"BaseQuestionId": 2,
"Type": "sample string 3",
"Content": "sample string 4",
"Description": "sample string 5",
"Scale": {
"Positions": [
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
},
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
}
]
},
"Sequence": 6,
"Text": "sample string 7",
"ScaleBehavior": "sample string 8",
"CustomerDataColumnId": 1,
"IsArchived": true
},
{
"Id": "a84ff830-131d-4fb3-9b72-ee3d6fe96b97",
"BaseQuestionId": 2,
"Type": "sample string 3",
"Content": "sample string 4",
"Description": "sample string 5",
"Scale": {
"Positions": [
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
},
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
}
]
},
"Sequence": 6,
"Text": "sample string 7",
"ScaleBehavior": "sample string 8",
"CustomerDataColumnId": 1,
"IsArchived": true
}
]
}
]
},
{
"Id": "179e9a9b-0458-43a6-8d01-1f154f878a53",
"Name": "sample string 2",
"Sequence": 3,
"IsRepeatable": true,
"Title": "sample string 5",
"IsArchived": true,
"Sections": [
{
"Id": "8df7f87d-c4b2-440b-b1fd-d3013dc29433",
"Name": "sample string 2",
"Sequence": 3,
"IsRepeatable": true,
"Title": "sample string 5",
"IsArchived": true,
"Questions": [
{
"Id": "a84ff830-131d-4fb3-9b72-ee3d6fe96b97",
"BaseQuestionId": 2,
"Type": "sample string 3",
"Content": "sample string 4",
"Description": "sample string 5",
"Scale": {
"Positions": [
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
},
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
}
]
},
"Sequence": 6,
"Text": "sample string 7",
"ScaleBehavior": "sample string 8",
"CustomerDataColumnId": 1,
"IsArchived": true
},
{
"Id": "a84ff830-131d-4fb3-9b72-ee3d6fe96b97",
"BaseQuestionId": 2,
"Type": "sample string 3",
"Content": "sample string 4",
"Description": "sample string 5",
"Scale": {
"Positions": [
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
},
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
}
]
},
"Sequence": 6,
"Text": "sample string 7",
"ScaleBehavior": "sample string 8",
"CustomerDataColumnId": 1,
"IsArchived": true
}
]
},
{
"Id": "8df7f87d-c4b2-440b-b1fd-d3013dc29433",
"Name": "sample string 2",
"Sequence": 3,
"IsRepeatable": true,
"Title": "sample string 5",
"IsArchived": true,
"Questions": [
{
"Id": "a84ff830-131d-4fb3-9b72-ee3d6fe96b97",
"BaseQuestionId": 2,
"Type": "sample string 3",
"Content": "sample string 4",
"Description": "sample string 5",
"Scale": {
"Positions": [
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
},
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
}
]
},
"Sequence": 6,
"Text": "sample string 7",
"ScaleBehavior": "sample string 8",
"CustomerDataColumnId": 1,
"IsArchived": true
},
{
"Id": "a84ff830-131d-4fb3-9b72-ee3d6fe96b97",
"BaseQuestionId": 2,
"Type": "sample string 3",
"Content": "sample string 4",
"Description": "sample string 5",
"Scale": {
"Positions": [
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
},
{
"Id": 1,
"Label": "sample string 1",
"Value": 1,
"Ranking": 1
}
]
},
"Sequence": 6,
"Text": "sample string 7",
"ScaleBehavior": "sample string 8",
"CustomerDataColumnId": 1,
"IsArchived": true
}
]
}
]
}
],
"Id": "2571d67b-914b-4aa0-ab9d-5ac5ac965326",
"Name": "sample string 2",
"IsConcept": true
}
application/xml, text/xml
Sample:
<Form xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Models">
<Id xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Domain.Shared.Models">2571d67b-914b-4aa0-ab9d-5ac5ac965326</Id>
<IsConcept xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Domain.Shared.Models">true</IsConcept>
<Name xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Domain.Shared.Models">sample string 2</Name>
<Pages>
<FormPage>
<Id>179e9a9b-0458-43a6-8d01-1f154f878a53</Id>
<IsArchived>true</IsArchived>
<IsRepeatable>true</IsRepeatable>
<Name>sample string 2</Name>
<Sections>
<FormSection>
<Id>8df7f87d-c4b2-440b-b1fd-d3013dc29433</Id>
<IsArchived>true</IsArchived>
<IsRepeatable>true</IsRepeatable>
<Name>sample string 2</Name>
<Questions>
<FormQuestion>
<BaseQuestionId>2</BaseQuestionId>
<Content>sample string 4</Content>
<CustomerDataColumnId>1</CustomerDataColumnId>
<Description>sample string 5</Description>
<Id>a84ff830-131d-4fb3-9b72-ee3d6fe96b97</Id>
<IsArchived>true</IsArchived>
<Scale xmlns:d8p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
<d8p1:Positions>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
</d8p1:Positions>
</Scale>
<ScaleBehavior>sample string 8</ScaleBehavior>
<Sequence>6</Sequence>
<Text>sample string 7</Text>
<Type>sample string 3</Type>
</FormQuestion>
<FormQuestion>
<BaseQuestionId>2</BaseQuestionId>
<Content>sample string 4</Content>
<CustomerDataColumnId>1</CustomerDataColumnId>
<Description>sample string 5</Description>
<Id>a84ff830-131d-4fb3-9b72-ee3d6fe96b97</Id>
<IsArchived>true</IsArchived>
<Scale xmlns:d8p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
<d8p1:Positions>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
</d8p1:Positions>
</Scale>
<ScaleBehavior>sample string 8</ScaleBehavior>
<Sequence>6</Sequence>
<Text>sample string 7</Text>
<Type>sample string 3</Type>
</FormQuestion>
</Questions>
<Sequence>3</Sequence>
<Title>sample string 5</Title>
</FormSection>
<FormSection>
<Id>8df7f87d-c4b2-440b-b1fd-d3013dc29433</Id>
<IsArchived>true</IsArchived>
<IsRepeatable>true</IsRepeatable>
<Name>sample string 2</Name>
<Questions>
<FormQuestion>
<BaseQuestionId>2</BaseQuestionId>
<Content>sample string 4</Content>
<CustomerDataColumnId>1</CustomerDataColumnId>
<Description>sample string 5</Description>
<Id>a84ff830-131d-4fb3-9b72-ee3d6fe96b97</Id>
<IsArchived>true</IsArchived>
<Scale xmlns:d8p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
<d8p1:Positions>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
</d8p1:Positions>
</Scale>
<ScaleBehavior>sample string 8</ScaleBehavior>
<Sequence>6</Sequence>
<Text>sample string 7</Text>
<Type>sample string 3</Type>
</FormQuestion>
<FormQuestion>
<BaseQuestionId>2</BaseQuestionId>
<Content>sample string 4</Content>
<CustomerDataColumnId>1</CustomerDataColumnId>
<Description>sample string 5</Description>
<Id>a84ff830-131d-4fb3-9b72-ee3d6fe96b97</Id>
<IsArchived>true</IsArchived>
<Scale xmlns:d8p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
<d8p1:Positions>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
</d8p1:Positions>
</Scale>
<ScaleBehavior>sample string 8</ScaleBehavior>
<Sequence>6</Sequence>
<Text>sample string 7</Text>
<Type>sample string 3</Type>
</FormQuestion>
</Questions>
<Sequence>3</Sequence>
<Title>sample string 5</Title>
</FormSection>
</Sections>
<Sequence>3</Sequence>
<Title>sample string 5</Title>
</FormPage>
<FormPage>
<Id>179e9a9b-0458-43a6-8d01-1f154f878a53</Id>
<IsArchived>true</IsArchived>
<IsRepeatable>true</IsRepeatable>
<Name>sample string 2</Name>
<Sections>
<FormSection>
<Id>8df7f87d-c4b2-440b-b1fd-d3013dc29433</Id>
<IsArchived>true</IsArchived>
<IsRepeatable>true</IsRepeatable>
<Name>sample string 2</Name>
<Questions>
<FormQuestion>
<BaseQuestionId>2</BaseQuestionId>
<Content>sample string 4</Content>
<CustomerDataColumnId>1</CustomerDataColumnId>
<Description>sample string 5</Description>
<Id>a84ff830-131d-4fb3-9b72-ee3d6fe96b97</Id>
<IsArchived>true</IsArchived>
<Scale xmlns:d8p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
<d8p1:Positions>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
</d8p1:Positions>
</Scale>
<ScaleBehavior>sample string 8</ScaleBehavior>
<Sequence>6</Sequence>
<Text>sample string 7</Text>
<Type>sample string 3</Type>
</FormQuestion>
<FormQuestion>
<BaseQuestionId>2</BaseQuestionId>
<Content>sample string 4</Content>
<CustomerDataColumnId>1</CustomerDataColumnId>
<Description>sample string 5</Description>
<Id>a84ff830-131d-4fb3-9b72-ee3d6fe96b97</Id>
<IsArchived>true</IsArchived>
<Scale xmlns:d8p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
<d8p1:Positions>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
</d8p1:Positions>
</Scale>
<ScaleBehavior>sample string 8</ScaleBehavior>
<Sequence>6</Sequence>
<Text>sample string 7</Text>
<Type>sample string 3</Type>
</FormQuestion>
</Questions>
<Sequence>3</Sequence>
<Title>sample string 5</Title>
</FormSection>
<FormSection>
<Id>8df7f87d-c4b2-440b-b1fd-d3013dc29433</Id>
<IsArchived>true</IsArchived>
<IsRepeatable>true</IsRepeatable>
<Name>sample string 2</Name>
<Questions>
<FormQuestion>
<BaseQuestionId>2</BaseQuestionId>
<Content>sample string 4</Content>
<CustomerDataColumnId>1</CustomerDataColumnId>
<Description>sample string 5</Description>
<Id>a84ff830-131d-4fb3-9b72-ee3d6fe96b97</Id>
<IsArchived>true</IsArchived>
<Scale xmlns:d8p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
<d8p1:Positions>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
</d8p1:Positions>
</Scale>
<ScaleBehavior>sample string 8</ScaleBehavior>
<Sequence>6</Sequence>
<Text>sample string 7</Text>
<Type>sample string 3</Type>
</FormQuestion>
<FormQuestion>
<BaseQuestionId>2</BaseQuestionId>
<Content>sample string 4</Content>
<CustomerDataColumnId>1</CustomerDataColumnId>
<Description>sample string 5</Description>
<Id>a84ff830-131d-4fb3-9b72-ee3d6fe96b97</Id>
<IsArchived>true</IsArchived>
<Scale xmlns:d8p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
<d8p1:Positions>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
<d8p1:ScalePosition>
<d8p1:Id>1</d8p1:Id>
<d8p1:Label>sample string 1</d8p1:Label>
<d8p1:Ranking>1</d8p1:Ranking>
<d8p1:Value>1</d8p1:Value>
</d8p1:ScalePosition>
</d8p1:Positions>
</Scale>
<ScaleBehavior>sample string 8</ScaleBehavior>
<Sequence>6</Sequence>
<Text>sample string 7</Text>
<Type>sample string 3</Type>
</FormQuestion>
</Questions>
<Sequence>3</Sequence>
<Title>sample string 5</Title>
</FormSection>
</Sections>
<Sequence>3</Sequence>
<Title>sample string 5</Title>
</FormPage>
</Pages>
</Form>
Response Status Codes
| Status Code | Name | Description |
|---|---|---|
| 200 | OK | The request has succeeded. |
| 400 | Bad Request | Fulfilling the request would cause an invalid state. Request needs modification. |
| 401 | Unauthorized | Missing or invalid authentication token. |
| 403 | Forbidden | Server refuses to authorize the request. |
| 408 | Request Timeout | The server timed out waiting for the request. |
| 429 | Too Many Requests | Too many requests in a given amount of time. |
| 500 | Internal Server Error | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | Service Unavailable | The server is unable to proces the request at the moment, try again later. |