Users Creation
Allows to create users in the system.
URL: /admin/adnet/pub/admin/usuarios.html?op=a&o=xml
Mandatory parameters:
- Site Type
◦ Parameter: t
◦ Possible values:
- Client user: if the client is a network - 128, if it`s a site - 8 and if it`s an agency - 16
- External Network: 512
- Agency: 1.
- Advertiser: 4
- Self-service Advertiser: 1024
- Owned Site: 64
- External Site: 2
- Site`s ID (only if option 2 or 7 were selected in the previous point).
◦ Parameter: sitio_id_TIPO (where TIPO must be replaced with the parameter value t from the previous point).
◦ Possible values: The correspondent IDs to the selected Site Type. For example: if in the previous point Advertiser was selected, the name of the parameter would be sitio_id_4 and it`s value would be the advertiser`s ID.
- Name.
◦ Parameter: nombre
◦ Value: characters chain
- Last Name.
◦ Parameter: last name
◦ Value: characters chain
- Login.
◦ Parameter: login
◦ Value: characters chain. The login must be unique for every user in the interface.
- Password
◦ Parameter: password
◦ Value: characters chain (it must contain numbers and letters)
- Password (confirmation)
◦ Parameter: password2
◦ Value: It must have the same content as the parameter password.
◦ Parameter: email
◦ Value: A valid email address
- Grants
◦ Parameter: nivel_permisos
◦ Possible values: 0 for minimal permissions, 1 for all possible permissions. Both (minimal and all) are determined by the user`s profile (advertiser, agency,etc).
- Send welcome e-mail
◦ Parameter: enviar_mail_bienvenida
◦ Possible values:
- No: 0
- Login and password: 1
- Customer care info: 2
- Login, password and customer care info: 3
- Preferences
◦ Parameter: preferencias_default
◦ Possible values: 1 (It considers the default preferences in the account)
Optional parameters
- Instant messenger
◦ Parameter: instant_messenger
◦ Value: instant messenger software user name.
- Cellphone
◦ Parameter: celular
◦ Value: cellphone number
- Phone
◦ Parameter: telefono
◦ Value: phone number
- Custom id
◦ Parameter: custom_id
◦ Mandatory: if it`s established in the account`s Global Preferences.
◦ Value: It`s a customized identifier in an external system. It can be alphanumeric.
- Comments
◦ Parameter: observaciones
◦ Value: Free text field for comments about the user.
- Campaign Groups
◦ Parameter: gpauta_id
◦ Possible values: Select the campaign groups (ids) users will be able to access reports from.
- Allowed access IP addresses
◦ Parameter: redes_permitidas
◦ Value: Enter a list of IP addresses from which interface access is allowed. Enter one IP address per line or leave the field blank to allow access from any IP address. Use aaa.bbb.ccc.ddd/nnn.nnn.nnn.nnn format for entering network blocks.
User Preferences:
When creating a user it´s possible to indicate their preferences: language, number and date format,etc. It´s possible to indicate the value for each individual preference or the default values can be taken if it´s indicated.
If the default values are needed, the parameter preferencias_default=1 must be used in the request. Nevertheless, if a value has to be indicated in particular, this has to be made for all the preferences. It´s not possible to combine the 2 mechanisms at the same time (default values and specific values).
The preferences and their possible values are the following:
- Language
◦ Parameter: usuario_preferencia_1
◦ Possible values: ar (arabic), bg (bulgarian), ca (catalá), de (deutsch), en (english), es (spanish), pt (portuguese), ru (russian).
◦ Default valuet: es (spanish).
- Date format
◦ Parameter: usuario_preferencia_3
◦ Possible values: 1 (dd/mm/aaaa), 2 (mm/dd/aaaa), 3 (arabic).
◦ Default format: 1 (dd/mm/aaaa).
- Number format
◦ Parameter: usuario_preferencia_4
◦ Possible values: 1 (x.xxx.xxx,yy), 2 (x,xxx,xxx.yy), 3 (arabic).
◦ Default value: 1 (x.xxx.xxx,yy).
- Number of rows for Reports
◦ Parameter: usuario_preferencia_6
◦ Possible values: 10, 30, 50, 100, 200, 500, 1000, 2000, 5000, 10000
◦ Default value: 30
- Number of rows for Lists
◦ Parameter: usuario_preferencia_7
◦ Possible values: 10, 30, 50, 100
◦ Default value: 30
- Animated charts
◦ Parameter: usuario_preferencia_8
◦ Possible values: (yes), 1 (no)
◦ Default value: 1 (no)
- Add ad: show ad format warnings
◦ Parameter: usuario_preferencia_9
◦ Possible values: (yes), 1 (no)
◦ Default value: 1 (no)
- Link URL validation
◦ Parameter: usuario_preferencia_12
◦ Possible values: (off), 1 (on)
◦ Default value: 1 (on)
- When adding ads, automatically select spaces
◦ Parameter: usuario_preferencia_13
◦ Possible values: (never), 1 (always), 2 (Only when there is only one space)
◦ Default value:2 (Only when there is only one space)
- Show begin and and end dates in ad lists
◦ Parameter: usuario_preferencia_14
◦ Possible values: (yes), 1 (no)
◦ Default value: 1 (no)
- Receive an e-mail notification about the service
◦ Parameter: usuario_preferencia_15
◦ Possible values: (yes), 1 (no)
◦ Default value: 1 (no)
- In the list of campaigns, show the id of the campaign next to the name
◦ Parameter: usuario_preferencia_18
◦ Possible values: (yes), 1 (no)
◦ Default value: 1 (no)
- Campaign list: show a filter by ad size
◦ Parameter: usuario_preferencia_21
◦ Possible values: (yes), 1 (no)
◦ Default value: 1 (no)
- Richmedia - Show the RM tag in the list (it makes the page to take longer to load)
◦ Parameter: usuario_preferencia_22
◦ Possible values: (yes), 1 (no)
◦ Default value: 1 (no)
- Interface visualization
◦ Parameter: usuario_preferencia_24
◦ Possible values: (traditional), 1 (new version)
◦ Default value: 0 (traditional)
- Use trafficker as dashboard filter
◦ Parameter: usuario_preferencia_25
◦ Possible values: (yes), 1 (no)
◦ Default value: 1 (no)
- E-mail reports format
◦ Parameter: usuario_preferencia_26
◦ Possible values: csv (CSV format), xslx (Excel format - excel 2007+)
◦ Default values: csv (CSV format)
Examples of URLs with parameters:
https://admin.eu.e-planning.net/admin/adnet/pub/admin/usuarios.html?op=a&o=xml&t=128&nombre=user&apellido=api&login=apilog&password=138gfh4&password2=138gfh4&email=sborneoepl@gmail.com&nivel_permisos=1&enviar_mail_bienvenida=0&preferencias_default=1
Response
It contains an object <operacion> that contains a tag <resultado>. The result could be either 1 (successful operation) or 0 (failed operation).If the operation is unsuccessful, it adds a list of errors through tags <error>, containing the attribute that specifies the attribute's name with error, and message with the error message.
Response example without errors
<operacion> <resultado>1</resultado> <identificador>1390</identificador> </operacion> |
Response example with errors
<operacion> <resultado>0</resultado> <errores> <error atributo='login' mensaje='Ya existe otro usuario con el mismo login'/> </errores> </operacion> |