Trendsic Platform Service

<back to all web services

CustomerCheckinPauseRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/customercheckins/{Id}/pause
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CustomerCheckinPauseRequest
    {
        public UUID Id = null;
        public String Reason = null;
        public Integer ExpectedMinutes = null;
        
        public UUID getId() { return Id; }
        public CustomerCheckinPauseRequest setId(UUID value) { this.Id = value; return this; }
        public String getReason() { return Reason; }
        public CustomerCheckinPauseRequest setReason(String value) { this.Reason = value; return this; }
        public Integer getExpectedMinutes() { return ExpectedMinutes; }
        public CustomerCheckinPauseRequest setExpectedMinutes(Integer value) { this.ExpectedMinutes = value; return this; }
    }

    public static class CustomerCheckinOpResponse
    {
        public ResponseStatus ResponseStatus = null;
        public String FromLine = null;
        public String ToLine = null;
        public Integer Status = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CustomerCheckinOpResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public String getFromLine() { return FromLine; }
        public CustomerCheckinOpResponse setFromLine(String value) { this.FromLine = value; return this; }
        public String getToLine() { return ToLine; }
        public CustomerCheckinOpResponse setToLine(String value) { this.ToLine = value; return this; }
        public Integer getStatus() { return Status; }
        public CustomerCheckinOpResponse setStatus(Integer value) { this.Status = value; return this; }
    }

}

Java CustomerCheckinPauseRequest 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/customercheckins/{Id}/pause HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomerCheckinPauseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ExpectedMinutes>0</ExpectedMinutes>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Reason>String</Reason>
</CustomerCheckinPauseRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerCheckinOpResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FromLine>String</FromLine>
  <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>
  <Status>0</Status>
  <ToLine>String</ToLine>
</CustomerCheckinOpResponse>