Required role: | Admin | Required permission: | CanAccess |
GET | /sync/accounts |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IncludeProducts | query | bool? | No | Should the related products of the accounts be included in the retrieved results? |
IncludeOrders | query | bool? | No | Should the related orders of the accounts be included in the retrieved results? |
SkipProducts | query | int? | No | Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. |
TakeProducts | query | int? | No | Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. |
SkipOrders | query | int? | No | Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. |
TakeOrders | query | int? | No | Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. |
Skip | query | int? | No | The number of query results to skip. |
Take | query | int? | No | The number of query results to include. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IncludeProducts | form | bool? | No | Should the related products of the accounts be included in the retrieved results? |
IncludeOrders | form | bool? | No | Should the related orders of the accounts be included in the retrieved results? |
SkipProducts | form | int? | No | Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. |
TakeProducts | form | int? | No | Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. |
SkipOrders | form | int? | No | Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. |
TakeOrders | form | int? | No | Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. |
Skip | form | int? | No | The number of query results to skip. |
Take | form | int? | No | The number of query results to include. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | The number of query results to skip. |
Take | form | int? | No | The number of query results to include. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductsMap | form | Dictionary<int, List<Product>> | Yes | The dictionary of products associated to found user accounts. |
OrdersMap | form | Dictionary<int, List<Order>> | Yes | The dictionary of orders associated with each found user account. |
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<Account> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | Yes | The unique identifier of the user account. |
Index | form | int | Yes | The position of this instance in a collection of 'Account' instances |
RefId | form | int? | Yes | The unique identifier of the customer associated with this account. |
RefIdStr | form | string | No | The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'. |
UserName | form | string | Yes | The unique user name of the user account. |
form | string | No | The electronic mail address of the user account. | |
DisplayName | form | string | No | The friendly name of the user account. |
FirstName | form | string | No | The first name of the owner (natural person) of the user account. |
LastName | form | string | No | The last name of the owner (natural person) of the user account. |
FullName | form | string | No | The unique identifier of the customer associated with this account. |
Gender | form | string | No | The gender of the owner (natural person) of the user account. |
Language | form | string | No | The language of the owner of teh user account. |
Company | form | string | No | The company, where the user is an employee. |
ProfileUrl | form | string | Yes | The profile URL of the user account. |
Roles | form | List<string> | Yes | The roles assigned to the user account. |
Permissions | form | List<string> | Yes | The permissions assigned to the user account. |
PrimaryEmail | form | string | No | The primary e-mail address of the user. |
Salt | form | string | No | Random data to enhance the security of the user password. |
PasswordHash | form | string | No | The hash value of the user password that the PBKDF2 algorithm produces. |
DigestHa1Hash | form | string | No | The hash value of the user password that the DigestHa1 algorithm produces. |
InvalidLoginAttempts | form | int | No | The number of times the user account tried to sign in but failed. |
LastLoginAttempt | form | DateTime? | No | The last time the user account attempted a sign in. |
LockedDate | form | DateTime? | No | The date and time when the user acount was denied access. |
CreatedDate | form | DateTime | No | The date and time when the user account was created. |
ModifiedDate | form | DateTime | No | The date and time when the user account was last modified. |
PhoneNumber | form | string | No | The telephone number of the owner of the user account. |
BirthDate | form | DateTime? | No | The birth date of the owner of the user account |
BirthDateRaw | form | string | No | The string representation of the birth date of the user account. |
Address | form | string | No | The mail address of the user account. |
Address2 | form | string | No | Additional information for the specified 'Address' of the user. |
City | form | string | No | The city of the owner of the user account. |
State | form | string | No | The state of the owner of the user account. |
Country | form | string | No | The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'. |
Culture | form | string | No | The locale of the user account. |
MailAddress | form | string | No | The mail address of the user account. |
Nickname | form | string | No | The nickname of the user of the user account. |
PostalCode | form | string | No | The postal code of the user account. |
TimeZone | form | string | No | The time zone of the user of the user account. |
Meta | form | Dictionary<string, string> | No | Additional information to attach to the user account. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/accounts HTTP/1.1 Host: taxfiling.pwc.de Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AccountQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses"> <Offset xmlns="http://schemas.servicestack.net/types">0</Offset> <Total xmlns="http://schemas.servicestack.net/types">0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models" xmlns="http://schemas.servicestack.net/types"> <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> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus xmlns="http://schemas.servicestack.net/types"> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> <OrdersMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfintArrayOfOrderKY2vvLcG> <d2p1:Key>0</d2p1:Key> <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models"> <d4p1:Order> <d4p1:AccountId>0</d4p1:AccountId> <d4p1:ClientIPAddress>String</d4p1:ClientIPAddress> <d4p1:CreationDate>0001-01-01T00:00:00</d4p1:CreationDate> <d4p1:DataName>String</d4p1:DataName> <d4p1:DataType>String</d4p1:DataType> <d4p1:ExpiryDate>0001-01-01T00:00:00</d4p1:ExpiryDate> <d4p1:Id>0</d4p1:Id> <d4p1:IsTest>false</d4p1:IsTest> <d4p1:Name>String</d4p1:Name> <d4p1:ProcessType>String</d4p1:ProcessType> <d4p1:ProductId>0</d4p1:ProductId> <d4p1:RequestDuration>PT0S</d4p1:RequestDuration> <d4p1:RequestHttpMethod>String</d4p1:RequestHttpMethod> <d4p1:RequestTimestamp>0001-01-01T00:00:00</d4p1:RequestTimestamp> <d4p1:RequestUri>String</d4p1:RequestUri> <d4p1:ResponseStatusCode>Continue</d4p1:ResponseStatusCode> <d4p1:ResponseTimestamp>0001-01-01T00:00:00</d4p1:ResponseTimestamp> <d4p1:ServiceName>String</d4p1:ServiceName> <d4p1:UnitOfMeasurement>String</d4p1:UnitOfMeasurement> </d4p1:Order> </d2p1:Value> </d2p1:KeyValueOfintArrayOfOrderKY2vvLcG> </OrdersMap> <ProductsMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfintArrayOfProductKY2vvLcG> <d2p1:Key>0</d2p1:Key> <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models"> <d4p1:Product> <d4p1:Description>String</d4p1:Description> <d4p1:Id>0</d4p1:Id> <d4p1:Index>0</d4p1:Index> <d4p1:Name>String</d4p1:Name> <d4p1:Tags> <d2p1:string>String</d2p1:string> </d4p1:Tags> <d4p1:Version>String</d4p1:Version> </d4p1:Product> </d2p1:Value> </d2p1:KeyValueOfintArrayOfProductKY2vvLcG> </ProductsMap> </AccountQueryResponse>