| POST,OPTIONS | /v1/documentshare |
|---|
import 'package:servicestack/servicestack.dart';
class DocumentShare implements IConvertible
{
int? DocumentShareId;
String? DocumentShareUID;
String? TokenHash;
String? AttachmentId;
String? SensitivityTier;
bool? RequireOtp;
String? OtpChannel;
String? DeliveryChannels;
int? RecipientContactId;
String? RecipientEmail;
String? RecipientPhone;
bool? SmsConsentSnapshot;
String? CreatedByUserId;
int? CreatedByAgentId;
DateTime? CreatedAtUtc;
DateTime? ExpiresAtUtc;
int? MaxViews;
int? ViewCount;
DateTime? RevokedAtUtc;
String? RevokedByUserId;
DocumentShare({this.DocumentShareId,this.DocumentShareUID,this.TokenHash,this.AttachmentId,this.SensitivityTier,this.RequireOtp,this.OtpChannel,this.DeliveryChannels,this.RecipientContactId,this.RecipientEmail,this.RecipientPhone,this.SmsConsentSnapshot,this.CreatedByUserId,this.CreatedByAgentId,this.CreatedAtUtc,this.ExpiresAtUtc,this.MaxViews,this.ViewCount,this.RevokedAtUtc,this.RevokedByUserId});
DocumentShare.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
DocumentShareId = json['DocumentShareId'];
DocumentShareUID = json['DocumentShareUID'];
TokenHash = json['TokenHash'];
AttachmentId = json['AttachmentId'];
SensitivityTier = json['SensitivityTier'];
RequireOtp = json['RequireOtp'];
OtpChannel = json['OtpChannel'];
DeliveryChannels = json['DeliveryChannels'];
RecipientContactId = json['RecipientContactId'];
RecipientEmail = json['RecipientEmail'];
RecipientPhone = json['RecipientPhone'];
SmsConsentSnapshot = json['SmsConsentSnapshot'];
CreatedByUserId = json['CreatedByUserId'];
CreatedByAgentId = json['CreatedByAgentId'];
CreatedAtUtc = JsonConverters.fromJson(json['CreatedAtUtc'],'DateTime',context!);
ExpiresAtUtc = JsonConverters.fromJson(json['ExpiresAtUtc'],'DateTime',context!);
MaxViews = json['MaxViews'];
ViewCount = json['ViewCount'];
RevokedAtUtc = JsonConverters.fromJson(json['RevokedAtUtc'],'DateTime',context!);
RevokedByUserId = json['RevokedByUserId'];
return this;
}
Map<String, dynamic> toJson() => {
'DocumentShareId': DocumentShareId,
'DocumentShareUID': DocumentShareUID,
'TokenHash': TokenHash,
'AttachmentId': AttachmentId,
'SensitivityTier': SensitivityTier,
'RequireOtp': RequireOtp,
'OtpChannel': OtpChannel,
'DeliveryChannels': DeliveryChannels,
'RecipientContactId': RecipientContactId,
'RecipientEmail': RecipientEmail,
'RecipientPhone': RecipientPhone,
'SmsConsentSnapshot': SmsConsentSnapshot,
'CreatedByUserId': CreatedByUserId,
'CreatedByAgentId': CreatedByAgentId,
'CreatedAtUtc': JsonConverters.toJson(CreatedAtUtc,'DateTime',context!),
'ExpiresAtUtc': JsonConverters.toJson(ExpiresAtUtc,'DateTime',context!),
'MaxViews': MaxViews,
'ViewCount': ViewCount,
'RevokedAtUtc': JsonConverters.toJson(RevokedAtUtc,'DateTime',context!),
'RevokedByUserId': RevokedByUserId
};
getTypeName() => "DocumentShare";
TypeContext? context = _ctx;
}
class DocumentShareExtended extends DocumentShare implements IConvertible
{
String? AttachmentName;
String? RecipientDisplayName;
String? RecipientType;
String? CreatedByName;
String? Status;
DocumentShareExtended({this.AttachmentName,this.RecipientDisplayName,this.RecipientType,this.CreatedByName,this.Status});
DocumentShareExtended.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
AttachmentName = json['AttachmentName'];
RecipientDisplayName = json['RecipientDisplayName'];
RecipientType = json['RecipientType'];
CreatedByName = json['CreatedByName'];
Status = json['Status'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'AttachmentName': AttachmentName,
'RecipientDisplayName': RecipientDisplayName,
'RecipientType': RecipientType,
'CreatedByName': CreatedByName,
'Status': Status
});
getTypeName() => "DocumentShareExtended";
TypeContext? context = _ctx;
}
class DocumentShareResponse implements IConvertible
{
ResponseStatus? ResponseStatus;
List<DocumentShareExtended>? DocumentShare = [];
String? ShareUrl;
DocumentShareResponse({this.ResponseStatus,this.DocumentShare,this.ShareUrl});
DocumentShareResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
DocumentShare = JsonConverters.fromJson(json['DocumentShare'],'List<DocumentShareExtended>',context!);
ShareUrl = json['ShareUrl'];
return this;
}
Map<String, dynamic> toJson() => {
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
'DocumentShare': JsonConverters.toJson(DocumentShare,'List<DocumentShareExtended>',context!),
'ShareUrl': ShareUrl
};
getTypeName() => "DocumentShareResponse";
TypeContext? context = _ctx;
}
class DocumentShareCreateRequest implements IConvertible
{
String? AttachmentId;
int? RecipientContactId;
String? RecipientEmail;
String? RecipientPhone;
bool? IsAdhoc;
String? SensitivityTier;
bool? RequireOtp;
String? OtpChannel;
String? DeliveryChannels;
int? ExpiresInHours;
int? MaxViews;
DocumentShareCreateRequest({this.AttachmentId,this.RecipientContactId,this.RecipientEmail,this.RecipientPhone,this.IsAdhoc,this.SensitivityTier,this.RequireOtp,this.OtpChannel,this.DeliveryChannels,this.ExpiresInHours,this.MaxViews});
DocumentShareCreateRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
AttachmentId = json['AttachmentId'];
RecipientContactId = json['RecipientContactId'];
RecipientEmail = json['RecipientEmail'];
RecipientPhone = json['RecipientPhone'];
IsAdhoc = json['IsAdhoc'];
SensitivityTier = json['SensitivityTier'];
RequireOtp = json['RequireOtp'];
OtpChannel = json['OtpChannel'];
DeliveryChannels = json['DeliveryChannels'];
ExpiresInHours = json['ExpiresInHours'];
MaxViews = json['MaxViews'];
return this;
}
Map<String, dynamic> toJson() => {
'AttachmentId': AttachmentId,
'RecipientContactId': RecipientContactId,
'RecipientEmail': RecipientEmail,
'RecipientPhone': RecipientPhone,
'IsAdhoc': IsAdhoc,
'SensitivityTier': SensitivityTier,
'RequireOtp': RequireOtp,
'OtpChannel': OtpChannel,
'DeliveryChannels': DeliveryChannels,
'ExpiresInHours': ExpiresInHours,
'MaxViews': MaxViews
};
getTypeName() => "DocumentShareCreateRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
'DocumentShare': TypeInfo(TypeOf.Class, create:() => DocumentShare()),
'DocumentShareExtended': TypeInfo(TypeOf.Class, create:() => DocumentShareExtended()),
'DocumentShareResponse': TypeInfo(TypeOf.Class, create:() => DocumentShareResponse()),
'List<DocumentShareExtended>': TypeInfo(TypeOf.Class, create:() => <DocumentShareExtended>[]),
'DocumentShareCreateRequest': TypeInfo(TypeOf.Class, create:() => DocumentShareCreateRequest()),
});
Dart DocumentShareCreateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/documentshare HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<DocumentShareCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<DeliveryChannels>String</DeliveryChannels>
<ExpiresInHours>0</ExpiresInHours>
<IsAdhoc>false</IsAdhoc>
<MaxViews>0</MaxViews>
<OtpChannel>String</OtpChannel>
<RecipientContactId>0</RecipientContactId>
<RecipientEmail>String</RecipientEmail>
<RecipientPhone>String</RecipientPhone>
<RequireOtp>false</RequireOtp>
<SensitivityTier>String</SensitivityTier>
</DocumentShareCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DocumentShareResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<DocumentShare>
<DocumentShareExtended>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<CreatedAtUtc>0001-01-01T00:00:00</CreatedAtUtc>
<CreatedByAgentId>0</CreatedByAgentId>
<CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
<DeliveryChannels>String</DeliveryChannels>
<DocumentShareId>0</DocumentShareId>
<DocumentShareUID>00000000-0000-0000-0000-000000000000</DocumentShareUID>
<ExpiresAtUtc>0001-01-01T00:00:00</ExpiresAtUtc>
<MaxViews>0</MaxViews>
<OtpChannel>String</OtpChannel>
<RecipientContactId>0</RecipientContactId>
<RecipientEmail>String</RecipientEmail>
<RecipientPhone>String</RecipientPhone>
<RequireOtp>false</RequireOtp>
<RevokedAtUtc>0001-01-01T00:00:00</RevokedAtUtc>
<RevokedByUserId>00000000-0000-0000-0000-000000000000</RevokedByUserId>
<SensitivityTier>String</SensitivityTier>
<SmsConsentSnapshot>false</SmsConsentSnapshot>
<TokenHash>String</TokenHash>
<ViewCount>0</ViewCount>
<AttachmentName>String</AttachmentName>
<CreatedByName>String</CreatedByName>
<RecipientDisplayName>String</RecipientDisplayName>
<RecipientType>String</RecipientType>
<Status>String</Status>
</DocumentShareExtended>
</DocumentShare>
<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>
<ShareUrl>String</ShareUrl>
</DocumentShareResponse>