Erinevused

Siin näed erinevusi valitud versiooni ja hetkel kehtiva lehekülje vahel.

partner_api:v0_4:create_account [13.09.2011 12:18]
admin [Errors]
partner_api:v0_4:create_account [20.10.2011 11:24] (Hetkel kehtiv)
admin [Example request]
Rida 1: Rida 1:
-===== Create account =====+===== Loo konto ===== 
 +Antud teenus võimaldab Partneril luua kontot ARHIVAAR PRO süsteemis. On olemas kaks ainulaadset kontotüüpi: füüsiline isik ja firma.
  
 <code> <code>
Rida 5: Rida 6:
 </code> </code>
  
-==== Request parameters ====+==== Päringu parameetrid ====
  
-Parameter Kind Notes +Parameeter Tüüp Kirjeldus 
-| registrationType \\ | **Required**. String. \\ | Possible values are USER or COMPANY | +| registrationType \\ | **Kohustuslik**. String. \\ | Registreerimise tüüp. Sobiv väärtus: \\ \\ **USER** - füüsiline isik \\ **COMPANY** - firma 
-| regNo \\ | Optional. String. \\ | Registration number of companyRequire for COMPANY registration type +| regNo \\ | Vabatahtlik. String. \\ | Firma registrikoodSee parameeter peab olema määratud ainult juhul kui luuakse konto registreerimise tüübiga **COMPANY**. \\ \\ Selle parameetri pikkus peab olema ''8'' numbrimärki. 
-| personalCode | Optional. String. \\ | Personal code for individual accountRequire for USER registration type +| personalCode | Vabatahtlik. String. \\ | Füüsilise isiku isikukoodSee parameeter peab olema määratud ainult juhul kui luuakse konto registreerimise tüübiga **USER**. \\ \\ Selle parameetri pikkus peab olema ''11'' numbrimärki. 
-| name  \\ | **Required**. String. \\ | Company name or person firstname and surname +| 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 \\ | **Required**. String. \\ | The address of the company or the person +| 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 \\ | **Required**. String. | The contact email of the company or the person +| 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 \\ | **Required**. String. \\ | The phone of the company or the person +| 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 \\ | Optional. String. \\ | The fax of the company or the person +| 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 | **Required**. Integer. \\ | Number of pages. | +| service | **Kohustuslik**. Integer. \\ | Lehekülgede arv mis peab olema konto paketil, näiteks ''9000''. Eelmääratud pakettide saamiseks võib kasutada [[partner_api:v0_4:list_packages|]] 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 \\ | **Required**. Short. \\ | The county of the company or the personPossible value 1 - Harjumaa2 - Hiiumaa;3 - Ida-Virumaa4 - Jõgevamaa5 - Järvamaa6 - Läänemaa7 - Lääne-Virumaa8 - Põlvamaa9 - Pärnumaa10 - Raplamaa11 - Saaremaa;  12 - Tartumaa13 - Valgamaa14 - Viljandimaa;  15 - Võrumaa | +| county \\ | **Kohustuslik**. Short. \\ | Firma või füüsilise isiku piirkond, olenevalt registreerimise tüübistPeab 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 \\ | **Required**. String. \\ | The city of the company or the person +| 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 \\ | **Required**. String. \\ | The zip code of the company or the person +| 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 \\ | **Required**. String. \\ | The administrator personal codeFor personal account parameters companyRegNo and administratorPersonalCode  should be equal |+| administratorPersonalCode \\ | **Kohustuslik**. String. \\ | Konto administraatori isikukoodRegistreerimise tüübi **USER** puhul peab parameetrite ''personalCode'' ja ''administratorPersonalCode'' väärtus olema samasugune. \\ \\ Selle parameetri pikkus peab olema ''11'' numbrimärki. |
  
