Case Reports

Import/Export (Full Case, Custom Reports, Export Templates)

The Case export endpoint is synchronous and works on one or more Cases (up to 100; for more Cases, please batch your requests).

The Custom Report and Export Template endpoints are asynchronous and work on one or more Cases. The asynchronous endpoints are used with the following pattern:

1 request to execute the report (schedule a task that generates the report).
1 or more requests to check the status.
1 request to download the report.

The endpoints described here create resources that are only visible to the creating user by default but do allow for customization, see Visibility.

Get Schema (v3)

GET

text

https://www.clarinetlive.com/api/v3/cases/schema

Request

No body.

The Accept header should be populated with either application/xml to get the XML Schema Document or application/json to get the JSON schema document.

Response

The full schema in the requested format. This schema is used for both imports and exports.

Export single case (v3)

Endpoint

GET

text

https://www.clarinetlive.com/api/v3/cases?caseReference={caseReference}

text

https://www.clarinetlive.com/api/v3/cases/{publicID}

Request

caseReference should be the reference of the case you wish to export. Alternatively, the public ID of the case can be specified in the path.

No body.

Supports JSON with Accept header set to application/json or XML with the Accept header set to application/xml.

Response

Returns the case in the requested format (either JSON or XML).

Note that the JSON format is significantly different to the v2 format described in (JSON and XSD Mapping). Use the Get Schema endpoint to see the format.

Export a Case (v1, v2)

Initial Request Endpoint

GET

text

https://www.clarinetlive.com/api/v2/cases?caseReference=<case reference>

Role

Case Management

Request

By default, this returns the Case in the same JSON format that is accepted by POST.

To retrieve the Case in Common Case Standard (CCS) XML Format, add an Accept header of application/XML.

To retrieve the Case in single case export (XLSX) Format, add an Accept header of application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.

Responses

Some specific responses for this endpoint are listed below. General information about responses, status codes, and errors can be found in Responses and Errors.

Code	Description
200	The Case has been exported in the format requested

Custom Report (for one Portfolio)

Initial Request Endpoint POST

text

https://www.clarinetlive.com/api/latest/report/portfolio?reportName=<report name>&portfolioName=<portfolio name>

Role

Portfolio View

Request

The body of the POST can either be empty or contain a JSON object with the Visibility fields specified. If it contains the Visibility fields, the Content-Type should be application/json.

Responses

Some specific responses for this endpoint are listed below. General information about responses, status codes and errors can be found in Responses and Errors.

Code	Description
200	The report request is a duplicate of another so the original report request will be fulfilled and this one will be ignored. The response body will contain a status object, as described under the Status Request endpoint, that corresponds to the original report request. The response Location header will contain a URL for this status object.
201	This will execute the Custom Report against all Cases contained in the named Portfolio and create either the CSV or Excel report, as specified in the Custom Report definition. The response body will contain a status object, as described under the Status Request endpoint. The response Location header will contain a URL for this status object.

Custom Report (for one or more Portfolios)

Initial Request Endpoint

POST

text

https://www.clarinetlive.com/api/latest/report/portfolios?reportName=<report name>

Role

Portfolio View

Request

The body of the POST should contain a JSON object containing a JSON array of Portfolio names and optionally the Visibility fields specified. The Content-Type should be application/JSON.

json

{
	"PortfolioNames": ["Portfolio 1", "Portfolio B"]
}

Responses

Some specific responses for this endpoint are listed below. General information about responses, status codes, and errors can be found in Responses and Errors.

Code	Description
200	The report request is a duplicate of another so the original report request will be fulfilled and this one will be ignored. The response body will contain a status object, as described under the Status Request endpoint, that corresponds to the original report request. The response Location header will contain a URL for this status object.
201	This will execute the Custom Report against all Cases contained in any of the named Portfolios and create either the CSV or Excel report, as specified in the Custom Report definition. The response body will contain a status object, as described under the Status Request endpoint. The response Location header will contain a URL for this status object.

Custom Report (for a Search result)

Initial Request Endpoint POST

text

https://www.clarinetlive.com/api/latest/report/savedSearch?reportName=<report name>&searchName=<search name>

Role

Case Management

Request

The body of the POST can either be empty or contain a JSON object with the Visibility fields specified. If it contains the Visibility fields, the Content-Type should be application/JSON.

Responses

Some specific responses for this endpoint are listed below. General information about responses, status codes, and errors can be found in Responses and Errors.

