Tax Filing Service

<back to all web services

BatchRegisterAccountsAsync

RegisterAccountsBatchAsync

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

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanAdd
The following routes are available for this service:
POST/async/accounts/batch
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    /**
    * Represents a service request to register one or more accounts in a batch operation.
    */
    @Api(Description="Represents a service request to register one or more accounts in a batch operation.")
    public static class BatchRegisterAccountsAsync extends BatchRegisterAccountsBase
    {
        /**
        * The accounts to register and corresponding product subscriptions.
        */
        @ApiMember(Description="The accounts to register and corresponding product subscriptions.", IsRequired=true)
        public ArrayList<Account> accounts = null;
        
        public ArrayList<Account> getAccounts() { return accounts; }
        public BatchRegisterAccountsAsync setAccounts(ArrayList<Account> value) { this.accounts = value; return this; }
    }

    /**
    * Specifies a base service request to register one or more accounts in a batch operation.
    */
    @Api(Description="Specifies a base service request to register one or more accounts in a batch operation.")
    public static class BatchRegisterAccountsBase implements IPost
    {
        /**
        * The accounts to register and corresponding product subscriptions.
        */
        @ApiMember(Description="The accounts to register and corresponding product subscriptions.", IsRequired=true)
        public ArrayList<Account> accounts = null;
        
        public ArrayList<Account> getAccounts() { return accounts; }
        public BatchRegisterAccountsBase setAccounts(ArrayList<Account> value) { this.accounts = value; return this; }
    }

    /**
    * Represents a user account.
    */
    @Api(Description="Represents a user account.")
    public static class Account implements IHasUserName
    {
        /**
        * The unique identifier of the user account.
        */
        @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
        public Integer id = 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)
        public Integer index = 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)
        public Integer refId = 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'.")
        public String refIdStr = null;

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

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

        /**
        * The friendly name of the user account.
        */
        @ApiMember(Description="The friendly name of the user account.")
        public String displayName = 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.")
        public String firstName = 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.")
        public String lastName = null;

        /**
        * The unique identifier of the customer associated with this account.
        */
        @ApiMember(Description="The unique identifier of the customer associated with this account.")
        public String fullName = 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.")
        public String gender = null;

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

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

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

        /**
        * The roles assigned to the user account.
        */
        @ApiMember(Description="The roles assigned to the user account.")
        public ArrayList<String> roles = null;

        /**
        * The permissions assigned to the user account.
        */
        @ApiMember(Description="The permissions assigned to the user account.")
        public ArrayList<String> permissions = null;

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

        /**
        * Random data to enhance the security of the user password.
        */
        @ApiMember(Description="Random data to enhance the security of the user password.")
        public String salt = 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.")
        public String passwordHash = 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.")
        public String digestHa1Hash = 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.")
        public Integer invalidLoginAttempts = null;

        /**
        * The last time the user account attempted a sign in.
        */
        @ApiMember(Description="The last time the user account attempted a sign in.")
        public Date lastLoginAttempt = 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.")
        public Date lockedDate = null;

        /**
        * The date and time when the user account was created.
        */
        @ApiMember(Description="The date and time when the user account was created.")
        public Date createdDate = 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.")
        public Date modifiedDate = null;

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

        /**
        * The birth date of the owner of the user account
        */
        @ApiMember(Description="The birth date of the owner of the user account")
        public Date birthDate = 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.")
        public String birthDateRaw = null;

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

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

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

        /**
        * The state of the owner of the user account.
        */
        @ApiMember(Description="The state of the owner of the user account.")
        public String state = 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'.")
        public String country = null;

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

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

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

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

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

        /**
        * Additional information to attach to the user account.
        */
        @ApiMember(Description="Additional information to attach to the user account.")
        public HashMap<String,String> meta = null;
        
        public Integer getId() { return id; }
        public Account setId(Integer value) { this.id = value; return this; }
        public Integer getIndex() { return index; }
        public Account setIndex(Integer value) { this.index = value; return this; }
        public Integer getRefId() { return refId; }
        public Account setRefId(Integer value) { this.refId = value; return this; }
        public String getRefIdStr() { return refIdStr; }
        public Account setRefIdStr(String value) { this.refIdStr = value; return this; }
        public String getUserName() { return userName; }
        public Account setUserName(String value) { this.userName = value; return this; }
        public String getEmail() { return email; }
        public Account setEmail(String value) { this.email = value; return this; }
        public String getDisplayName() { return displayName; }
        public Account setDisplayName(String value) { this.displayName = value; return this; }
        public String getFirstName() { return firstName; }
        public Account setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public Account setLastName(String value) { this.lastName = value; return this; }
        public String getFullName() { return fullName; }
        public Account setFullName(String value) { this.fullName = value; return this; }
        public String getGender() { return gender; }
        public Account setGender(String value) { this.gender = value; return this; }
        public String getLanguage() { return language; }
        public Account setLanguage(String value) { this.language = value; return this; }
        public String getCompany() { return company; }
        public Account setCompany(String value) { this.company = value; return this; }
        public String getProfileUrl() { return profileUrl; }
        public Account setProfileUrl(String value) { this.profileUrl = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public Account setRoles(ArrayList<String> value) { this.roles = value; return this; }
        public ArrayList<String> getPermissions() { return permissions; }
        public Account setPermissions(ArrayList<String> value) { this.permissions = value; return this; }
        public String getPrimaryEmail() { return primaryEmail; }
        public Account setPrimaryEmail(String value) { this.primaryEmail = value; return this; }
        public String getSalt() { return salt; }
        public Account setSalt(String value) { this.salt = value; return this; }
        public String getPasswordHash() { return passwordHash; }
        public Account setPasswordHash(String value) { this.passwordHash = value; return this; }
        public String getDigestHa1Hash() { return digestHa1Hash; }
        public Account setDigestHa1Hash(String value) { this.digestHa1Hash = value; return this; }
        public Integer getInvalidLoginAttempts() { return invalidLoginAttempts; }
        public Account setInvalidLoginAttempts(Integer value) { this.invalidLoginAttempts = value; return this; }
        public Date getLastLoginAttempt() { return lastLoginAttempt; }
        public Account setLastLoginAttempt(Date value) { this.lastLoginAttempt = value; return this; }
        public Date getLockedDate() { return lockedDate; }
        public Account setLockedDate(Date value) { this.lockedDate = value; return this; }
        public Date getCreatedDate() { return createdDate; }
        public Account setCreatedDate(Date value) { this.createdDate = value; return this; }
        public Date getModifiedDate() { return modifiedDate; }
        public Account setModifiedDate(Date value) { this.modifiedDate = value; return this; }
        public String getPhoneNumber() { return phoneNumber; }
        public Account setPhoneNumber(String value) { this.phoneNumber = value; return this; }
        public Date getBirthDate() { return birthDate; }
        public Account setBirthDate(Date value) { this.birthDate = value; return this; }
        public String getBirthDateRaw() { return birthDateRaw; }
        public Account setBirthDateRaw(String value) { this.birthDateRaw = value; return this; }
        public String getAddress() { return address; }
        public Account setAddress(String value) { this.address = value; return this; }
        public String getAddress2() { return address2; }
        public Account setAddress2(String value) { this.address2 = value; return this; }
        public String getCity() { return city; }
        public Account setCity(String value) { this.city = value; return this; }
        public String getState() { return state; }
        public Account setState(String value) { this.state = value; return this; }
        public String getCountry() { return country; }
        public Account setCountry(String value) { this.country = value; return this; }
        public String getCulture() { return culture; }
        public Account setCulture(String value) { this.culture = value; return this; }
        public String getMailAddress() { return mailAddress; }
        public Account setMailAddress(String value) { this.mailAddress = value; return this; }
        public String getNickname() { return nickname; }
        public Account setNickname(String value) { this.nickname = value; return this; }
        public String getPostalCode() { return postalCode; }
        public Account setPostalCode(String value) { this.postalCode = value; return this; }
        public String getTimeZone() { return timeZone; }
        public Account setTimeZone(String value) { this.timeZone = value; return this; }
        public HashMap<String,String> getMeta() { return meta; }
        public Account setMeta(HashMap<String,String> value) { this.meta = value; return this; }
    }

}

