Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /async/customers |
|---|
namespace PwC.Metering.Core.Domain.Concretes.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type CustomerType =
| Internal = 0
| Network = 1
| External = 2
///<summary>
///Represents a user account.
///</summary>
[<Api(Description="Represents a user account.")>]
[<AllowNullLiteral>]
type Account() =
///<summary>
///The unique identifier of the user account.
///</summary>
[<ApiMember(Description="The unique identifier of the user account.", IsRequired=true)>]
member val Id:Int32 = new Int32() with get,set
///<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)>]
member val Index:Int32 = new Int32() with get,set
///<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)>]
member val RefId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<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'.")>]
member val RefIdStr:String = null with get,set
///<summary>
///The unique user name of the user account.
///</summary>
[<ApiMember(Description="The unique user name of the user account.", IsRequired=true)>]
member val UserName:String = null with get,set
///<summary>
///The electronic mail address of the user account.
///</summary>
[<ApiMember(Description="The electronic mail address of the user account.")>]
member val Email:String = null with get,set
///<summary>
///The friendly name of the user account.
///</summary>
[<ApiMember(Description="The friendly name of the user account.")>]
member val DisplayName:String = null with get,set
///<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.")>]
member val FirstName:String = null with get,set
///<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.")>]
member val LastName:String = null with get,set
///<summary>
///The unique identifier of the customer associated with this account.
///</summary>
[<ApiMember(Description="The unique identifier of the customer associated with this account.")>]
member val FullName:String = null with get,set
///<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.")>]
member val Gender:String = null with get,set
///<summary>
///The language of the owner of teh user account.
///</summary>
[<ApiMember(Description="The language of the owner of teh user account.")>]
member val Language:String = null with get,set
///<summary>
///The company, where the user is an employee.
///</summary>
[<ApiMember(Description="The company, where the user is an employee.")>]
member val Company:String = null with get,set
///<summary>
///The profile URL of the user account.
///</summary>
[<ApiMember(Description="The profile URL of the user account.", IsRequired=true)>]
member val ProfileUrl:String = null with get,set
///<summary>
///The roles assigned to the user account.
///</summary>
[<ApiMember(Description="The roles assigned to the user account.")>]
member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///The permissions assigned to the user account.
///</summary>
[<ApiMember(Description="The permissions assigned to the user account.")>]
member val Permissions:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///The primary e-mail address of the user.
///</summary>
[<ApiMember(Description="The primary e-mail address of the user.")>]
member val PrimaryEmail:String = null with get,set
///<summary>
///Random data to enhance the security of the user password.
///</summary>
[<ApiMember(Description="Random data to enhance the security of the user password.")>]
member val Salt:String = null with get,set
///<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.")>]
member val PasswordHash:String = null with get,set
///<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.")>]
member val DigestHa1Hash:String = null with get,set
///<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.")>]
member val InvalidLoginAttempts:Int32 = new Int32() with get,set
///<summary>
///The last time the user account attempted a sign in.
///</summary>
[<ApiMember(Description="The last time the user account attempted a sign in.")>]
member val LastLoginAttempt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<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.")>]
member val LockedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///The date and time when the user account was created.
///</summary>
[<ApiMember(Description="The date and time when the user account was created.")>]
member val CreatedDate:DateTime = new DateTime() with get,set
///<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.")>]
member val ModifiedDate:DateTime = new DateTime() with get,set
///<summary>
///The telephone number of the owner of the user account.
///</summary>
[<ApiMember(Description="The telephone number of the owner of the user account.")>]
member val PhoneNumber:String = null with get,set
///<summary>
///The birth date of the owner of the user account
///</summary>
[<ApiMember(Description="The birth date of the owner of the user account")>]
member val BirthDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<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.")>]
member val BirthDateRaw:String = null with get,set
///<summary>
///The mail address of the user account.
///</summary>
[<ApiMember(Description="The mail address of the user account.")>]
member val Address:String = null with get,set
///<summary>
///Additional information for the specified 'Address' of the user.
///</summary>
[<ApiMember(Description="Additional information for the specified 'Address' of the user.")>]
member val Address2:String = null with get,set
///<summary>
///The city of the owner of the user account.
///</summary>
[<ApiMember(Description="The city of the owner of the user account.")>]
member val City:String = null with get,set
///<summary>
///The state of the owner of the user account.
///</summary>
[<ApiMember(Description="The state of the owner of the user account.")>]
member val State:String = null with get,set
///<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'.")>]
member val Country:String = null with get,set
///<summary>
///The locale of the user account.
///</summary>
[<ApiMember(Description="The locale of the user account.")>]
member val Culture:String = null with get,set
///<summary>
///The mail address of the user account.
///</summary>
[<ApiMember(Description="The mail address of the user account.")>]
member val MailAddress:String = null with get,set
///<summary>
///The nickname of the user of the user account.
///</summary>
[<ApiMember(Description="The nickname of the user of the user account.")>]
member val Nickname:String = null with get,set
///<summary>
///The postal code of the user account.
///</summary>
[<ApiMember(Description="The postal code of the user account.")>]
member val PostalCode:String = null with get,set
///<summary>
///The time zone of the user of the user account.
///</summary>
[<ApiMember(Description="The time zone of the user of the user account.")>]
member val TimeZone:String = null with get,set
///<summary>
///Additional information to attach to the user account.
///</summary>
[<ApiMember(Description="Additional information to attach to the user account.")>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
///<summary>
///Represents a customer (business organization or entrepreneur).
///</summary>
[<Api(Description="Represents a customer (business organization or entrepreneur).")>]
[<AllowNullLiteral>]
type Customer() =
///<summary>
///The unique identifier of the customer.
///</summary>
[<ApiMember(Description="The unique identifier of the customer.", IsRequired=true)>]
member val Id:Int32 = new Int32() with get,set
///<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)>]
member val Index:Int32 = new Int32() with get,set
///<summary>
///Full name or organization name of customer.
///</summary>
[<ApiMember(Description="Full name or organization name of customer.", IsRequired=true)>]
[<Validate(Validator="NotEmpty")>]
member val Name:String = null with get,set
///<summary>
///The country of residence or business of customer.
///</summary>
[<ApiMember(Description="The country of residence or business of customer.")>]
member val Country:String = null with get,set
///<summary>
///The type of customer.
///</summary>
[<ApiMember(Description="The type of customer.")>]
member val Type:CustomerType = new CustomerType() with get,set
///<summary>
///The list of user accounts associated with this customer.
///</summary>
[<ApiMember(Description="The list of user accounts associated with this customer.")>]
[<Ignore>]
member val Accounts:ResizeArray<Account> = new ResizeArray<Account>() with get,set
///<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.")>]
[<AllowNullLiteral>]
type CustomerQueryResponse() =
inherit QueryResponse<Customer>()
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<Customer> = new ResizeArray<Customer>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///The number of query results to skip.
///</summary>
[<Api(Description="The number of query results to skip.")>]
[<AllowNullLiteral>]
type PaginationBase() =
///<summary>
///The number of query results to skip.
///</summary>
[<ApiMember(Description="The number of query results to skip.")>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to include.
///</summary>
[<ApiMember(Description="The number of query results to include.")>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Specifies a service to search for customers.
///</summary>
[<Api(Description="Specifies a service to search for customers.")>]
[<AllowNullLiteral>]
type RetrieveAllCustomersBase() =
inherit PaginationBase()
interface IGet
///<summary>
///Should related accounts be included in the retrieved customers?
///</summary>
[<ApiMember(Description="Should related accounts be included in the retrieved customers?")>]
member val IncludeAccounts:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<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. ")>]
member val SkipAccounts:Nullable<Int32> = new Nullable<Int32>() with get,set
///<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. ")>]
member val TakeAccounts:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to skip.
///</summary>
[<ApiMember(Description="The number of query results to skip.")>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to include.
///</summary>
[<ApiMember(Description="The number of query results to include.")>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Represents a service request to retrieve all customers in an asynchronous operation.
///</summary>
[<Api(Description="Represents a service request to retrieve all customers in an asynchronous operation.")>]
[<AllowNullLiteral>]
type RetrieveAllCustomersAsync() =
inherit RetrieveAllCustomersBase()
///<summary>
///Should related accounts be included in the retrieved customers?
///</summary>
[<ApiMember(Description="Should related accounts be included in the retrieved customers?")>]
member val IncludeAccounts:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<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. ")>]
member val SkipAccounts:Nullable<Int32> = new Nullable<Int32>() with get,set
///<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. ")>]
member val TakeAccounts:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to skip.
///</summary>
[<ApiMember(Description="The number of query results to skip.")>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to include.
///</summary>
[<ApiMember(Description="The number of query results to include.")>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<T>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<T> = new ResizeArray<T>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
F# RetrieveAllCustomersAsync 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.
GET /async/customers 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
}
}
}