Antud teenus võimaldab Partneril luua kontot ARHIVAAR PRO süsteemis. On olemas kaks ainulaadset kontotüüpi: füüsiline isik ja firma.
https://api.arhivaar.ee/partner-api/account/create.html
Parameeter | Tüüp | Kirjeldus |
---|---|---|
registrationType | Kohustuslik. String. | Registreerimise tüüp. Sobiv väärtus: USER - füüsiline isik COMPANY - firma |
regNo | Vabatahtlik. String. | Firma registrikood. See parameeter peab olema määratud ainult juhul kui luuakse konto registreerimise tüübiga COMPANY. Selle parameetri pikkus peab olema 8 numbrimärki. |
personalCode | Vabatahtlik. String. | Füüsilise isiku isikukood. See parameeter peab olema määratud ainult juhul kui luuakse konto registreerimise tüübiga USER. Selle parameetri pikkus peab olema 11 numbrimärki. |
name | Kohustuslik. String. | Registreerimise tüübi USER puhul peab selle parameetri väärtus olema füüsilise isiku nimi (ees- ja perekonnanimi, eraldatud ühe tühikuga). Firma konto puhul peab selle parameetri väärtus olema organisatsiooni nimi. Selle parameetri pikkus peab olema vähemalt 2 tähemärki ja ei tohi olla suurem kui 150 tähemärki. |
address | Kohustuslik. String. | Firma või füüsilise isiku aadress, olenevalt registreerimise tüübist. Selle parameetri pikkus peab olema vähemalt 4 tähemärki ja ei tohi olla suurem kui 200 tähemärki. |
contactEmail | Kohustuslik. String. | Firma või füüsilise isiku e-maili aadress, olenevalt registreerimise tüübist. Selle parameetri pikkus peab olema vähemalt 5 tähemärki ja ei tohi olla suurem kui 100 tähemärki. |
phone | Kohustuslik. String. | Firma või füüsilise isiku telefoninumber, olenevalt registreerimise tüübist. Selle parameetri pikkus peab olema vähemalt 4 tähemärki ja ei tohi olla suurem kui 30 tähemärki. Telefoninumber peab vastama järgnevale regulaaravaldisele: (\+|\d)(\d| |-)* |
fax | Vabatahtlik. String. | Firma või füüsilise isiku faksinumber, olenevalt registreerimise tüübist. Selle parameetri pikkus peab olema vähemalt 4 tähemärki ja ei tohi olla suurem kui 30 tähemärki. Faksinumber peab vastama järgnevale regulaaravaldisele: (\+|\d)(\d| |-)* |
service | Kohustuslik. Integer. | Lehekülgede arv mis peab olema konto paketil, näiteks 9000 . Eelmääratud pakettide saamiseks võib kasutada Pakettide loetelu teenust. On võimalik valida ka lehekülgede arv mis ei ole eelmääratud pakettide hulgas, see arv peab olema vähemalt 10000 või suurem. |
county | Kohustuslik. Short. | Firma või füüsilise isiku piirkond, olenevalt registreerimise tüübist. Peab olema üks alljärgnevatest väärtustest: 1 - Harjumaa 2 - Hiiumaa 3 - Ida-Virumaa 4 - Jõgevamaa 5 - Järvamaa 6 - Läänemaa 7 - Lääne-Virumaa 8 - Põlvamaa 9 - Pärnumaa 10 - Raplamaa 11 - Saaremaa 12 - Tartumaa 13 - Valgamaa 14 - Viljandimaa 15 - Võrumaa |
city | Kohustuslik. String. | Firma või füüsilise isiku linn, olenevalt registreerimise tüübist. Selle parameetri pikkus peab olema vähemalt 2 tähemärki ja ei tohi olla suurem kui 100 tähemärki. |
zipCode | Kohustuslik. String. | Firma või füüsilise isiku postiindeks, olenevalt registreerimise tüübist. Selle parameetri pikkus peab olema vähemalt 2 tähemärki ja ei tohi olla suurem kui 20 tähemärki. |
administratorPersonalCode | Kohustuslik. String. | Konto administraatori isikukood. Registreerimise tüübi USER puhul peab parameetrite personalCode ja administratorPersonalCode väärtus olema samasugune. Selle parameetri pikkus peab olema 11 numbrimärki. |
Väli | Tüüp | Kirjeldus |
---|---|---|
response | String. | Väärtus OK või ERROR. |
responseDescription | Error. | Sisaldab ühte veakoodi, vaadake allpool. See väli on tagastatud ainult juhul, kui päringu tegemisel tekkis viga, st response väli sisaldab väärtust ERROR. |
cliendId | String. | Kodeeritud konto ID. |
Nimetus | Kirjeldus |
---|---|
INVALID_REGISTRATION_TYPE | Parameetrile registrationType on omistatud vigane väärtus või see puudub. |
INVALID_REG_NO | Parameetrile regNo on omistatud vigane väärtus või see puudub. |
REG_NO_EXISTS | Parameetrile regNo vastav konto on juba olemas. |
INVALID_PERSONAL_CODE | Parameetrile personalCode on omistatud vigane väärtus või see puudub. |
PERSONAL_CODE_EXISTS | Parameetrile personalCode vastav konto on juba olemas. |
INVALID_NAME | Parameetrile name on omistatud vigane väärtus või see puudub. |
INVALID_ADDRESS | Parameetrile address on omistatud vigane väärtus või see puudub. |
INVALID_CONTACT_EMAIL | Parameetrile contactEmail on omistatud vigane väärtus või see puudub. |
INVALID_PHONE | Parameetrile phone on omistatud vigane väärtus või see puudub. |
INVALID_FAX | Parameetrile fax on omistatud vigane väärtus. |
INVALID_SERVICE | Parameetrile service on omistatud vigane väärtus või see puudub. |
INVALID_COUNTY | Parameetrile county on omistatud vigane väärtus või see puudub. |
INVALID_CITY | Parameetrile city on omistatud vigane väärtus või see puudub. |
INVALID_ZIP_CODE | Parameetrile zipCode on omistatud vigane väärtus või see puudub. |
INVALID_ADMINISTRATOR | Parameetrile administratorPersonalCode on omistatud vigane väärtus või see puudub. |
Antud päring loob konto registreerimise tüübiga COMPANY. Päring kasutab järgnevaid parameetreid:
Parameeter | Väärtus |
---|---|
registrationType | COMPANY |
regNo | 11709925 |
name | Eesti Arhivaar |
address | Lõõtsa 2b |
contactEmail | arhivaar@arhivaar.ee |
phone | +3726400400 |
fax | +3726400401 |
service | 8000 |
county | 1 |
city | Tallinn |
zipCode | 11415 |
administratorPersonalCode | 37101010021 |
POST /partner-api/account/create.html HTTP/1.1 Content-Length: 314 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 Host: api.arhivaar.ee User-Agent: Test Client registrationType=COMPANY®No=11709925&name=Eesti+Arhivaar&address=L%C3%B5%C3%B5tsa+2b&contactEmail=arhivaar%40arhivaar.ee&phone=%2B3726400400&fax=%2B3726400401&service=8000&county=1&city=Tallinn&zipCode=11415&administratorPersonalCode=37101010021&acc_key=ynatubqr9fmlxu618kwc&sig=ZRlw%2Fx5eVJskVUd2vaAQ3G7lW60%3D
See on vastus mille server saadab eelnevale päringule.
HTTP/1.1 200 OK Date: Sat, 01 Jan 2011 14:56:08 GMT Server: Apache Cache-Control: no-store,max-age=0,must-revalidate Expires: 0 Content-Length: 55 Content-Type: application/json;charset=UTF-8 {"clientId":"6475736574794c4e2f594d3d","response":"OK"}
Antud päring loob konto registreerimise tüübiga USER. Päring kasutab järgnevaid parameetreid:
Parameeter | Väärtus |
---|---|
registrationType | USER |
personalCode | 37101010021 |
name | Test user |
address | Test address 1 |
contactEmail | tester@arhivaar.ee |
phone | +37259998586 |
fax | +37259998587 |
service | 1000 |
county | 15 |
city | Võru |
zipCode | 74563 |
administratorPersonalCode | 37101010021 |
POST /partner-api/account/create.html HTTP/1.1 Content-Length: 314 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 Host: api.arhivaar.ee User-Agent: Test Client registrationType=USER&personalCode=37101010021&name=Test+user&address=Test+address+1&contactEmail=tester%40arhivaar.ee&phone=%2B37259998586&fax=%2B37259998587&service=1000&county=15&city=V%C3%B5ru&zipCode=74563&administratorPersonalCode=37101010021&acc_key=ynatubqr9fmlxu618kwc&sig=cJLuF%2FjVXVqe7B5EIogAQ0sfYK4%3D
See on vastus mille server saadab eelnevale päringule.
HTTP/1.1 200 OK Date: Sat, 01 Jan 2011 07:33:11 GMT Server: Apache Cache-Control: no-store,max-age=0,must-revalidate Expires: 0 Content-Length: 55 Content-Type: application/json;charset=UTF-8 {"clientId":"796d6d51786c4a57487a493d","response":"OK"}