Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReportId | form | Guid | No | Filter by ReportId. |
Number | form | String | No | Filter by the Report number. |
FormId | form | Guid | No | Filter Reports by the FormId of the form template the reports were raised from. |
FormName | form | String | No | Filter Reports by the name of the form template the reports were raised from. |
Summary | form | String | No | Filter Reports by the report summary. |
ReportStatus | query | ReportStatus | Yes | Filter Reports by their status.Allowable Values
|
Category | form | String | No | Filter by the Report category. |
RaisedFrom | form | String | No | Filter Reports by the name of the record it was raised from. |
Owner | form | String | No | Filter by the owner of the Report. |
RaisedBy | form | String | No | Filter by the report raiser. |
ClosedBy | form | String | No | Filter by the report closer. |
RaisedDate | query | string | No | Return all Reports that have been raised on requested date. Requested dates should be of the format: yyyy/MM/dd HH:mm:ss. If no HH:mm:ss is entered the default will be 00:00:00. |
SubmittedDate | query | string | No | Return all Reports that have been submitted on requested date. Requested dates should be of the format: yyyy/MM/dd HH:mm:ss. If no HH:mm:ss is entered the default will be 00:00:00. |
StartDate | query | string | No | Return all Reports that have been submitted since the requested date. Requested dates should be of the format: yyyy/MM/dd HH:mm:ss. If no HH:mm:ss is entered the default will be 00:00:00. |
EndDate | query | string | No | Return all Reports that have been submitted before the requested date. Requested dates should be of the format: yyyy/MM/dd HH:mm:ss. If no HH:mm:ss is entered the default will be 23:59:59. |
ClosedDate | query | String | No | Return all Reports that have been closed on requested date. Requested dates should be of the format: yyyy/MM/dd HH:mm:ss. If no HH:mm:ss is entered the default will be 00:00:00. |
IsMandatory | query | BooleanFilter | Yes | Filter reports by their mandatory status.Allowable Values
|
OrganisationUnit | query | String | No | Filter by the Organisation Unit assigned to the Report |
FieldFilter | query | Dictionary<Guid, String> | No | Filter by report fields, additional info fields or classification fields. First supply the FieldBankFieldId or the ListId of the classification, then the field value. If more than one filter is supplied, all conditions must pass to find a matching report. |
RiskRating | query | Integer | No | Filter by the Risk Assessment's Risk Rating. Will only compare with the latest assessment. |
SuggestedAction | query | SuggestedAction | No | Filter by the Risk Assessment's Suggested Action. Will only compare with the latest assessment.Allowable Values
|
RiskComment | query | String | No | Filter by the Risk Assessment's Comment. Will only compare with the latest assessment. |
RiskPerformer | query | String | No | Filter by the username of the Risk Assessment's Performer. Will only compare with the latest assessment. |
ModifiedDateTime | query | String | No | Return all Reports that have been modified since the requested date. Requested dates should be of the format: yyyy/MM/dd HH:mm:ss. If no HH:mm:ss is entered the default will be 00:00:00. |
OrderBy | form | ReportOrder | Yes | Property to order by in Ascending order. Default is 'Name'.Allowable Values
|
OrderByDesc | form | ReportOrder | Yes | Property to order by in Descending order.Allowable Values
|
ThenBy | form | ReportOrder | 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
|
ThenByDesc | form | ReportOrder | 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
|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Version | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Reports | form | List<Report> | No | |
FilteredResultCount | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalResults | form | int | No | |
Skip | form | int | No | |
Take | form | int | No | |
Links | form | List<Link> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StatusDescription | form | string | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
RequestUrl | form | string | No | |
Method | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReportId | form | Guid | No | |
Number | form | string | No | |
FormId | form | Guid | No | |
FormName | form | string | No | |
Summary | form | string | No | |
ReportStatus | form | ReportStatus | No | |
Category | form | string | No | |
RaisedFrom | form | string | No | |
Owner | form | string | No | |
OwnerId | form | Guid? | No | |
RaisedBy | form | string | No | |
RaisedById | form | Guid | No | |
ClosedBy | form | string | No | |
ClosedById | form | Guid? | No | |
OrganisationUnit | form | string | No | |
OrganisationUnitId | form | Guid | No | |
RaisedDate | form | string | No | |
SubmittedDate | form | string | No | |
ClosedDate | form | string | No | |
IsMandatory | form | bool | No | |
ModifiedDateTime | form | string | No | |
LinkedReports | form | List<LinkedReports> | No | |
Fields | form | List<ReportField> | No | |
ReportAttachments | form | List<ReportAttachment> | No | |
ReportClassifications | form | List<ReportClassificationField> | No | |
AdditionalInfoFields | form | List<AdditionalInfoField> | No | |
ReportRiskAssessments | form | List<ReportRiskAssessment> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReportId | form | Guid | No | |
Name | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Item | form | string | No | |
Value | form | string | No | |
Code | form | string | No | |
Text | form | string | No | |
GuidValue | form | Guid? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
Filename | form | string | No | |
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
List | form | string | No | |
ListId | form | Guid? | No | |
Mandatory | form | bool | No | |
SelectedItems | form | List<string> | No | |
Values | form | List<ReportClassificationFieldValue> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | string | No | |
Code | form | string | No | |
Text | form | string | No | |
GuidValue | form | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RiskAssessmentValue | form | int | No | |
SuggestedAction | form | string | No | |
Comment | form | string | No | |
PerformedBy | form | string | No | |
PerformedById | form | Guid | No | |
PerformedDate | form | string | No | |
RiskRatingDisplayValue | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap12 HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetReports 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>
<ReportId>00000000-0000-0000-0000-000000000000</ReportId>
<Number>String</Number>
<FormId>00000000-0000-0000-0000-000000000000</FormId>
<FormName>String</FormName>
<Summary>String</Summary>
<ReportStatus>All</ReportStatus>
<Category>String</Category>
<RaisedFrom>String</RaisedFrom>
<Owner>String</Owner>
<RaisedBy>String</RaisedBy>
<ClosedBy>String</ClosedBy>
<RaisedDate>String</RaisedDate>
<SubmittedDate>String</SubmittedDate>
<StartDate>String</StartDate>
<EndDate>String</EndDate>
<ClosedDate>String</ClosedDate>
<IsMandatory>All</IsMandatory>
<OrganisationUnit>String</OrganisationUnit>
<FieldFilter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfguidstring>
<d2p1:Key>00000000-0000-0000-0000-000000000000</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfguidstring>
</FieldFilter>
<RiskRating>0</RiskRating>
<SuggestedAction>Accept</SuggestedAction>
<RiskComment>String</RiskComment>
<RiskPerformer>String</RiskPerformer>
<ModifiedDateTime>String</ModifiedDateTime>
</GetReports>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetReportsResponse 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> <Reports> <Report> <ReportId>00000000-0000-0000-0000-000000000000</ReportId> <Number>String</Number> <FormId>00000000-0000-0000-0000-000000000000</FormId> <FormName>String</FormName> <Summary>String</Summary> <ReportStatus>All</ReportStatus> <Category>String</Category> <RaisedFrom>String</RaisedFrom> <Owner>String</Owner> <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId> <RaisedBy>String</RaisedBy> <RaisedById>00000000-0000-0000-0000-000000000000</RaisedById> <ClosedBy>String</ClosedBy> <ClosedById>00000000-0000-0000-0000-000000000000</ClosedById> <OrganisationUnit>String</OrganisationUnit> <OrganisationUnitId>00000000-0000-0000-0000-000000000000</OrganisationUnitId> <RaisedDate>String</RaisedDate> <SubmittedDate>String</SubmittedDate> <ClosedDate>String</ClosedDate> <IsMandatory>false</IsMandatory> <ModifiedDateTime>String</ModifiedDateTime> <LinkedReports> <LinkedReports> <ReportId>00000000-0000-0000-0000-000000000000</ReportId> <Name>String</Name> </LinkedReports> </LinkedReports> <Fields> <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> </Fields> <ReportAttachments> <ReportAttachment> <Id>00000000-0000-0000-0000-000000000000</Id> <Filename>String</Filename> <Description>String</Description> </ReportAttachment> </ReportAttachments> <ReportClassifications> <ReportClassificationField> <Id>00000000-0000-0000-0000-000000000000</Id> <List>String</List> <ListId>00000000-0000-0000-0000-000000000000</ListId> <Mandatory>false</Mandatory> <SelectedItems xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>String</d6p1:string> </SelectedItems> <Values> <ReportClassificationFieldValue> <Code>String</Code> <GuidValue>00000000-0000-0000-0000-000000000000</GuidValue> <Text>String</Text> <Value>String</Value> </ReportClassificationFieldValue> </Values> </ReportClassificationField> </ReportClassifications> <AdditionalInfoFields> <AdditionalInfoField> <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> </AdditionalInfoField> </AdditionalInfoFields> <ReportRiskAssessments> <ReportRiskAssessment> <RiskAssessmentValue>0</RiskAssessmentValue> <SuggestedAction>String</SuggestedAction> <Comment>String</Comment> <PerformedBy>String</PerformedBy> <PerformedById>00000000-0000-0000-0000-000000000000</PerformedById> <PerformedDate>String</PerformedDate> <RiskRating>String</RiskRating> </ReportRiskAssessment> </ReportRiskAssessments> </Report> </Reports> <FilteredResultCount>0</FilteredResultCount> </GetReportsResponse> </soap12:Body> </soap12:Envelope>