Trendsic Platform Service

<back to all web services

PinsForEntityRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pins/{EntityType}/{EntityID}
GET,OPTIONS/v1/pins/{EntityType}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class PinsForEntityRequest
    {
        public String EntityType = null;
        public Integer EntityID = null;
        public UUID EntityUID = null;
        
        public String getEntityType() { return EntityType; }
        public PinsForEntityRequest setEntityType(String value) { this.EntityType = value; return this; }
        public Integer getEntityID() { return EntityID; }
        public PinsForEntityRequest setEntityID(Integer value) { this.EntityID = value; return this; }
        public UUID getEntityUID() { return EntityUID; }
        public PinsForEntityRequest setEntityUID(UUID value) { this.EntityUID = value; return this; }
    }

    public static class SheetPinListResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<SheetPin> Pins = new ArrayList<SheetPin>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public SheetPinListResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<SheetPin> getPins() { return Pins; }
        public SheetPinListResponse setPins(ArrayList<SheetPin> value) { this.Pins = value; return this; }
    }

    public static class SheetPin
    {
        public Integer SheetPinID = null;
        public Integer SheetID = null;
        public String EntityType = null;
        public Integer EntityID = null;
        public UUID EntityUID = null;
        public Double X = null;
        public Double Y = null;
        public String Label = null;
        public String CreatedBy = null;
        public Date CreatedAt = null;
        public String EntityNo = null;
        public String EntityTitle = null;
        public String EntityStatus = null;
        public UUID InspectionUID = null;
        public String SheetNumber = null;
        public String SheetTitle = null;
        public Integer PlanSetID = null;
        public UUID PlanSetUID = null;
        public String PlanSetName = null;
        
        public Integer getSheetPinID() { return SheetPinID; }
        public SheetPin setSheetPinID(Integer value) { this.SheetPinID = value; return this; }
        public Integer getSheetID() { return SheetID; }
        public SheetPin setSheetID(Integer value) { this.SheetID = value; return this; }
        public String getEntityType() { return EntityType; }
        public SheetPin setEntityType(String value) { this.EntityType = value; return this; }
        public Integer getEntityID() { return EntityID; }
        public SheetPin setEntityID(Integer value) { this.EntityID = value; return this; }
        public UUID getEntityUID() { return EntityUID; }
        public SheetPin setEntityUID(UUID value) { this.EntityUID = value; return this; }
        public Double getX() { return X; }
        public SheetPin setX(Double value) { this.X = value; return this; }
        public Double getY() { return Y; }
        public SheetPin setY(Double value) { this.Y = value; return this; }
        public String getLabel() { return Label; }
        public SheetPin setLabel(String value) { this.Label = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public SheetPin setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public SheetPin setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public String getEntityNo() { return EntityNo; }
        public SheetPin setEntityNo(String value) { this.EntityNo = value; return this; }
        public String getEntityTitle() { return EntityTitle; }
        public SheetPin setEntityTitle(String value) { this.EntityTitle = value; return this; }
        public String getEntityStatus() { return EntityStatus; }
        public SheetPin setEntityStatus(String value) { this.EntityStatus = value; return this; }
        public UUID getInspectionUID() { return InspectionUID; }
        public SheetPin setInspectionUID(UUID value) { this.InspectionUID = value; return this; }
        public String getSheetNumber() { return SheetNumber; }
        public SheetPin setSheetNumber(String value) { this.SheetNumber = value; return this; }
        public String getSheetTitle() { return SheetTitle; }
        public SheetPin setSheetTitle(String value) { this.SheetTitle = value; return this; }
        public Integer getPlanSetID() { return PlanSetID; }
        public SheetPin setPlanSetID(Integer value) { this.PlanSetID = value; return this; }
        public UUID getPlanSetUID() { return PlanSetUID; }
        public SheetPin setPlanSetUID(UUID value) { this.PlanSetUID = value; return this; }
        public String getPlanSetName() { return PlanSetName; }
        public SheetPin setPlanSetName(String value) { this.PlanSetName = value; return this; }
    }

}

Java PinsForEntityRequest 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/pins/{EntityType}/{EntityID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SheetPinListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Pins>
    <SheetPin>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <EntityID>0</EntityID>
      <EntityNo>String</EntityNo>
      <EntityStatus>String</EntityStatus>
      <EntityTitle>String</EntityTitle>
      <EntityType>String</EntityType>
      <EntityUID>00000000-0000-0000-0000-000000000000</EntityUID>
      <InspectionUID>00000000-0000-0000-0000-000000000000</InspectionUID>
      <Label>String</Label>
      <PlanSetID>0</PlanSetID>
      <PlanSetName>String</PlanSetName>
      <PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
      <SheetID>0</SheetID>
      <SheetNumber>String</SheetNumber>
      <SheetPinID>0</SheetPinID>
      <SheetTitle>String</SheetTitle>
      <X>0</X>
      <Y>0</Y>
    </SheetPin>
  </Pins>
  <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>
</SheetPinListResponse>