Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /sync/customers/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.Domain.Concretes.Models
Imports PwC.Metering.Core.Services.Contracts.Responses
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
'''<Summary>
'''Represents a customer (business organization or entrepreneur).
'''</Summary>
<Api(Description:="Represents a customer (business organization or entrepreneur).")>
Public Partial Class Customer
Implements IHasName
Public Sub New()
Accounts = New List(Of Account)
End Sub
'''<Summary>
'''The unique identifier of the customer.
'''</Summary>
<ApiMember(Description:="The unique identifier of the customer.", IsRequired:=true)>
Public Overridable Property Id As Integer
'''<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 Overridable Property Index As Integer
'''<Summary>
'''Full name or organization name of customer.
'''</Summary>
<ApiMember(Description:="Full name or organization name of customer.", IsRequired:=true)>
<Validate(Validator:="NotEmpty")>
Public Overridable Property Name As String
'''<Summary>
'''The country of residence or business of customer.
'''</Summary>
<ApiMember(Description:="The country of residence or business of customer.")>
Public Overridable Property Country As String
'''<Summary>
'''The type of customer.
'''</Summary>
<ApiMember(Description:="The type of customer.")>
Public Overridable Property Type As CustomerType
'''<Summary>
'''The list of user accounts associated with this customer.
'''</Summary>
<ApiMember(Description:="The list of user accounts associated with this customer.")>
<Ignore>
Public Overridable Property Accounts As List(Of Account)
End Class
Public Enum CustomerType
Internal
Network
External
End Enum
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 request to query customer data.
'''</Summary>
<Api(Description:="Represents a service request to query customer data.")>
Public Partial Class SearchCustomers
Inherits SearchCustomersBase
'''<Summary>
'''The unique identifier of the customer.
'''</Summary>
<ApiMember(Description:="The unique identifier of the customer.")>
Public Overridable Property CustomerId As Nullable(Of Integer)
'''<Summary>
'''The name of the customer.
'''</Summary>
<ApiMember(Description:="The name of the customer.")>
Public Overridable Property Name As String
'''<Summary>
'''Search by using the name of the customer that starts with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the name of the customer that starts with the specified value.")>
Public Overridable Property NameStartsWith As String
'''<Summary>
'''Search by using the name of the customer that ends with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the name of the customer that ends with the specified value.")>
Public Overridable Property NameEndsWith As String
'''<Summary>
'''Search by using the name of the customer that contains the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the name of the customer that contains the specified value.")>
Public Overridable Property NameContains As String
'''<Summary>
'''The country of residence or headquarters of customer.
'''</Summary>
<ApiMember(Description:="The country of residence or headquarters of customer.")>
Public Overridable Property Country As String
'''<Summary>
'''Search by using the country of the customer that starts with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the country of the customer that starts with the specified value.")>
Public Overridable Property CountryStartsWith As String
'''<Summary>
'''Search by using the country of the customer that ends with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the country of the customer that ends with the specified value.")>
Public Overridable Property CountryEndsWith As String
'''<Summary>
'''Search by using the country of the customer that contains the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the country of the customer that contains the specified value.")>
Public Overridable Property CountryContains As String
'''<Summary>
'''The type of customer.
'''</Summary>
<ApiMember(Description:="The type of customer.")>
Public Overridable Property Type As Nullable(Of CustomerType)
'''<Summary>
'''Should related accounts be included in the retrieved customers?
'''</Summary>
<ApiMember(Description:="Should related accounts be included in the retrieved customers?")>
Public Overridable Property IncludeAccounts As Nullable(Of Boolean)
'''<Summary>
'''Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")>
Public Overridable Property SkipAccounts As Nullable(Of Integer)
'''<Summary>
'''Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")>
Public Overridable Property TakeAccounts 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 customers.
'''</Summary>
<Api(Description:="Specifies a service to search for customers.")>
Public Partial Class SearchCustomersBase
Inherits PaginationBase
Implements IGet
'''<Summary>
'''The unique identifier of the customer.
'''</Summary>
<ApiMember(Description:="The unique identifier of the customer.")>
Public Overridable Property CustomerId As Nullable(Of Integer)
'''<Summary>
'''The name of the customer.
'''</Summary>
<ApiMember(Description:="The name of the customer.")>
Public Overridable Property Name As String
'''<Summary>
'''Search by using the name of the customer that starts with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the name of the customer that starts with the specified value.")>
Public Overridable Property NameStartsWith As String
'''<Summary>
'''Search by using the name of the customer that ends with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the name of the customer that ends with the specified value.")>
Public Overridable Property NameEndsWith As String
'''<Summary>
'''Search by using the name of the customer that contains the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the name of the customer that contains the specified value.")>
Public Overridable Property NameContains As String
'''<Summary>
'''The country of residence or headquarters of customer.
'''</Summary>
<ApiMember(Description:="The country of residence or headquarters of customer.")>
Public Overridable Property Country As String
'''<Summary>
'''Search by using the country of the customer that starts with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the country of the customer that starts with the specified value.")>
Public Overridable Property CountryStartsWith As String
'''<Summary>
'''Search by using the country of the customer that ends with the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the country of the customer that ends with the specified value.")>
Public Overridable Property CountryEndsWith As String
'''<Summary>
'''Search by using the country of the customer that contains the specified value.
'''</Summary>
<ApiMember(Description:="Search by using the country of the customer that contains the specified value.")>
Public Overridable Property CountryContains As String
'''<Summary>
'''The type of customer.
'''</Summary>
<ApiMember(Description:="The type of customer.")>
Public Overridable Property Type As Nullable(Of CustomerType)
'''<Summary>
'''Should related accounts be included in the retrieved customers?
'''</Summary>
<ApiMember(Description:="Should related accounts be included in the retrieved customers?")>
Public Overridable Property IncludeAccounts As Nullable(Of Boolean)
'''<Summary>
'''Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")>
Public Overridable Property SkipAccounts As Nullable(Of Integer)
'''<Summary>
'''Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true.
'''</Summary>
<ApiMember(Description:="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")>
Public Overridable Property TakeAccounts 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 customers.
'''</Summary>
<Api(Description:="Represents a query response that contains a structured error information and encapsulates customers.")>
Public Partial Class CustomerQueryResponse
Inherits QueryResponse(Of Customer)
Public Sub New()
Results = New List(Of Customer)
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 Customer)
<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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/customers/search HTTP/1.1 Host: taxfiling.pwc.de Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
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
}
}
]
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}