{"_id":"560eb0dfcac9dc0d007af86d","user":"55073244485d65190072238f","project":"55073274485d651900722390","__v":21,"category":{"_id":"551c6aaa0360770d00f5ce7c","__v":4,"project":"55073274485d651900722390","pages":["551c6aab0360770d00f5ce7d","551c6aab0360770d00f5ce7e","551c6aab0360770d00f5ce7f","551c6aab0360770d00f5ce80","551c6aab0360770d00f5ce81","551c6ac923a1ee190034d1f2","5526aedd1e01230d00b1db3f","5526aee5b87cef230047be65"],"version":"551c6aaa0360770d00f5ce7b","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-16T19:43:49.645Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"version":{"_id":"551c6aaa0360770d00f5ce7b","forked_from":"55073275485d651900722393","__v":7,"project":"55073274485d651900722390","createdAt":"2015-04-01T22:01:14.266Z","releaseDate":"2015-04-01T22:01:14.266Z","categories":["551c6aaa0360770d00f5ce7c","551c6b280360770d00f5ce83","551c6b4523a1ee190034d1f4","551c6c447405910d00900a08","5526dd4fe69c7d0d00047e4f","5528029dd831d919000f23d6","560eb01639fad419002ae1da"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.5.0","version":"1.5"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-02T16:29:19.747Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"This document describes the format of the ZeroPush export. The export can be initiated at [https://zeropush.com/migration](https://zeropush.com/migration)\n\nThe migration process will email you once the export is complete with a link to download the XML file. You will be able to access it for 24 hours, after that it will expire. You may export it again for another 24 hours.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"XML File Format\"\n}\n[/block]\nXML Elements\n\n`<account>` - root level element.\n`<users>` - collections of `<user>` elements.\n`<user>` - a user.\n`<apps>` - collection of `<app>` elements\n`<app>` - an app. Contains `<certificate>`, `<devices>`, and `<channels>`\n`<certificate>` - a PEM formatted push certificate and private key\n`<channels>` - collections of `<channel>` elements\n`<channel>` -  a channel\n`<devices>` - collection of `<device>` elements\n`<device>` - a device\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Entity Details\"\n}\n[/block]\nThe table below describes the valid attributes for each entity.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`user`\",\n    \"1-0\": \"`app`\",\n    \"2-0\": \"`channel`\",\n    \"3-0\": \"`device`\",\n    \"h-1\": \"Attributes\",\n    \"h-0\": \"Element\",\n    \"0-1\": \"email\\nname\\nlocale\\ntimezone\\nphone_number\\ncompany\\nbilling_email\\nbilling_name\\nbilling_phone_number\\nbilling_address\",\n    \"1-1\": \"platform - can be \\\"ios\\\", \\\"safari\\\", or \\\"gcm\\\"\\nname - the application name\\napp_token\\nserver_token\\nproduction - true | false whether we use the sandbox\\napi_version - \\\"1.4\\\" or \\\"1.5\\\"\\ngcm_api_key\\ngcm_project_number\",\n    \"3-1\": \"token - the iOS or GCM registration token\\nactive - true | false\\nbadge - the internal badge count for the device\",\n    \"2-1\": \"name\\ndevice_token\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\nRefer the `Export XSD` sample to see the schema\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\"?>\\n<account>\\n\\t<users>\\n    <user email=\\\"user:::at:::example.com\\\" name=\\\"Test User\\\" />\\n  </users>\\n  <apps>\\n    <app platform=\\\"ios\\\" name=\\\"Test App\\\" app_token=\\\"xxx\\\" server_token=\\\"xxx\\\" production=\\\"false\\\">\\n      <certificate><![CDATA[ ... ]]></certificate>\\n      <devices>\\n        <device token=\\\"abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789\\\" active=\\\"true\\\" badge=\\\"0\\\" />\\n      </devices>\\n      <channels>\\n        <channel name=\\\"test\\\" device_token=\\\"abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789\\\"/>\\n      </channels>\\n    </app>\\n    <app platform=\\\"gcm\\\" app_token=\\\"xxx\\\" server_token=\\\"xxx\\\" production=\\\"false\\\" gcm_api_key=\\\"xxxx\\\" gcm_project_number=\\\"12345\\\">\\n      <devices></devices>\\n      <channels></channels>\\n    </app>\\n  </apps>\\n</account>\",\n      \"language\": \"xml\",\n      \"name\": \"Sample Export XML\"\n    },\n    {\n      \"code\": \"<xs:schema xmlns:xs=\\\"http://www.w3.org/2001/XMLSchema\\\">\\n  <xs:element name=\\\"account\\\">\\n    <xs:complexType>\\n      <xs:sequence>\\n        <xs:element name=\\\"users\\\">\\n          <xs:complexType>\\n            <xs:sequence>\\n              <xs:element name=\\\"user\\\">\\n                <xs:complexType>\\n                  <xs:simpleContent>\\n                    <xs:extension base=\\\"xs:string\\\">\\n                      <xs:attribute type=\\\"xs:string\\\" name=\\\"email\\\"/>\\n                      <xs:attribute type=\\\"xs:string\\\" name=\\\"name\\\"/>\\n                      <xs:attribute type=\\\"xs:string\\\" name=\\\"locale\\\"/>\\n                      <xs:attribute type=\\\"xs:string\\\" name=\\\"timezone\\\"/>\\n                      <xs:attribute type=\\\"xs:string\\\" name=\\\"phone_number\\\"/>\\n                      <xs:attribute type=\\\"xs:string\\\" name=\\\"company\\\"/>\\n                      <xs:attribute type=\\\"xs:string\\\" name=\\\"billing_email\\\"/>\\n                      <xs:attribute type=\\\"xs:string\\\" name=\\\"billing_name\\\"/>\\n                      <xs:attribute type=\\\"xs:string\\\" name=\\\"billing_phone_number\\\"/>\\n                      <xs:attribute type=\\\"xs:string\\\" name=\\\"billing_address\\\"/>\\n                    </xs:extension>\\n                  </xs:simpleContent>\\n                </xs:complexType>\\n              </xs:element>\\n            </xs:sequence>\\n          </xs:complexType>\\n        </xs:element>\\n        <xs:element name=\\\"apps\\\">\\n          <xs:complexType>\\n            <xs:sequence>\\n              <xs:element name=\\\"app\\\" maxOccurs=\\\"unbounded\\\" minOccurs=\\\"0\\\">\\n                <xs:complexType>\\n                  <xs:sequence>\\n                    <xs:element type=\\\"xs:string\\\" name=\\\"certificate\\\" minOccurs=\\\"0\\\"/>\\n                    <xs:element name=\\\"devices\\\">\\n                      <xs:complexType mixed=\\\"true\\\">\\n                        <xs:sequence>\\n                          <xs:element name=\\\"device\\\" maxOccurs=\\\"unbounded\\\" minOccurs=\\\"0\\\">\\n                            <xs:complexType>\\n                              <xs:simpleContent>\\n                                <xs:extension base=\\\"xs:string\\\">\\n                                  <xs:attribute type=\\\"xs:string\\\" name=\\\"token\\\" use=\\\"required\\\"/>\\n                                  <xs:attribute type=\\\"xs:boolean\\\" name=\\\"active\\\" use=\\\"required\\\"/>\\n                                  <xs:attribute type=\\\"xs:short\\\" name=\\\"badge\\\" use=\\\"required\\\"/>\\n                                </xs:extension>\\n                              </xs:simpleContent>\\n                            </xs:complexType>\\n                          </xs:element>\\n                        </xs:sequence>\\n                      </xs:complexType>\\n                    </xs:element>\\n                    <xs:element name=\\\"channels\\\">\\n                      <xs:complexType mixed=\\\"true\\\">\\n                        <xs:sequence>\\n                          <xs:element name=\\\"channel\\\" maxOccurs=\\\"unbounded\\\" minOccurs=\\\"0\\\">\\n                            <xs:complexType>\\n                              <xs:simpleContent>\\n                                <xs:extension base=\\\"xs:string\\\">\\n                                  <xs:attribute type=\\\"xs:string\\\" name=\\\"name\\\" use=\\\"required\\\"/>\\n                                  <xs:attribute type=\\\"xs:string\\\" name=\\\"device_token\\\" use=\\\"required\\\"/>\\n                                </xs:extension>\\n                              </xs:simpleContent>\\n                            </xs:complexType>\\n                          </xs:element>\\n                        </xs:sequence>\\n                      </xs:complexType>\\n                    </xs:element>\\n                  </xs:sequence>\\n                  <xs:attribute type=\\\"xs:string\\\" name=\\\"app_token\\\" use=\\\"required\\\"/>\\n                  <xs:attribute type=\\\"xs:string\\\" name=\\\"name\\\" use=\\\"required\\\"/>\\n                  <xs:attribute type=\\\"xs:string\\\" name=\\\"server_token\\\" use=\\\"required\\\"/>\\n                  <xs:attribute type=\\\"xs:boolean\\\" name=\\\"production\\\" use=\\\"required\\\"/>\\n                  <xs:attribute type=\\\"xs:float\\\" name=\\\"api_version\\\" use=\\\"optional\\\"/>  \\n                  <xs:attribute type=\\\"xs:string\\\" name=\\\"bundle_id\\\" use=\\\"optional\\\"/>\\n                  <xs:attribute type=\\\"xs:string\\\" name=\\\"platform\\\" use=\\\"required\\\"/>\\n                  <xs:attribute type=\\\"xs:string\\\" name=\\\"gcm_api_key\\\" use=\\\"optional\\\"/>\\n                  <xs:attribute type=\\\"xs:string\\\" name=\\\"gcm_project_number\\\" use=\\\"optional\\\"/>\\n                </xs:complexType>\\n              </xs:element>\\n            </xs:sequence>\\n          </xs:complexType>\\n        </xs:element>\\n      </xs:sequence>\\n    </xs:complexType>\\n  </xs:element>\\n</xs:schema>\",\n      \"language\": \"xml\",\n      \"name\": \"Export XSD\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"data-export","type":"basic","title":"Data Export"}
This document describes the format of the ZeroPush export. The export can be initiated at [https://zeropush.com/migration](https://zeropush.com/migration) The migration process will email you once the export is complete with a link to download the XML file. You will be able to access it for 24 hours, after that it will expire. You may export it again for another 24 hours. [block:api-header] { "type": "basic", "title": "XML File Format" } [/block] XML Elements `<account>` - root level element. `<users>` - collections of `<user>` elements. `<user>` - a user. `<apps>` - collection of `<app>` elements `<app>` - an app. Contains `<certificate>`, `<devices>`, and `<channels>` `<certificate>` - a PEM formatted push certificate and private key `<channels>` - collections of `<channel>` elements `<channel>` - a channel `<devices>` - collection of `<device>` elements `<device>` - a device [block:api-header] { "type": "basic", "title": "Entity Details" } [/block] The table below describes the valid attributes for each entity. [block:parameters] { "data": { "0-0": "`user`", "1-0": "`app`", "2-0": "`channel`", "3-0": "`device`", "h-1": "Attributes", "h-0": "Element", "0-1": "email\nname\nlocale\ntimezone\nphone_number\ncompany\nbilling_email\nbilling_name\nbilling_phone_number\nbilling_address", "1-1": "platform - can be \"ios\", \"safari\", or \"gcm\"\nname - the application name\napp_token\nserver_token\nproduction - true | false whether we use the sandbox\napi_version - \"1.4\" or \"1.5\"\ngcm_api_key\ngcm_project_number", "3-1": "token - the iOS or GCM registration token\nactive - true | false\nbadge - the internal badge count for the device", "2-1": "name\ndevice_token" }, "cols": 2, "rows": 4 } [/block] Refer the `Export XSD` sample to see the schema [block:code] { "codes": [ { "code": "<?xml version=\"1.0\"?>\n<account>\n\t<users>\n <user email=\"user@example.com\" name=\"Test User\" />\n </users>\n <apps>\n <app platform=\"ios\" name=\"Test App\" app_token=\"xxx\" server_token=\"xxx\" production=\"false\">\n <certificate><![CDATA[ ... ]]></certificate>\n <devices>\n <device token=\"abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789\" active=\"true\" badge=\"0\" />\n </devices>\n <channels>\n <channel name=\"test\" device_token=\"abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789\"/>\n </channels>\n </app>\n <app platform=\"gcm\" app_token=\"xxx\" server_token=\"xxx\" production=\"false\" gcm_api_key=\"xxxx\" gcm_project_number=\"12345\">\n <devices></devices>\n <channels></channels>\n </app>\n </apps>\n</account>", "language": "xml", "name": "Sample Export XML" }, { "code": "<xs:schema xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">\n <xs:element name=\"account\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"users\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"user\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute type=\"xs:string\" name=\"email\"/>\n <xs:attribute type=\"xs:string\" name=\"name\"/>\n <xs:attribute type=\"xs:string\" name=\"locale\"/>\n <xs:attribute type=\"xs:string\" name=\"timezone\"/>\n <xs:attribute type=\"xs:string\" name=\"phone_number\"/>\n <xs:attribute type=\"xs:string\" name=\"company\"/>\n <xs:attribute type=\"xs:string\" name=\"billing_email\"/>\n <xs:attribute type=\"xs:string\" name=\"billing_name\"/>\n <xs:attribute type=\"xs:string\" name=\"billing_phone_number\"/>\n <xs:attribute type=\"xs:string\" name=\"billing_address\"/>\n </xs:extension>\n </xs:simpleContent>\n </xs:complexType>\n </xs:element>\n </xs:sequence>\n </xs:complexType>\n </xs:element>\n <xs:element name=\"apps\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"app\" maxOccurs=\"unbounded\" minOccurs=\"0\">\n <xs:complexType>\n <xs:sequence>\n <xs:element type=\"xs:string\" name=\"certificate\" minOccurs=\"0\"/>\n <xs:element name=\"devices\">\n <xs:complexType mixed=\"true\">\n <xs:sequence>\n <xs:element name=\"device\" maxOccurs=\"unbounded\" minOccurs=\"0\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute type=\"xs:string\" name=\"token\" use=\"required\"/>\n <xs:attribute type=\"xs:boolean\" name=\"active\" use=\"required\"/>\n <xs:attribute type=\"xs:short\" name=\"badge\" use=\"required\"/>\n </xs:extension>\n </xs:simpleContent>\n </xs:complexType>\n </xs:element>\n </xs:sequence>\n </xs:complexType>\n </xs:element>\n <xs:element name=\"channels\">\n <xs:complexType mixed=\"true\">\n <xs:sequence>\n <xs:element name=\"channel\" maxOccurs=\"unbounded\" minOccurs=\"0\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute type=\"xs:string\" name=\"name\" use=\"required\"/>\n <xs:attribute type=\"xs:string\" name=\"device_token\" use=\"required\"/>\n </xs:extension>\n </xs:simpleContent>\n </xs:complexType>\n </xs:element>\n </xs:sequence>\n </xs:complexType>\n </xs:element>\n </xs:sequence>\n <xs:attribute type=\"xs:string\" name=\"app_token\" use=\"required\"/>\n <xs:attribute type=\"xs:string\" name=\"name\" use=\"required\"/>\n <xs:attribute type=\"xs:string\" name=\"server_token\" use=\"required\"/>\n <xs:attribute type=\"xs:boolean\" name=\"production\" use=\"required\"/>\n <xs:attribute type=\"xs:float\" name=\"api_version\" use=\"optional\"/> \n <xs:attribute type=\"xs:string\" name=\"bundle_id\" use=\"optional\"/>\n <xs:attribute type=\"xs:string\" name=\"platform\" use=\"required\"/>\n <xs:attribute type=\"xs:string\" name=\"gcm_api_key\" use=\"optional\"/>\n <xs:attribute type=\"xs:string\" name=\"gcm_project_number\" use=\"optional\"/>\n </xs:complexType>\n </xs:element>\n </xs:sequence>\n </xs:complexType>\n </xs:element>\n </xs:sequence>\n </xs:complexType>\n </xs:element>\n</xs:schema>", "language": "xml", "name": "Export XSD" } ] } [/block]