Platform API

<back to all web services

ConnectionStatusUpdate

Update the status of the specified connection

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

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

<ConnectionStatusUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ConnectionId>00000000-0000-0000-0000-000000000000</ConnectionId>
  <ContactId>00000000-0000-0000-0000-000000000000</ContactId>
  <ContactTypeId>00000000-0000-0000-0000-000000000000</ContactTypeId>
  <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
</ConnectionStatusUpdate>

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

<ConnectionStatusUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <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>
</ConnectionStatusUpdateResponse>