PUT api/DCMLitigationReport?clientId={clientId}&assessmentCycleId={assessmentCycleId}&excel={excel}

Request Information

URI Parameters

Name	Type	Additional information
clientId	globally unique identifier	Required
assessmentCycleId	string	Required
excel	boolean	Required

Body Parameters

CustomLitigationReportFilters

Name	Type	Additional information
entityId	string	None.
countryId	string	None.
regionId	string	None.
stateId	string	None.
locationId	string	None.
filedById	string	None.
companyRepresentativeId	string	None.
caseCatogoryId	string	None.
viewReport	string	None.
complianceMonth	string	None.
fromDate	string	None.
toDate	string	None.
filterByDateOf	string	None.
tblSearch	string	None.
litigationCaseType	string	None.

Request Formats

application/json, text/json

Sample:

{
  "entityId": "sample string 1",
  "countryId": "sample string 2",
  "regionId": "sample string 3",
  "stateId": "sample string 4",
  "locationId": "sample string 5",
  "filedById": "sample string 6",
  "companyRepresentativeId": "sample string 7",
  "caseCatogoryId": "sample string 8",
  "viewReport": "sample string 9",
  "complianceMonth": "sample string 10",
  "fromDate": "sample string 11",
  "toDate": "sample string 12",
  "filterByDateOf": "sample string 13",
  "tblSearch": "sample string 14",
  "litigationCaseType": "sample string 15"
}

application/xml, text/xml

Sample:

<CustomLitigationReportFilters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <caseCatogoryId>sample string 8</caseCatogoryId>
  <companyRepresentativeId>sample string 7</companyRepresentativeId>
  <complianceMonth>sample string 10</complianceMonth>
  <countryId>sample string 2</countryId>
  <entityId>sample string 1</entityId>
  <filedById>sample string 6</filedById>
  <filterByDateOf>sample string 13</filterByDateOf>
  <fromDate>sample string 11</fromDate>
  <litigationCaseType>sample string 15</litigationCaseType>
  <locationId>sample string 5</locationId>
  <regionId>sample string 3</regionId>
  <stateId>sample string 4</stateId>
  <tblSearch>sample string 14</tblSearch>
  <toDate>sample string 12</toDate>
  <viewReport>sample string 9</viewReport>
</CustomLitigationReportFilters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of CustomDCMLitigationTracker

