Tax Filing Service
| Required role: | Admin | Required permissions: | CanAccess, CanAdd |
| POST | /sync/customers/batch |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* Represents a service request to register one or more customers in a batch operation.
*/
@Api(Description="Represents a service request to register one or more customers in a batch operation.")
open class BatchRegisterCustomers : BatchRegisterCustomersBase()
{
/**
* The customers to register.
*/
@ApiMember(Description="The customers to register.", IsRequired=true)
var customers:ArrayList<Customer> = ArrayList<Customer>()
}
/**
* Specifies a base service request to register one or more customers in a batch operation.
*/
@Api(Description="Specifies a base service request to register one or more customers in a batch operation.")
open class BatchRegisterCustomersBase : IPost
{
/**
* The customers to register.
*/
@ApiMember(Description="The customers to register.", IsRequired=true)
var customers:ArrayList<Customer> = ArrayList<Customer>()
}
/**
* Represents a customer (business organization or entrepreneur).
*/
@Api(Description="Represents a customer (business organization or entrepreneur).")
open class Customer : IHasName
{
/**
* The unique identifier of the customer.
*/
@ApiMember(Description="The unique identifier of the customer.", IsRequired=true)
var id:Int? = null
/**
* The position of this instance in a collection of 'Customer' instances
*/
@ApiMember(Description="The position of this instance in a collection of 'Customer' instances", IsRequired=true)
var index:Int? = null
/**
* Full name or organization name of customer.
*/
@ApiMember(Description="Full name or organization name of customer.", IsRequired=true)
@Validate(Validator="NotEmpty")
var name:String? = null
/**
* The country of residence or business of customer.
*/
@ApiMember(Description="The country of residence or business of customer.")
var country:String? = null
/**
* The type of customer.
*/
@ApiMember(Description="The type of customer.")
@SerializedName("type") var Type:CustomerType? = null
/**
* The list of user accounts associated with this customer.
*/
@ApiMember(Description="The list of user accounts associated with this customer.")
@Ignore()
var accounts:ArrayList<Account> = ArrayList<Account>()
}
enum class CustomerType
{
Internal,
Network,
External,
}
/**
* Represents a user account.
*/
@Api(Description="Represents a user account.")
open class Account : IHasUserName
{
/**
* The unique identifier of the user account.
*/
@ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
var id:Int? = null
/**
* The position of this instance in a collection of 'Account' instances
*/
@ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true)
var index:Int? = null
/**
* The unique identifier of the customer associated with this account.
*/
@ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
var refId:Int? = null
/**
* The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
*/
@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'.")
var refIdStr:String? = null
/**
* The unique user name of the user account.
*/
@ApiMember(Description="The unique user name of the user account.", IsRequired=true)
var userName:String? = null
/**
* The electronic mail address of the user account.
*/
@ApiMember(Description="The electronic mail address of the user account.")
var email:String? = null
/**
* The friendly name of the user account.
*/
@ApiMember(Description="The friendly name of the user account.")
var displayName:String? = null
/**
* The first name of the owner (natural person) of the user account.
*/
@ApiMember(Description="The first name of the owner (natural person) of the user account.")
var firstName:String? = null
/**
* The last name of the owner (natural person) of the user account.
*/
@ApiMember(Description="The last name of the owner (natural person) of the user account.")
var lastName:String? = null
/**
* The unique identifier of the customer associated with this account.
*/
@ApiMember(Description="The unique identifier of the customer associated with this account.")
var fullName:String? = null
/**
* The gender of the owner (natural person) of the user account.
*/
@ApiMember(Description="The gender of the owner (natural person) of the user account.")
var gender:String? = null
/**
* The language of the owner of teh user account.
*/
@ApiMember(Description="The language of the owner of teh user account.")
var language:String? = null
/**
* The company, where the user is an employee.
*/
@ApiMember(Description="The company, where the user is an employee.")
var company:String? = null
/**
* The profile URL of the user account.
*/
@ApiMember(Description="The profile URL of the user account.", IsRequired=true)
var profileUrl:String? = null
/**
* The roles assigned to the user account.
*/
@ApiMember(Description="The roles assigned to the user account.")
var roles:ArrayList<String> = ArrayList<String>()
/**
* The permissions assigned to the user account.
*/
@ApiMember(Description="The permissions assigned to the user account.")
var permissions:ArrayList<String> = ArrayList<String>()
/**
* The primary e-mail address of the user.
*/
@ApiMember(Description="The primary e-mail address of the user.")
var primaryEmail:String? = null
/**
* Random data to enhance the security of the user password.
*/
@ApiMember(Description="Random data to enhance the security of the user password.")
var salt:String? = null
/**
* The hash value of the user password that the PBKDF2 algorithm produces.
*/
@ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.")
var passwordHash:String? = null
/**
* The hash value of the user password that the DigestHa1 algorithm produces.
*/
@ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.")
var digestHa1Hash:String? = null
/**
* The number of times the user account tried to sign in but failed.
*/
@ApiMember(Description="The number of times the user account tried to sign in but failed.")
var invalidLoginAttempts:Int? = null
/**
* The last time the user account attempted a sign in.
*/
@ApiMember(Description="The last time the user account attempted a sign in.")
var lastLoginAttempt:Date? = null
/**
* The date and time when the user acount was denied access.
*/
@ApiMember(Description="The date and time when the user acount was denied access.")
var lockedDate:Date? = null
/**
* The date and time when the user account was created.
*/
@ApiMember(Description="The date and time when the user account was created.")
var createdDate:Date? = null
/**
* The date and time when the user account was last modified.
*/
@ApiMember(Description="The date and time when the user account was last modified.")
var modifiedDate:Date? = null
/**
* The telephone number of the owner of the user account.
*/
@ApiMember(Description="The telephone number of the owner of the user account.")
var phoneNumber:String? = null
/**
* The birth date of the owner of the user account
*/
@ApiMember(Description="The birth date of the owner of the user account")
var birthDate:Date? = null
/**
* The string representation of the birth date of the user account.
*/
@ApiMember(Description="The string representation of the birth date of the user account.")
var birthDateRaw:String? = null
/**
* The mail address of the user account.
*/
@ApiMember(Description="The mail address of the user account.")
var address:String? = null
/**
* Additional information for the specified 'Address' of the user.
*/
@ApiMember(Description="Additional information for the specified 'Address' of the user.")
var address2:String? = null
/**
* The city of the owner of the user account.
*/
@ApiMember(Description="The city of the owner of the user account.")
var city:String? = null
/**
* The state of the owner of the user account.
*/
@ApiMember(Description="The state of the owner of the user account.")
var state:String? = null
/**
* The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
*/
@ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")
var country:String? = null
/**
* The locale of the user account.
*/
@ApiMember(Description="The locale of the user account.")
var culture:String? = null
/**
* The mail address of the user account.
*/
@ApiMember(Description="The mail address of the user account.")
var mailAddress:String? = null
/**
* The nickname of the user of the user account.
*/
@ApiMember(Description="The nickname of the user of the user account.")
var nickname:String? = null
/**
* The postal code of the user account.
*/
@ApiMember(Description="The postal code of the user account.")
var postalCode:String? = null
/**
* The time zone of the user of the user account.
*/
@ApiMember(Description="The time zone of the user of the user account.")
var timeZone:String? = null
/**
* Additional information to attach to the user account.
*/
@ApiMember(Description="Additional information to attach to the user account.")
var meta:HashMap<String,String> = HashMap<String,String>()
}
Kotlin 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
}
}
}
]