Trendsic Platform Service

<back to all web services

InspectionRequestRequest

Requires Authentication
The following routes are available for this service:
GET,POST,OPTIONS/v1/inspections/{InspectionUID}/requests
"use strict";
export class InspectionRequest {
    /** @param {{InspectionRequestID?:number,InspectionID?:number,Agency?:string,ContactName?:string,ContactPhone?:string,PermitNo?:string,RequestedDate?:string,RequestedWindow?:string,Status?:string,ConfirmationNo?:string,Outcome?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    InspectionRequestID;
    /** @type {number} */
    InspectionID;
    /** @type {string} */
    Agency;
    /** @type {string} */
    ContactName;
    /** @type {string} */
    ContactPhone;
    /** @type {string} */
    PermitNo;
    /** @type {?string} */
    RequestedDate;
    /** @type {string} */
    RequestedWindow;
    /** @type {string} */
    Status;
    /** @type {string} */
    ConfirmationNo;
    /** @type {string} */
    Outcome;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class InspectionRequestsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Requests?:InspectionRequest[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {InspectionRequest[]} */
    Requests = [];
}
export class InspectionRequestRequest {
    /** @param {{InspectionUID?:string,Agency?:string,ContactName?:string,ContactPhone?:string,PermitNo?:string,RequestedDate?:string,RequestedWindow?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    InspectionUID;
    /** @type {string} */
    Agency;
    /** @type {string} */
    ContactName;
    /** @type {string} */
    ContactPhone;
    /** @type {string} */
    PermitNo;
    /** @type {?string} */
    RequestedDate;
    /** @type {string} */
    RequestedWindow;
}

JavaScript InspectionRequestRequest 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.

POST /v1/inspections/{InspectionUID}/requests HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InspectionRequestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Agency>String</Agency>
  <ContactName>String</ContactName>
  <ContactPhone>String</ContactPhone>
  <InspectionUID>00000000-0000-0000-0000-000000000000</InspectionUID>
  <PermitNo>String</PermitNo>
  <RequestedDate>0001-01-01T00:00:00</RequestedDate>
  <RequestedWindow>String</RequestedWindow>
</InspectionRequestRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InspectionRequestsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Requests>
    <InspectionRequest>
      <Agency>String</Agency>
      <ConfirmationNo>String</ConfirmationNo>
      <ContactName>String</ContactName>
      <ContactPhone>String</ContactPhone>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <InspectionID>0</InspectionID>
      <InspectionRequestID>0</InspectionRequestID>
      <Outcome>String</Outcome>
      <PermitNo>String</PermitNo>
      <RequestedDate>0001-01-01T00:00:00</RequestedDate>
      <RequestedWindow>String</RequestedWindow>
      <Status>String</Status>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </InspectionRequest>
  </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>
</InspectionRequestsResponse>