Coruson API

GetReportFields

Coruson Reports

The following routes are available for this service:
GET	/api/reports/fields	Query for Coruson Report Fields

**GetReportFields** Parameters:
Name	Parameter	Data Type	Required	Description
FieldId	query	Guid	No	Filter by FieldId.
ReportId	query	Guid	No	Filter by the Id of the Report the Fields belong to.
Label	query	String	No	Filter by the name of the Field.
FieldType	query	FieldType	Yes	Filter by the type of Field. Allowable Values All TextBox TextArea Numerical DateTime CheckList SelectList RadioGroup Date Location SectionRepeater
FieldBankFieldId	query	Guid	No	Filter by the FieldBankFieldId of the Field.
SectionId	query	Guid	No	Filter by the section Id.
SectionName	query	string	No	Filter by the name of the section.
OrderBy	query	ReportFieldOrder	Yes	Property to order by in Ascending order. Default is 'Name'. Allowable Values Default Label
OrderByDesc	query	ReportFieldOrder	Yes	Property to order by in Descending order. Allowable Values Default Label
ThenBy	query	ReportFieldOrder	Yes	Second Property to order by in Ascending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored. Allowable Values Default Label
ThenByDesc	query	ReportFieldOrder	Yes	Second Property to order by in Descending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored. Allowable Values Default Label

**PagingRequestBase<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Skip	form	Integer	No	Number of items to skip before returning results. Minimum suitable value is 0 and is also the default value.
Take	form	Integer	No	Number of items to return per page. Must be a number in the range 1-100. Default value is 100.
OrderBy	form	Enum	No	Order By
OrderByDesc	form	Enum	No	Order By Descending
ThenBy	form	Enum	No	Then By
ThenByDesc	form	Enum	No	Then By Descending

**RequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	int	No

**GetReportFieldsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ReportFields	form	List<ReportField>	No

**GetResponseBase** Parameters:
Name	Parameter	Data Type	Required
TotalResults	form	int	No
Skip	form	int	No
Take	form	int	No
Links	form	List<Link>	No

**ResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
StatusDescription	form	string	No
ResponseStatus	form	ResponseStatus	No

**Link** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
RequestUrl	form	string	No
Method	form	string	No

**ReportField** Parameters:
Name	Parameter	Data Type	Required
FieldId	form	Guid	No
Label	form	string	No
Value	form	string	No
Code	form	string	No
Text	form	string	No
GuidValue	form	Guid?	No
FieldType	form	FieldType	No
FieldBankFieldId	form	Guid	No
ChildItems	form	List<ChildItems>	No
SectionId	form	Guid	No
SectionName	form	string	No
PersistentFormSectionId	form	Guid?	No
SectionTemplateId	form	Guid?	No
ParentSectionId	form	Guid?	No
CollectionType	form	FieldCollectionType	No
CollectionId	form	Guid?	No
CollectionName	form	string	No
Confidental	form	bool	No
ReportId	form	Guid	No

**ChildItems** Parameters:
Name	Parameter	Data Type	Required
Item	form	string	No
Value	form	string	No
Code	form	string	No
Text	form	string	No
GuidValue	form	Guid?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

                    POST /xml/reply/GetReportFields HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: application/xml
Content-Length: length

<GetReportFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Version>0</Version>
  <Skip>0</Skip>
  <Take>0</Take>
  <OrderBy>Default</OrderBy>
  <OrderByDesc>Default</OrderByDesc>
  <ThenBy>Default</ThenBy>
  <ThenByDesc>Default</ThenByDesc>
  <FieldId>00000000-0000-0000-0000-000000000000</FieldId>
  <ReportId>00000000-0000-0000-0000-000000000000</ReportId>
  <Label>String</Label>
  <FieldType>All</FieldType>
  <FieldBankFieldId>00000000-0000-0000-0000-000000000000</FieldBankFieldId>
  <SectionId>00000000-0000-0000-0000-000000000000</SectionId>
  <SectionName>String</SectionName>
</GetReportFields>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetReportFieldsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <StatusDescription>String</StatusDescription>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
  <TotalResults>0</TotalResults>
  <Skip>0</Skip>
  <Take>0</Take>
  <Links>
    <Link>
      <Name>String</Name>
      <RequestUrl>String</RequestUrl>
      <Method>String</Method>
    </Link>
  </Links>
  <ReportFields>
    <ReportField>
      <FieldId>00000000-0000-0000-0000-000000000000</FieldId>
      <Label>String</Label>
      <Value>String</Value>
      <Code>String</Code>
      <Text>String</Text>
      <GuidValue>00000000-0000-0000-0000-000000000000</GuidValue>
      <FieldType>All</FieldType>
      <FieldBankFieldId>00000000-0000-0000-0000-000000000000</FieldBankFieldId>
      <ChildItems>
        <ChildItems>
          <Item>String</Item>
          <Value>String</Value>
          <Code>String</Code>
          <Text>String</Text>
          <GuidValue>00000000-0000-0000-0000-000000000000</GuidValue>
        </ChildItems>
      </ChildItems>
      <SectionId>00000000-0000-0000-0000-000000000000</SectionId>
      <SectionName>String</SectionName>
      <PersistentFormSectionId>00000000-0000-0000-0000-000000000000</PersistentFormSectionId>
      <SectionTemplateId>00000000-0000-0000-0000-000000000000</SectionTemplateId>
      <ParentSectionId>00000000-0000-0000-0000-000000000000</ParentSectionId>
      <CollectionType>All</CollectionType>
      <CollectionId>00000000-0000-0000-0000-000000000000</CollectionId>
      <CollectionName>String</CollectionName>
      <Confidential>false</Confidential>
      <ReportId>00000000-0000-0000-0000-000000000000</ReportId>
    </ReportField>
  </ReportFields>
</GetReportFieldsResponse>

Coruson API

GetReportFields

Coruson Reports

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

HTTP + XML