Trendsic Platform Service

<back to all web services

ImagingBatchesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/imaging/batches
"use strict";
export class ImagingBatchDto {
    /** @param {{BatchId?:number,BatchKey?:string,Title?:string,CreatedByLbl?:string,CreatedLabel?:string,Stage?:string,Dpi?:string,Color?:string,DestroyAfter?:boolean,ContainersJson?:string,QaJson?:string,ImportReceipt?:string,LogJson?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    BatchId;
    /** @type {string} */
    BatchKey;
    /** @type {string} */
    Title;
    /** @type {string} */
    CreatedByLbl;
    /** @type {string} */
    CreatedLabel;
    /** @type {string} */
    Stage;
    /** @type {string} */
    Dpi;
    /** @type {string} */
    Color;
    /** @type {boolean} */
    DestroyAfter;
    /** @type {string} */
    ContainersJson;
    /** @type {string} */
    QaJson;
    /** @type {string} */
    ImportReceipt;
    /** @type {string} */
    LogJson;
}
export class ImagingBatchesResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Batches?:ImagingBatchDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ImagingBatchDto[]} */
    Batches = [];
}
export class ImagingBatchesRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript ImagingBatchesRequest 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 /v1/records/imaging/batches HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Batches: 
	[
		{
			BatchId: 0,
			BatchKey: String,
			Title: String,
			CreatedByLbl: String,
			CreatedLabel: String,
			Stage: String,
			Dpi: String,
			Color: String,
			DestroyAfter: False,
			ContainersJson: String,
			QaJson: String,
			ImportReceipt: String,
			LogJson: String
		}
	]
}