cdocutils.nodes document q)q}q(U nametypesq}q(XxmlqNX-serialization of types for transfer over httpqNX identifierqNXhtmlq NXjsonq NXbooleanq NXdescriberesponseq NXsystemmetadataq NXobjectlocationlistqNXcsvqNX objectlistqNuUsubstitution_defsq}qUparse_messagesq]q(cdocutils.nodes system_message q)q}q(U rawsourceqUUparentqcdocutils.nodes section q)q}q(hUU referencedqKhh)q}q(hUhh)q }q!(hUhhUsourceq"Xi/var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/Serialization.txtq#Utagnameq$Usectionq%U attributesq&}q'(Udupnamesq(]Uclassesq)]Ubackrefsq*]Uidsq+]q,U-serialization-of-types-for-transfer-over-httpq-aUnamesq.]q/hauUlineq0KUdocumentq1hUchildrenq2]q3(cdocutils.nodes title q4)q5}q6(hX-Serialization of Types for Transfer Over HTTPq7hh h"h#h$Utitleq8h&}q9(h(]h)]h*]h+]h.]uh0Kh1hh2]q:cdocutils.nodes Text q;X-Serialization of Types for Transfer Over HTTPq(hh7hh5ubaubh)q?}q@(hUhh h"h#h$h%h&}qA(h(]h)]h*]h+]qBUbooleanqCah.]qDh auh0Kh1hh2]qE(h4)qF}qG(hXBooleanqHhh?h"h#h$h8h&}qI(h(]h)]h*]h+]h.]uh0Kh1hh2]qJh;XBooleanqKqL}qM(hhHhhFubaubcdocutils.nodes paragraph qN)qO}qP(hXbWhen the response is simply a boolean True or False, the response returned is in one of two forms:qQhh?h"h#h$U paragraphqRh&}qS(h(]h)]h*]h+]h.]uh0Kh1hh2]qTh;XbWhen the response is simply a boolean True or False, the response returned is in one of two forms:qUqV}qW(hhQhhOubaubcdocutils.nodes enumerated_list qX)qY}qZ(hUhh?h"h#h$Uenumerated_listq[h&}q\(Usuffixq]U)h+]h*]h(]Uprefixq^Uh)]h.]Uenumtypeq_U loweralphaq`uh0K h1hh2]qa(cdocutils.nodes list_item qb)qc}qd(hX_For cases where false is a valid response: a single character "1" if *True*, or "0" if *False* hhYh"h#h$U list_itemqeh&}qf(h(]h)]h*]h+]h.]uh0Nh1hh2]qghN)qh}qi(hX^For cases where false is a valid response: a single character "1" if *True*, or "0" if *False*hhch"h#h$hRh&}qj(h(]h)]h*]h+]h.]uh0K h2]qk(h;XEFor cases where false is a valid response: a single character "1" if qlqm}qn(hXEFor cases where false is a valid response: a single character "1" if hhhubcdocutils.nodes emphasis qo)qp}qq(hX*True*h&}qr(h(]h)]h*]h+]h.]uhhhh2]qsh;XTrueqtqu}qv(hUhhpubah$Uemphasisqwubh;X , or "0" if qxqy}qz(hX , or "0" if hhhubho)q{}q|(hX*False*h&}q}(h(]h)]h*]h+]h.]uhhhh2]q~h;XFalseqq}q(hUhh{ubah$hwubeubaubhb)q}q(hXFor cases where false coincides with a DataONE exception: an arbitrary body if *True* (ignored by caller), and an error-indicating HTTP status code and serialized error object if *False*. hhYh"h#h$heh&}q(h(]h)]h*]h+]h.]uh0Nh1hh2]qhN)q}q(hXFor cases where false coincides with a DataONE exception: an arbitrary body if *True* (ignored by caller), and an error-indicating HTTP status code and serialized error object if *False*.hhh"h#h$hRh&}q(h(]h)]h*]h+]h.]uh0K h2]q(h;XOFor cases where false coincides with a DataONE exception: an arbitrary body if qq}q(hXOFor cases where false coincides with a DataONE exception: an arbitrary body if hhubho)q}q(hX*True*h&}q(h(]h)]h*]h+]h.]uhhh2]qh;XTrueqq}q(hUhhubah$hwubh;X^ (ignored by caller), and an error-indicating HTTP status code and serialized error object if qq}q(hX^ (ignored by caller), and an error-indicating HTTP status code and serialized error object if hhubho)q}q(hX*False*h&}q(h(]h)]h*]h+]h.]uhhh2]qh;XFalseqq}q(hUhhubah$hwubh;X.q}q(hX.hhubeubaubeubeubh)q}q(hUhh h"h#h$h%h&}q(h(]h)]h*]h+]qU objectlistqah.]qhauh0Kh1hh2]q(h4)q}q(hX ObjectListqhhh"h#h$h8h&}q(h(]h)]h*]h+]h.]uh0Kh1hh2]qh;X ObjectListqq}q(hhhhubaubh)q}q(hUhKhhh"h#h$h%h&}q(h(]qXjsonqah)]h*]h+]qUjsonqah.]uh0Kh1hh2]q(h4)q}q(hXJSONqhhh"h#h$h8h&}q(h(]h)]h*]h+]h.]uh0Kh1hh2]qh;XJSONqq}q(hhhhubaubcdocutils.nodes literal_block q)q}q(hX{{ 'start': , 'count': , 'total': , 'objectInfo': [ { 'identifier':, 'objectFormat':, 'checksum': { 'algorithm':, 'value': }, 'dateSysMetadataModified':, 'size': }, ... ] }hhh"h#h$U literal_blockqh&}q(U xml:spaceqUpreserveqh+]h*]h(]h)]h.]uh0Kh1hh2]qh;X{{ 'start': , 'count': , 'total': , 'objectInfo': [ { 'identifier':, 'objectFormat':, 'checksum': { 'algorithm':, 'value': }, 'dateSysMetadataModified':, 'size': }, ... ] }qDžq}q(hUhhubaubeubh)q}q(hUhKhhh"h#h$h%h&}q(h(]qXcsvqah)]h*]h+]qUcsvqah.]uh0K2h1hh2]q(h4)q}q(hXCSVqhhh"h#h$h8h&}q(h(]h)]h*]h+]h.]uh0K2h1hh2]qh;XCSVqׅq}q(hhhhubaubh)q}q(hX#,, identifier,objectFormat,algorithm,checksum,dateSysMetadataModified,size "","","","","",hhh"h#h$hh&}q(hhh+]h*]h(]h)]h.]uh0K6h1hh2]qh;X#,, identifier,objectFormat,algorithm,checksum,dateSysMetadataModified,size "","","","","",qޅq}q(hUhhubaubeubh)q}q(hUhKhhh"h#h$h%h&}q(h(]qXxmlqah)]h*]h+]qUxmlqah.]uh0K;h1hh2]q(h4)q}q(hXXMLqhhh"h#h$h8h&}q(h(]h)]h*]h+]h.]uh0K;h1hh2]qh;XXMLqq}q(hhhhubaubh)q}q(hXW _identifier_ _object class_ _hash of object_ _date time last modified_ _byte size of object_ ... _identifier_ _object class_ _hash of object_ _date time last modified_ _byte size of object_ ... r?}r@(hXReturned in response to hj:ubcsphinx.addnodes pending_xref rA)rB}rC(hX:func:`MN_crud.describe`rDhj:h"h#h$U pending_xrefrEh&}rF(UreftypeXfuncUrefwarnrGU reftargetrHXMN_crud.describeU refdomainXpyrIh+]h*]U refexplicith(]h)]h.]UrefdocrJXdesign/SerializationrKUpy:classrLNU py:modulerMNuh0KYh2]rNcdocutils.nodes literal rO)rP}rQ(hjDh&}rR(h(]h)]rS(UxrefrTjIXpy-funcrUeh*]h+]h.]uhjBh2]rVh;XMN_crud.describe()rWrX}rY(hUhjPubah$UliteralrZubaubh;Xk which is called using the HTTP HEAD verb. As such, the response is entirely in the HTTP headers (no body).r[r\}r](hXk which is called using the HTTP HEAD verb. As such, the response is entirely in the HTTP headers (no body).hj:ubeubcdocutils.nodes field_list r^)r_}r`(hUhj+h"h#h$U field_listrah&}rb(h(]h)]h*]h+]h.]uh0K\h1hh2]rc(cdocutils.nodes field rd)re}rf(hUhj_h"h#h$Ufieldrgh&}rh(h(]h)]h*]h+]h.]uh0K\h1hh2]ri(cdocutils.nodes field_name rj)rk}rl(hXContent-Lengthrmhjeh"h#h$U field_namernh&}ro(h(]h)]h*]h+]h.]uh0Kh2]rph;XContent-Lengthrqrr}rs(hjmhjkubaubcdocutils.nodes field_body rt)ru}rv(hX:attr:`SystemMetadata.size`rwh&}rx(h(]h)]h*]h+]h.]uhjeh2]ryhN)rz}r{(hjwhjuh"h#h$hRh&}r|(h(]h)]h*]h+]h.]uh0K\h2]r}jA)r~}r(hjwhjzh"h#h$jEh&}r(UreftypeXattrjGjHXSystemMetadata.sizeU refdomainXpyrh+]h*]U refexplicith(]h)]h.]jJjKjLNjMNuh0K\h2]rjO)r}r(hjwh&}r(h(]h)]r(jTjXpy-attrreh*]h+]h.]uhj~h2]rh;XSystemMetadata.sizerr}r(hUhjubah$jZubaubaubah$U field_bodyrubeubjd)r}r(hUhj_h"h#h$jgh&}r(h(]h)]h*]h+]h.]uh0K]h1hh2]r(jj)r}r(hX Last-Modifiedrhjh"h#h$jnh&}r(h(]h)]h*]h+]h.]uh0Kh2]rh;X Last-Modifiedrr}r(hjhjubaubjt)r}r(hXrh&}r(h(]h)]h*]h+]h.]uhjh2]rhN)r}r(hjhjh"h#h$hRh&}r(h(]h)]h*]h+]h.]uh0K]h2]rh;Xrr}r(hjhjubaubah$jubeubjd)r}r(hUhj_h"h#h$jgh&}r(h(]h)]h*]h+]h.]uh0K^h1hh2]r(jj)r}r(hXDataONE-ObjectFormatrhjh"h#h$jnh&}r(h(]h)]h*]h+]h.]uh0Kh2]rh;XDataONE-ObjectFormatrr}r(hjhjubaubjt)r}r(hXrh&}r(h(]h)]h*]h+]h.]uhjh2]rhN)r}r(hjhjh"h#h$hRh&}r(h(]h)]h*]h+]h.]uh0K^h2]rh;Xrr}r(hjhjubaubah$jubeubjd)r}r(hUhj_h"h#h$jgh&}r(h(]h)]h*]h+]h.]uh0K_h1hh2]r(jj)r}r(hXDataONE-Checksumrhjh"h#h$jnh&}r(h(]h)]h*]h+]h.]uh0Kh2]rh;XDataONE-Checksumrr}r(hjhjubaubjt)r}r(hX , h&}r(h(]h)]h*]h+]h.]uhjh2]rhN)r}r(hX,rhjh"h#h$hRh&}r(h(]h)]h*]h+]h.]uh0K_h2]rh;X,rr}r(hjhjubaubah$jubeubeubeubh)r}r(hUhh h"h#h$h%h&}r(h(]h)]h*]h+]rU identifierrah.]rhauh0Kch1hh2]r(h4)r}r(hX Identifierrhjh"h#h$h8h&}r(h(]h)]h*]h+]h.]uh0Kch1hh2]rh;X Identifierrr}r(hjhjubaubhN)r}r(hXReturned as a simple string.rhjh"h#h$hRh&}r(h(]h)]h*]h+]h.]uh0Keh1hh2]rh;XReturned as a simple string.rr}r(hjhjubaubeubh)r}r(hUhh h"h#h$h%h&}r(h(]h)]h*]h+]rUsystemmetadatarah.]rh auh0Kih1hh2]r(h4)r}r(hXSystemMetadatarhjh"h#h$h8h&}r(h(]h)]h*]h+]h.]uh0Kih1hh2]rh;XSystemMetadatarr}r(hjhjubaubhN)r}r(hX(Currently returned only in the XML form.rhjh"h#h$hRh&}r(h(]h)]h*]h+]h.]uh0Kkh1hh2]rh;X(Currently returned only in the XML form.rr}r(hjhjubaubeubheubh"h#h$h%h&}r(h(]h)]h*]h+]rUobjectlocationlistrah.]rhauh0Koh1hh2]r(h4)r}r (hXObjectLocationListr hhh"h#h$h8h&}r (h(]h)]h*]h+]h.]uh0Koh1hh2]r h;XObjectLocationListr r}r(hj hjubaubhh)r}r(hUhKhhh"h#h$h%h&}r(h(]rhah)]h*]h+]rUid2rah.]uh0Kh1hh2]r(h4)r}r(hXCSVrhjh"h#h$h8h&}r(h(]h)]h*]h+]h.]uh0Kh1hh2]rh;XCSVrr}r(hjhjubaubh)r}r (hX#1234 node,url 'mn1.dataone.org/mn','http://mn1.dataone.org/mn/object?id=1234' 'mn2.dataone.org/some_base/mn','http://mn2.dataone.org/some_base/mn/object?id=1234' 'cn.dataone.org/cn','http://cn.dataone.org/cn/object?id=1234'hjh"h#h$hh&}r!(hhh+]h*]h(]h)]h.]uh0Kh1hh2]r"h;X#1234 node,url 'mn1.dataone.org/mn','http://mn1.dataone.org/mn/object?id=1234' 'mn2.dataone.org/some_base/mn','http://mn2.dataone.org/some_base/mn/object?id=1234' 'cn.dataone.org/cn','http://cn.dataone.org/cn/object?id=1234'r#r$}r%(hUhjubaubeubh)r&}r'(hUhKhhh"h#h$h%h&}r((h(]r)hah)]h*]h+]r*Uid3r+ah.]uh0Kh1hh2]r,(h4)r-}r.(hXXMLr/hj&h"h#h$h8h&}r0(h(]h)]h*]h+]h.]uh0Kh1hh2]r1h;XXMLr2r3}r4(hj/hj-ubaubh)r5}r6(hXG hj&h"h#h$hh&}r7(hhh+]h*]h(]h)]h.]uh0Kh1hh2]r8h;XG r9r:}r;(hUhj5ubaubeubh)r<}r=(hUhKhhh"h#h$h%h&}r>(h(]r?hah)]h*]h+]r@Uid4rAah.]uh0Kh1hh2]rB(h4)rC}rD(hXHTMLrEhj<h"h#h$h8h&}rF(h(]h)]h*]h+]h.]uh0Kh1hh2]rGh;XHTMLrHrI}rJ(hjEhjCubaubh)rK}rL(hX...
    mn1.dataone.org/mn mn1.dataone.org/some_base/mn cn.dataone.org/cn
...hj<h"h#h$hh&}rM(hhh+]h*]h(]h)]h.]uh0Kh1hh2]rNh;X...
    mn1.dataone.org/mn mn1.dataone.org/some_base/mn cn.dataone.org/cn
...rOrP}rQ(hUhjKubaubeubeubh"h#h$h%h&}rR(h(]rShah)]h*]h+]rTUid1rUah.]uh0Krh1hh2]rV(h4)rW}rX(hXJSONrYhhh"h#h$h8h&}rZ(h(]h)]h*]h+]h.]uh0Krh1hh2]r[h;XJSONr\r]}r^(hjYhjWubaubh)r_}r`(hX{ 'identifier':'1234', 'locations': [ ['mn1.dataone.org/mn', 'http://mn1.dataone.org/mn/object?id=1234'], ['mn2.dataone.org/some_base/mn', 'http://mn2.dataone.org/some_base/mn/object?id=1234'], ['cn.dataone.org/cn', 'http://cn.dataone.org/cn/object?id=1234'] ] }hhh"h#h$hh&}ra(hhh+]h*]h(]h)]h.]uh0Kvh1hh2]rbh;X{ 'identifier':'1234', 'locations': [ ['mn1.dataone.org/mn', 'http://mn1.dataone.org/mn/object?id=1234'], ['mn2.dataone.org/some_base/mn', 'http://mn2.dataone.org/some_base/mn/object?id=1234'], ['cn.dataone.org/cn', 'http://cn.dataone.org/cn/object?id=1234'] ] }rcrd}re(hUhj_ubaubeubh"h#h$Usystem_messagerfh&}rg(h(]UlevelKh+]h*]rhjUaUsourceh#h)]h.]UlineKrUtypeUINFOriuh0Krh1hh2]rjhN)rk}rl(hX'Duplicate implicit target name: "json".h&}rm(h(]h)]h*]h+]h.]uhhh2]rnh;X'Duplicate implicit target name: "json".rorp}rq(hUhjkubah$hRubaubh)rr}rs(hUhjh"h#h$jfh&}rt(h(]UlevelKh+]h*]rujaUsourceh#h)]h.]UlineKUtypejiuh0Kh1hh2]rvhN)rw}rx(hX&Duplicate implicit target name: "csv".h&}ry(h(]h)]h*]h+]h.]uhjrh2]rzh;X&Duplicate implicit target name: "csv".r{r|}r}(hUhjwubah$hRubaubh)r~}r(hUhj&h"h#h$jfh&}r(h(]UlevelKh+]h*]rj+aUsourceh#h)]h.]UlineKUtypejiuh0Kh1hh2]rhN)r}r(hX&Duplicate implicit target name: "xml".h&}r(h(]h)]h*]h+]h.]uhj~h2]rh;X&Duplicate implicit target name: "xml".rr}r(hUhjubah$hRubaubh)r}r(hUhj<h"h#h$jfh&}r(h(]UlevelKh+]h*]rjAaUsourceh#h)]h.]UlineKUtypejiuh0Kh1hh2]rhN)r}r(hX'Duplicate implicit target name: "html".h&}r(h(]h)]h*]h+]h.]uhjh2]rh;X'Duplicate implicit target name: "html".rr}r(hUhjubah$hRubaubeUcurrent_sourcerNU decorationrNUautofootnote_startrKUnameidsr}r(hNhh-hjh Nh Nh hCh j/h jhjhNhhuh2]rh ahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh1hU current_linerNUtransform_messagesr]rh)r}r(hUh&}r(h(]UlevelKh+]h*]Usourceh#h)]h.]Utypejiuh2]rhN)r}r(hUh&}r(h(]h)]h*]h+]h.]uhjh2]rh;X-Hyperlink target "index-0" is not referenced.rr}r(hUhjubah$hRubah$jfubaUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttps://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh8NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrUUTF-8rU_sourcerh#Ugettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrU https://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]Ufile_insertion_enabledrU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hhj+j&jjh-h jAj<jjhhjUhhhhCh?jjj/j+jjjhhhhhuUsubstitution_namesr }r h$h1h&}r (h(]h+]h*]Usourceh#h)]h.]uU footnotesr ]r Urefidsr}rj]rj asub.