Trendsic Platform Service

<back to all web services

VisitBumpRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/visits/bump
"use strict";
export class VisitActionResponse {
    /** @param {{Success?:boolean,Message?:string,Affected?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Success;
    /** @type {string} */
    Message;
    /** @type {number} */
    Affected;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class VisitBumpRequest {
    /** @param {{JobID?:number,ProjectID?:number,CrewID?:number,Date?:string,AgreementJobID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    JobID;
    /** @type {number} */
    ProjectID;
    /** @type {?number} */
    CrewID;
    /** @type {string} */
    Date;
    /** @type {?number} */
    AgreementJobID;
}

JavaScript VisitBumpRequest 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/visits/bump HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<VisitBumpRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgreementJobID>0</AgreementJobID>
  <CrewID>0</CrewID>
  <Date>String</Date>
  <JobID>0</JobID>
  <ProjectID>0</ProjectID>
</VisitBumpRequest>

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

<VisitActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Affected>0</Affected>
  <Message>String</Message>
  <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>
  <Success>false</Success>
</VisitActionResponse>