Trendsic Platform Service

<back to all web services

GetInspectionReport

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/InspectionReport/{AgentUID}/{ContactUID}/
"use strict";
export class Employee {
    /** @param {{FirstName?:string,MiddleName?:string,LastName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FirstName;
    /** @type {string} */
    MiddleName;
    /** @type {string} */
    LastName;
}
export class InspectionReport {
    /** @param {{AgentUID?:string,ContactUID?:string,InspectionReportUID?:string,TradeName?:string,BusinessPhone?:string,StreetAddress?:string,ZipCode?:string,OwnersName?:string,ComplianceStatus?:number,IsBusinessClassABeer?:boolean,IsBusinessClassBBeer?:boolean,IsBusinessClassALiquor?:boolean,IsBusinessClassBLiquor?:boolean,IsBusinessClassD?:boolean,IsBusinessClassM?:boolean,IsBusinessClassP?:boolean,IsBusinessClassR?:boolean,IsBusinessClassRAH?:boolean,ClassBeerAccountNum?:string,ClassBeerStateNum?:string,ClassLiquorAccountNum?:string,ClassLiquorStateNum?:string,LicensedEmployees?:Employee[],AgentName?:string,ManagerSignature?:Object,ManagerName?:string,ManagerPhone?:string,InspectionDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AgentUID;
    /** @type {string} */
    ContactUID;
    /** @type {string} */
    InspectionReportUID;
    /** @type {string} */
    TradeName;
    /** @type {string} */
    BusinessPhone;
    /** @type {string} */
    StreetAddress;
    /** @type {string} */
    ZipCode;
    /** @type {string} */
    OwnersName;
    /** @type {number} */
    ComplianceStatus;
    /** @type {boolean} */
    IsBusinessClassABeer;
    /** @type {boolean} */
    IsBusinessClassBBeer;
    /** @type {boolean} */
    IsBusinessClassALiquor;
    /** @type {boolean} */
    IsBusinessClassBLiquor;
    /** @type {boolean} */
    IsBusinessClassD;
    /** @type {boolean} */
    IsBusinessClassM;
    /** @type {boolean} */
    IsBusinessClassP;
    /** @type {boolean} */
    IsBusinessClassR;
    /** @type {boolean} */
    IsBusinessClassRAH;
    /** @type {string} */
    ClassBeerAccountNum;
    /** @type {string} */
    ClassBeerStateNum;
    /** @type {string} */
    ClassLiquorAccountNum;
    /** @type {string} */
    ClassLiquorStateNum;
    /** @type {Employee[]} */
    LicensedEmployees = [];
    /** @type {string} */
    AgentName;
    /** @type {Object} */
    ManagerSignature;
    /** @type {string} */
    ManagerName;
    /** @type {string} */
    ManagerPhone;
    /** @type {string} */
    InspectionDate;
}
export class GetInspectionReportResponse {
    /** @param {{Result?:InspectionReport[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {InspectionReport[]} */
    Result = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetInspectionReport {
    /** @param {{AgentUID?:string,ContactUID?:string,InspectionReportUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AgentUID;
    /** @type {string} */
    ContactUID;
    /** @type {string} */
    InspectionReportUID;
}

JavaScript GetInspectionReport 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/InspectionReport/{AgentUID}/{ContactUID}/ HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<GetInspectionReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Result>
    <InspectionReport>
      <AgentName>String</AgentName>
      <AgentUID>00000000-0000-0000-0000-000000000000</AgentUID>
      <BusinessPhone>String</BusinessPhone>
      <ClassBeerAccountNum>String</ClassBeerAccountNum>
      <ClassBeerStateNum>String</ClassBeerStateNum>
      <ClassLiquorAccountNum>String</ClassLiquorAccountNum>
      <ClassLiquorStateNum>String</ClassLiquorStateNum>
      <ComplianceStatus>0</ComplianceStatus>
      <ContactUID>00000000-0000-0000-0000-000000000000</ContactUID>
      <InspectionDate>0001-01-01T00:00:00</InspectionDate>
      <InspectionReportUID>00000000-0000-0000-0000-000000000000</InspectionReportUID>
      <IsBusinessClassABeer>false</IsBusinessClassABeer>
      <IsBusinessClassALiquor>false</IsBusinessClassALiquor>
      <IsBusinessClassBBeer>false</IsBusinessClassBBeer>
      <IsBusinessClassBLiquor>false</IsBusinessClassBLiquor>
      <IsBusinessClassD>false</IsBusinessClassD>
      <IsBusinessClassM>false</IsBusinessClassM>
      <IsBusinessClassP>false</IsBusinessClassP>
      <IsBusinessClassR>false</IsBusinessClassR>
      <IsBusinessClassRAH>false</IsBusinessClassRAH>
      <LicensedEmployees>
        <Employee>
          <FirstName>String</FirstName>
          <IsOnDuty>false</IsOnDuty>
          <LastName>String</LastName>
          <LicenseExpirationDate>0001-01-01T00:00:00</LicenseExpirationDate>
          <LicenseNumber>String</LicenseNumber>
          <LicenseTypeCode>0</LicenseTypeCode>
          <MiddleName>String</MiddleName>
        </Employee>
      </LicensedEmployees>
      <ManagerName>String</ManagerName>
      <ManagerPhone>String</ManagerPhone>
      <ManagerSignature />
      <OwnersName>String</OwnersName>
      <StreetAddress>String</StreetAddress>
      <TradeName>String</TradeName>
      <ZipCode>String</ZipCode>
    </InspectionReport>
  </Result>
</GetInspectionReportResponse>