Code	Description
200	The report request is a duplicate of another so the original report request will be fulfilled and this one will be ignored. The status (header and body) response will be for the original report. The response body will contain a status object, as described under the Status Request endpoint, that corresponds to the original report request. The response Location header will contain a URL for this status object."CaseReferences"
201	This will execute the specified search, and then execute the Custom Report against all Cases contained in the results of that search. It will create either the CSV or Excel report, as specified in the Custom Report definition. The response body will contain a status object, as described under the Status Request endpoint. The response Location header will contain a URL for this status object.

Code

Description

200

The report request is a duplicate of another so the original report request will be fulfilled and this one will be ignored. The status (header and body) response will be for the original report. The response body will contain a status object, as described under the Status Request endpoint, that corresponds to the original report request. The response Location header will contain a URL for this status object."CaseReferences"

201

This will execute the specified search, and then execute the Custom Report against all Cases contained in the results of that search. It will create either the CSV or Excel report, as specified in the Custom Report definition. The response body will contain a status object, as described under the Status Request endpoint. The response Location header will contain a URL for this status object.

Custom Report (for one or more Cases)

Initial Request Endpoint

POST

text

https://www.clarinetlive.com/api/latest/report/cases?reportName=<report name>

Role

Case Management

Request

The body of the POST should contain a JSON object containing a JSON array of Case References and optionally the Visibility fields specified. The Content-Type should be application/JSON.

json

{
	"CaseReferences": ["Case 1", "Case B"]
}

Responses

Some specific responses for this endpoint are listed below. General information about responses, status codes, and errors can be found in Responses and Errors.

Code	Description
200	The report request is a duplicate of another so the original report request will be fulfilled and this one will be ignored. The response body will contain a status object, as described under the Status Request endpoint, that corresponds to the original report request. The response Location header will contain a URL for this status object.
201	This will execute the report against each case specified in the body of the POST, and create either the CSV or Excel report, as specified in the Custom Report definition. The response body will contain a status object, as described under the Status Request endpoint. The response Location header will contain a URL for this status object.

Built-in Report (for one or more Cases)

Initial Request Endpoint

POST https://www.clarinetlive.com/api/latest/report/annualpremiums.

POST https://www.clarinetlive.com/api/latest/report/broadriversubmissionpackage.

POST https://www.clarinetlive.com/api/latest/report/casestatus.

(File Type must be specified as “CSV” or “pdf”).

POST https://www.clarinetlive.com/api/latest/report/compliancechecklist.

(File Type must be specified as “CSV” or “pdf”).

POST https://www.clarinetlive.com/api/latest/report/externalvaluationhistory.

(File Type must be specified as “CSV” or “xlsx”).

POST https://www.clarinetlive.com/api/latest/report/lyricexport.

POST https://www.clarinetlive.com/api/latest/report/lyricexportwithdocuments.

POST https://www.clarinetlive.com/api/latest/report/paymenthistory.

POST https://www.clarinetlive.com/api/latest/report/paymenthistorypaid.

POST https://www.clarinetlive.com/api/latest/report/pbireport.

POST https://www.clarinetlive.com/api/latest/report/premiumscheduleandndbstreams.

POST https://www.clarinetlive.com/api/latest/report/resscapitalsubmissionpackage.

POST https://www.clarinetlive.com/api/latest/report/wellsfargopremiuminstruction.

Role

Case Management

This report needs the role: External Valuation History - Read.

Request

The body of the POST should contain a JSON object containing a JSON array of Case References and optionally the Visibility fields specified. The Content-Type should be application/json.

json

{
	"CaseReferences":["Case 1", "Case B"]
}

For the reports that require it, the File Type must be specified as follows:

json

{
	"FileType": "csv"
}

Responses

Some specific responses for this endpoint are listed below. General information about responses, status codes, and errors can be found in Responses and Errors.

Code	Description
200	The report request is a duplicate of another so the original report request will be fulfilled and this one will be ignored. The response body will contain a status object, as described under the Status Request endpoint, that corresponds to the original report request. The response Location header will contain a URL for this status object.
201	This will execute the report against each case specified in the body of the POST. The response body will contain a status object, as described under the Status Request endpoint. The response Location header will contain a URL for this status object.

Report Parameters

Some reports accept additional parameters to vary their behavior. In the UI, you will be prompted for them when trying to run certain reports. To provide those parameters using the API, you can set them in the body of the request.

For example,

json

{
	"ReportParameters": {
	  "PremiumHistoryFrom": "2025-01-01",
	  "PremiumHistoryTo": "2025-01-01"
	}
}

This functionality is available for report endpoints where the request is provided as a POST.

