Cochrane+ App API

<back to all web services

Migrate

The following routes are available for this service:
GET/migrateMigration method used to perform custom logic
"use strict";
export class ApiServiceResponse {
    /** @param {{description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    description;
    /** @type {string} */
    heading;
    /** @type {boolean} */
    wasSuccessful;
    /** @type {Object} */
    modelState;
}
export class MigrateResponse extends ApiServiceResponse {
    /** @param {{recordsUpdated?:number,recordsDeleted?:number,recordsAdded?:number,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    recordsUpdated;
    /** @type {number} */
    recordsDeleted;
    /** @type {number} */
    recordsAdded;
}
export class Migrate {
    constructor(init) { Object.assign(this, init) }
}

JavaScript Migrate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /migrate HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	recordsUpdated: 0,
	recordsDeleted: 0,
	recordsAdded: 0,
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}