Platform API

AddContactRole

Add a custom role for the licensee

The following routes are available for this service:
POST	/api/roles

import 'package:servicestack/servicestack.dart';

class ListItemFilterModel implements IConvertible
{
    String? ListItemFilterId;
    String? FilterName;
    String? ListId;
    String? ListItemId;
    bool? ListItemIsInFilter;

    ListItemFilterModel({this.ListItemFilterId,this.FilterName,this.ListId,this.ListItemId,this.ListItemIsInFilter});
    ListItemFilterModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ListItemFilterId = json['ListItemFilterId'];
        FilterName = json['FilterName'];
        ListId = json['ListId'];
        ListItemId = json['ListItemId'];
        ListItemIsInFilter = json['ListItemIsInFilter'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ListItemFilterId': ListItemFilterId,
        'FilterName': FilterName,
        'ListId': ListId,
        'ListItemId': ListItemId,
        'ListItemIsInFilter': ListItemIsInFilter
    };

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

class RoleDetailsModel implements IConvertible
{
    /**
    * Role Id
    */
    // @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
    String? RoleId;

    /**
    * Role Name
    */
    // @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    String? RoleName;

    /**
    * Role Connection Definition Id
    */
    // @ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")
    String? RoleConnectionDefinitionId;

    /**
    * Contact Types the Role applies to
    */
    // @ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
    List<String>? ContactTypes;

    /**
    * Does the role require contacts to accept it?
    */
    // @ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")
    bool? RequireContactsToAccept;

    /**
    * Filters linked to the custom role.
    */
    // @ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")
    List<ListItemFilterModel>? ListItemFilters;

    RoleDetailsModel({this.RoleId,this.RoleName,this.RoleConnectionDefinitionId,this.ContactTypes,this.RequireContactsToAccept,this.ListItemFilters});
    RoleDetailsModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RoleId = json['RoleId'];
        RoleName = json['RoleName'];
        RoleConnectionDefinitionId = json['RoleConnectionDefinitionId'];
        ContactTypes = JsonConverters.fromJson(json['ContactTypes'],'List<String>',context!);
        RequireContactsToAccept = json['RequireContactsToAccept'];
        ListItemFilters = JsonConverters.fromJson(json['ListItemFilters'],'List<ListItemFilterModel>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RoleId': RoleId,
        'RoleName': RoleName,
        'RoleConnectionDefinitionId': RoleConnectionDefinitionId,
        'ContactTypes': JsonConverters.toJson(ContactTypes,'List<String>',context!),
        'RequireContactsToAccept': RequireContactsToAccept,
        'ListItemFilters': JsonConverters.toJson(ListItemFilters,'List<ListItemFilterModel>',context!)
    };

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

/**
* Add a custom role for the licensee
*/
// @Api(Description="Add a custom role for the licensee")
class AddContactRole implements IConvertible
{
    /**
    * Details of the Contact Role to be Added.
    */
    // @ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Added.", IsRequired=true, Name="RoleDetails", ParameterType="query")
    RoleDetailsModel? RoleDetails;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'ListItemFilterModel': TypeInfo(TypeOf.Class, create:() => ListItemFilterModel()),
    'RoleDetailsModel': TypeInfo(TypeOf.Class, create:() => RoleDetailsModel()),
    'List<ListItemFilterModel>': TypeInfo(TypeOf.Class, create:() => <ListItemFilterModel>[]),
    'AddContactRole': TypeInfo(TypeOf.Class, create:() => AddContactRole()),
});

Dart AddContactRole 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 /api/roles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddContactRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <RoleDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ContactTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </d2p1:ContactTypes>
    <d2p1:ListItemFilters>
      <d2p1:ListItemFilterModel>
        <d2p1:FilterName>String</d2p1:FilterName>
        <d2p1:ListId>00000000-0000-0000-0000-000000000000</d2p1:ListId>
        <d2p1:ListItemFilterId>00000000-0000-0000-0000-000000000000</d2p1:ListItemFilterId>
        <d2p1:ListItemId>00000000-0000-0000-0000-000000000000</d2p1:ListItemId>
        <d2p1:ListItemIsInFilter>false</d2p1:ListItemIsInFilter>
      </d2p1:ListItemFilterModel>
    </d2p1:ListItemFilters>
    <d2p1:RequireContactsToAccept>false</d2p1:RequireContactsToAccept>
    <d2p1:RoleConnectionDefinitionId>00000000-0000-0000-0000-000000000000</d2p1:RoleConnectionDefinitionId>
    <d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
    <d2p1:RoleName>String</d2p1:RoleName>
  </RoleDetails>
</AddContactRole>

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

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>