Tax Filing Service

<back to all web services

BatchRegisterCustomersAsync

RegisterCustomersBatchAsync

Represents a service request to register one or more customers in a batch operation.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanAdd
The following routes are available for this service:
POST/async/customers/batch
import Foundation
import ServiceStack

/**
* 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.")
public class BatchRegisterCustomersAsync : BatchRegisterCustomersBase
{
    /**
    * The customers to register.
    */
    // @ApiMember(Description="The customers to register.", IsRequired=true)
    public var customers:[Customer] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case customers
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        customers = try container.decodeIfPresent([Customer].self, forKey: .customers) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if customers.count > 0 { try container.encode(customers, forKey: .customers) }
    }
}

/**
* 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.")
public class BatchRegisterCustomersBase : IPost, Codable
{
    /**
    * The customers to register.
    */
    // @ApiMember(Description="The customers to register.", IsRequired=true)
    public var customers:[Customer] = []

    required public init(){}
}

/**
* Represents a customer (business organization or entrepreneur).
*/
// @Api(Description="Represents a customer (business organization or entrepreneur).")
public class Customer : IHasName, Codable
{
    /**
    * The unique identifier of the customer.
    */
    // @ApiMember(Description="The unique identifier of the customer.", IsRequired=true)
    public var id:Int

    /**
    * 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)
    public var index:Int

    /**
    * Full name or organization name of customer.
    */
    // @ApiMember(Description="Full name or organization name of customer.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    public var name:String

    /**
    * The country of residence or business of customer.
    */
    // @ApiMember(Description="The country of residence or business of customer.")
    public var country:String

    /**
    * The type of customer.
    */
    // @ApiMember(Description="The type of customer.")
    public var type:CustomerType

    /**
    * The list of user accounts associated with this customer.
    */
    // @ApiMember(Description="The list of user accounts associated with this customer.")
    // @Ignore()
    public var accounts:[Account] = []

    required public init(){}
}

public enum CustomerType : String, Codable
{
    case Internal
    case Network
    case External
}

/**
* Represents a user account.
*/
// @Api(Description="Represents a user account.")
public class Account : IHasUserName, Codable
{
    /**
    * The unique identifier of the user account.
    */
    // @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
    public var id:Int

    /**
    * 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)
    public var index:Int

    /**
    * The unique identifier of the customer associated with this account.
    */
    // @ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
    public var refId:Int?

    /**
    * 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'.")
    public var refIdStr:String

    /**
    * The unique user name of the user account.
    */
    // @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
    public var userName:String

    /**
    * The electronic mail address of the user account.
    */
    // @ApiMember(Description="The electronic mail address of the user account.")
    public var email:String

    /**
    * The friendly name of the user account.
    */
    // @ApiMember(Description="The friendly name of the user account.")
    public var displayName:String

    /**
    * 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.")
    public var firstName:String

    /**
    * 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.")
    public var lastName:String

    /**
    * The unique identifier of the customer associated with this account.
    */
    // @ApiMember(Description="The unique identifier of the customer associated with this account.")
    public var fullName:String

    /**
    * The gender of the owner (natural person) of the user account.
    */
    // @ApiMember(Description="The gender of the owner (natural person) of the user account.")
    public var gender:String

    /**
    * The language of the owner of teh user account.
    */
    // @ApiMember(Description="The language of the owner of teh user account.")
    public var language:String

    /**
    * The company, where the user is an employee.
    */
    // @ApiMember(Description="The company, where the user is an employee.")
    public var company:String

    /**
    * The profile URL of the user account.
    */
    // @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
    public var profileUrl:String

    /**
    * The roles assigned to the user account.
    */
    // @ApiMember(Description="The roles assigned to the user account.")
    public var roles:[String] = []

    /**
    * The permissions assigned to the user account.
    */
    // @ApiMember(Description="The permissions assigned to the user account.")
    public var permissions:[String] = []

    /**
    * The primary e-mail address of the user.
    */
    // @ApiMember(Description="The primary e-mail address of the user.")
    public var primaryEmail:String

    /**
    * Random data to enhance the security of the user password.
    */
    // @ApiMember(Description="Random data to enhance the security of the user password.")
    public var salt:String

    /**
    * 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.")
    public var passwordHash:String

    /**
    * 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.")
    public var digestHa1Hash:String

    /**
    * 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.")
    public var invalidLoginAttempts:Int

    /**
    * The last time the user account attempted a sign in.
    */
    // @ApiMember(Description="The last time the user account attempted a sign in.")
    public var lastLoginAttempt:Date?

    /**
    * The date and time when the user acount was denied access.
    */
    // @ApiMember(Description="The date and time when the user acount was denied access.")
    public var lockedDate:Date?

    /**
    * The date and time when the user account was created.
    */
    // @ApiMember(Description="The date and time when the user account was created.")
    public var createdDate:Date

    /**
    * The date and time when the user account was last modified.
    */
    // @ApiMember(Description="The date and time when the user account was last modified.")
    public var modifiedDate:Date

    /**
    * The telephone number of the owner of the user account.
    */
    // @ApiMember(Description="The telephone number of the owner of the user account.")
    public var phoneNumber:String

    /**
    * The birth date of the owner of the user account
    */
    // @ApiMember(Description="The birth date of the owner of the user account")
    public var birthDate:Date?

    /**
    * The string representation of the birth date of the user account.
    */
    // @ApiMember(Description="The string representation of the birth date of the user account.")
    public var birthDateRaw:String

    /**
    * The mail address of the user account.
    */
    // @ApiMember(Description="The mail address of the user account.")
    public var address:String

    /**
    * Additional information for the specified 'Address' of the user.
    */
    // @ApiMember(Description="Additional information for the specified 'Address' of the user.")
    public var address2:String

    /**
    * The city of the owner of the user account.
    */
    // @ApiMember(Description="The city of the owner of the user account.")
    public var city:String

    /**
    * The state of the owner of the user account.
    */
    // @ApiMember(Description="The state of the owner of the user account.")
    public var state:String

    /**
    * 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'.")
    public var country:String

    /**
    * The locale of the user account.
    */
    // @ApiMember(Description="The locale of the user account.")
    public var culture:String

    /**
    * The mail address of the user account.
    */
    // @ApiMember(Description="The mail address of the user account.")
    public var mailAddress:String

    /**
    * The nickname of the user of the user account.
    */
    // @ApiMember(Description="The nickname of the user of the user account.")
    public var nickname:String

    /**
    * The postal code of the user account.
    */
    // @ApiMember(Description="The postal code of the user account.")
    public var postalCode:String

    /**
    * The time zone of the user of the user account.
    */
    // @ApiMember(Description="The time zone of the user of the user account.")
    public var timeZone:String

    /**
    * Additional information to attach to the user account.
    */
    // @ApiMember(Description="Additional information to attach to the user account.")
    public var meta:[String:String] = [:]

    required public init(){}
}


Swift BatchRegisterCustomersAsync DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /async/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
			}
		}
	}
]