Counter Reports (v1)

http://localhost/mod-erm-usage

Table of contents

mod-erm-usage API

This documents the API calls that can be made to query and manage counter reports

Counter Reports

Collection of counter-report items.

GET /counter-reports

Get all reports

GET /counter-reports
Query Parameters
  • tiny: (boolean - default: false)
  • query: (string)

    A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
    
    active=true sortBy username
    
  • orderBy: (string)

    Order by field: field A, field B

  • order: (one of desc, asc - default: desc)

    Order

  • offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)

    Skip over a number of elements by specifying an offset value for the query

    Example:

    0
  • limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)

    Limit the number of elements returned in the response

    Example:

    10
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of counter-report items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "counterReports": {
      "type": "array",
      "id": "counterReportData",
      "items": {
        "type": "object",
        "$ref": "counterreport.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "counterReports",
    "totalRecords"
  ]
}

Example:

{
  "counterReports": [
    {
    	"id": "8c6b1c02-e153-4413-970b-1b1a3eca1328",
    	"downloadTime": "2018-09-13T12:57:01.414+0000",
    	"creationTime": "2018-09-13T12:57:01.414+0000",
    	"release": "4",
    	"reportName": "JR1",
    	"yearMonth": "2018-07",
    	"customerId": "Customer123Id",
    	"vendorId": "5fb03fb5-56c0-4a6e-9f4e-194d1b540140",
    	"platformId": "19b535aa-7007-435a-96da-a390853e6666",
    	"format": "xml",
    	"report": {}
    },
    {
    	"id": "8c6b1c02-e153-4413-970b-1b1a3eca1330",
    	"downloadTime": "2018-09-13T12:57:01.414+0000",
    	"creationTime": "2018-09-13T12:57:01.414+0000",
    	"release": "5",
    	"reportName": "TR_J1",
    	"yearMonth": "2018-07",
    	"customerId": "Customer123Id",
    	"vendorId": "5fb03fb5-56c0-4a6e-9f4e-194d1b540140",
    	"platformId": "19b535aa-7007-435a-96da-a390853e6666",
    	"format": "json",
    	"report": {}
    }
  ],
  "totalRecords": 2
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list counter-reports -- malformed parameter 'query', syntax error at column 6

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list counter-reports -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /counter-reports

Post new report

POST /counter-reports
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Counter Report Schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "downloadTime": {
      "type": "string",
      "format": "date-time"
    },
    "failedAttempts": {
      "description": "Count of failed download attempts",
      "type": "integer"
    },
    "failedReason": {
      "description": "Error message from failed download attempt",
      "type": "string"
    },
    "release": {
      "type": "string"
    },
    "reportName": {
      "type": "string"
    },
    "yearMonth": {
      "type": "string",
      "format": "date-month"
    },
    "customerId": {
      "type": "string"
    },
    "vendorId": {
      "type": "string"
    },
    "platformId": {
      "type": "string"
    },
    "providerId": {
      "type": "string"
    },
    "format": {
      "type": "string"
    },
    "report": {
      "description": "Actual counter report data",
      "type": "object"
    },
    "metadata": {
      "description": "Metadata about creation and changes, provided by the server (client should not provide)",
      "type": "object",
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "downloadTime",
    "release",
    "reportName",
    "yearMonth",
    "customerId",
    "vendorId",
    "platformId"
  ],
  "additionalProperties": true
}

Example:

