Trendsic Platform Service

<back to all web services

AvailableFactFinderCodeRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,DELETE,OPTIONS/v1/AvailableFactFinderCode/{AgentId}
"use strict";
export class FactFinderCode {
    /** @param {{Id?:number,AgentId?:number,SerialNumber?:number,ShipDate?:string,TrackingNumber?:string,CreatedDate?:string,ContactId?:number,AssignedDate?:string,AgentName?:string,ContactName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    AgentId;
    /** @type {number} */
    SerialNumber;
    /** @type {string} */
    ShipDate;
    /** @type {string} */
    TrackingNumber;
    /** @type {string} */
    CreatedDate;
    /** @type {number} */
    ContactId;
    /** @type {string} */
    AssignedDate;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    ContactName;
}
export class FactFinderCodeResponse {
    /** @param {{ResponseStatus?:ResponseStatus,FactFinderCode?:FactFinderCode[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {FactFinderCode[]} */
    FactFinderCode = [];
}
export class AvailableFactFinderCodeRequest {
    /** @param {{AgentId?:number,StartCode?:number,EndCode?:number,TrackingNumber?:string,ShipDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {number} */
    StartCode;
    /** @type {number} */
    EndCode;
    /** @type {string} */
    TrackingNumber;
    /** @type {string} */
    ShipDate;
}

JavaScript AvailableFactFinderCodeRequest 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/AvailableFactFinderCode/{AgentId} 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
		}
	},
	FactFinderCode: 
	[
		{
			Id: 0,
			AgentId: 0,
			SerialNumber: 0,
			ShipDate: 0001-01-01,
			TrackingNumber: String,
			CreatedDate: 0001-01-01,
			ContactId: 0,
			AssignedDate: 0001-01-01,
			AgentName: String,
			ContactName: String
		}
	]
}