Name	Type	Additional information
totalcount	integer	None.
LitigationTrackerID	globally unique identifier	None.
groupEntityId	globally unique identifier	None.
groupEntity	string	None.
entityId	globally unique identifier	None.
Entity	string	None.
countryId	globally unique identifier	None.
Country	string	None.
regionId	globally unique identifier	None.
Region	string	None.
stateId	globally unique identifier	None.
State	string	None.
locationId	globally unique identifier	None.
Location	string	None.
complianceCategoryId	globally unique identifier	None.
CompliaceCategory	string	None.
clientId	globally unique identifier	None.
SerialNumber	string	None.
FiledBy	string	None.
FiledAgainst	string	None.
BeforeCourt	string	None.
BriefOfDispute	string	None.
AmountInvolved	integer	None.
MatterStartDate	date	None.
Status	string	None.
DateOfLastHearing	date	None.
Lawyer	string	None.
CompanyRepresentative	string	None.
CaseNumber	string	None.
ActionPlan	string	None.
CaseCategory	string	None.
CostOfHearing	string	None.
DateOfNextHearing	date	None.
FileName	string	None.
FileType	string	None.
FileUploadDate	date	None.
InsertBy	string	None.
InsertDate	date	None.
WhatTranspired	string	None.
LitigationNumber	string	None.
DocumentName	string	None.
DocumentExt	string	None.
TCaseCategory	string	None.
companyRepresentativeIds	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "totalcount": 1,
    "LitigationTrackerID": "4de740ab-4071-4610-96d4-a67b5b54430f",
    "groupEntityId": "44aa0b92-32df-4e04-919f-9ee6c65cdd24",
    "groupEntity": "sample string 4",
    "entityId": "9db1683b-7111-4564-ade8-6f584b90c43d",
    "Entity": "sample string 6",
    "countryId": "d8885e5f-fbb5-492f-8a78-b2ae6f6449a6",
    "Country": "sample string 8",
    "regionId": "b88367d9-c3d2-4ba2-93dd-71d9ff9be634",
    "Region": "sample string 10",
    "stateId": "0676c942-351a-44a2-bf23-57aa841f258d",
    "State": "sample string 12",
    "locationId": "2d8a21a1-f0f5-455d-80c3-f5f7f69e5465",
    "Location": "sample string 14",
    "complianceCategoryId": "5fa9d9fe-4c42-4483-a501-c8564b98c802",
    "CompliaceCategory": "sample string 16",
    "clientId": "fe7442ff-d1d3-4ba8-bfa5-c9254a58b116",
    "SerialNumber": "sample string 18",
    "FiledBy": "sample string 19",
    "FiledAgainst": "sample string 20",
    "BeforeCourt": "sample string 21",
    "BriefOfDispute": "sample string 22",
    "AmountInvolved": 23,
    "MatterStartDate": "2025-06-27T23:13:36.2890312+00:00",
    "Status": "sample string 24",
    "DateOfLastHearing": "2025-06-27T23:13:36.2890312+00:00",
    "Lawyer": "sample string 25",
    "CompanyRepresentative": "sample string 26",
    "CaseNumber": "sample string 27",
    "ActionPlan": "sample string 28",
    "CaseCategory": "sample string 29",
    "CostOfHearing": "sample string 30",
    "DateOfNextHearing": "2025-06-27T23:13:36.2890312+00:00",
    "FileName": "sample string 31",
    "FileType": "sample string 32",
    "FileUploadDate": "2025-06-27T23:13:36.2890312+00:00",
    "InsertBy": "sample string 33",
    "InsertDate": "2025-06-27T23:13:36.2890312+00:00",
    "WhatTranspired": "sample string 34",
    "LitigationNumber": "sample string 35",
    "DocumentName": "sample string 36",
    "DocumentExt": "sample string 37",
    "TCaseCategory": "sample string 38",
    "companyRepresentativeIds": "sample string 39"
  },
  {
    "totalcount": 1,
    "LitigationTrackerID": "4de740ab-4071-4610-96d4-a67b5b54430f",
    "groupEntityId": "44aa0b92-32df-4e04-919f-9ee6c65cdd24",
    "groupEntity": "sample string 4",
    "entityId": "9db1683b-7111-4564-ade8-6f584b90c43d",
    "Entity": "sample string 6",
    "countryId": "d8885e5f-fbb5-492f-8a78-b2ae6f6449a6",
    "Country": "sample string 8",
    "regionId": "b88367d9-c3d2-4ba2-93dd-71d9ff9be634",
    "Region": "sample string 10",
    "stateId": "0676c942-351a-44a2-bf23-57aa841f258d",
    "State": "sample string 12",
    "locationId": "2d8a21a1-f0f5-455d-80c3-f5f7f69e5465",
    "Location": "sample string 14",
    "complianceCategoryId": "5fa9d9fe-4c42-4483-a501-c8564b98c802",
    "CompliaceCategory": "sample string 16",
    "clientId": "fe7442ff-d1d3-4ba8-bfa5-c9254a58b116",
    "SerialNumber": "sample string 18",
    "FiledBy": "sample string 19",
    "FiledAgainst": "sample string 20",
    "BeforeCourt": "sample string 21",
    "BriefOfDispute": "sample string 22",
    "AmountInvolved": 23,
    "MatterStartDate": "2025-06-27T23:13:36.2890312+00:00",
    "Status": "sample string 24",
    "DateOfLastHearing": "2025-06-27T23:13:36.2890312+00:00",
    "Lawyer": "sample string 25",
    "CompanyRepresentative": "sample string 26",
    "CaseNumber": "sample string 27",
    "ActionPlan": "sample string 28",
    "CaseCategory": "sample string 29",
    "CostOfHearing": "sample string 30",
    "DateOfNextHearing": "2025-06-27T23:13:36.2890312+00:00",
    "FileName": "sample string 31",
    "FileType": "sample string 32",
    "FileUploadDate": "2025-06-27T23:13:36.2890312+00:00",
    "InsertBy": "sample string 33",
    "InsertDate": "2025-06-27T23:13:36.2890312+00:00",
    "WhatTranspired": "sample string 34",
    "LitigationNumber": "sample string 35",
    "DocumentName": "sample string 36",
    "DocumentExt": "sample string 37",
    "TCaseCategory": "sample string 38",
    "companyRepresentativeIds": "sample string 39"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomDCMLitigationTracker xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.Models">
  <CustomDCMLitigationTracker>
    <ActionPlan>sample string 28</ActionPlan>
    <AmountInvolved>23</AmountInvolved>
    <BeforeCourt>sample string 21</BeforeCourt>
    <BriefOfDispute>sample string 22</BriefOfDispute>
    <CaseCategory>sample string 29</CaseCategory>
    <CaseNumber>sample string 27</CaseNumber>
    <CompanyRepresentative>sample string 26</CompanyRepresentative>
    <CompliaceCategory>sample string 16</CompliaceCategory>
    <CostOfHearing>sample string 30</CostOfHearing>
    <Country>sample string 8</Country>
    <DateOfLastHearing>2025-06-27T23:13:36.2890312+00:00</DateOfLastHearing>
    <DateOfNextHearing>2025-06-27T23:13:36.2890312+00:00</DateOfNextHearing>
    <DocumentExt>sample string 37</DocumentExt>
    <DocumentName>sample string 36</DocumentName>
    <Entity>sample string 6</Entity>
    <FileName>sample string 31</FileName>
    <FileType>sample string 32</FileType>
    <FileUploadDate>2025-06-27T23:13:36.2890312+00:00</FileUploadDate>
    <FiledAgainst>sample string 20</FiledAgainst>
    <FiledBy>sample string 19</FiledBy>
    <InsertBy>sample string 33</InsertBy>
    <InsertDate>2025-06-27T23:13:36.2890312+00:00</InsertDate>
    <Lawyer>sample string 25</Lawyer>
    <LitigationNumber>sample string 35</LitigationNumber>
    <LitigationTrackerID>4de740ab-4071-4610-96d4-a67b5b54430f</LitigationTrackerID>
    <Location>sample string 14</Location>
    <MatterStartDate>2025-06-27T23:13:36.2890312+00:00</MatterStartDate>
    <Region>sample string 10</Region>
    <SerialNumber>sample string 18</SerialNumber>
    <State>sample string 12</State>
    <Status>sample string 24</Status>
    <TCaseCategory>sample string 38</TCaseCategory>
    <WhatTranspired>sample string 34</WhatTranspired>
    <clientId>fe7442ff-d1d3-4ba8-bfa5-c9254a58b116</clientId>
    <companyRepresentativeIds>sample string 39</companyRepresentativeIds>
    <complianceCategoryId>5fa9d9fe-4c42-4483-a501-c8564b98c802</complianceCategoryId>
    <countryId>d8885e5f-fbb5-492f-8a78-b2ae6f6449a6</countryId>
    <entityId>9db1683b-7111-4564-ade8-6f584b90c43d</entityId>
    <groupEntity>sample string 4</groupEntity>
    <groupEntityId>44aa0b92-32df-4e04-919f-9ee6c65cdd24</groupEntityId>
    <locationId>2d8a21a1-f0f5-455d-80c3-f5f7f69e5465</locationId>
    <regionId>b88367d9-c3d2-4ba2-93dd-71d9ff9be634</regionId>
    <stateId>0676c942-351a-44a2-bf23-57aa841f258d</stateId>
    <totalcount>1</totalcount>
  </CustomDCMLitigationTracker>
  <CustomDCMLitigationTracker>
    <ActionPlan>sample string 28</ActionPlan>
    <AmountInvolved>23</AmountInvolved>
    <BeforeCourt>sample string 21</BeforeCourt>
    <BriefOfDispute>sample string 22</BriefOfDispute>
    <CaseCategory>sample string 29</CaseCategory>
    <CaseNumber>sample string 27</CaseNumber>
    <CompanyRepresentative>sample string 26</CompanyRepresentative>
    <CompliaceCategory>sample string 16</CompliaceCategory>
    <CostOfHearing>sample string 30</CostOfHearing>
    <Country>sample string 8</Country>
    <DateOfLastHearing>2025-06-27T23:13:36.2890312+00:00</DateOfLastHearing>
    <DateOfNextHearing>2025-06-27T23:13:36.2890312+00:00</DateOfNextHearing>
    <DocumentExt>sample string 37</DocumentExt>
    <DocumentName>sample string 36</DocumentName>
    <Entity>sample string 6</Entity>
    <FileName>sample string 31</FileName>
    <FileType>sample string 32</FileType>
    <FileUploadDate>2025-06-27T23:13:36.2890312+00:00</FileUploadDate>
    <FiledAgainst>sample string 20</FiledAgainst>
    <FiledBy>sample string 19</FiledBy>
    <InsertBy>sample string 33</InsertBy>
    <InsertDate>2025-06-27T23:13:36.2890312+00:00</InsertDate>
    <Lawyer>sample string 25</Lawyer>
    <LitigationNumber>sample string 35</LitigationNumber>
    <LitigationTrackerID>4de740ab-4071-4610-96d4-a67b5b54430f</LitigationTrackerID>
    <Location>sample string 14</Location>
    <MatterStartDate>2025-06-27T23:13:36.2890312+00:00</MatterStartDate>
    <Region>sample string 10</Region>
    <SerialNumber>sample string 18</SerialNumber>
    <State>sample string 12</State>
    <Status>sample string 24</Status>
    <TCaseCategory>sample string 38</TCaseCategory>
    <WhatTranspired>sample string 34</WhatTranspired>
    <clientId>fe7442ff-d1d3-4ba8-bfa5-c9254a58b116</clientId>
    <companyRepresentativeIds>sample string 39</companyRepresentativeIds>
    <complianceCategoryId>5fa9d9fe-4c42-4483-a501-c8564b98c802</complianceCategoryId>
    <countryId>d8885e5f-fbb5-492f-8a78-b2ae6f6449a6</countryId>
    <entityId>9db1683b-7111-4564-ade8-6f584b90c43d</entityId>
    <groupEntity>sample string 4</groupEntity>
    <groupEntityId>44aa0b92-32df-4e04-919f-9ee6c65cdd24</groupEntityId>
    <locationId>2d8a21a1-f0f5-455d-80c3-f5f7f69e5465</locationId>
    <regionId>b88367d9-c3d2-4ba2-93dd-71d9ff9be634</regionId>
    <stateId>0676c942-351a-44a2-bf23-57aa841f258d</stateId>
    <totalcount>1</totalcount>
  </CustomDCMLitigationTracker>
</ArrayOfCustomDCMLitigationTracker>