Tax Filing Service
| Required role: | Admin | Required permissions: | CanAccess, CanAdd |
| POST | /sync/customers/batch |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.Metering.Core.Services.Contracts.Requests;
using PwC.Metering.Core.Domain.Concretes.Models;
namespace PwC.Metering.Core.Domain.Concretes.Models
{
///<summary>
///Represents a user account.
///</summary>
[Api(Description="Represents a user account.")]
public partial class Account
: IHasUserName
{
public Account()
{
Roles = new List<string>{};
Permissions = new List<string>{};
Meta = new Dictionary<string, string>{};
}
///<summary>
///The unique identifier of the user account.
///</summary>
[ApiMember(Description="The unique identifier of the user account.", IsRequired=true)]
public virtual int Id { get; set; }
///<summary>
///The position of this instance in a collection of 'Account' instances
///</summary>
[ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true)]
public virtual int Index { get; set; }
///<summary>
///The unique identifier of the customer associated with this account.
///</summary>
[ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)]
public virtual int? RefId { get; set; }
///<summary>
///The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
///</summary>
[ApiMember(Description="The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.")]
public virtual string RefIdStr { get; set; }
///<summary>
///The unique user name of the user account.
///</summary>
[ApiMember(Description="The unique user name of the user account.", IsRequired=true)]
public virtual string UserName { get; set; }
///<summary>
///The electronic mail address of the user account.
///</summary>
[ApiMember(Description="The electronic mail address of the user account.")]
public virtual string Email { get; set; }
///<summary>
///The friendly name of the user account.
///</summary>
[ApiMember(Description="The friendly name of the user account.")]
public virtual string DisplayName { get; set; }
///<summary>
///The first name of the owner (natural person) of the user account.
///</summary>
[ApiMember(Description="The first name of the owner (natural person) of the user account.")]
public virtual string FirstName { get; set; }
///<summary>
///The last name of the owner (natural person) of the user account.
///</summary>
[ApiMember(Description="The last name of the owner (natural person) of the user account.")]
public virtual string LastName { get; set; }
///<summary>
///The unique identifier of the customer associated with this account.
///</summary>
[ApiMember(Description="The unique identifier of the customer associated with this account.")]
public virtual string FullName { get; set; }
///<summary>
///The gender of the owner (natural person) of the user account.
///</summary>
[ApiMember(Description="The gender of the owner (natural person) of the user account.")]
public virtual string Gender { get; set; }
///<summary>
///The language of the owner of teh user account.
///</summary>
[ApiMember(Description="The language of the owner of teh user account.")]
public virtual string Language { get; set; }
///<summary>
///The company, where the user is an employee.
///</summary>
[ApiMember(Description="The company, where the user is an employee.")]
public virtual string Company { get; set; }
///<summary>
///The profile URL of the user account.
///</summary>
[ApiMember(Description="The profile URL of the user account.", IsRequired=true)]
public virtual string ProfileUrl { get; set; }
///<summary>
///The roles assigned to the user account.
///</summary>
[ApiMember(Description="The roles assigned to the user account.")]
public virtual List<string> Roles { get; set; }
///<summary>
///The permissions assigned to the user account.
///</summary>
[ApiMember(Description="The permissions assigned to the user account.")]
public virtual List<string> Permissions { get; set; }
///<summary>
///The primary e-mail address of the user.
///</summary>
[ApiMember(Description="The primary e-mail address of the user.")]
public virtual string PrimaryEmail { get; set; }
///<summary>
///Random data to enhance the security of the user password.
///</summary>
[ApiMember(Description="Random data to enhance the security of the user password.")]
public virtual string Salt { get; set; }
///<summary>
///The hash value of the user password that the PBKDF2 algorithm produces.
///</summary>
[ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.")]
public virtual string PasswordHash { get; set; }
///<summary>
///The hash value of the user password that the DigestHa1 algorithm produces.
///</summary>
[ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.")]
public virtual string DigestHa1Hash { get; set; }
///<summary>
///The number of times the user account tried to sign in but failed.
///</summary>
[ApiMember(Description="The number of times the user account tried to sign in but failed.")]
public virtual int InvalidLoginAttempts { get; set; }
///<summary>
///The last time the user account attempted a sign in.
///</summary>
[ApiMember(Description="The last time the user account attempted a sign in.")]
public virtual DateTime? LastLoginAttempt { get; set; }
///<summary>
///The date and time when the user acount was denied access.
///</summary>
[ApiMember(Description="The date and time when the user acount was denied access.")]
public virtual DateTime? LockedDate { get; set; }
///<summary>
///The date and time when the user account was created.
///</summary>
[ApiMember(Description="The date and time when the user account was created.")]
public virtual DateTime CreatedDate { get; set; }
///<summary>
///The date and time when the user account was last modified.
///</summary>
[ApiMember(Description="The date and time when the user account was last modified.")]
public virtual DateTime ModifiedDate { get; set; }
///<summary>
///The telephone number of the owner of the user account.
///</summary>
[ApiMember(Description="The telephone number of the owner of the user account.")]
public virtual string PhoneNumber { get; set; }
///<summary>
///The birth date of the owner of the user account
///</summary>
[ApiMember(Description="The birth date of the owner of the user account")]
public virtual DateTime? BirthDate { get; set; }
///<summary>
///The string representation of the birth date of the user account.
///</summary>
[ApiMember(Description="The string representation of the birth date of the user account.")]
public virtual string BirthDateRaw { get; set; }
///<summary>
///The mail address of the user account.
///</summary>
[ApiMember(Description="The mail address of the user account.")]
public virtual string Address { get; set; }
///<summary>
///Additional information for the specified 'Address' of the user.
///</summary>
[ApiMember(Description="Additional information for the specified 'Address' of the user.")]
public virtual string Address2 { get; set; }
///<summary>
///The city of the owner of the user account.
///</summary>
[ApiMember(Description="The city of the owner of the user account.")]
public virtual string City { get; set; }
///<summary>
///The state of the owner of the user account.
///</summary>
[ApiMember(Description="The state of the owner of the user account.")]
public virtual string State { get; set; }
///<summary>
///The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
///</summary>
[ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")]
public virtual string Country { get; set; }
///<summary>
///The locale of the user account.
///</summary>
[ApiMember(Description="The locale of the user account.")]
public virtual string Culture { get; set; }
///<summary>
///The mail address of the user account.
///</summary>
[ApiMember(Description="The mail address of the user account.")]
public virtual string MailAddress { get; set; }
///<summary>
///The nickname of the user of the user account.
///</summary>
[ApiMember(Description="The nickname of the user of the user account.")]
public virtual string Nickname { get; set; }
///<summary>
///The postal code of the user account.
///</summary>
[ApiMember(Description="The postal code of the user account.")]
public virtual string PostalCode { get; set; }
///<summary>
///The time zone of the user of the user account.
///</summary>
[ApiMember(Description="The time zone of the user of the user account.")]
public virtual string TimeZone { get; set; }
///<summary>
///Additional information to attach to the user account.
///</summary>
[ApiMember(Description="Additional information to attach to the user account.")]
public virtual Dictionary<string, string> Meta { get; set; }
}
///<summary>
///Represents a customer (business organization or entrepreneur).
///</summary>
[Api(Description="Represents a customer (business organization or entrepreneur).")]
public partial class Customer
: IHasName
{
public Customer()
{
Accounts = new List<Account>{};
}
///<summary>
///The unique identifier of the customer.
///</summary>
[ApiMember(Description="The unique identifier of the customer.", IsRequired=true)]
public virtual int Id { get; set; }
///<summary>
///The position of this instance in a collection of 'Customer' instances
///</summary>
[ApiMember(Description="The position of this instance in a collection of 'Customer' instances", IsRequired=true)]
public virtual int Index { get; set; }
///<summary>
///Full name or organization name of customer.
///</summary>
[ApiMember(Description="Full name or organization name of customer.", IsRequired=true)]
[Validate("NotEmpty")]
public virtual string Name { get; set; }
///<summary>
///The country of residence or business of customer.
///</summary>
[ApiMember(Description="The country of residence or business of customer.")]
public virtual string Country { get; set; }
///<summary>
///The type of customer.
///</summary>
[ApiMember(Description="The type of customer.")]
public virtual CustomerType Type { get; set; }
///<summary>
///The list of user accounts associated with this customer.
///</summary>
[ApiMember(Description="The list of user accounts associated with this customer.")]
[Ignore]
public virtual List<Account> Accounts { get; set; }
}
public enum CustomerType
{
Internal,
Network,
External,
}
}
namespace PwC.Metering.Core.Services.Contracts.Requests
{
///<summary>
///Represents a service request to register one or more customers in a batch operation.
///</summary>
[Api(Description="Represents a service request to register one or more customers in a batch operation.")]
public partial class BatchRegisterCustomers
: BatchRegisterCustomersBase
{
public BatchRegisterCustomers()
{
Customers = new List<Customer>{};
}
///<summary>
///The customers to register.
///</summary>
[ApiMember(Description="The customers to register.", IsRequired=true)]
public virtual List<Customer> Customers { get; set; }
}
///<summary>
///Specifies a base service request to register one or more customers in a batch operation.
///</summary>
[Api(Description="Specifies a base service request to register one or more customers in a batch operation.")]
public partial class BatchRegisterCustomersBase
: IPost
{
public BatchRegisterCustomersBase()
{
Customers = new List<Customer>{};
}
///<summary>
///The customers to register.
///</summary>
[ApiMember(Description="The customers to register.", IsRequired=true)]
public virtual List<Customer> Customers { get; set; }
}
}
C# BatchRegisterCustomers 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 /sync/customers/batch HTTP/1.1
Host: taxfiling.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BatchRegisterCustomers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Requests">
<Customers xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
<d2p1:Customer>
<d2p1:Accounts>
<d2p1:Account>
<d2p1:Address>String</d2p1:Address>
<d2p1:Address2>String</d2p1:Address2>
<d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
<d2p1:BirthDateRaw>String</d2p1:BirthDateRaw>
<d2p1:City>String</d2p1:City>
<d2p1:Company>String</d2p1:Company>
<d2p1:Country>String</d2p1:Country>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:Culture>String</d2p1:Culture>
<d2p1:DigestHa1Hash>String</d2p1:DigestHa1Hash>
<d2p1:DisplayName>String</d2p1:DisplayName>
<d2p1:Email>String</d2p1:Email>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:FullName>String</d2p1:FullName>
<d2p1:Gender>String</d2p1:Gender>
<d2p1:Id>0</d2p1:Id>
<d2p1:Index>0</d2p1:Index>
<d2p1:InvalidLoginAttempts>0</d2p1:InvalidLoginAttempts>
<d2p1:Language>String</d2p1:Language>
<d2p1:LastLoginAttempt>0001-01-01T00:00:00</d2p1:LastLoginAttempt>
<d2p1:LastName>String</d2p1:LastName>
<d2p1:LockedDate>0001-01-01T00:00:00</d2p1:LockedDate>
<d2p1:MailAddress>String</d2p1:MailAddress>
<d2p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d2p1:Meta>
<d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
<d2p1:Nickname>String</d2p1:Nickname>
<d2p1:PasswordHash>String</d2p1:PasswordHash>
<d2p1:Permissions xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</d2p1:Permissions>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:PostalCode>String</d2p1:PostalCode>
<d2p1:PrimaryEmail>String</d2p1:PrimaryEmail>
<d2p1:ProfileUrl>String</d2p1:ProfileUrl>
<d2p1:RefId>0</d2p1:RefId>
<d2p1:RefIdStr>String</d2p1:RefIdStr>
<d2p1:Roles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</d2p1:Roles>
<d2p1:Salt>String</d2p1:Salt>
<d2p1:State>String</d2p1:State>
<d2p1:TimeZone>String</d2p1:TimeZone>
<d2p1:UserName>String</d2p1:UserName>
</d2p1:Account>
</d2p1:Accounts>
<d2p1:Country>String</d2p1:Country>
<d2p1:Id>0</d2p1:Id>
<d2p1:Index>0</d2p1:Index>
<d2p1:Name>String</d2p1:Name>
<d2p1:Type>Internal</d2p1:Type>
</d2p1:Customer>
</Customers>
</BatchRegisterCustomers>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses">
<CustomerResponse>
<ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:Message>String</d3p1:Message>
<d3p1:StackTrace>String</d3p1:StackTrace>
<d3p1:Errors>
<d3p1:ResponseError>
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:FieldName>String</d3p1:FieldName>
<d3p1:Message>String</d3p1:Message>
<d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d3p1:Meta>
</d3p1:ResponseError>
</d3p1:Errors>
<d3p1: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>
</d3p1:Meta>
</ResponseStatus>
<Customer xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
<d3p1:Accounts>
<d3p1:Account>
<d3p1:Address>String</d3p1:Address>
<d3p1:Address2>String</d3p1:Address2>
<d3p1:BirthDate>0001-01-01T00:00:00</d3p1:BirthDate>
<d3p1:BirthDateRaw>String</d3p1:BirthDateRaw>
<d3p1:City>String</d3p1:City>
<d3p1:Company>String</d3p1:Company>
<d3p1:Country>String</d3p1:Country>
<d3p1:CreatedDate>0001-01-01T00:00:00</d3p1:CreatedDate>
<d3p1:Culture>String</d3p1:Culture>
<d3p1:DigestHa1Hash>String</d3p1:DigestHa1Hash>
<d3p1:DisplayName>String</d3p1:DisplayName>
<d3p1:Email>String</d3p1:Email>
<d3p1:FirstName>String</d3p1:FirstName>
<d3p1:FullName>String</d3p1:FullName>
<d3p1:Gender>String</d3p1:Gender>
<d3p1:Id>0</d3p1:Id>
<d3p1:Index>0</d3p1:Index>
<d3p1:InvalidLoginAttempts>0</d3p1:InvalidLoginAttempts>
<d3p1:Language>String</d3p1:Language>
<d3p1:LastLoginAttempt>0001-01-01T00:00:00</d3p1:LastLoginAttempt>
<d3p1:LastName>String</d3p1:LastName>
<d3p1:LockedDate>0001-01-01T00:00:00</d3p1:LockedDate>
<d3p1:MailAddress>String</d3p1:MailAddress>
<d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d3p1:Meta>
<d3p1:ModifiedDate>0001-01-01T00:00:00</d3p1:ModifiedDate>
<d3p1:Nickname>String</d3p1:Nickname>
<d3p1:PasswordHash>String</d3p1:PasswordHash>
<d3p1:Permissions xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</d3p1:Permissions>
<d3p1:PhoneNumber>String</d3p1:PhoneNumber>
<d3p1:PostalCode>String</d3p1:PostalCode>
<d3p1:PrimaryEmail>String</d3p1:PrimaryEmail>
<d3p1:ProfileUrl>String</d3p1:ProfileUrl>
<d3p1:RefId>0</d3p1:RefId>
<d3p1:RefIdStr>String</d3p1:RefIdStr>
<d3p1:Roles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</d3p1:Roles>
<d3p1:Salt>String</d3p1:Salt>
<d3p1:State>String</d3p1:State>
<d3p1:TimeZone>String</d3p1:TimeZone>
<d3p1:UserName>String</d3p1:UserName>
</d3p1:Account>
</d3p1:Accounts>
<d3p1:Country>String</d3p1:Country>
<d3p1:Id>0</d3p1:Id>
<d3p1:Index>0</d3p1:Index>
<d3p1:Name>String</d3p1:Name>
<d3p1:Type>Internal</d3p1:Type>
</Customer>
<Index>0</Index>
</CustomerResponse>
</ArrayOfCustomerResponse>