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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AdditionalServiceListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Requests>
    <AdditionalServiceRequest>
      <AdditionalServiceRequestID>0</AdditionalServiceRequestID>
      <AdditionalServiceRequestUID>00000000-0000-0000-0000-000000000000</AdditionalServiceRequestUID>
      <AgreementJobID>0</AgreementJobID>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <BranchName>String</BranchName>
      <ConvertedJobID>0</ConvertedJobID>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <CustomerContactID>0</CustomerContactID>
      <CustomerEmail>String</CustomerEmail>
      <CustomerName>String</CustomerName>
      <CustomerPhone>String</CustomerPhone>
      <CustomerSmsOptIn>false</CustomerSmsOptIn>
      <Description>String</Description>
      <FinalPriceAfterCompletion>false</FinalPriceAfterCompletion>
      <JobID>0</JobID>
      <PhotoCount>0</PhotoCount>
      <Photos>
        <AdditionalServiceRequestPhoto>
          <AdditionalServiceRequestPhotoID>0</AdditionalServiceRequestPhotoID>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <MimeType>String</MimeType>
          <Url>String</Url>
        </AdditionalServiceRequestPhoto>
      </Photos>
      <ProjectID>0</ProjectID>
      <ProjectName>String</ProjectName>
      <ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
      <QuoteApprovedAt>0001-01-01T00:00:00</QuoteApprovedAt>
      <QuoteApprovedByName>String</QuoteApprovedByName>
      <QuoteID>0</QuoteID>
      <QuoteStatus>String</QuoteStatus>
      <QuoteTotal>0</QuoteTotal>
      <QuoteUID>00000000-0000-0000-0000-000000000000</QuoteUID>
      <RequestedByContactID>0</RequestedByContactID>
      <RequestedByName>String</RequestedByName>
      <Status>String</Status>
      <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <UpdatedBy>String</UpdatedBy>
    </AdditionalServiceRequest>
  </Requests>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AdditionalServiceListResponse>