{
  "id": "7c0faed5-3ab6-4657-8179-fee651d6a569",
  "downloadTime": "2019-02-14T08:42:04.885+0000",
  "release": "4",
  "reportName": "JR1",
  "yearMonth": "2018-12",
  "customerId": "customer1234",
  "vendorId": "48b1c9c4-cfb6-47fc-b34f-cff9cd2f8240",
  "platformId": "uuid-123456789",
  "providerId": "4b659cb9-e4bb-493d-ae30-5f5690c54802",
  "format": "???",
  "report": {
    "vendor": {
      "id": "SEM001",
      "name": "Semantico Ltd.",
      "contact": [
        {
          "email": "info@semantico.com",
          "contact": "tbc"
        }
      ],
      "logoUrl": "http://www.semantico.com/wp-content/themes/semantico/images/logo-new.png",
      "webSiteUrl": "http://www.semantico.com"
    },
    "created": "2019-02-11T12:35:45.066Z",
    "name": "Journal Report 1 (R4)",
    "id": "1549888545066",
    "title": "JR1:4",
    "version": "4",
    "customer": [
      {
        "id": "customer1234",
        "contact": [],
        "reportItems": [
          {
            "itemDate": [],
            "itemName": "19th-Century Music",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "University of California Press",
            "itemIdentifier": [
              {
                "type": "ONLINE_ISSN",
                "value": "1533-8606"
              },
              {
                "type": "PRINT_ISSN",
                "value": "0148-2076"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 5,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 4,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 9,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          },
          {
            "itemDate": [],
            "itemName": "AA Files",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "Architectural Association School of Architecture",
            "itemIdentifier": [
              {
                "type": "PRINT_ISSN",
                "value": "0261-6823"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 5,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 2,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 7,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          },
          {
            "itemDate": [],
            "itemName": "ABA Journal",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "American Bar Association",
            "itemIdentifier": [
              {
                "type": "ONLINE_ISSN",
                "value": "2162-7983"
              },
              {
                "type": "PRINT_ISSN",
                "value": "0747-0088"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 2,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 2,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 4,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          }
        ],
        "institutionalIdentifier": []
      }
    ]
  }
}

Response 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers
  • Location: required (string)

    URI to the created counter-report item

Body

Media type: application/json

Type: any

Example:

{
  "id": "7c0faed5-3ab6-4657-8179-fee651d6a569",
  "downloadTime": "2019-02-14T08:42:04.885+0000",
  "release": "4",
  "reportName": "JR1",
  "yearMonth": "2018-12",
  "customerId": "customer1234",
  "vendorId": "48b1c9c4-cfb6-47fc-b34f-cff9cd2f8240",
  "platformId": "uuid-123456789",
  "providerId": "4b659cb9-e4bb-493d-ae30-5f5690c54802",
  "format": "???",
  "report": {
    "vendor": {
      "id": "SEM001",
      "name": "Semantico Ltd.",
      "contact": [
        {
          "email": "info@semantico.com",
          "contact": "tbc"
        }
      ],
      "logoUrl": "http://www.semantico.com/wp-content/themes/semantico/images/logo-new.png",
      "webSiteUrl": "http://www.semantico.com"
    },
    "created": "2019-02-11T12:35:45.066Z",
    "name": "Journal Report 1 (R4)",
    "id": "1549888545066",
    "title": "JR1:4",
    "version": "4",
    "customer": [
      {
        "id": "customer1234",
        "contact": [],
        "reportItems": [
          {
            "itemDate": [],
            "itemName": "19th-Century Music",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "University of California Press",
            "itemIdentifier": [
              {
                "type": "ONLINE_ISSN",
                "value": "1533-8606"
              },
              {
                "type": "PRINT_ISSN",
                "value": "0148-2076"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 5,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 4,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 9,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          },
          {
            "itemDate": [],
            "itemName": "AA Files",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "Architectural Association School of Architecture",
            "itemIdentifier": [
              {
                "type": "PRINT_ISSN",
                "value": "0261-6823"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 5,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 2,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 7,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          },
          {
            "itemDate": [],
            "itemName": "ABA Journal",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "American Bar Association",
            "itemIdentifier": [
              {
                "type": "ONLINE_ISSN",
                "value": "2162-7983"
              },
              {
                "type": "PRINT_ISSN",
                "value": "0747-0088"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 2,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 2,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 4,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          }
        ],
        "institutionalIdentifier": []
      }
    ]
  }
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to add counter-report -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create counter-reports -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /counter-reports/{id}

Get one report identified by id

GET /counter-reports/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Counter Report Schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "downloadTime": {
      "type": "string",
      "format": "date-time"
    },
    "failedAttempts": {
      "description": "Count of failed download attempts",
      "type": "integer"
    },
    "failedReason": {
      "description": "Error message from failed download attempt",
      "type": "string"
    },
    "release": {
      "type": "string"
    },
    "reportName": {
      "type": "string"
    },
    "yearMonth": {
      "type": "string",
      "format": "date-month"
    },
    "customerId": {
      "type": "string"
    },
    "vendorId": {
      "type": "string"
    },
    "platformId": {
      "type": "string"
    },
    "providerId": {
      "type": "string"
    },
    "format": {
      "type": "string"
    },
    "report": {
      "description": "Actual counter report data",
      "type": "object"
    },
    "metadata": {
      "description": "Metadata about creation and changes, provided by the server (client should not provide)",
      "type": "object",
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "downloadTime",
    "release",
    "reportName",
    "yearMonth",
    "customerId",
    "vendorId",
    "platformId"
  ],
  "additionalProperties": true
}

Example:

{
  "id": "7c0faed5-3ab6-4657-8179-fee651d6a569",
  "downloadTime": "2019-02-14T08:42:04.885+0000",
  "release": "4",
  "reportName": "JR1",
  "yearMonth": "2018-12",
  "customerId": "customer1234",
  "vendorId": "48b1c9c4-cfb6-47fc-b34f-cff9cd2f8240",
  "platformId": "uuid-123456789",
  "providerId": "4b659cb9-e4bb-493d-ae30-5f5690c54802",
  "format": "???",
  "report": {
    "vendor": {
      "id": "SEM001",
      "name": "Semantico Ltd.",
      "contact": [
        {
          "email": "info@semantico.com",
          "contact": "tbc"
        }
      ],
      "logoUrl": "http://www.semantico.com/wp-content/themes/semantico/images/logo-new.png",
      "webSiteUrl": "http://www.semantico.com"
    },
    "created": "2019-02-11T12:35:45.066Z",
    "name": "Journal Report 1 (R4)",
    "id": "1549888545066",
    "title": "JR1:4",
    "version": "4",
    "customer": [
      {
        "id": "customer1234",
        "contact": [],
        "reportItems": [
          {
            "itemDate": [],
            "itemName": "19th-Century Music",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "University of California Press",
            "itemIdentifier": [
              {
                "type": "ONLINE_ISSN",
                "value": "1533-8606"
              },
              {
                "type": "PRINT_ISSN",
                "value": "0148-2076"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 5,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 4,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 9,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          },
          {
            "itemDate": [],
            "itemName": "AA Files",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "Architectural Association School of Architecture",
            "itemIdentifier": [
              {
                "type": "PRINT_ISSN",
                "value": "0261-6823"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 5,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 2,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 7,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          },
          {
            "itemDate": [],
            "itemName": "ABA Journal",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "American Bar Association",
            "itemIdentifier": [
              {
                "type": "ONLINE_ISSN",
                "value": "2162-7983"
              },
              {
                "type": "PRINT_ISSN",
                "value": "0747-0088"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 2,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 2,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 4,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          }
        ],
        "institutionalIdentifier": []
      }
    ]
  }
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"counter-report not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /counter-reports/{id}

Delete report identified by id

DELETE /counter-reports/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to delete counter-report -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"counter-report not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

PUT /counter-reports/{id}

Put report identified by id

PUT /counter-reports/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Counter Report Schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "downloadTime": {
      "type": "string",
      "format": "date-time"
    },
    "failedAttempts": {
      "description": "Count of failed download attempts",
      "type": "integer"
    },
    "failedReason": {
      "description": "Error message from failed download attempt",
      "type": "string"
    },
    "release": {
      "type": "string"
    },
    "reportName": {
      "type": "string"
    },
    "yearMonth": {
      "type": "string",
      "format": "date-month"
    },
    "customerId": {
      "type": "string"
    },
    "vendorId": {
      "type": "string"
    },
    "platformId": {
      "type": "string"
    },
    "providerId": {
      "type": "string"
    },
    "format": {
      "type": "string"
    },
    "report": {
      "description": "Actual counter report data",
      "type": "object"
    },
    "metadata": {
      "description": "Metadata about creation and changes, provided by the server (client should not provide)",
      "type": "object",
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "downloadTime",
    "release",
    "reportName",
    "yearMonth",
    "customerId",
    "vendorId",
    "platformId"
  ],
  "additionalProperties": true
}

Example:

{
  "id": "7c0faed5-3ab6-4657-8179-fee651d6a569",
  "downloadTime": "2019-02-14T08:42:04.885+0000",
  "release": "4",
  "reportName": "JR1",
  "yearMonth": "2018-12",
  "customerId": "customer1234",
  "vendorId": "48b1c9c4-cfb6-47fc-b34f-cff9cd2f8240",
  "platformId": "uuid-123456789",
  "providerId": "4b659cb9-e4bb-493d-ae30-5f5690c54802",
  "format": "???",
  "report": {
    "vendor": {
      "id": "SEM001",
      "name": "Semantico Ltd.",
      "contact": [
        {
          "email": "info@semantico.com",
          "contact": "tbc"
        }
      ],
      "logoUrl": "http://www.semantico.com/wp-content/themes/semantico/images/logo-new.png",
      "webSiteUrl": "http://www.semantico.com"
    },
    "created": "2019-02-11T12:35:45.066Z",
    "name": "Journal Report 1 (R4)",
    "id": "1549888545066",
    "title": "JR1:4",
    "version": "4",
    "customer": [
      {
        "id": "customer1234",
        "contact": [],
        "reportItems": [
          {
            "itemDate": [],
            "itemName": "19th-Century Music",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "University of California Press",
            "itemIdentifier": [
              {
                "type": "ONLINE_ISSN",
                "value": "1533-8606"
              },
              {
                "type": "PRINT_ISSN",
                "value": "0148-2076"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 5,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 4,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 9,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          },
          {
            "itemDate": [],
            "itemName": "AA Files",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "Architectural Association School of Architecture",
            "itemIdentifier": [
              {
                "type": "PRINT_ISSN",
                "value": "0261-6823"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 5,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 2,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 7,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          },
          {
            "itemDate": [],
            "itemName": "ABA Journal",
            "itemDataType": "JOURNAL",
            "itemPlatform": "Ithaka",
            "itemAttribute": [],
            "itemPublisher": "American Bar Association",
            "itemIdentifier": [
              {
                "type": "ONLINE_ISSN",
                "value": "2162-7983"
              },
              {
                "type": "PRINT_ISSN",
                "value": "0747-0088"
              }
            ],
            "itemContributor": [],
            "itemPerformance": [
              {
                "period": {
                  "end": "2018-12-31",
                  "begin": "2018-12-01"
                },
                "category": "REQUESTS",
                "instance": [
                  {
                    "count": 2,
                    "metricType": "FT_HTML"
                  },
                  {
                    "count": 2,
                    "metricType": "FT_PDF"
                  },
                  {
                    "count": 4,
                    "metricType": "FT_TOTAL"
                  }
                ]
              }
            ]
          }
        ],
        "institutionalIdentifier": []
      }
    ]
  }
}

Response 204

Item successfully updated

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to update counter-report -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"counter-report not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

GET /counter-reports/csv/{id}

Get the report identified by id as CSV

GET /counter-reports/csv/{id}
URI Parameters
  • id: required (string)

Response 200

Body

Media type: text/csv

Type: any

Response 500

Server Error

Body

Media type: text/plain

Type: any

GET /counter-reports/csv/provider/{id}/report/{name}/from/{begin}/to/{end}

Get report for several months as CSV for a provider id

GET /counter-reports/csv/provider/{id}/report/{name}/from/{begin}/to/{end}
URI Parameters
  • id: required (string)
  • name: required (string)
  • begin: required (string)
  • end: required (string)

Response 501

Not Implemented

Body

Media type: text/plain

Type: any