POST api/CustomReport/validate-parameters
No documentation available.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
request | No documentation available. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{ "SearchRequest": { "$id": "2", "Filters": { "$id": "3", "$values": [ { "$id": "4", "<Field>k__BackingField": "sample string 1", "<Operator>k__BackingField": "sample string 2", "<Value>k__BackingField": { "$id": "5" }, "<Logic>k__BackingField": "sample string 4", "<Filters>k__BackingField": { "$id": "6", "$values": [ { "$ref": "4" }, { "$ref": "4" }, { "$ref": "4" } ] } }, { "$ref": "4" }, { "$ref": "4" } ] }, "Page": 1, "PageSize": 2, "Sort": { "$id": "7", "Field": "sample string 1", "Dir": "sample string 2", "SecondaryField": "sample string 3", "SecondaryDir": "sample string 4", "ThirdField": "sample string 5", "ThirdDir": "sample string 6" }, "PreviousPageSize": 3 }, "UseStoredProcedure": true, "ReportCode": "sample string 2", "ReportName": "sample string 3", "ExportReportAsOptions": { "$id": "8", "$values": [ { "$id": "9", "Id": "sample string 1", "Text": "sample string 2", "OtherText": "sample string 3", "OtherData": { "$id": "10" } }, { "$ref": "9" }, { "$ref": "9" } ] }, "ExportReportAs": "sample string 4", "PreviewReport": true, "ActiveReportFields": { "$id": "11", "$values": [ { "$id": "12", "FieldName": "sample string 1", "IsRequired": true, "FieldLabel": "sample string 3", "FilterStatement": "sample string 4" }, { "$ref": "12" }, { "$ref": "12" } ] }, "Officer": "sample string 6", "ApplicationTypeLovId": 1, "DisplayApplicationTypeLovId": 1, "ApplicationStatusLovId": 1, "LocalGovernmentAreaId": 1, "WorkflowStatus": "sample string 7", "WorkflowStatus2": "sample string 8", "DateTypeFilter": "sample string 9", "DateFrom": "2024-11-09T13:03:24.5777907+11:00", "DateTo": "2024-11-09T13:03:24.5777907+11:00", "SuburbName": "sample string 10", "SuburbLovId": 1, "TeamId": 11, "SortOption": "sample string 12", "IsDisplayFilteredDate": true, "WorkflowStatuses": { "$id": "13", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "WorkflowStatuses2": { "$id": "14", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "DateTypeFilters": { "$id": "15", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "LocalGovernmentAreas": { "$id": "16", "$values": [ { "$id": "17", "CodeLovId": 1, "CodeType": "sample string 2", "Description": "sample string 3", "AlternativeDesc": "sample string 4", "ShortDesc": "sample string 5", "ActiveFlag": true, "SequenceNo": 1, "SystemCode": "sample string 7", "IsStreetAddressFlag": true }, { "$ref": "17" }, { "$ref": "17" } ] }, "ApplicationTypes": { "$id": "18", "$values": [ { "$id": "19", "Id": 1, "CodeDesc": "sample string 2", "AlternativeDesc": "sample string 3", "SystemCode": "sample string 4", "SequenceNo": 1 }, { "$ref": "19" }, { "$ref": "19" } ] }, "DisplayApplicationTypes": { "$id": "20", "$values": [ { "$ref": "19" }, { "$ref": "19" }, { "$ref": "19" } ] }, "ApplicationStatuses": { "$id": "21", "$values": [ { "$ref": "19" }, { "$ref": "19" }, { "$ref": "19" } ] }, "SuburbLookupCodes": { "$id": "22", "$values": [ { "$ref": "17" }, { "$ref": "17" }, { "$ref": "17" } ] }, "OfficerAndPositionList": { "$id": "23", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "TeamList": { "$id": "24", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "ProcedureTypeShrIhoList": { "$id": "25", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "ProcedureTypeShrIho": "sample string 14", "SortOptions": { "$id": "26", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "Validation": { "$id": "27", "SuccessOutput": { "$id": "28" }, "Success": true, "ErrorMessages": null, "WarningMessages": { "$id": "29", "$values": [ "sample string 1", "sample string 2", "sample string 3" ] }, "InfoMessages": { "$id": "30", "$values": [ "sample string 1", "sample string 2", "sample string 3" ] }, "DatabaseErrorMessage": "sample string 3", "SuccessMessage": "sample string 4", "RelatedKeyId": "sample string 5" }, "PageAccess": { "$id": "31", "PageCode": "sample string 1", "StepAccesses": { "$id": "32", "$values": [ { "$id": "33", "StageCode": "sample string 1", "StepCode": "sample string 2" }, { "$ref": "33" }, { "$ref": "33" } ] }, "Positions": { "$id": "34", "$values": [ "sample string 1", "sample string 2", "sample string 3" ] } }, "UserRole": 0 }
application/x-www-form-urlencoded
Sample:
Response Information
Response body formats
application/json, text/json
Sample:
{ "SearchRequest": { "$id": "2", "Filters": { "$id": "3", "$values": [ { "$id": "4", "<Field>k__BackingField": "sample string 1", "<Operator>k__BackingField": "sample string 2", "<Value>k__BackingField": { "$id": "5" }, "<Logic>k__BackingField": "sample string 4", "<Filters>k__BackingField": { "$id": "6", "$values": [ { "$ref": "4" }, { "$ref": "4" }, { "$ref": "4" } ] } }, { "$ref": "4" }, { "$ref": "4" } ] }, "Page": 1, "PageSize": 2, "Sort": { "$id": "7", "Field": "sample string 1", "Dir": "sample string 2", "SecondaryField": "sample string 3", "SecondaryDir": "sample string 4", "ThirdField": "sample string 5", "ThirdDir": "sample string 6" }, "PreviousPageSize": 3 }, "UseStoredProcedure": true, "ReportCode": "sample string 2", "ReportName": "sample string 3", "ExportReportAsOptions": { "$id": "8", "$values": [ { "$id": "9", "Id": "sample string 1", "Text": "sample string 2", "OtherText": "sample string 3", "OtherData": { "$id": "10" } }, { "$ref": "9" }, { "$ref": "9" } ] }, "ExportReportAs": "sample string 4", "PreviewReport": true, "ActiveReportFields": { "$id": "11", "$values": [ { "$id": "12", "FieldName": "sample string 1", "IsRequired": true, "FieldLabel": "sample string 3", "FilterStatement": "sample string 4" }, { "$ref": "12" }, { "$ref": "12" } ] }, "Officer": "sample string 6", "ApplicationTypeLovId": 1, "DisplayApplicationTypeLovId": 1, "ApplicationStatusLovId": 1, "LocalGovernmentAreaId": 1, "WorkflowStatus": "sample string 7", "WorkflowStatus2": "sample string 8", "DateTypeFilter": "sample string 9", "DateFrom": "2024-11-09T13:03:24.6090441+11:00", "DateTo": "2024-11-09T13:03:24.6090441+11:00", "SuburbName": "sample string 10", "SuburbLovId": 1, "TeamId": 11, "SortOption": "sample string 12", "IsDisplayFilteredDate": true, "WorkflowStatuses": { "$id": "13", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "WorkflowStatuses2": { "$id": "14", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "DateTypeFilters": { "$id": "15", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "LocalGovernmentAreas": { "$id": "16", "$values": [ { "$id": "17", "CodeLovId": 1, "CodeType": "sample string 2", "Description": "sample string 3", "AlternativeDesc": "sample string 4", "ShortDesc": "sample string 5", "ActiveFlag": true, "SequenceNo": 1, "SystemCode": "sample string 7", "IsStreetAddressFlag": true }, { "$ref": "17" }, { "$ref": "17" } ] }, "ApplicationTypes": { "$id": "18", "$values": [ { "$id": "19", "Id": 1, "CodeDesc": "sample string 2", "AlternativeDesc": "sample string 3", "SystemCode": "sample string 4", "SequenceNo": 1 }, { "$ref": "19" }, { "$ref": "19" } ] }, "DisplayApplicationTypes": { "$id": "20", "$values": [ { "$ref": "19" }, { "$ref": "19" }, { "$ref": "19" } ] }, "ApplicationStatuses": { "$id": "21", "$values": [ { "$ref": "19" }, { "$ref": "19" }, { "$ref": "19" } ] }, "SuburbLookupCodes": { "$id": "22", "$values": [ { "$ref": "17" }, { "$ref": "17" }, { "$ref": "17" } ] }, "OfficerAndPositionList": { "$id": "23", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "TeamList": { "$id": "24", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "ProcedureTypeShrIhoList": { "$id": "25", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "ProcedureTypeShrIho": "sample string 14", "SortOptions": { "$id": "26", "$values": [ { "$ref": "9" }, { "$ref": "9" }, { "$ref": "9" } ] }, "Validation": { "$id": "27", "SuccessOutput": { "$id": "28" }, "Success": true, "ErrorMessages": null, "WarningMessages": { "$id": "29", "$values": [ "sample string 1", "sample string 2", "sample string 3" ] }, "InfoMessages": { "$id": "30", "$values": [ "sample string 1", "sample string 2", "sample string 3" ] }, "DatabaseErrorMessage": "sample string 3", "SuccessMessage": "sample string 4", "RelatedKeyId": "sample string 5" }, "PageAccess": { "$id": "31", "PageCode": "sample string 1", "StepAccesses": { "$id": "32", "$values": [ { "$id": "33", "StageCode": "sample string 1", "StepCode": "sample string 2" }, { "$ref": "33" }, { "$ref": "33" } ] }, "Positions": { "$id": "34", "$values": [ "sample string 1", "sample string 2", "sample string 3" ] } }, "UserRole": 0 }