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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

globally unique identifier

Required
assessmentCycleId

string

Required
excel

boolean

Required

Body Parameters

CustomLitigationReportFilters
NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "26eadebe-74f0-4245-9f52-02601f1aa37c",
    "groupEntityId": "561a37b1-3b3d-4c77-bef5-e0dc2e550d9c",
    "groupEntity": "sample string 4",
    "entityId": "1593430d-9d62-4b44-b11a-865579b59a78",
    "Entity": "sample string 6",
    "countryId": "926f94e2-1df7-4dfd-b2cd-6c93f9abac42",
    "Country": "sample string 8",
    "regionId": "b0d1a7c5-b894-4f15-bbcc-9de6575f1257",
    "Region": "sample string 10",
    "stateId": "d99ac7ff-37a4-4fcf-ac13-4f8c992bf26e",
    "State": "sample string 12",
    "locationId": "5c2579ae-066b-41dc-9959-95ee61070d45",
    "Location": "sample string 14",
    "complianceCategoryId": "85d0fe6a-7cb5-4757-8124-982eb3643099",
    "CompliaceCategory": "sample string 16",
    "clientId": "9672f7b5-c42b-45a0-a9c9-b3bb68ab16ce",
    "SerialNumber": "sample string 18",
    "FiledBy": "sample string 19",
    "FiledAgainst": "sample string 20",
    "BeforeCourt": "sample string 21",
    "BriefOfDispute": "sample string 22",
    "AmountInvolved": 23,
    "MatterStartDate": "2025-03-20T22:53:35.1813349+00:00",
    "Status": "sample string 24",
    "DateOfLastHearing": "2025-03-20T22:53:35.1813349+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-03-20T22:53:35.1813349+00:00",
    "FileName": "sample string 31",
    "FileType": "sample string 32",
    "FileUploadDate": "2025-03-20T22:53:35.1813349+00:00",
    "InsertBy": "sample string 33",
    "InsertDate": "2025-03-20T22:53:35.1813349+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": "26eadebe-74f0-4245-9f52-02601f1aa37c",
    "groupEntityId": "561a37b1-3b3d-4c77-bef5-e0dc2e550d9c",
    "groupEntity": "sample string 4",
    "entityId": "1593430d-9d62-4b44-b11a-865579b59a78",
    "Entity": "sample string 6",
    "countryId": "926f94e2-1df7-4dfd-b2cd-6c93f9abac42",
    "Country": "sample string 8",
    "regionId": "b0d1a7c5-b894-4f15-bbcc-9de6575f1257",
    "Region": "sample string 10",
    "stateId": "d99ac7ff-37a4-4fcf-ac13-4f8c992bf26e",
    "State": "sample string 12",
    "locationId": "5c2579ae-066b-41dc-9959-95ee61070d45",
    "Location": "sample string 14",
    "complianceCategoryId": "85d0fe6a-7cb5-4757-8124-982eb3643099",
    "CompliaceCategory": "sample string 16",
    "clientId": "9672f7b5-c42b-45a0-a9c9-b3bb68ab16ce",
    "SerialNumber": "sample string 18",
    "FiledBy": "sample string 19",
    "FiledAgainst": "sample string 20",
    "BeforeCourt": "sample string 21",
    "BriefOfDispute": "sample string 22",
    "AmountInvolved": 23,
    "MatterStartDate": "2025-03-20T22:53:35.1813349+00:00",
    "Status": "sample string 24",
    "DateOfLastHearing": "2025-03-20T22:53:35.1813349+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-03-20T22:53:35.1813349+00:00",
    "FileName": "sample string 31",
    "FileType": "sample string 32",
    "FileUploadDate": "2025-03-20T22:53:35.1813349+00:00",
    "InsertBy": "sample string 33",
    "InsertDate": "2025-03-20T22:53:35.1813349+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-03-20T22:53:35.1813349+00:00</DateOfLastHearing>
    <DateOfNextHearing>2025-03-20T22:53:35.1813349+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-03-20T22:53:35.1813349+00:00</FileUploadDate>
    <FiledAgainst>sample string 20</FiledAgainst>
    <FiledBy>sample string 19</FiledBy>
    <InsertBy>sample string 33</InsertBy>
    <InsertDate>2025-03-20T22:53:35.1813349+00:00</InsertDate>
    <Lawyer>sample string 25</Lawyer>
    <LitigationNumber>sample string 35</LitigationNumber>
    <LitigationTrackerID>26eadebe-74f0-4245-9f52-02601f1aa37c</LitigationTrackerID>
    <Location>sample string 14</Location>
    <MatterStartDate>2025-03-20T22:53:35.1813349+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>9672f7b5-c42b-45a0-a9c9-b3bb68ab16ce</clientId>
    <companyRepresentativeIds>sample string 39</companyRepresentativeIds>
    <complianceCategoryId>85d0fe6a-7cb5-4757-8124-982eb3643099</complianceCategoryId>
    <countryId>926f94e2-1df7-4dfd-b2cd-6c93f9abac42</countryId>
    <entityId>1593430d-9d62-4b44-b11a-865579b59a78</entityId>
    <groupEntity>sample string 4</groupEntity>
    <groupEntityId>561a37b1-3b3d-4c77-bef5-e0dc2e550d9c</groupEntityId>
    <locationId>5c2579ae-066b-41dc-9959-95ee61070d45</locationId>
    <regionId>b0d1a7c5-b894-4f15-bbcc-9de6575f1257</regionId>
    <stateId>d99ac7ff-37a4-4fcf-ac13-4f8c992bf26e</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-03-20T22:53:35.1813349+00:00</DateOfLastHearing>
    <DateOfNextHearing>2025-03-20T22:53:35.1813349+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-03-20T22:53:35.1813349+00:00</FileUploadDate>
    <FiledAgainst>sample string 20</FiledAgainst>
    <FiledBy>sample string 19</FiledBy>
    <InsertBy>sample string 33</InsertBy>
    <InsertDate>2025-03-20T22:53:35.1813349+00:00</InsertDate>
    <Lawyer>sample string 25</Lawyer>
    <LitigationNumber>sample string 35</LitigationNumber>
    <LitigationTrackerID>26eadebe-74f0-4245-9f52-02601f1aa37c</LitigationTrackerID>
    <Location>sample string 14</Location>
    <MatterStartDate>2025-03-20T22:53:35.1813349+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>9672f7b5-c42b-45a0-a9c9-b3bb68ab16ce</clientId>
    <companyRepresentativeIds>sample string 39</companyRepresentativeIds>
    <complianceCategoryId>85d0fe6a-7cb5-4757-8124-982eb3643099</complianceCategoryId>
    <countryId>926f94e2-1df7-4dfd-b2cd-6c93f9abac42</countryId>
    <entityId>1593430d-9d62-4b44-b11a-865579b59a78</entityId>
    <groupEntity>sample string 4</groupEntity>
    <groupEntityId>561a37b1-3b3d-4c77-bef5-e0dc2e550d9c</groupEntityId>
    <locationId>5c2579ae-066b-41dc-9959-95ee61070d45</locationId>
    <regionId>b0d1a7c5-b894-4f15-bbcc-9de6575f1257</regionId>
    <stateId>d99ac7ff-37a4-4fcf-ac13-4f8c992bf26e</stateId>
    <totalcount>1</totalcount>
  </CustomDCMLitigationTracker>
</ArrayOfCustomDCMLitigationTracker>