Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /sync/accounts/search |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports PwC.Metering.Core.Services.Contracts.Requests
Imports PwC.Metering.Core.Services.Contracts.Helpers
Imports PwC.Metering.Core.Services.Contracts.Responses
Imports PwC.Metering.Core.Domain.Concretes.Models
Namespace Global
Namespace PwC.Metering.Core.Domain.Concretes.Models
'''<Summary>
'''Represents a user account.
'''</Summary>
<Api(Description:="Represents a user account.")>
Public Partial Class Account
Implements IHasUserName
Public Sub New()
Roles = New List(Of String)
Permissions = New List(Of String)
Meta = New Dictionary(Of String, String)
End Sub
'''<Summary>
'''The unique identifier of the user account.
'''</Summary>
<ApiMember(Description:="The unique identifier of the user account.", IsRequired:=true)>
Public Overridable Property Id As Integer
'''<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 Overridable Property Index As Integer
'''<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 Overridable Property RefId As Nullable(Of Integer)
'''<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 Overridable Property RefIdStr As String
'''<Summary>
'''The unique user name of the user account.
'''</Summary>
<ApiMember(Description:="The unique user name of the user account.", IsRequired:=true)>
Public Overridable Property UserName As String
'''<Summary>
'''The electronic mail address of the user account.
'''</Summary>
<ApiMember(Description:="The electronic mail address of the user account.")>
Public Overridable Property Email As String
'''<Summary>
'''The friendly name of the user account.
'''</Summary>
<ApiMember(Description:="The friendly name of the user account.")>
Public Overridable Property DisplayName As String
'''<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 Overridable Property FirstName As String
'''<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 Overridable Property LastName As String
'''<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 Overridable Property FullName As String
'''<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 Overridable Property Gender As String
'''<Summary>
'''The language of the owner of teh user account.
'''</Summary>
<ApiMember(Description:="The language of the owner of teh user account.")>
Public Overridable Property Language As String
'''<Summary>
'''The company, where the user is an employee.
'''</Summary>
<ApiMember(Description:="The company, where the user is an employee.")>
Public Overridable Property Company As String
'''<Summary>
'''The profile URL of the user account.
'''</Summary>
<ApiMember(Description:="The profile URL of the user account.", IsRequired:=true)>
Public Overridable Property ProfileUrl As String
'''<Summary>
'''The roles assigned to the user account.
'''</Summary>
<ApiMember(Description:="The roles assigned to the user account.")>
Public Overridable Property Roles As List(Of String)
'''<Summary>
'''The permissions assigned to the user account.
'''</Summary>
<ApiMember(Description:="The permissions assigned to the user account.")>
Public Overridable Property Permissions As List(Of String)
'''<Summary>
'''The primary e-mail address of the user.
'''</Summary>
<ApiMember(Description:="The primary e-mail address of the user.")>
Public Overridable Property PrimaryEmail As String
'''<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 Overridable Property Salt As String
'''<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 Overridable Property PasswordHash As String
'''<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 Overridable Property DigestHa1Hash As String
'''<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 Overridable Property InvalidLoginAttempts As Integer
'''<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 Overridable Property LastLoginAttempt As Nullable(Of Date)
'''<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 Overridable Property LockedDate As Nullable(Of Date)
'''<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 Overridable Property CreatedDate As Date
'''<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 Overridable Property ModifiedDate As Date
'''<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 Overridable Property PhoneNumber As String
'''<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 Overridable Property BirthDate As Nullable(Of Date)
'''<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 Overridable Property BirthDateRaw As String
'''<Summary>
'''The mail address of the user account.
'''</Summary>
<ApiMember(Description:="The mail address of the user account.")>
Public Overridable Property Address As String
'''<Summary>
'''Additional information for the specified 'Address' of the user.
'''</Summary>
<ApiMember(Description:="Additional information for the specified 'Address' of the user.")>
Public Overridable Property Address2 As String
'''<Summary>
'''The city of the owner of the user account.
'''</Summary>
<ApiMember(Description:="The city of the owner of the user account.")>
Public Overridable Property City As String
'''<Summary>
'''The state of the owner of the user account.
'''</Summary>
<ApiMember(Description:="The state of the owner of the user account.")>
Public Overridable Property State As String
'''<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 Overridable Property Country As String
'''<Summary>
'''The locale of the user account.
'''</Summary>
<ApiMember(Description:="The locale of the user account.")>
Public Overridable Property Culture As String
'''<Summary>
'''The mail address of the user account.
'''</Summary>
<ApiMember(Description:="The mail address of the user account.")>
Public Overridable Property MailAddress As String
'''<Summary>
'''The nickname of the user of the user account.
'''</Summary>
<ApiMember(Description:="The nickname of the user of the user account.")>
Public Overridable Property Nickname As String
'''<Summary>
'''The postal code of the user account.
'''</Summary>
<ApiMember(Description:="The postal code of the user account.")>
Public Overridable Property PostalCode As String
'''<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 Overridable Property TimeZone As String
'''<Summary>
'''Additional information to attach to the user account.
'''</Summary>
<ApiMember(Description:="Additional information to attach to the user account.")>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
End Namespace
Namespace PwC.Metering.Core.Services.Contracts.Helpers
'''<Summary>
'''The number of query results to skip.
'''</Summary>
<Api(Description:="The number of query results to skip.")>
Public Partial Class PaginationBase
Implements IPaginate
'''<Summary>
'''The number of query results to skip.
'''</Summary>
<ApiMember(Description:="The number of query results to skip.")>
Public Overridable Property Skip As Nullable(Of Integer)
'''<Summary>
'''The number of query results to include.
'''</Summary>
<ApiMember(Description:="The number of query results to include.")>
Public Overridable Property Take As Nullable(Of Integer)
End Class
End Namespace
Namespace PwC.Metering.Core.Services.Contracts.Requests
'''<Summary>
'''Represents a service to search for accounts.
'''</Summary>
<Api(Description:="Represents a service to search for accounts.")>
Public Partial Class SearchAccounts
Inherits SearchAccountsBase
'''<Summary>
'''The unique identifier of the user account.
'''</Summary>
<ApiMember(Description:="The unique identifier of the user account.")>
Public Overridable Property AccountId As Nullable(Of Integer)
'''<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 Overridable Property CustomerId As Nullable(Of Integer)
'''<Summary>
'''The user name of the user account.
'''</Summary>
<ApiMember(Description:="The user name of the user account.")>
Public Overridable Property UserName As String
'''<Summary>
'''Search by using the user name that starts with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the user name that starts with the specified value.")>
Public Overridable Property UserNameStartsWith As String
'''<Summary>
'''Search by using the user name that ends with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the user name that ends with the specified value.")>
Public Overridable Property UserNameEndsWith As String
'''<Summary>
'''Search by using the user name that contains the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the user name that contains the specified value.")>
Public Overridable Property UserNameContains As String
'''<Summary>
'''The display name of the user account.
'''</Summary>
<ApiMember(Description:="The display name of the user account.")>
Public Overridable Property DisplayName As String
'''<Summary>
'''The e-mail address of the user account.
'''</Summary>
<ApiMember(Description:="The e-mail address of the user account.")>
Public Overridable Property Email As String
'''<Summary>
'''Search by using the e-mail address of the user account that starts with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the e-mail address of the user account that starts with the specified value.")>
Public Overridable Property EmailStartsWith As String
'''<Summary>
'''Search by using the e-mail address of the user account that ends with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the e-mail address of the user account that ends with the specified value.")>
Public Overridable Property EmailEndsWith As String
'''<Summary>
'''Search by using the e-mail address of the user account that contains the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the e-mail address of the user account that contains the specified value.")>
Public Overridable Property EmailContains As String
'''<Summary>
'''Search by using the display name that starts with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the display name that starts with the specified value.")>
Public Overridable Property DisplayNameStartsWith As String
'''<Summary>
'''Search by using the display name that ends with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the display name that ends with the specified value.")>
Public Overridable Property DisplayNameEndsWith As String
'''<Summary>
'''Search by using the display name that contains the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the display name that contains the specified value.")>
Public Overridable Property DisplayNameContains As String
'''<Summary>
'''Search with the profile URL of the user account.
'''</Summary>
<ApiMember(Description:="Search with the profile URL of the user account.")>
Public Overridable Property ProfileUrl As String
'''<Summary>
'''Should the related products of the account be included in the retrieved accounts?
'''</Summary>
<ApiMember(Description:="Should the related products of the account be included in the retrieved accounts?")>
Public Overridable Property IncludeProducts As Boolean
'''<Summary>
'''Should the related orders of the account be included in the retrieved accounts?
'''</Summary>
<ApiMember(Description:="Should the related orders of the account be included in the retrieved accounts?")>
Public Overridable Property IncludeOrders As Boolean
'''<Summary>
'''Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. ")>
Public Overridable Property SkipProducts As Nullable(Of Integer)
'''<Summary>
'''Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. ")>
Public Overridable Property TakeProducts As Nullable(Of Integer)
'''<Summary>
'''Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. ")>
Public Overridable Property SkipOrders As Nullable(Of Integer)
'''<Summary>
'''Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. ")>
Public Overridable Property TakeOrders As Nullable(Of Integer)
'''<Summary>
'''The number of query results to skip.
'''</Summary>
<ApiMember(Description:="The number of query results to skip.")>
Public Overridable Property Skip As Nullable(Of Integer)
'''<Summary>
'''The number of query results to include.
'''</Summary>
<ApiMember(Description:="The number of query results to include.")>
Public Overridable Property Take As Nullable(Of Integer)
End Class
'''<Summary>
'''Specifies a service to search for accounts.
'''</Summary>
<Api(Description:="Specifies a service to search for accounts.")>
Public Partial Class SearchAccountsBase
Inherits PaginationBase
Implements IGet
'''<Summary>
'''The unique identifier of the user account.
'''</Summary>
<ApiMember(Description:="The unique identifier of the user account.")>
Public Overridable Property AccountId As Nullable(Of Integer)
'''<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 Overridable Property CustomerId As Nullable(Of Integer)
'''<Summary>
'''The user name of the user account.
'''</Summary>
<ApiMember(Description:="The user name of the user account.")>
Public Overridable Property UserName As String
'''<Summary>
'''Search by using the user name that starts with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the user name that starts with the specified value.")>
Public Overridable Property UserNameStartsWith As String
'''<Summary>
'''Search by using the user name that ends with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the user name that ends with the specified value.")>
Public Overridable Property UserNameEndsWith As String
'''<Summary>
'''Search by using the user name that contains the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the user name that contains the specified value.")>
Public Overridable Property UserNameContains As String
'''<Summary>
'''The display name of the user account.
'''</Summary>
<ApiMember(Description:="The display name of the user account.")>
Public Overridable Property DisplayName As String
'''<Summary>
'''The e-mail address of the user account.
'''</Summary>
<ApiMember(Description:="The e-mail address of the user account.")>
Public Overridable Property Email As String
'''<Summary>
'''Search by using the e-mail address of the user account that starts with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the e-mail address of the user account that starts with the specified value.")>
Public Overridable Property EmailStartsWith As String
'''<Summary>
'''Search by using the e-mail address of the user account that ends with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the e-mail address of the user account that ends with the specified value.")>
Public Overridable Property EmailEndsWith As String
'''<Summary>
'''Search by using the e-mail address of the user account that contains the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the e-mail address of the user account that contains the specified value.")>
Public Overridable Property EmailContains As String
'''<Summary>
'''Search by using the display name that starts with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the display name that starts with the specified value.")>
Public Overridable Property DisplayNameStartsWith As String
'''<Summary>
'''Search by using the display name that ends with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the display name that ends with the specified value.")>
Public Overridable Property DisplayNameEndsWith As String
'''<Summary>
'''Search by using the display name that contains the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the display name that contains the specified value.")>
Public Overridable Property DisplayNameContains As String
'''<Summary>
'''Search with the profile URL of the user account.
'''</Summary>
<ApiMember(Description:="Search with the profile URL of the user account.")>
Public Overridable Property ProfileUrl As String
'''<Summary>
'''Should the related products of the account be included in the retrieved accounts?
'''</Summary>
<ApiMember(Description:="Should the related products of the account be included in the retrieved accounts?")>
Public Overridable Property IncludeProducts As Boolean
'''<Summary>
'''Should the related orders of the account be included in the retrieved accounts?
'''</Summary>
<ApiMember(Description:="Should the related orders of the account be included in the retrieved accounts?")>
Public Overridable Property IncludeOrders As Boolean
'''<Summary>
'''Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. ")>
Public Overridable Property SkipProducts As Nullable(Of Integer)
'''<Summary>
'''Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. ")>
Public Overridable Property TakeProducts As Nullable(Of Integer)
'''<Summary>
'''Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. ")>
Public Overridable Property SkipOrders As Nullable(Of Integer)
'''<Summary>
'''Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. ")>
Public Overridable Property TakeOrders As Nullable(Of Integer)
'''<Summary>
'''The number of query results to skip.
'''</Summary>
<ApiMember(Description:="The number of query results to skip.")>
Public Overridable Property Skip As Nullable(Of Integer)
'''<Summary>
'''The number of query results to include.
'''</Summary>
<ApiMember(Description:="The number of query results to include.")>
Public Overridable Property Take As Nullable(Of Integer)
End Class
End Namespace
Namespace PwC.Metering.Core.Services.Contracts.Responses
'''<Summary>
'''Represents a query response that contains a structured error information and encapsulates user accounts.
'''</Summary>
<Api(Description:="Represents a query response that contains a structured error information and encapsulates user accounts.")>
Public Partial Class AccountQueryResponse
Inherits QueryResponse(Of Account)
Public Sub New()
ProductsMap = New Dictionary(Of Integer, List(Of Product))
OrdersMap = New Dictionary(Of Integer, List(Of Order))
Results = New List(Of Account)
Meta = New Dictionary(Of String, String)
End Sub
'''<Summary>
'''The dictionary of products associated to found user accounts.
'''</Summary>
<ApiMember(Description:="The dictionary of products associated to found user accounts.")>
Public Overridable Property ProductsMap As Dictionary(Of Integer, List(Of Product))
'''<Summary>
'''The dictionary of orders associated with each found user account.
'''</Summary>
<ApiMember(Description:="The dictionary of orders associated with each found user account.")>
Public Overridable Property OrdersMap As Dictionary(Of Integer, List(Of Order))
<DataMember(Order:=1)>
Public Overridable Property Offset As Integer
<DataMember(Order:=2)>
Public Overridable Property Total As Integer
<DataMember(Order:=3)>
Public Overridable Property Results As List(Of Account)
<DataMember(Order:=4)>
Public Overridable Property Meta As Dictionary(Of String, String)
<DataMember(Order:=5)>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
Namespace ServiceStack
<DataContract>
Public Partial Class QueryResponse(Of T)
Public Sub New()
Results = New List(Of T)
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property Offset As Integer
<DataMember(Order:=2)>
Public Overridable Property Total As Integer
<DataMember(Order:=3)>
Public Overridable Property Results As List(Of T)
<DataMember(Order:=4)>
Public Overridable Property Meta As Dictionary(Of String, String)
<DataMember(Order:=5)>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/accounts/search HTTP/1.1 Host: taxfiling.staging.pwc.de Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"productsMap":{"0":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}]},"ordersMap":{"0":[{"id":0,"productId":0,"accountId":0,"name":"String","serviceName":"String","requestTimestamp":"\/Date(-62135596800000-0000)\/","responseTimestamp":"\/Date(-62135596800000-0000)\/","requestUri":"String","requestHttpMethod":"String","requestDuration":"PT0S","responseStatusCode":"Continue","clientIPAddress":"String","unitOfMeasurement":"String","processType":"String","dataType":"String","dataName":"String","creationDate":"\/Date(-62135596800000-0000)\/","expiryDate":"\/Date(-62135596800000-0000)\/","isTest":false}]},"offset":0,"total":0,"results":[{"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":"\/Date(-62135596800000-0000)\/","lockedDate":"\/Date(-62135596800000-0000)\/","createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","phoneNumber":"String","birthDate":"\/Date(-62135596800000-0000)\/","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"}}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}