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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
customers:
[
{
id: 0,
index: 0,
name: String,
country: String,
type: Internal,
accounts:
[
{
id: 0,
index: 0,
refId: 0,
refIdStr: String,
userName: String,
email: String,
displayName: String,
firstName: String,
lastName: String,
fullName: String,
gender: String,
language: String,
company: String,
profileUrl: String,
roles:
[
String
],
permissions:
[
String
],
primaryEmail: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
phoneNumber: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
meta:
{
String: String
}
}
]
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
customer:
{
id: 0,
index: 0,
name: String,
country: String,
type: Internal,
accounts:
[
{
id: 0,
index: 0,
refId: 0,
refIdStr: String,
userName: String,
email: String,
displayName: String,
firstName: String,
lastName: String,
fullName: String,
gender: String,
language: String,
company: String,
profileUrl: String,
roles:
[
String
],
permissions:
[
String
],
primaryEmail: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
phoneNumber: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
meta:
{
String: String
}
}
]
},
index: 0,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}
]