Trendsic Platform Service

<back to all web services

AdditionalServiceListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/additionalservice
"use strict";
export class AdditionalServiceRequestPhoto {
    /** @param {{AdditionalServiceRequestPhotoID?:number,Url?:string,MimeType?:string,CreatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AdditionalServiceRequestPhotoID;
    /** @type {string} */
    Url;
    /** @type {string} */
    MimeType;
    /** @type {?string} */
    CreatedAt;
}
export class AdditionalServiceRequest {
    /** @param {{AdditionalServiceRequestID?:number,AdditionalServiceRequestUID?:string,TenantId?:string,BranchId?:string,BranchName?:string,ProjectID?:number,ProjectName?:string,ProjectUID?:string,JobID?:number,AgreementJobID?:number,RequestedByContactID?:number,RequestedByName?:string,CustomerContactID?:number,CustomerName?:string,CustomerEmail?:string,CustomerPhone?:string,CustomerSmsOptIn?:boolean,Description?:string,Status?:string,QuoteID?:number,QuoteUID?:string,QuoteStatus?:string,QuoteTotal?:number,FinalPriceAfterCompletion?:boolean,QuoteApprovedByName?:string,QuoteApprovedAt?:string,ConvertedJobID?:number,PhotoCount?:number,CreatedBy?:string,CreatedAt?:string,UpdatedBy?:string,UpdatedAt?:string,Photos?:AdditionalServiceRequestPhoto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AdditionalServiceRequestID;
    /** @type {string} */
    AdditionalServiceRequestUID;
    /** @type {string} */
    TenantId;
    /** @type {?string} */
    BranchId;
    /** @type {string} */
    BranchName;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    ProjectName;
    /** @type {?string} */
    ProjectUID;
    /** @type {?number} */
    JobID;
    /** @type {?number} */
    AgreementJobID;
    /** @type {?number} */
    RequestedByContactID;
    /** @type {string} */
    RequestedByName;
    /** @type {?number} */
    CustomerContactID;
    /** @type {string} */
    CustomerName;
    /** @type {string} */
    CustomerEmail;
    /** @type {string} */
    CustomerPhone;
    /** @type {boolean} */
    CustomerSmsOptIn;
    /** @type {string} */
    Description;
    /** @type {string} */
    Status;
    /** @type {?number} */
    QuoteID;
    /** @type {?string} */
    QuoteUID;
    /** @type {string} */
    QuoteStatus;
    /** @type {?number} */
    QuoteTotal;
    /** @type {boolean} */
    FinalPriceAfterCompletion;
    /** @type {string} */
    QuoteApprovedByName;
    /** @type {?string} */
    QuoteApprovedAt;
    /** @type {?number} */
    ConvertedJobID;
    /** @type {number} */
    PhotoCount;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {string} */
    UpdatedBy;
    /** @type {?string} */
    UpdatedAt;
    /** @type {AdditionalServiceRequestPhoto[]} */
    Photos = [];
}
export class AdditionalServiceListResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Requests?:AdditionalServiceRequest[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AdditionalServiceRequest[]} */
    Requests = [];
}
export class AdditionalServiceListRequest {
    /** @param {{Status?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Status;
}

JavaScript AdditionalServiceListRequest 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/additionalservice 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
		}
	},
	Requests: 
	[
		{
			AdditionalServiceRequestID: 0,
			AdditionalServiceRequestUID: 00000000000000000000000000000000,
			TenantId: 00000000000000000000000000000000,
			BranchId: 00000000000000000000000000000000,
			BranchName: String,
			ProjectID: 0,
			ProjectName: String,
			ProjectUID: 00000000000000000000000000000000,
			JobID: 0,
			AgreementJobID: 0,
			RequestedByContactID: 0,
			RequestedByName: String,
			CustomerContactID: 0,
			CustomerName: String,
			CustomerEmail: String,
			CustomerPhone: String,
			CustomerSmsOptIn: False,
			Description: String,
			Status: String,
			QuoteID: 0,
			QuoteUID: 00000000000000000000000000000000,
			QuoteStatus: String,
			QuoteTotal: 0,
			FinalPriceAfterCompletion: False,
			QuoteApprovedByName: String,
			QuoteApprovedAt: 0001-01-01,
			ConvertedJobID: 0,
			PhotoCount: 0,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedBy: String,
			UpdatedAt: 0001-01-01,
			Photos: 
			[
				{
					AdditionalServiceRequestPhotoID: 0,
					Url: String,
					MimeType: String,
					CreatedAt: 0001-01-01
				}
			]
		}
	]
}