Retrieves a summary of the matter that is suitable for display purposes.
| Name | Description | Default |
|---|---|---|
id
|
File number or unique file ID. |
Content Type:
application/xml
or
application/json
Summary details or an error message.
| XML JSON |
|---|
<Response>
<Result>
<Clients> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<FileAs>string</FileAs>
<Liaison>
<ID>long</ID>
<FileAs>string</FileAs>
</Liaison>
<IsPrimary>bool</IsPrimary>
</Item>
</Clients>
<File>
<FileHeading>string</FileHeading>
<Matter>string</Matter>
<HistoricalCode>string</HistoricalCode>
<Workgroup>
<ID>long</ID>
<Name>string</Name>
</Workgroup>
<MaterClient>
<ID>long</ID>
<FileAs>string</FileAs>
</MaterClient>
<ShelfLocation>string</ShelfLocation>
<IsShelfLocationCurrent>bool</IsShelfLocationCurrent>
<IsReadyForArchival>bool</IsReadyForArchival>
</File>
<Members> <!--Array of 'Item'-->
<Item>
<Role>string</Role>
<Members> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<Code>string</Code>
<Contact>
<ID>long</ID>
<FileAs>string</FileAs>
</Contact>
</Item>
</Members>
</Item>
</Members>
<Billing>
<BillTo>
<ID>long</ID>
<FileAs>string</FileAs>
</BillTo>
<ClientReference>string</ClientReference>
<BillingScale>
<ID>long</ID>
<Name>string</Name>
<EffectiveFrom>datetime</EffectiveFrom>
</BillingScale>
<StatutoryScale>
<ID>long</ID>
<Name>string</Name>
</StatutoryScale>
<BillingCycle>string</BillingCycle>
<Discount>string</Discount>
<TrustAuthority>
<ID>long</ID>
<Description>string</Description>
<Date>datetime</Date>
</TrustAuthority>
<DefaultProduct>
<ID>long</ID>
<Code>string</Code>
<Description>string</Description>
</DefaultProduct>
</Billing>
<Notes>string</Notes> <!--Free-form notes (RTF)-->
<Court>
<Action>string</Action>
<Roles> <!--Array of 'Item'-->
<Item>
<Role>string</Role>
<Contacts> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<FileAs>string</FileAs>
</Item>
</Contacts>
</Item>
</Roles>
</Court>
<Parties> <!--Array of 'Item'-->
<Item>
<Role>string</Role>
<Contacts> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<FileAs>string</FileAs>
</Item>
</Contacts>
</Item>
</Parties>
<RelatedFiles> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<FileNumber>string</FileNumber>
<Matter>string</Matter>
<CompanyID>long</CompanyID>
<PrimaryClientID>long</PrimaryClientID>
</Item>
</RelatedFiles>
<Representatives> <!--Array of 'Item'-->
<Item>
<Representative>
<ID>long</ID>
<FileAs>string</FileAs>
</Representative>
<Reference>string</Reference>
<Parties>
<Role>string</Role>
<Contacts> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<FileAs>string</FileAs>
</Item>
</Contacts>
</Parties>
</Item>
</Representatives>
<DistroList> <!--Array of 'Item'-->
<Item>
<Contact>
<ID>long</ID>
<FileAs>string</FileAs>
</Contact>
<Member>
<ID>long</ID>
<Code>string</Code>
<Contact>
<ID>long</ID>
<FileAs>string</FileAs>
</Contact>
</Member>
<RecipientType>string</RecipientType>
</Item>
</DistroList>
<ThirdParties> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<FileAs>string</FileAs>
<Description>string</Description>
</Item>
</ThirdParties>
<Fields> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<Name>string</Name>
<Category>string</Category>
<Type>string</Type>
<ImplementationGuid>guid</ImplementationGuid>
<Values> <!--Array of 'Item'-->
<Item>string</Item>
</Values>
</Item>
</Fields>
<ID>long</ID> <!--Unique file ID-->
<FileNumber>string</FileNumber> <!--Human-readable file number-->
<FileType>string</FileType> <!--'Client', 'Prospect' or 'Admin'-->
<ArchiveType>string</ArchiveType> <!--'Paper', 'Packet' or 'None'-->
<Created>
<Date>datetime</Date>
<MemberCode>string</MemberCode>
</Created>
<Archived>
<Date>datetime</Date>
<MemberCode>string</MemberCode>
</Archived>
<Destroyed>
<Date>datetime</Date>
<MemberCode>string</MemberCode>
</Destroyed>
<LastModified>
<Date>datetime</Date>
<MemberCode>string</MemberCode>
<ModificationTypes> <!--Array of 'Item'-->
<Item>string</Item>
</ModificationTypes>
</LastModified>
<HasUnresolvedConflict>bool</HasUnresolvedConflict> <!--Conflict check status-->
</Result>
<Message>string</Message> <!--Error message-->
</Response>
|
{
"Result": {
"Clients": [{
"ID": "long",
"FileAs": "string",
"Liaison": {
"ID": "long",
"FileAs": "string"
},
"IsPrimary": "bool"
}],
"File": {
"FileHeading": "string",
"Matter": "string",
"HistoricalCode": "string",
"Workgroup": {
"ID": "long",
"Name": "string"
},
"MaterClient": {
"ID": "long",
"FileAs": "string"
},
"ShelfLocation": "string",
"IsShelfLocationCurrent": "bool",
"IsReadyForArchival": "bool"
},
"Members": [{
"Role": "string",
"Members": [{
"ID": "long",
"Code": "string",
"Contact": {
"ID": "long",
"FileAs": "string"
}
}]
}],
"Billing": {
"BillTo": {
"ID": "long",
"FileAs": "string"
},
"ClientReference": "string",
"BillingScale": {
"ID": "long",
"Name": "string",
"EffectiveFrom": "datetime"
},
"StatutoryScale": {
"ID": "long",
"Name": "string"
},
"BillingCycle": "string",
"Discount": "string",
"TrustAuthority": {
"ID": "long",
"Description": "string",
"Date": "datetime"
},
"DefaultProduct": {
"ID": "long",
"Code": "string",
"Description": "string"
}
},
"Notes": "string", // Free-form notes (RTF)
"Court": {
"Action": "string",
"Roles": [{
"Role": "string",
"Contacts": [{
"ID": "long",
"FileAs": "string"
}]
}]
},
"Parties": [{
"Role": "string",
"Contacts": [{
"ID": "long",
"FileAs": "string"
}]
}],
"RelatedFiles": [{
"ID": "long",
"FileNumber": "string",
"Matter": "string",
"CompanyID": "long",
"PrimaryClientID": "long"
}],
"Representatives": [{
"Representative": {
"ID": "long",
"FileAs": "string"
},
"Reference": "string",
"Parties": {
"Role": "string",
"Contacts": [{
"ID": "long",
"FileAs": "string"
}]
}
}],
"DistroList": [{
"Contact": {
"ID": "long",
"FileAs": "string"
},
"Member": {
"ID": "long",
"Code": "string",
"Contact": {
"ID": "long",
"FileAs": "string"
}
},
"RecipientType": "string"
}],
"ThirdParties": [{
"ID": "long",
"FileAs": "string",
"Description": "string"
}],
"Fields": [{
"ID": "long",
"Name": "string",
"Category": "string",
"Type": "string",
"ImplementationGuid": "guid",
"Values": [ "string" ]
}],
"ID": "long", // Unique file ID
"FileNumber": "string", // Human-readable file number
"FileType": "string", // 'Client', 'Prospect' or 'Admin'
"ArchiveType": "string", // 'Paper', 'Packet' or 'None'
"Created": {
"Date": "datetime",
"MemberCode": "string"
},
"Archived": {
"Date": "datetime",
"MemberCode": "string"
},
"Destroyed": {
"Date": "datetime",
"MemberCode": "string"
},
"LastModified": {
"Date": "datetime",
"MemberCode": "string",
"ModificationTypes": [ "string" ]
},
"HasUnresolvedConflict": "bool" // Conflict check status
},
"Message": "string" // Error message
}
|
| Code | Condition |
|---|---|
| 200 OK | The operation completed successfully. |
| 400 Bad Request | Invalid file ID. |
| 401 Unauthorized | Access token is invalid, expired or not specified. |
| 403 Forbidden | The user does not have permission to view the matter. |
| 404 Not Found | File not found. |
| 406 Not Acceptable | Content type specified in the Accept header isn't supported. |
| 500 Internal Server Error | An internal error occurred. |