/Tenants
Description
Get a list of clients
Request
URI Parameters
Page
integer
Page number for paging | Default: 0
Items
integer
Sets the number of entries per page | Default: 10 | All: 0
SearchTerm
string
Filter for words
SearchIn
string
Properties in which to search. The separator between these properties is "|".
OrderBy
string
Properties to be sorted by. An exclamation mark ! at the end indicates downward sorting. To sort by several properties, they must be separated by a "|".
Filter
string
A filter can be defined to limit the result set. For example: (Property EQ Value OR Property2 GT Value2) AND (Property3 CT 'String') See the description for the FilterQueryLanguage for more information.
Body Parameters
None.
Response
Resource Description
AdditionalInformation
string
Required
Length: including between 0 and 80
Database field: [CLIENTPROGRAM].[ProgrammeVersion]
Company
string
Required
Length: including between 0 and 80
Database field: [CLIENT].[Company]
CurrencyThreeLetter
string
Required
Length: including between 0 and 3
Database field: [CLIENTPROGRAM].[ProgrammeVersion]
FirstName
string
Required
Length: including between 0 and 80
Database field: [CLIENT].[Firstname]
Kind
string
Required
Database field: [CLIENT].[ClientType]
LastName
string
Required
Length: including between 0 and 80
Database field: [CLIENT].[Name]
Name
string
Required
Length: including between 0 and 14
Database field: [CLIENT].[DatabaseName]
Salutation
string
Required
Length: including between 0 and 80
Database field: [CLIENT].[Salutation]
TenantCountry
string
Required
Length: including between 0 and 2
Database field: [CLIENT].[ClientCountry]
VersionNumber
string
Required
Length: including between 0 and 40
Database field: [CLIENTPROGRAM].[ProgrammeVersion]
Address
Read only
The detail address model of a client.
Contact
Read only
The detail contact model of a client.
Response Formats
application/json
Example:
[
{
"AdditionalInformation": "sample string 1",
"Company": "sample string 2",
"CurrencyThreeLetter": "sample string 3",
"FirstName": "sample string 4",
"Kind": "sample string 5",
"LastName": "sample string 6",
"Name": "sample string 7",
"Salutation": "sample string 8",
"TenantCountry": "sample string 9",
"VersionNumber": "sample string 10",
"Address": {
"City": null,
"CountryId": null,
"HouseNumber": null,
"Street": null,
"ZipCode": null
},
"Contact": {
"EMail": null,
"FaxNumber": null,
"HomePageUrl": null,
"TelephoneNumber": null
}
},
{
"AdditionalInformation": "sample string 1",
"Company": "sample string 2",
"CurrencyThreeLetter": "sample string 3",
"FirstName": "sample string 4",
"Kind": "sample string 5",
"LastName": "sample string 6",
"Name": "sample string 7",
"Salutation": "sample string 8",
"TenantCountry": "sample string 9",
"VersionNumber": "sample string 10",
"Address": {
"City": null,
"CountryId": null,
"HouseNumber": null,
"Street": null,
"ZipCode": null
},
"Contact": {
"EMail": null,
"FaxNumber": null,
"HomePageUrl": null,
"TelephoneNumber": null
}
}
]