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 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class SheetPin implements IConvertible
{
    int? SheetPinID;
    int? SheetID;
    String? EntityType;
    int? EntityID;
    String? EntityUID;
    double? X;
    double? Y;
    String? Label;
    String? CreatedBy;
    DateTime? CreatedAt;
    String? EntityNo;
    String? EntityTitle;
    String? EntityStatus;
    String? InspectionUID;
    String? SheetNumber;
    String? SheetTitle;
    int? PlanSetID;
    String? PlanSetUID;
    String? PlanSetName;

    SheetPin({this.SheetPinID,this.SheetID,this.EntityType,this.EntityID,this.EntityUID,this.X,this.Y,this.Label,this.CreatedBy,this.CreatedAt,this.EntityNo,this.EntityTitle,this.EntityStatus,this.InspectionUID,this.SheetNumber,this.SheetTitle,this.PlanSetID,this.PlanSetUID,this.PlanSetName});
    SheetPin.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SheetPinID = json['SheetPinID'];
        SheetID = json['SheetID'];
        EntityType = json['EntityType'];
        EntityID = json['EntityID'];
        EntityUID = json['EntityUID'];
        X = JsonConverters.toDouble(json['X']);
        Y = JsonConverters.toDouble(json['Y']);
        Label = json['Label'];
        CreatedBy = json['CreatedBy'];
        CreatedAt = JsonConverters.fromJson(json['CreatedAt'],'DateTime',context!);
        EntityNo = json['EntityNo'];
        EntityTitle = json['EntityTitle'];
        EntityStatus = json['EntityStatus'];
        InspectionUID = json['InspectionUID'];
        SheetNumber = json['SheetNumber'];
        SheetTitle = json['SheetTitle'];
        PlanSetID = json['PlanSetID'];
        PlanSetUID = json['PlanSetUID'];
        PlanSetName = json['PlanSetName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SheetPinID': SheetPinID,
        'SheetID': SheetID,
        'EntityType': EntityType,
        'EntityID': EntityID,
        'EntityUID': EntityUID,
        'X': X,
        'Y': Y,
        'Label': Label,
        'CreatedBy': CreatedBy,
        'CreatedAt': JsonConverters.toJson(CreatedAt,'DateTime',context!),
        'EntityNo': EntityNo,
        'EntityTitle': EntityTitle,
        'EntityStatus': EntityStatus,
        'InspectionUID': InspectionUID,
        'SheetNumber': SheetNumber,
        'SheetTitle': SheetTitle,
        'PlanSetID': PlanSetID,
        'PlanSetUID': PlanSetUID,
        'PlanSetName': PlanSetName
    };

    getTypeName() => "SheetPin";
    TypeContext? context = _ctx;
}

class SheetPinListResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<SheetPin>? Pins = [];

    SheetPinListResponse({this.ResponseStatus,this.Pins});
    SheetPinListResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Pins = JsonConverters.fromJson(json['Pins'],'List<SheetPin>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Pins': JsonConverters.toJson(Pins,'List<SheetPin>',context!)
    };

    getTypeName() => "SheetPinListResponse";
    TypeContext? context = _ctx;
}

class PinsForEntityRequest implements IConvertible
{
    String? EntityType;
    int? EntityID;
    String? EntityUID;

    PinsForEntityRequest({this.EntityType,this.EntityID,this.EntityUID});
    PinsForEntityRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        EntityType = json['EntityType'];
        EntityID = json['EntityID'];
        EntityUID = json['EntityUID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'EntityType': EntityType,
        'EntityID': EntityID,
        'EntityUID': EntityUID
    };

    getTypeName() => "PinsForEntityRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'SheetPin': TypeInfo(TypeOf.Class, create:() => SheetPin()),
    'SheetPinListResponse': TypeInfo(TypeOf.Class, create:() => SheetPinListResponse()),
    'List<SheetPin>': TypeInfo(TypeOf.Class, create:() => <SheetPin>[]),
    'PinsForEntityRequest': TypeInfo(TypeOf.Class, create:() => PinsForEntityRequest()),
});

Dart 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>