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 .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/accounts HTTP/1.1 Host: taxfiling.pwc.de Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv 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: 0001-01-01, responseTimestamp: 0001-01-01, requestUri: String, requestHttpMethod: String, requestDuration: PT0S, responseStatusCode: Continue, clientIPAddress: String, unitOfMeasurement: String, processType: String, dataType: String, dataName: String, creationDate: 0001-01-01, expiryDate: 0001-01-01, 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: 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 } } }