Platform API

ConnectionStatusUpdate

Update the status of the specified connection

The following routes are available for this service:
All Verbs	/api/connections/{ConnectionId}/cancel
All Verbs	/api/connections/{ConnectionId}/remove

import 'package:servicestack/servicestack.dart';

class ConnectionStatusUpdateResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;

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

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

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

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

/**
* Update the status of the specified connection
*/
// @Api(Description="Update the status of the specified connection")
class ConnectionStatusUpdate implements IConvertible
{
    /**
    * Connection to be updated
    */
    // @ApiMember(Description="Connection to be updated", IsRequired=true, Name="ConnectionId")
    String? ConnectionId;

    /**
    * Id of the contact linked to the connection
    */
    // @ApiMember(Description="Id of the contact linked to the connection", IsRequired=true, Name="ContactId")
    String? ContactId;

    /**
    * Type of contact being connected with. For e.g. Real Person, Virtual Person etc.
    */
    // @ApiMember(DataType="Guid", Description="Type of contact being connected with. For e.g. Real Person, Virtual Person etc.", IsRequired=true, Name="ContactTypeId")
    String? ContactTypeId;

    /**
    * Role Id linked to the connection request
    */
    // @ApiMember(Description="Role Id linked to the connection request", IsRequired=true, Name="RoleId")
    String? RoleId;

    ConnectionStatusUpdate({this.ConnectionId,this.ContactId,this.ContactTypeId,this.RoleId});
    ConnectionStatusUpdate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ConnectionId = json['ConnectionId'];
        ContactId = json['ContactId'];
        ContactTypeId = json['ContactTypeId'];
        RoleId = json['RoleId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ConnectionId': ConnectionId,
        'ContactId': ContactId,
        'ContactTypeId': ContactTypeId,
        'RoleId': RoleId
    };

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'ConnectionStatusUpdateResponse': TypeInfo(TypeOf.Class, create:() => ConnectionStatusUpdateResponse()),
    'ConnectionStatusUpdate': TypeInfo(TypeOf.Class, create:() => ConnectionStatusUpdate()),
});

Dart ConnectionStatusUpdate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/connections/{ConnectionId}/cancel HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ConnectionId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000-0000-0000-0000-000000000000","ContactTypeId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000"}

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}