Group
You can query a list of group (e.g. i an storelocator mobile application) and you'll retrieve a list of object as describe below. But all the business object of Adelya pertain to a group. For security reason and in order not to overload the returned dataset, a small subset of those properties are returned. See below.
id
Adelya Internal object ID - no insert/no update
Alphanumeric (even if yet just number are in), it's the table primary key, returned on persist or use for fast look-up
idExternal
Your reference
Alpha
127 characters max
codeGroup
A String code used in URL for this group
must be unique
32 characters max, only A-Za-z0-9 stricter than RFC 3986
descrGroup
A title
text
255 characters max
type
type
E, G, or M : E for a root node of an organization (HQ e.g.), G for an intermediate Node, M for a leaf node (Shop), default is M
1 characters max
dateCreate
creation date of this object
datetime
dateUpdate
when was the last update of this object
datetime
dateValidUntil
until this date this account is valid (can be null = never ending)
date
archive
is this account archive ? When an account is flagged as archive, it means it is ready for deletion.
boolean
companyName
legal name
text
127 characters max
salesDescr
commercial name (used for display and emails sender name)
text
127 characters max
shortSalesDescr
shot commercial name (used also for Sms)
10 characters max
companyRegNumber
text
127 characters max
manager
email of the default contact
according to rfc
255 characters max
sharingMember
can I logas in this account (default is true)
boolean (not updatable)
criteria
10 additional fields
See below
address
see: Address
billingAddress
see: Address
email
according to rfc
255 characters max
tel
according to E164 from ITU
30 characters max
tel2
according to E164 from ITU
30 characters max
mobile
according to E164 from ITU
255 characters max
webSite
url according to rfc
255 characters max
copyright
used legal notices (for example in w2s)
255 characters max
socialUrls
subobject : see socialUrls
group
the father group.
Group object
managementType
describe the relation with the father group. an INDEPENDENT will be isolated from is father account
String in BRANCH, INDEPENDENT, FRANCHISEE, ASSOCIATION, UNKNOWN. Default value is UNKNOWN
255 characters max
companyBrief
long description for the shop
text
openingHours
Alpha
255 characters max
defaultCurrency
(default is EUR)
3 chars ISO code
3 characters max
defaultLanguage
(default is FR)
2 chars ISO code
2 characters max
defaultImage
URL default image
url according to rfc
512 characters max
defaultTZ
TZ id, default : Europe/Paris
255 characters max
tags
free entered tags
text with separator (space or comma)
255 characters max
services
list of services
text with separator (space or comma)
255 characters max
legalFileDeclarationNumber
customer file declaration number
Alpha
50 characters max
SocialUrls
a subobject that group the mains social urls of a Group
facebook
FB url
url according to rfc
255 characters max
Youtube
Youtube url
url according to rfc
255 characters max
twitter
TW url
url according to rfc
255 characters max
instagram
instagram url
url according to rfc
255 characters max
linkedIn
linkedIn url
url according to rfc
255 characters max
other
free entry url
url according to rfc
255 characters max
Criteria
Depending on your customization, a Group may have additionnal information. This information is stored in criteria, there is 10 numeric and 10 alphanumeric criteria available
cc1
Any data that do not fit in the std fields
alpha
255 characters max
cc2
alpha
255 characters max
cc3
alpha
255 characters max
cc4
alpha
255 characters max
cc5
alpha
255 characters max
cc6
alpha
255 characters max
cc7
alpha
255 characters max
cc8
alpha
255 characters max
cc9
alpha
255 characters max
cc10
alpha
255 characters max
cc11
alpha
255 characters max
cc12
alpha
255 characters max
cc13
alpha
255 characters max
cc14
alpha
255 characters max
cc15
alpha
255 characters max
cn1
numeric field, used also for int, boolean
double
cn2
double
cn3
double
cn4
double
cn5
double
cn6
double
cn7
double
cn8
double
cn9
double
cn10
double
cn11
double
cn12
double
cn13
double
cn14
double
cn15
double
cd1
Date field
date
cd2
date
cd3
date
cd4
date
cd5
date
cd6
date
cd7
date
cd8
date
cd9
date
cd10
date
cd11
date
cd12
date
cd13
date
cd14
date
cd15
date
Example
Creating a new independent sub account
{
Group:{
"codeGroup":"TESTAPI2",
"descrGroup":"Test API creation",
"idExternal":"my_account_ref",
"type":"M",
"managementType":"INDEPENDENT",
"socialUrls" : {
"facebook":"https://www.facebook.com/matestpage"
}
}
}
Group as a property of an Object
id
Adelya Internal object ID
Alphanumeric (even if yet just number are in), it's the table primary key, returned on persist or use for fast look-up
idExternal
Your reference
text
codeGroup
Our reference
text
salesDescr
commercial name (used for display and emails)
text
Example
discover Group information on an object
{
"AdEvent":{
"id":"63230648",
"type":"UPDATE",
"date":"2013-10-29 11:49:07",
"sparam":"",
"fvalue":"0.0",
"comment":"",
"member":"123082",
"user":"113222",
"group":{
"id":"9",
"codeGroup":"WWWADELYATEST",
"idExternal":"",
"salesDescr":"Adelya"
}
}
}