Java BatchRegisterAccountsAsync DTOs

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

HTTP + XML

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

POST /async/accounts/batch HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchRegisterAccountsAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Requests">
  <Accounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
    <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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1: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>
  </Accounts>
</BatchRegisterAccountsAsync>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses">
  <AccountResponse>
    <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>
    <Account xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
      <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: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>
      <d3p1:ModifiedDate>0001-01-01T00:00:00</d3p1:ModifiedDate>
      <d3p1:Nickname>String</d3p1:Nickname>
      <d3p1:PasswordHash>String</d3p1:PasswordHash>
      <d3p1:Permissions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d3p1:Roles>
      <d3p1:Salt>String</d3p1:Salt>
      <d3p1:State>String</d3p1:State>
      <d3p1:TimeZone>String</d3p1:TimeZone>
      <d3p1:UserName>String</d3p1:UserName>
    </Account>
    <Index>0</Index>
    <Orders xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
      <d3p1:Order>
        <d3p1:AccountId>0</d3p1:AccountId>
        <d3p1:ClientIPAddress>String</d3p1:ClientIPAddress>
        <d3p1:CreationDate>0001-01-01T00:00:00</d3p1:CreationDate>
        <d3p1:DataName>String</d3p1:DataName>
        <d3p1:DataType>String</d3p1:DataType>
        <d3p1:ExpiryDate>0001-01-01T00:00:00</d3p1:ExpiryDate>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:IsTest>false</d3p1:IsTest>
        <d3p1:Name>String</d3p1:Name>
        <d3p1:ProcessType>String</d3p1:ProcessType>
        <d3p1:ProductId>0</d3p1:ProductId>
        <d3p1:RequestDuration>PT0S</d3p1:RequestDuration>
        <d3p1:RequestHttpMethod>String</d3p1:RequestHttpMethod>
        <d3p1:RequestTimestamp>0001-01-01T00:00:00</d3p1:RequestTimestamp>
        <d3p1:RequestUri>String</d3p1:RequestUri>
        <d3p1:ResponseStatusCode>Continue</d3p1:ResponseStatusCode>
        <d3p1:ResponseTimestamp>0001-01-01T00:00:00</d3p1:ResponseTimestamp>
        <d3p1:ServiceName>String</d3p1:ServiceName>
        <d3p1:UnitOfMeasurement>String</d3p1:UnitOfMeasurement>
      </d3p1:Order>
    </Orders>
    <Products xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
      <d3p1:Product>
        <d3p1:Description>String</d3p1:Description>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:Index>0</d3p1:Index>
        <d3p1:Name>String</d3p1:Name>
        <d3p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d3p1:Tags>
        <d3p1:Version>String</d3p1:Version>
      </d3p1:Product>
    </Products>
  </AccountResponse>
</ArrayOfAccountResponse>