Trendsic Platform Service

<back to all web services

KioskHelpRequest

The following routes are available for this service:
POST,OPTIONS/v1/kiosk/help
import 'package:servicestack/servicestack.dart';

class KioskHelpResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    bool? Sent;

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

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

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

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

class KioskHelpRequest implements IConvertible
{
    String? ApiKey;
    String? LocationId;

    KioskHelpRequest({this.ApiKey,this.LocationId});
    KioskHelpRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApiKey = json['ApiKey'];
        LocationId = json['LocationId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApiKey': ApiKey,
        'LocationId': LocationId
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'KioskHelpResponse': TypeInfo(TypeOf.Class, create:() => KioskHelpResponse()),
    'KioskHelpRequest': TypeInfo(TypeOf.Class, create:() => KioskHelpRequest()),
});

Dart KioskHelpRequest 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/kiosk/help HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<KioskHelpResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Sent>false</Sent>
</KioskHelpResponse>