Export Templates (for Portfolio, Search results, or Cases)

Initial Request Endpoint

POST https://www.clarinetlive.com/api/latest/exporttemplate.

Role

Export Templates View

Request

The body of the POST should contain a JSON object. The Content-Type header should be set to application/JSON and for optional fields:

You can either specify null as their value or omit them entirely.
Optional fields that are missing or set to null will have a default value set by ClariNet. Some of these defaults can be set via the Admin menu using the ClariNet LS website.
All defaulted values are included in the output.

Request Parameters

ExportTemplate: Only a single Export Template should be specified as a valid ClariNet LS Export Template. String, required.

One of PortfolioName, SearchName, and CaseReferences should be specified.

PortfolioName: A valid ClariNet LS Portfolio. String, optional.

SearchName: A valid ClariNet LS Saved Search. String, optional.

CaseReferences: An array of valid ClariNet LS Case References. String array, optional.

Parameters: An array of parameters for the Export Template, each parameter should be in the following format:

ParameterName: The name of the Export Template parameter.

Depending on the Parameter Type specified in the Export Template, one of the following must then be supplied:

DateValue: Date
IntegerValue: Integer
DecimalValue: Decimal
TextValue: String

FileType: Output Format to use for the Export Template. Specify the file extension of the Format to use, or leave empty to use the default export format—string, optional.

AdditionalUsers: An array of valid usernames to which the report is also visible from the “MyReports” screen in ClarinetLS—string array, optional.

SubscriberWide: True or false – if set to true, the report is visible to all users within the requestor’s company. Boolean, optional.

Request Examples

Here is an example valid request body:

json

{
    "exportTemplate": "My Export Template",
    "portfolioName": null,
    "searchName": "A Saved Search",
    "caseReferences": null,
    "parameters":[
        {
          "parameterName": "My Parameter",
          "integerValue": 5
        }
    ],
    "fileType": "txt",
    "additionalUsers": null,
    "subscriberWide": true
}

Responses

Some specific responses for this endpoint are listed below. General information about responses, status codes, and errors can be found in Responses and Errors.

Code	Description
201	If the request has been validated successfully, you will receive a 201 Created response. The response body will contain a status object, as described under the Status Request endpoint. The response Location header will contain a URL for this status object.
200	The report request is a duplicate of another so the original report request will be fulfilled and this one will be ignored. The response body will contain a status object, as described under the Status Request endpoint, that corresponds to the original report request. The response Location header will contain a URL for this status object.

Status Request

Endpoint

GET

text

https://www.clarinetlive.com/api/latest/report/status?reportId=<reportId>

Responses

Some specific responses for this endpoint are listed below. General information about responses, status codes, and errors can be found in Responses and Errors.

Code Description

200 The body containing a JSON object to return the status of the requested report.

{ "fileName":"file.csv", "title":"yourReport", "status":"Requested", "message":"" }

The status field will show whether it has been Requested (meaning that is has been added to a job queue), Started (meaning it is being processed) or Completed (and can now be downloaded).

The message field will contain extra information relating to the request e.g. AdditionalUsers specified will be ignored when using SubscriberWide.

If the report is Completed, the Location header will contain a URL that could be used to access the Download Report endpoint.

Code	Description
200	The body containing a JSON object to return the status of the requested report. `{ "fileName":"file.csv", "title":"yourReport", "status":"Requested", "message":"" }` The status field will show whether it has been Requested (meaning that is has been added to a job queue), Started (meaning it is being processed) or Completed (and can now be downloaded). The message field will contain extra information relating to the request e.g. AdditionalUsers specified will be ignored when using SubscriberWide. If the report is Completed, the Location header will contain a URL that could be used to access the Download Report endpoint.

Download Request

Endpoint

GET

text

https://www.clarinetlive.com/api/latest/report?reportId=<reportId>

Responses

Some specific responses for this endpoint are listed below. General information about responses, status codes, and errors can be found in Responses and Errors.

Code	Description
200	When the report status has been updated to Completed the report can be downloaded. The response will contain the file specified in a previous request.

Case Reports ​

Import/Export (Full Case, Custom Reports, Export Templates)

Get Schema (v3)

Request

Response

Export single case (v3)

Endpoint

Request

Response

Export a Case (v1, v2)

Custom Report (for one Portfolio)

Custom Report (for one or more Portfolios)

Custom Report (for a Search result)

Custom Report (for one or more Cases)

Built-in Report (for one or more Cases)

Report Parameters

Export Templates (for Portfolio, Search results, or Cases)

Status Request

Download Request

Case Reports