Hvordan fungerer &frankly opplasting API og tjeneste

Endret Thu, 20 Mar ved 6:10 PM

Denne tjenesten og API-endepunktet gir kundene muligheter til å laste opp filer til &frankly for å gi bruker- og organisasjonsdata til oss for import til &frankly.


Det er noen alternativer med hensyn til hvilke fil- og filformater som kan brukes, les mer nedenfor i delen Ulike filformater.


Opplastingstjenesten er tilgjengelig som:


API (REST/HTTPS)

Sikker FTP (SFTP)

Vertsnavnet/base-URLen er den samme for begge endepunktene: upload.api.andfrankly.com 


Les mer her:&frankly upload API & service | API Reference 


Merk: Dette er ikke samme API som &frankly organisation API (&frankly organization API | API Reference) 


Filformat
Excel fil

Tips: Når du laster opp en Excel-fil kan du legge til brukerinformasjon og gruppeinformasjon i samme fil, men på forskjellige ark.


Krav og restriksjoner:


Overskriftslinjen (første rad) bør navngis nøyaktig slik den står under, ellers vil den kolonnen bli behandlet som et attributt i &frankly.

Hvis et felt er tomt, vil opplastings-APIet hoppe over denne verdien.

Støttede filutvidelser er: xls, xlsx

Koding må være UTF-8

 


Du finner en eksempelfil nederst i artikkelen


Feltbeskrivelser:


Sheet name = Users  

Header/Name/First row

Example value

Note

EmployeeID

E123456

Column & value mandatory, must be in column 1

FirstName

Testman

Column & value mandatory, must be in column 2

LastName

Foobar

Column & value mandatory, must be in column 3

Email

Testman.Foobar@com.co

Value optional (If there is a value for PhoneNumber) , Column mandatory (must be on column 4)

PhoneNumber

+00 1234 567

Value optional (if there is a value for Email).

Need to have the country code in beginning and correct number format for that country(+46 XXX XXXXXX)

IsManager

1

Optional. Provides role manager to this user. 

Department

DEP_001

Optional. Can be repeated if users should be member in more then one group. This is externalid on group. 

DepartmentName

Sales team

Optional. Can be repeated if users should be member in more then one group. This is name on group. Will not be used if Department is set. 

EmployeeManagerID

E654321

Optional. The externalid on the manager.This will add this user as manager on groups that this person is member of. 

EmployeeManagerName

foo barsson

Optional. The externalid on the manager.This will add this user as manager on groups that this person is member of. Will not be used if ManagerID is set.

Active

0

Optional. If empty it will leave user at is current state. Values: 1 / 0

Language

sv

Optional (BCP47)



Csv-brukerfil


Krav og restriksjoner:


  • Overskriftslinje (første rad) er navnet nøyaktig slik det står under, ellers vil den kolonnen bli håndtert som et attributt i &frankly.
  • Hvis et felt er tomt, vil opplastings-APIet hoppe over denne verdien.
  • Støttede formater er: csv-filer atskilt med; (semikolon) eller | (rør).
  • Koding må være UTF-8

Du finner en eksempelfil nederst i artikkelen


Header/Name/First row

Example value

Note

Employee ID

E123456

Column & value mandatory, must be in column 1

First Name

Testman

Column & value mandatory, must be in column 2

Last Name

Foobar

Column & value mandatory, must be in column 3

Email

Testman.Foobar@com.co

Value optional (If there is a value for PhoneNumber) , Column mandatory (must be on column 4)

PhoneNumber(Optional)

+00 1234 567

Value optional (if there is a value for Email).

Need to have the country code in the beginning and the correct number format for that country(+46 XXX XXXXXX)

IsManager

1

Optional. Provides role manager to this user. 

Group memberships

DEP_001

Optional. Can be repeated if users should be member in more then one group. This is OrgUnitID on group. 

Group Name

Sales team

Optional. It can be repeated if users should be members in more than one group. This is externalid on group. It will not be used if "Group memberships" is set.

Employee ManagerID

E654321

Optional. The Employee ID on the manager.This will add this user as manager on groups that this person is member of. 

Active

0

Optional. If empty it will leave user at is current state

Language

sv

Optional (BCP47)


Krav og restriksjoner:


  • Overskriftslinje (første rad) må være til stede for alle 5 kolonnene
  • Hvis et felt er tomt, vil opplastings-APIet hoppe over denne verdien.
  • Støttede formater er: csv-filer atskilt med; (semikolon) eller | (rør).
  • Koding må være UTF-8

Du finner en eksempelfil her nederst i artikkelen


Header/Name/First row (all mandatory)

Example value

Note

OrgUnitID

DEP_001

Column & value mandatory, must be in column 1

Name

HR

Column & value mandatory, must be in column 2

Description

HR Department

Column mandatory, value optional, must be in column 3

ResponsibleManager

E654321

Column mandatory, value optional, must be in column 4. 

The externalid on manager. This will add this user as manager on this group

ParentOrgUnit

DEP_002

Column mandatory, value optional, must be in column 5.

The OrgUnitID of the parent group (if not set will then be top/root group).


Var denne artikkelen nyttig?

Så bra!

Takk for din tilbakemelding

Beklager at vi ikke kunne være mer til hjelp

Takk for din tilbakemelding

Fortell oss hvordan vi kan forbedre denne artikkelen.

Velg minst én av grunnene
CAPTCHA-verifisering er obligatorisk.

Tilbakemeldingen er sendt inn

Vi setter pris på tilbakemeldingen din og vil prøve å rette på artikkelen