-==== Response ==== +==== Vastus ==== 
-Field\\ ^ Kind \\ ^ Notes \\ ^ +Väli\\ ^ Tüüp \\ ^ Kirjeldus \\ ^ 
-| response \\ | String. \\ | Valid values are "OK" or "ERROR". \\ | +| response \\ | String. \\ | Väärtus **OK** või **ERROR** \\ | 
-| responseDescription| Error\\ | Contains one of the error codessee belowThis field is returned only if the request resulted in an errori.e. the "response" field contains value "ERROR". \\ | +| responseDescription | [[api:v0_4:lisaobjektid#error|Error]]. \\ | Sisaldab ühte veakoodivaadake allpoolSee väli on tagastatud ainult juhulkui päringu tegemisel tekkis viga, st ''response'' väli sisaldab väärtust **ERROR** \\ | 
-| cliendId \\ | String.\\ | Encoded client ID |+| cliendId \\ | String.\\ | Kodeeritud konto ID|
  
  
-==== Errors ==== +==== Veakoodid ==== 
-Error Description +Nimetus Kirjeldus 
-| INVALID_REGISTRATION_TYPE | The value specified for the "registrationType" parameter is missing or not valid. | +| INVALID_REGISTRATION_TYPE | Parameetrile ''registrationType'' on omistatud vigane väärtus või see puudub. | 
-| INVALID_REG_NO | The value specified for the "regNo" parameter is missing or not validValue must be 8 or 11 digits long, an unique company registration number or a valid personal code. | +| INVALID_REG_NO | Parameetrile ''regNo'' on omistatud vigane väärtus või see puudub
-| INVALID_PERSONAL_CODE | The value specified for the "personalCode" parameter is missing or not valid. Value must be a valid  personal code. \\ | +| REG_NO_EXISTS | Parameetrile ''regNo'' vastav konto on juba olemas. | 
-| INVALID_NAME | The value specified for the "name" parameter is missing or not valid. Value must be 2 - 150 chars long. | +| INVALID_PERSONAL_CODE | Parameetrile ''personalCode'' on omistatud vigane väärtus või see puudub. \\ 
-| INVALID_ADDRESS | The value specified for the "address" parameter is missing or not valid. Value must be 4 - 200 chars long. | +| PERSONAL_CODE_EXISTS | Parameetrile ''personalCode'' vastav konto on juba olemas. 
-| INVALID_CONTACT_EMAIL \\ | The value specified for the "contactEmail" parameter is missing or not valid. Value must be a valid email and 5 - 100 chars long. | +| INVALID_NAME | Parameetrile ''name'' on omistatud vigane väärtus või see puudub. | 
-| INVALID_PHONE \\ | The value specified for the "phone" parameter is missing or not validValue must be a valid email and 4 - 30 chars long. May contain only  +, \-, spaces and digits +| INVALID_ADDRESS | Parameetrile ''address'' on omistatud vigane väärtus või see puudub. | 
-| INVALID_FAX \\ | The value specified for the "fax" parameter is not validValue must be a valid email and 4 - 30 chars long. May contain only  +, \-, space and digits +| INVALID_CONTACT_EMAIL \\ | Parameetrile ''contactEmail'' on omistatud vigane väärtus või see puudub. | 
-| INVALID_SERVICE \\ | The value specified for the "service" parameter is missing or not valid. | +| INVALID_PHONE \\ | Parameetrile ''phone'' on omistatud vigane väärtus või see puudub. | 
-| INVALID_COUNTY \\ | The value specified for the "county" parameter is missing or not valid. | +| INVALID_FAX \\ | Parameetrile ''fax'' on omistatud vigane väärtus. | 
-| INVALID_CITY \\ | The value specified for the "city" parameter is missing or not validValue must be a valid email and 2 - 100 chars long. May contain only lеtters, digits, - and spaces. First char must be a letter   \\ | +| INVALID_SERVICE \\ | Parameetrile ''service'' on omistatud vigane väärtus või see puudub. | 
-| INVALID_ZIP_CODE \\ | The value specified for the &quot;zipCode&quotparameter is missing or not validValue must be a valid email and 4 20 chars long. May contain only lеttersdigits and spaces. | +| INVALID_COUNTY \\ | Parameetrile ''county'' on omistatud vigane väärtus või see puudub. | 
-INVALID_ADMINISTRATOR \\ The value specified for the &quot;administratorPersonalCode&quotparameter is missing or not validValue must be a valid  personal code. |+| 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. | 
 + 
 + 
 +==== Näidispäring ==== 
 +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 | 
 + 
 +&lt;code> 
 +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&regNo=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&amp;administratorPersonalCode=37101010021&acc_key=ynatubqr9fmlxu618kwc&sig=ZRlw%2Fx5eVJskVUd2vaAQ3G7lW60%3D 
 +</code> 
 + 
 + 
 +==== Näidisvastus ==== 
 +See on vastus mille server saadab eelnevale päringule. 
 +<code> 
 +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"} 
 +</code> 
 + 
 + 
 +==== Näidispäring ==== 
 +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 | 
 + 
 +&lt;code> 
 +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&amp;acc_key=ynatubqr9fmlxu618kwc&sig=cJLuF%2FjVXVqe7B5EIogAQ0sfYK4%3D 
 +</code> 
 + 
 + 
 +==== Näidisvastus ==== 
 +See on vastus mille server saadab eelnevale päringule. 
 + 
 +<code
 +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"} 
 +</code>
 
Eesti Arhivaar OÜ © 2011. Kõik õigused on kaitstud. Tegevusluba nr. 000110.