| All Verbs | /Accounts |
|---|
import 'package:servicestack/servicestack.dart';
// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
class PagingMetadata implements IConvertible
{
/**
* Starting Record
*/
// @DataMember
// @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
String? Offset;
/**
* Number of records to return (PageSize)
*/
// @DataMember
// @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
String? Limit;
/**
* Total Number of Records in a Full Reponse (if no paging)
*/
// @DataMember
// @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
int? TotalRecords;
/**
* Total Number of Records in this Reponse (on this page)
*/
// @DataMember
// @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
int? ResponseRecords;
PagingMetadata({this.Offset,this.Limit,this.TotalRecords,this.ResponseRecords});
PagingMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Offset = json['Offset'];
Limit = json['Limit'];
TotalRecords = json['TotalRecords'];
ResponseRecords = json['ResponseRecords'];
return this;
}
Map<String, dynamic> toJson() => {
'Offset': Offset,
'Limit': Limit,
'TotalRecords': TotalRecords,
'ResponseRecords': ResponseRecords
};
getTypeName() => "PagingMetadata";
TypeContext? context = _ctx;
}
// @DataContract(Namespace="schemas.agentivity.com/types")
abstract class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
/**
* Comma Delimited List of Owning Company Codes
*/
// @DataMember
List<String>? OwningCompanyCode;
/**
* UserName in form of an email address
*/
// @DataMember
String? UserName;
CompanyLevelRequestBase({this.OwningCompanyCode,this.UserName});
CompanyLevelRequestBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
OwningCompanyCode = JsonConverters.fromJson(json['OwningCompanyCode'],'List<String>',context!);
UserName = json['UserName'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'OwningCompanyCode': JsonConverters.toJson(OwningCompanyCode,'List<String>',context!),
'UserName': UserName
});
getTypeName() => "CompanyLevelRequestBase";
TypeContext? context = _ctx;
}
// @DataContract(Name="OwningAgencyLocation", Namespace="schemas.agentivity.com/types")
class AgencyAccountOwningAgencyLocation implements IConvertible
{
// @DataMember(Order=10)
String? ID;
// @DataMember(Order=20)
DateTime? LastMatchedDate;
AgencyAccountOwningAgencyLocation({this.ID,this.LastMatchedDate});
AgencyAccountOwningAgencyLocation.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ID = json['ID'];
LastMatchedDate = JsonConverters.fromJson(json['LastMatchedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ID': ID,
'LastMatchedDate': JsonConverters.toJson(LastMatchedDate,'DateTime',context!)
};
getTypeName() => "AgencyAccountOwningAgencyLocation";
TypeContext? context = _ctx;
}
// @DataContract(Name="AgencyAccount", Namespace="schemas.agentivity.com/types")
class AgencyAccount implements IConvertible
{
// @DataMember(Order=10)
String? ID;
// @DataMember(Order=20)
String? Name;
// @DataMember(Order=30)
String? Manager;
// @DataMember(Order=40)
DateTime? CreationDateTime;
// @DataMember(Order=50)
List<AgencyAccountOwningAgencyLocation>? OwningAgencyLocations;
// @DataMember(Order=60)
int? CompanyId;
// @DataMember(Order=70)
DateTime? LastMatchedDate;
AgencyAccount({this.ID,this.Name,this.Manager,this.CreationDateTime,this.OwningAgencyLocations,this.CompanyId,this.LastMatchedDate});
AgencyAccount.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ID = json['ID'];
Name = json['Name'];
Manager = json['Manager'];
CreationDateTime = JsonConverters.fromJson(json['CreationDateTime'],'DateTime',context!);
OwningAgencyLocations = JsonConverters.fromJson(json['OwningAgencyLocations'],'List<AgencyAccountOwningAgencyLocation>',context!);
CompanyId = json['CompanyId'];
LastMatchedDate = JsonConverters.fromJson(json['LastMatchedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ID': ID,
'Name': Name,
'Manager': Manager,
'CreationDateTime': JsonConverters.toJson(CreationDateTime,'DateTime',context!),
'OwningAgencyLocations': JsonConverters.toJson(OwningAgencyLocations,'List<AgencyAccountOwningAgencyLocation>',context!),
'CompanyId': CompanyId,
'LastMatchedDate': JsonConverters.toJson(LastMatchedDate,'DateTime',context!)
};
getTypeName() => "AgencyAccount";
TypeContext? context = _ctx;
}
// @DataContract(Namespace="schemas.agentivity.com/types")
class Report<TItemResponse,TItem> implements IConvertible
{
// @DataMember(Order=1, EmitDefaultValue=false)
TItem? Item;
Report({this.Item});
Report.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Item = JsonConverters.fromJson(json['Item'],'TItem',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Item': JsonConverters.toJson(Item,'TItem',context!)
};
getTypeName() => "Report<$TItemResponse,$TItem>";
TypeContext? context = _ctx;
}
// @DataContract(Name="AgencyAccount", Namespace="schemas.agentivity.com/types")
class GetAccountsResponseReport extends Report<GetAccountsItemResponse,AgencyAccount> implements IConvertible
{
GetAccountsResponseReport();
GetAccountsResponseReport.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "GetAccountsResponseReport";
TypeContext? context = _ctx;
}
// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
class CacheMetadata implements IConvertible
{
// @DataMember(Order=1)
DateTime? CachedAt;
// @DataMember(Order=2)
DateTime? CacheExpiresAt;
// @DataMember(Order=0)
bool? IsFromCache;
CacheMetadata({this.CachedAt,this.CacheExpiresAt,this.IsFromCache});
CacheMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CachedAt = JsonConverters.fromJson(json['CachedAt'],'DateTime',context!);
CacheExpiresAt = JsonConverters.fromJson(json['CacheExpiresAt'],'DateTime',context!);
IsFromCache = json['IsFromCache'];
return this;
}
Map<String, dynamic> toJson() => {
'CachedAt': JsonConverters.toJson(CachedAt,'DateTime',context!),
'CacheExpiresAt': JsonConverters.toJson(CacheExpiresAt,'DateTime',context!),
'IsFromCache': IsFromCache
};
getTypeName() => "CacheMetadata";
TypeContext? context = _ctx;
}
// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class ResponseMetadata implements IConvertible
{
// @DataMember(Order=0)
bool? Success;
// @DataMember(Order=1)
bool? HasCache;
// @DataMember(Order=2)
bool? HasPaging;
// @DataMember(Order=3, EmitDefaultValue=false)
CacheMetadata? CacheMetadata;
// @DataMember(Order=4, EmitDefaultValue=false)
PagingMetadata? PagingMetadata;
ResponseMetadata({this.Success,this.HasCache,this.HasPaging,this.CacheMetadata,this.PagingMetadata});
ResponseMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Success = json['Success'];
HasCache = json['HasCache'];
HasPaging = json['HasPaging'];
CacheMetadata = JsonConverters.fromJson(json['CacheMetadata'],'CacheMetadata',context!);
PagingMetadata = JsonConverters.fromJson(json['PagingMetadata'],'PagingMetadata',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Success': Success,
'HasCache': HasCache,
'HasPaging': HasPaging,
'CacheMetadata': JsonConverters.toJson(CacheMetadata,'CacheMetadata',context!),
'PagingMetadata': JsonConverters.toJson(PagingMetadata,'PagingMetadata',context!)
};
getTypeName() => "ResponseMetadata";
TypeContext? context = _ctx;
}
// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class AgentivityError implements IConvertible
{
// @DataMember
String? ErrorCode;
// @DataMember
String? Message;
// @DataMember
String? StatusCode;
// @DataMember
String? VerboseMessage;
AgentivityError({this.ErrorCode,this.Message,this.StatusCode,this.VerboseMessage});
AgentivityError.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ErrorCode = json['ErrorCode'];
Message = json['Message'];
StatusCode = json['StatusCode'];
VerboseMessage = json['VerboseMessage'];
return this;
}
Map<String, dynamic> toJson() => {
'ErrorCode': ErrorCode,
'Message': Message,
'StatusCode': StatusCode,
'VerboseMessage': VerboseMessage
};
getTypeName() => "AgentivityError";
TypeContext? context = _ctx;
}
// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
class ItemResponse<TItem,TReport> implements IConvertible
{
// @DataMember(Order=1)
ResponseMetadata? ResponseMetadata;
// @DataMember(Order=2, EmitDefaultValue=false)
TReport? ResponseReport;
// @DataMember(Order=3, EmitDefaultValue=false)
AgentivityError? ResponseError;
ItemResponse({this.ResponseMetadata,this.ResponseReport,this.ResponseError});
ItemResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ResponseMetadata = JsonConverters.fromJson(json['ResponseMetadata'],'ResponseMetadata',context!);
ResponseReport = JsonConverters.fromJson(json['ResponseReport'],'TReport',context!);
ResponseError = JsonConverters.fromJson(json['ResponseError'],'AgentivityError',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ResponseMetadata': JsonConverters.toJson(ResponseMetadata,'ResponseMetadata',context!),
'ResponseReport': JsonConverters.toJson(ResponseReport,'TReport',context!),
'ResponseError': JsonConverters.toJson(ResponseError,'AgentivityError',context!)
};
getTypeName() => "ItemResponse<$TItem,$TReport>";
TypeContext? context = _ctx;
}
// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
class GetAccountsItemResponse extends ItemResponse<AgencyAccount,GetAccountsResponseReport> implements IConvertible
{
GetAccountsItemResponse();
GetAccountsItemResponse.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "GetAccountsItemResponse";
TypeContext? context = _ctx;
}
// @DataContract(Namespace="schemas.agentivity.com/types")
class GetAccounts extends CompanyLevelRequestBase implements IMemberOwningAgencyLocationID, IConvertible
{
/**
* Includes Owning Agency Locations for Accounts in the Result
*/
// @DataMember
bool? IncludeOwningAgencyLocations;
/**
* Comma Delimited List of PCCs
*/
// @DataMember
List<String>? OwningAgencyLocationID;
GetAccounts({this.IncludeOwningAgencyLocations,this.OwningAgencyLocationID});
GetAccounts.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
IncludeOwningAgencyLocations = json['IncludeOwningAgencyLocations'];
OwningAgencyLocationID = JsonConverters.fromJson(json['OwningAgencyLocationID'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'IncludeOwningAgencyLocations': IncludeOwningAgencyLocations,
'OwningAgencyLocationID': JsonConverters.toJson(OwningAgencyLocationID,'List<String>',context!)
});
getTypeName() => "GetAccounts";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
'AgencyAccountOwningAgencyLocation': TypeInfo(TypeOf.Class, create:() => AgencyAccountOwningAgencyLocation()),
'AgencyAccount': TypeInfo(TypeOf.Class, create:() => AgencyAccount()),
'List<AgencyAccountOwningAgencyLocation>': TypeInfo(TypeOf.Class, create:() => <AgencyAccountOwningAgencyLocation>[]),
'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
'GetAccountsResponseReport': TypeInfo(TypeOf.Class, create:() => GetAccountsResponseReport()),
'CacheMetadata': TypeInfo(TypeOf.Class, create:() => CacheMetadata()),
'ResponseMetadata': TypeInfo(TypeOf.Class, create:() => ResponseMetadata()),
'AgentivityError': TypeInfo(TypeOf.Class, create:() => AgentivityError()),
'ItemResponse<TItem,TReport>': TypeInfo(TypeOf.GenericDef,create:() => ItemResponse()),
'GetAccountsItemResponse': TypeInfo(TypeOf.Class, create:() => GetAccountsItemResponse()),
'GetAccounts': TypeInfo(TypeOf.Class, create:() => GetAccounts()),
});
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 /Accounts HTTP/1.1
Host: api.agentivity.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetAccounts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
<OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OwningCompanyCode>
<UserName>String</UserName>
<IncludeOwningAgencyLocations>false</IncludeOwningAgencyLocations>
<OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OwningAgencyLocationID>
</GetAccounts>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<ResponseMetadata>
<Success>false</Success>
<HasCache>false</HasCache>
<HasPaging>false</HasPaging>
<CacheMetadata>
<IsFromCache>false</IsFromCache>
<CachedAt>0001-01-01T00:00:00</CachedAt>
<CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
</CacheMetadata>
<PagingMetadata>
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
</PagingMetadata>
</ResponseMetadata>
<ResponseReport>
<Item>
<ID>String</ID>
<Name>String</Name>
<Manager>String</Manager>
<CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
<OwningAgencyLocations>
<OwningAgencyLocation>
<ID>String</ID>
<LastMatchedDate>0001-01-01T00:00:00</LastMatchedDate>
</OwningAgencyLocation>
</OwningAgencyLocations>
<CompanyId>0</CompanyId>
<LastMatchedDate>0001-01-01T00:00:00</LastMatchedDate>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>