let you create, manage, organize and distribute digital Passes to mobile devices.
\n\nAll the sample code is hosted on GitHub.
\n\nIf you have any suggestions or feature requests, please create a new issue.
\n\nIf you want to familiarize with the APIs before subscribing, you can use the Sandbox available at https://sandbox.passdock.com.\nThe only thing that chages is the subdomain.\nAccounts in the production website and in the sandbox are not linked in any way.
\n\nThe Sandbox will be periodically erased, so keep in mind that when performing your tests.\nThere isn't any way to keep your Templates and Passes there.
\n","copyright":"© 2012-2013 Creapptor","doc_url":"/doc","api_url":"/api","resources":{"analytics":{"doc_url":"/doc/analytics","api_url":"/api","name":"Analytics","short_description":"","full_description":"","version":"1","formats":[],"methods":[{"doc_url":"/doc/analytics/index","name":"index","apis":[{"api_url":"/api/v1/analytics","http_method":"GET","short_description":"Get all analytics"}],"formats":["json"],"full_description":"Returns all analytics for a user
\n","errors":[{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n {\n \"from_date\":\"2012-07-23T19:32:18Z\",\n \"to_date\":\"2014-03-19T08:43:52Z\",\n \"passes_count\":2382,\n \"redeemed_count\":2000,\n \"installed_count\":2000\n }"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"from_date","full_name":"from_date","description":"Starting date/time (expressed as EPOCH time in UTC)
\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"},{"name":"to_date","full_name":"to_date","description":"Ending date/time (expressed as EPOCH time in UTC)
\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"}],"examples":["curl -i https://api.passdock.com/api/v1/analytics?api_token=75778a65dfdae310a107d2ef0bbd3780&from_date=1343071938&to_date=1395218632"],"see":null,"see_url":null},{"doc_url":"/doc/analytics/templates","name":"templates","apis":[{"api_url":"/api/v1/analytics/templates/:id","http_method":"GET","short_description":"Get all analytics for template"}],"formats":["json"],"full_description":"Returns all analytics for a Template
\n","errors":[{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n {\n \"from_date\":\"2012-07-23T19:32:18Z\",\n \"to_date\":\"2014-03-19T08:43:52Z\",\n \"passes_count\":2382,\n \"redeemed_count\":2000,\n \"installed_count\":2000,\n \"removed\" : 1344,\n \"fetched\" : 2333,\n \"added\" : 1890,\n \"downloaded\": 1799\n }"}],"params":[{"name":"id","full_name":"id","description":"Templates ID
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"from_date","full_name":"from_date","description":"Starting date/time (expressed as EPOCH time in UTC)
\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"},{"name":"to_date","full_name":"to_date","description":"Ending date/time (expressed as EPOCH time in UTC)
\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"}],"examples":["curl -i https://api.passdock.com/api/v1/analytics/templates/1?api_token=75778a65dfdae310a107d2ef0bbd3780&from_date=1343071938&to_date=1395218632"],"see":null,"see_url":null},{"doc_url":"/doc/analytics/created","name":"created","apis":[{"api_url":"/api/v1/analytics/created","http_method":"GET","short_description":"Get analytics for created passes"}],"formats":["json"],"full_description":"Returns analytics for a user about created passes
\n","errors":[{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n {\n \"from_date\":\"2012-07-23T19:32:18Z\",\n \"to_date\":\"2014-03-19T08:43:52Z\",\n \"passes_count\":2382\n }"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"from_date","full_name":"from_date","description":"Starting date/time (expressed as EPOCH time in UTC)
\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"},{"name":"to_date","full_name":"to_date","description":"Ending date/time (expressed as EPOCH time in UTC)
\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"}],"examples":["curl -i https://api.passdock.com/api/v1/analytics/created?api_token=75778a65dfdae310a107d2ef0bbd3780&from_date=1343071938&to_date=1395218632"],"see":null,"see_url":null},{"doc_url":"/doc/analytics/redeemed","name":"redeemed","apis":[{"api_url":"/api/v1/analytics/redeemed","http_method":"GET","short_description":"Get analytics for redeemed passes"}],"formats":["json"],"full_description":"Returns analytics for a user about redeemed passes
\n","errors":[{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n {\n \"from_date\":\"2012-07-23T19:32:18Z\",\n \"to_date\":\"2014-03-19T08:43:52Z\",\n \"redeemed_count\":2382\n }"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"from_date","full_name":"from_date","description":"Starting date/time (expressed as EPOCH time in UTC)
\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"},{"name":"to_date","full_name":"to_date","description":"Ending date/time (expressed as EPOCH time in UTC)
\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"}],"examples":["curl -i https://api.passdock.com/api/v1/analytics/redeemed?api_token=75778a65dfdae310a107d2ef0bbd3780&from_date=1343071938&to_date=1395218632"],"see":null,"see_url":null},{"doc_url":"/doc/analytics/installed","name":"installed","apis":[{"api_url":"/api/v1/analytics/installed","http_method":"GET","short_description":"Get analytics for installed passes"}],"formats":["json"],"full_description":"Returns analytics for a user about installed passes
\n","errors":[{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n {\n \"from_date\":\"2012-07-23T19:32:18Z\",\n \"to_date\":\"2014-03-19T08:43:52Z\",\n \"installed_count\":2382\n }"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"from_date","full_name":"from_date","description":"Starting date/time (expressed as EPOCH time in UTC)
\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"},{"name":"to_date","full_name":"to_date","description":"Ending date/time (expressed as EPOCH time in UTC)
\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"}],"examples":["curl -i https://api.passdock.com/api/v1/analytics/installed?api_token=75778a65dfdae310a107d2ef0bbd3780&from_date=1343071938&to_date=1395218632"],"see":null,"see_url":null}]},"campaigns":{"doc_url":"/doc/campaigns","api_url":"/api","name":"Campaigns","short_description":"","full_description":"","version":"1","formats":[],"methods":[{"doc_url":"/doc/campaigns/index","name":"index","apis":[{"api_url":"/api/v1/campaigns","http_method":"GET","short_description":"Get all campaigns"}],"formats":["json"],"full_description":"Returns all your campaigns.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n[\n {\n id: 1,\n name: \"Pass & Email\",\n kind: 1,\n last_sent: null,\n list_id: null,\n email_content: \"Email HTML content
\",\n email_object: \"Email subject\",\n email_sender: \"Email sender name\"\n },\n {\n id: 2,\n name: \"SMS\",\n kind: 4,\n last_sent: null,\n list_id: null,\n sms_content: \"Text message\",\n sms_sender: \"Text or phone number\"\n }\n]"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/campaigns?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/campaigns/show","name":"show","apis":[{"api_url":"/api/v1/campaigns/:id","http_method":"GET","short_description":"Show a campaign"}],"formats":["json"],"full_description":"Returns a campaign
\n","errors":[{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Not Found","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n{\n id: 1,\n name: \"Email\",\n kind: 3,\n last_sent: null,\n list_id: null,\n email_content: \"Email HTML content
\",\n email_object: \"Email subject\",\n email_sender: \"Email sender name\"\n}"}],"params":[{"name":"id","full_name":"id","description":"Campaign ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/campaigns/1?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/campaigns/create","name":"create","apis":[{"api_url":"/api/v1/campaigns","http_method":"POST","short_description":"Create a Campaign"}],"formats":["json"],"full_description":"Create a new campaign.
\n\nAt the moment it is not possible to create pass campaigns through the API.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":201,"description":"Created","sample":"\n{\n id: 1,\n name: \"Email\",\n kind: 3,\n last_sent: null,\n list_id: null,\n email_content: \"Email HTML content
\",\n email_object: \"Email subject\",\n email_sender: \"Email sender name\"\n}"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"campaign","full_name":"campaign","description":"Object that contains List's informations
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"campaign[name]","description":"List's name
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"kind","full_name":"campaign[kind]","description":"Campaign kind. One of 3 or 4. At the moment it is not possible to create pass campaigns through the API.
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"list_id","full_name":"campaign[list_id]","description":"List ID if you want to send the campaign only to a subset of contacts.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"email_content","full_name":"campaign[email_content]","description":"Only for email campaigns: HTML content of the email
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"email_object","full_name":"campaign[email_object]","description":"Only for email campaigns: email subject
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"email_sender","full_name":"campaign[email_sender]","description":"Only for email campaigns: email sender name (not the email from address!)
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"sms_content","full_name":"campaign[sms_content]","description":"Only for SMS campaigns: SMS text
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"email_sender","full_name":"campaign[email_sender]","description":"Only for SMS campaigns: either a phone number (which must be previously authorized) or a string
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["curl -i -H \"Content-Type: application/json\" -d '{\"campaign\":{\"name\":\"Work\", \"kind\":3, \"email_content\": \"Test
\", \"email_object\": \"Subject\", \"email_sender\": \"Sender name\"}}' https://api.passdock.com/api/v1/campaigns?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/campaigns/update","name":"update","apis":[{"api_url":"/api/v1/campaigns/:id","http_method":"PUT","short_description":"Update Campaign"}],"formats":["json"],"full_description":"Update a Campaign.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":""}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"Campaign ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"campaign","full_name":"campaign","description":"Object that contains List's informations
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"campaign[name]","description":"List's name
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"list_id","full_name":"campaign[list_id]","description":"List ID if you want to send the campaign only to a subset of contacts.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"email_content","full_name":"campaign[email_content]","description":"Only for email campaigns: HTML content of the email
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"email_object","full_name":"campaign[email_object]","description":"Only for email campaigns: email subject
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"email_sender","full_name":"campaign[email_sender]","description":"Only for email campaigns: email sender name (not the email from address!)
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"sms_content","full_name":"campaign[sms_content]","description":"Only for SMS campaigns: SMS text
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"email_sender","full_name":"campaign[email_sender]","description":"Only for SMS campaigns: either a phone number (which must be previously authorized) or a string
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["curl -i -X PUT -H \"Content-Type: application/json\" -d '{\"campaign\":{\"name\":\"Work\", \"kind\":3, \"email_content\": \"Test
\", \"email_object\": \"Subject\", \"email_sender\": \"Sender name\"}}' https://api.passdock.com/api/v1/campaigns/1?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/campaigns/destroy","name":"destroy","apis":[{"api_url":"/api/v1/campaigns/:id","http_method":"DELETE","short_description":"Delete List"}],"formats":["json"],"full_description":"Delete a Campaign.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Campaign Not Found","sample":null}],"successes":[{"code":200,"description":"Deleted","sample":null}],"params":[{"name":"id","full_name":"id","description":"Campaign ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i -X DELETE https://api.passdock.com/api/v1/campaigns/1?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/campaigns/deliver","name":"deliver","apis":[{"api_url":"/api/v1/campaigns/deliver","http_method":"POST","short_description":"Deliver Campaign"}],"formats":["json"],"full_description":"Queues campaign for delivery.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null},{"code":417,"description":"Not enough credits","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":""}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"force","full_name":"force","description":"If you haven't got enough credits, it will try to deliver the campaign to as many contacts as possible
\n","required":false,"allow_nil":false,"validator":"Must be Boolean","expected_type":"string"}],"examples":["curl -i -X POST https://api.passdock.com/api/v1/campaigns/1/deliver?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/campaigns/kinds","name":"kinds","apis":[{"api_url":"/api/v1/campaigns/kinds","http_method":"GET","short_description":"Campaign kinds"}],"formats":["json"],"full_description":"Returns all available campaign kinds you can use to create a new campaign.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n{\n 1: \"Pass & Email\",\n 2: \"Pass & SMS\",\n 3: \"Email\",\n 4: \"SMS\"\n}\n"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/campaigns/kinds?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null}]},"certificates":{"doc_url":"/doc/certificates","api_url":"/api","name":"Certificates","short_description":"","full_description":"","version":"1","formats":[],"methods":[{"doc_url":"/doc/certificates/index","name":"index","apis":[{"api_url":"/api/v1/certificates","http_method":"GET","short_description":"Show available Certificates"}],"formats":["json"],"full_description":"Returns the list of Certificates previously uploaded by a User
\n","errors":[{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"[\n {\n \"description\": \"Passdock Sample 2\",\n \"id\": 2,\n \"pass_type_identifier\": \"pass.passdock.sample2\",\n \"team_identifier\": \"6J39RL8VD6\"\n },\n {\n \"description\": \"Legacy test 8\",\n \"id\": 5,\n \"pass_type_identifier\": \"pass.com.passdck.test8\",\n \"team_identifier\": \"6J39RL8VD6\"\n }\n ]"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/certificates?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null}]},"devices":{"doc_url":"/doc/devices","api_url":"/api","name":"Devices","short_description":"","full_description":"","version":"1","formats":[],"methods":[{"doc_url":"/doc/devices/index","name":"index","apis":[{"api_url":"/api/v1/templates/:template_id/passes/:id/devices","http_method":"GET","short_description":"Show Devices for a Pass"}],"formats":["json"],"full_description":"Returns the list of Devices registerd for a Pass
\n","errors":[{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Not Found","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"[\n {\n \"identifier\": \"652299c0d9605ab99bcf3fa3ce52addf\",\n \"token\": \"f12afa22a31b8cd4f6c9f0f7d97ba00a7998df5bc51c17bff4092524e69c5f68\",\n \"created_at\": \"2012-11-08T08:22:31Z\",\n \"updated_at\": \"2012-11-08T08:22:31Z\"\n },\n {\n \"identifier\": \"e468ca56e3bf71622d318437718b75df\",\n \"token\": \"f42a3a68c31f40db7d8cdd29af9a0a134361766807e6582bac33eedb4e203610\",\n \"created_at\": \"2012-11-07T13:16:45Z\",\n \"updated_at\": \"2012-11-07T13:16:45Z\"\n }\n ]"}],"params":[{"name":"template_id","full_name":"template_id","description":"Template ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"id","full_name":"id","description":"Pass ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/templates/106/passes/199/devices?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null}]},"families":{"doc_url":"/doc/families","api_url":"/api","name":"Families","short_description":"","full_description":"","version":"1","formats":[],"methods":[{"doc_url":"/doc/families/index","name":"index","apis":[{"api_url":"/api/v1/templates","http_method":"GET","short_description":"Get All Templates"}],"formats":["json"],"full_description":"Returns a JSON of the Templates owned by the user.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"[\n {\n \"auxiliary\": [\n {\n \"changeMessage\": \"Departure time changed to %@\",\n \"dateStyle\": \"PKDateStyleMedium\",\n \"key\": \"departure\",\n \"label\": \"DEPARTURE\",\n \"timeStyle\": \"PKDateStyleMedium\",\n \"value\": \"\"\n }\n ],\n \"back\": [\n {\n \"changeMessage\": \"\",\n \"key\": \"passport\",\n \"label\": \"PASSPORT\",\n \"value\": \"\"\n }\n ],\n \"bar\": {\n \"altText\": \"\",\n \"format\": \"PKBarcodeFormatQR\",\n \"message\": \"\",\n \"messageEncoding\": \"iso-8859-1\"\n },\n \"created_at\": \"2012-10-18T09:03:46Z\",\n \"custom\": [\n {\n \"transitType\": \"PKTransitTypeAir\"\n }\n ],\n \"header\": [\n {\n \"changeMessage\": \"Gate changed to %@\",\n \"key\": \"gate\",\n \"label\": \"GATE\",\n \"value\": \"\"\n }\n ],\n \"id\": 106,\n \"primary\": [\n {\n \"changeMessage\": \"Departure changed in %@\",\n \"key\": \"from\",\n \"label\": \"FROM\",\n \"value\": \"\"\n },\n {\n \"changeMessage\": \"Destination changed to %@\",\n \"key\": \"to\",\n \"label\": \"TO\",\n \"value\": \"\"\n }\n ],\n \"relevance\": {\n \"relevantDate\": \"\"\n },\n \"secondary\": [\n {\n \"changeMessage\": \"Passenger name changed to %@\",\n \"key\": \"name\",\n \"label\": \"NAME\",\n \"value\": \"\"\n }\n ],\n \"title\": \"Passdock Airways\",\n \"updated_at\": \"2012-10-18T09:13:47Z\",\n \"visual\": {\n \"backgroundColor\": \"rgb(237,184,61)\",\n \"foregroundColor\": \"rgb(255,255,255)\",\n \"labelColor\": \"\",\n \"logoText\": \"Passdock Airways\"\n }\n }\n ]"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"Page of results, currently the param is optional, but will be required soon. Each page contains 50 Templates ordered date (more recents first)
\n","required":false,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"}],"examples":["curl -i https://api.passdock.com/api/v1/templates?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/families/show","name":"show","apis":[{"api_url":"/api/v1/templates/:id","http_method":"GET","short_description":"Show Template"}],"formats":["json"],"full_description":"Returns a JSON of the Template
\n","errors":[{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Not Found","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"{\n \"auxiliary\": [\n {\n \"changeMessage\": \"Departure time changed to %@\",\n \"dateStyle\": \"PKDateStyleMedium\",\n \"key\": \"departure\",\n \"label\": \"DEPARTURE\",\n \"timeStyle\": \"PKDateStyleMedium\",\n \"value\": \"\"\n }\n ],\n \"back\": [\n {\n \"changeMessage\": \"\",\n \"key\": \"passport\",\n \"label\": \"PASSPORT\",\n \"value\": \"\"\n }\n ],\n \"bar\": {\n \"altText\": \"\",\n \"format\": \"PKBarcodeFormatQR\",\n \"message\": \"\",\n \"messageEncoding\": \"iso-8859-1\"\n },\n \"created_at\": \"2012-10-18T09:03:46Z\",\n \"custom\": [\n {\n \"transitType\": \"PKTransitTypeAir\"\n }\n ],\n \"header\": [\n {\n \"changeMessage\": \"Gate changed to %@\",\n \"key\": \"gate\",\n \"label\": \"GATE\",\n \"value\": \"\"\n }\n ],\n \"id\": 106,\n \"primary\": [\n {\n \"changeMessage\": \"Departure changed in %@\",\n \"key\": \"from\",\n \"label\": \"FROM\",\n \"value\": \"\"\n },\n {\n \"changeMessage\": \"Destination changed to %@\",\n \"key\": \"to\",\n \"label\": \"TO\",\n \"value\": \"\"\n }\n ],\n \"relevance\": {\n \"relevantDate\": \"\"\n },\n \"secondary\": [\n {\n \"changeMessage\": \"Passenger name changed to %@\",\n \"key\": \"name\",\n \"label\": \"NAME\",\n \"value\": \"\"\n }\n ],\n \"title\": \"Passdock Airways\",\n \"updated_at\": \"2012-10-18T09:13:47Z\",\n \"visual\": {\n \"backgroundColor\": \"rgb(237,184,61)\",\n \"foregroundColor\": \"rgb(255,255,255)\",\n \"labelColor\": \"\",\n \"logoText\": \"Passdock Airways\"\n }\n }"}],"params":[{"name":"id","full_name":"id","description":"Template ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/templates/106?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/families/create","name":"create","apis":[{"api_url":"/api/v1/templates","http_method":"POST","short_description":"Create Template"}],"formats":["json"],"full_description":"Create a new Template for a desired category.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":201,"description":"Created","sample":"{\"id\":12}"},{"code":201,"description":"Created with Debug Enabled","sample":"{\n \"add_serial_to_back\": true,\n \"auxiliary\": null,\n \"back\": null,\n \"bar\": {\n },\n \"custom\": null,\n \"description\": null,\n \"format_version\": null,\n \"header\": [\n {\n \"changeMessage\": \"Gate changed\",\n \"key\": \"gate\",\n \"label\": \"GATE\",\n \"value\": \"\"\n }\n ],\n \"kind_id\": 5,\n \"organization_name\": \"Passdock Airlines\",\n \"pass_type_identifier\": \"pass.passdock.sample1\",\n \"primary\": [\n ],\n \"relevance\": {\n \"relevantDate\": \"\"\n },\n \"secondary\": null,\n \"team_identifier\": \"6J39RL8VD6\",\n \"title\": \"Passdock Airways\",\n \"visual\": {\n \"backgroundColor\": \"rgb(32,87,132)\",\n \"foregroundColor\": \"rgb(255,255,255)\",\n \"labelColor\": \" \"\n }\n }"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"title","full_name":"title","description":"The title of the Template, must be unique between your templates
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"description","full_name":"description","description":"Brief description of the pass, used by the iOS accessibility technologies. Don't try to include all of the data on the pass in its description, just include enough detail to distinguish passes of the same type.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"kind_id","full_name":"kind_id","description":"The category of the Template: 1 for Boarding Pass, 2 for Event Ticket with background and thumbnail, 3 for Coupon, 4 for Store Card, 5 Generic, 6 for Event Ticket with strip.
Certificate to digitally sign each pass and send push notifications.
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"data","full_name":"certificate[data]","description":"The certificate blob in format.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]},{"name":"icon","full_name":"icon","description":"Icon for the Template, appears when the pass is shown in the lockscreen and as mail attachment.
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"filename","full_name":"icon[filename]","description":"Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"icon[data]","description":"Content of the image in base64 format.
Logo for the Template.
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"filename","full_name":"logo[filename]","description":"Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"logo[data]","description":"Content of the image in base64 format.
Background image for the Template, can be set only if the category is Event Ticket (kind_id = 2).
Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"background[data]","description":"Content of the image in base64 format.
Thumbnail image for the Template, can be set only if the category is Event Ticket and Generic (kind_id = 2 or 5).
Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"thumbnail[data]","description":"Content of the image in base64 format.
Strip image for the Template, can be set only if the category is Event Ticket, Coupon and Store Card (kind_id = 3, 4 or 6).
Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"strip[data]","description":"Content of the image in base64 format.
A JSON dictionary containing the template definition
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"header","full_name":"family[header]","description":"An array of fields for the header section, usually of just one element
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"field","full_name":"family[header][field]","description":"An Hash for each field
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"key","full_name":"family[header][field][key]","description":"The key for the field, invisible on the pass. Is used to create the passes via API as field identifier.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"label","full_name":"family[header][field][label]","description":"The label for the field, usually placed above the value.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"family[header][field][value]","description":"The value of the field, usually placed below the label.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"changeMessage","full_name":"family[header][field][changeMessage]","description":"The change message that will be shown in the lock screen and as notification when the value for the field is changed remotely.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"textAlignment","full_name":"family[header][field][textAlignment]","description":"Alignment for the field's contents. Must be one of the following values: PKTextAlignmentLeft, PKTextAlignmentCenter, PKTextAlignmentRight, PKTextAlignmentNatural.\nThis key is not allowed for primary fields.
Style of date to display. Must be one of the following values: PKDateStyleNone, PKDateStyleShort, PKDateStyleMedium, PKDateStyleLong, PKDateStyleFull.
Style of time to display. Must be one of the following values: PKDateStyleNone, PKDateStyleShort, PKDateStyleMedium, PKDateStyleLong, PKDateStyleFull.
If true, the label\\'s value is displayed as a relative date; otherwise, it is displayed as an absolute date. The default value is false.
ISO 4217 currency code for the field's value.
Style of number to display. Must be one of the following values: PKNumberStyleDecimal, PKNumberStylePercent, PKNumberStyleScientific, PKNumberStyleSpellOut.
Parameters related to the appearance of the pass
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"backgroundColor","full_name":"family[visual][backgroundColor]","description":"Background color of the pass, specified as an CSS-style RGB triple. For example, rgb(23, 187, 82).
Foreground color of the pass, specified as a CSS-style RGB triple. For example, rgb(100, 10, 110).
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"labelColor","full_name":"family[visual][labelColor]","description":"Color of the label text, specified as a CSS-style RGB triple. For example, rgb(255, 255, 255). If omitted, the label color is determined automatically.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"logoText","full_name":"family[visual][logoText]","description":"Text displayed next to the logo on the pass.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"suppressStripShine","full_name":"family[visual][suppressStripShine]","description":"If true and a strip image is present, the strip image is displayed without a shine effect. The default value is false.
An array of fields for the primary section
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"field","full_name":"family[primary][field]","description":"Exactly like the field for the header section
\n","required":false,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash"}]},{"name":"secondary","full_name":"family[secondary]","description":"An array of fields for the secondary section
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"field","full_name":"family[secondary][field]","description":"Exactly like the field for the header section
\n","required":false,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash"}]},{"name":"auxiliary","full_name":"family[auxiliary]","description":"An array of fields for the auxiliary section
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"field","full_name":"family[auxiliary][field]","description":"Exactly like the field for the header section
\n","required":false,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash"}]},{"name":"back","full_name":"family[back]","description":"An array of fields for the back section
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"field","full_name":"family[back][field]","description":"Exactly like the field for the header section
\n","required":false,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash"}]},{"name":"custom","full_name":"family[custom]","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"transitType","full_name":"family[custom][transitType]","description":"Required for boarding passes; otherwise not allowed. Type of transit. Must be one of the following values: PKTransitTypeAir, PKTransitTypeBoat, PKTransitTypeBus, PKTransitTypeGeneric, PKTransitTypeTrain.
An hash containing the Bar Section informations
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"message","full_name":"family[bar][message]","description":"The message to be put in the 2D code
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"format","full_name":"family[bar][format]","description":"Barcode format. Must be one of the following values: PKBarcodeFormatQR, PKBarcodeFormatPDF417, PKBarcodeFormatAztec.
The alternative text that will be put below the bar code.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"messageEncoding","full_name":"family[bar][messageEncoding]","description":"Text encoding that is used to convert the message from the string representation to a data representation to render the barcode. The value is typically iso-8859-1, but you may use another encoding that is supported by your barcode scanning infrastructure.
An hash containing the relevance informations like date, time and positions.
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"locations","full_name":"family[relevance][locations]","description":"Array of locations where the pass will appear on the lockscreen
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"latitude","full_name":"family[relevance][locations][latitude]","description":"Latitude
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"longitude","full_name":"family[relevance][locations][longitude]","description":"Longitude
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"altitude","full_name":"family[relevance][locations][altitude]","description":"Altitude
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"relevantText","full_name":"family[relevance][locations][relevantText]","description":"Text that will appear on the lockscreen when the place is reached.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]},{"name":"relevantDate","full_name":"family[relevance][relevantDate]","description":"Date and Time when the pass will appear on the lockscreen. Use ISO8601 format.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}]},{"name":"limit_to_1_device","full_name":"limit_to_1_device","description":"Limit to 1 device per pass
\n","required":false,"allow_nil":false,"validator":"Must be one of: 0, 1.","expected_type":"string"},{"name":"debug","full_name":"debug","description":"You get in response a JSON with the created object.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"errors","full_name":"errors","description":"If an error occurs you get the messages and not only the code.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"}],"examples":["curl -i -d 'debug=true&errors=true&family={\"title\":\"Passdock Airways\",\"header\":[{\"key\":\"gate\",\"label\":\"GATE\",\"value\":\"\",\"changeMessage\":\"Gate changed\"}],\"primary\":[],\"custom\":null,\"visual\":{\"backgroundColor\":\"rgb(32,87,132)\",\"foregroundColor\":\"rgb(255,255,255)\",\"labelColor\":\" \"},\"relevance\":{\"relevantDate\":\"\"},\"bar\":{}, \"organization_name\":\"Passdock Airlines\",\"kind_id\":5}&certificate={\"data\":\"THE_CERTIFICATE_ATTRIBUTE_BAG\"}&icon={\"filename\":\"test.png\",\"data\":\"THE_BASE_64_ENCODED_IMAGE\"}' https://api.passdock.com/api/v1/templates?api_token=11edb4f913d11cfa7ce8b61546948a3f\n"],"see":null,"see_url":null},{"doc_url":"/doc/families/update","name":"update","apis":[{"api_url":"/api/v1/templates/:template_id","http_method":"PUT","short_description":"Update Template"}],"formats":["json"],"full_description":"Update a desired Template.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"{\"id\":12}"},{"code":200,"description":"Updated with Debug Enabled","sample":"{\n \"add_serial_to_back\": true,\n \"auxiliary\": null,\n \"back\": null,\n \"bar\": {\n },\n \"custom\": null,\n \"description\": null,\n \"format_version\": null,\n \"header\": [\n {\n \"changeMessage\": \"Gate changed\",\n \"key\": \"gate\",\n \"label\": \"GATE\",\n \"value\": \"\"\n }\n ],\n \"organization_name\": \"Passdock Airlines\",\n \"pass_type_identifier\": \"pass.passdock.sample1\",\n \"primary\": [\n ],\n \"relevance\": {\n \"relevantDate\": \"\"\n },\n \"secondary\": null,\n \"team_identifier\": \"6J39RL8VD6\",\n \"title\": \"Passdock Airways\",\n \"visual\": {\n \"backgroundColor\": \"rgb(32,87,132)\",\n \"foregroundColor\": \"rgb(255,255,255)\",\n \"labelColor\": \" \"\n }\n }"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"title","full_name":"title","description":"The title of the Template, must be unique between your templates
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"description","full_name":"description","description":"Brief description of the pass, used by the iOS accessibility technologies. Don't try to include all of the data on the pass in its description, just include enough detail to distinguish passes of the same type.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"certificate","full_name":"certificate","description":"Certificate to digitally sign each pass and send push notifications.
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"data","full_name":"certificate[data]","description":"The certificate blob in format.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]},{"name":"icon","full_name":"icon","description":"Icon for the Template, appears when the pass is shown in the lockscreen and as mail attachment.
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"filename","full_name":"icon[filename]","description":"Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"icon[data]","description":"Content of the image in base64 format.
Logo for the Template.
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"filename","full_name":"logo[filename]","description":"Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"logo[data]","description":"Content of the image in base64 format.
Background image for the Template, can be set only if the category is Event Ticket (kind_id = 2).
Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"background[data]","description":"Content of the image in base64 format.
Thumbnail image for the Template, can be set only if the category is Event Ticket and Generic (kind_id = 2 or 5).
Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"thumbnail[data]","description":"Content of the image in base64 format.
Strip image for the Template, can be set only if the category is Event Ticket, Coupon and Store Card (kind_id = 3, 4 or 6).
Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"strip[data]","description":"Content of the image in base64 format.
A JSON dictionary containing the template definition
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"header","full_name":"family[header]","description":"An array of fields for the header section, usually of just one element
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"field","full_name":"family[header][field]","description":"An Hash for each field
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"key","full_name":"family[header][field][key]","description":"The key for the field, invisible on the pass. Is used to create the passes via API as field identifier.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"label","full_name":"family[header][field][label]","description":"The label for the field, usually placed above the value.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"family[header][field][value]","description":"The value of the field, usually placed below the label.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"changeMessage","full_name":"family[header][field][changeMessage]","description":"The change message that will be shown in the lock screen and as notification when the value for the field is changed remotely.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"textAlignment","full_name":"family[header][field][textAlignment]","description":"Alignment for the field's contents. Must be one of the following values: PKTextAlignmentLeft, PKTextAlignmentCenter, PKTextAlignmentRight, PKTextAlignmentNatural.\nThis key is not allowed for primary fields.
Style of date to display. Must be one of the following values: PKDateStyleNone, PKDateStyleShort, PKDateStyleMedium, PKDateStyleLong, PKDateStyleFull.
Style of time to display. Must be one of the following values: PKDateStyleNone, PKDateStyleShort, PKDateStyleMedium, PKDateStyleLong, PKDateStyleFull.
If true, the label\\'s value is displayed as a relative date; otherwise, it is displayed as an absolute date. The default value is false.
ISO 4217 currency code for the field's value.
Style of number to display. Must be one of the following values: PKNumberStyleDecimal, PKNumberStylePercent, PKNumberStyleScientific, PKNumberStyleSpellOut.
Parameters related to the appearance of the pass
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"backgroundColor","full_name":"family[visual][backgroundColor]","description":"Background color of the pass, specified as an CSS-style RGB triple. For example, rgb(23, 187, 82).
Foreground color of the pass, specified as a CSS-style RGB triple. For example, rgb(100, 10, 110).
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"labelColor","full_name":"family[visual][labelColor]","description":"Color of the label text, specified as a CSS-style RGB triple. For example, rgb(255, 255, 255). If omitted, the label color is determined automatically.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"logoText","full_name":"family[visual][logoText]","description":"Text displayed next to the logo on the pass.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"suppressStripShine","full_name":"family[visual][suppressStripShine]","description":"If true and a strip image is present, the strip image is displayed without a shine effect. The default value is false.
An array of fields for the primary section
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"field","full_name":"family[primary][field]","description":"Exactly like the field for the header section
\n","required":false,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash"}]},{"name":"secondary","full_name":"family[secondary]","description":"An array of fields for the secondary section
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"field","full_name":"family[secondary][field]","description":"Exactly like the field for the header section
\n","required":false,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash"}]},{"name":"auxiliary","full_name":"family[auxiliary]","description":"An array of fields for the auxiliary section
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"field","full_name":"family[auxiliary][field]","description":"Exactly like the field for the header section
\n","required":false,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash"}]},{"name":"back","full_name":"family[back]","description":"An array of fields for the back section
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"field","full_name":"family[back][field]","description":"Exactly like the field for the header section
\n","required":false,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash"}]},{"name":"custom","full_name":"family[custom]","description":"","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"transitType","full_name":"family[custom][transitType]","description":"Required for boarding passes; otherwise not allowed. Type of transit. Must be one of the following values: PKTransitTypeAir, PKTransitTypeBoat, PKTransitTypeBus, PKTransitTypeGeneric, PKTransitTypeTrain.
An hash containing the Bar Section informations
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"message","full_name":"family[bar][message]","description":"The message to be put in the 2D code
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"format","full_name":"family[bar][format]","description":"Barcode format. Must be one of the following values: PKBarcodeFormatQR, PKBarcodeFormatPDF417, PKBarcodeFormatAztec.
The alternative text that will be put below the bar code.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"messageEncoding","full_name":"family[bar][messageEncoding]","description":"Text encoding that is used to convert the message from the string representation to a data representation to render the barcode. The value is typically iso-8859-1, but you may use another encoding that is supported by your barcode scanning infrastructure.
An hash containing the relevance informations like date, time and positions.
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"locations","full_name":"family[relevance][locations]","description":"Array of locations where the pass will appear on the lockscreen
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"latitude","full_name":"family[relevance][locations][latitude]","description":"Latitude
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"longitude","full_name":"family[relevance][locations][longitude]","description":"Longitude
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"altitude","full_name":"family[relevance][locations][altitude]","description":"Altitude
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"relevantText","full_name":"family[relevance][locations][relevantText]","description":"Text that will appear on the lockscreen when the place is reached.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]},{"name":"relevantDate","full_name":"family[relevance][relevantDate]","description":"Date and Time when the pass will appear on the lockscreen. Use ISO8601 format.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}]},{"name":"limit_to_1_device","full_name":"limit_to_1_device","description":"Limit to 1 device per pass
\n","required":false,"allow_nil":false,"validator":"Must be one of: 0, 1.","expected_type":"string"},{"name":"debug","full_name":"debug","description":"You get in response a JSON with the created object.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"errors","full_name":"errors","description":"If an error occurs you get the messages and not only the code.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"}],"examples":[],"see":null,"see_url":null},{"doc_url":"/doc/families/destroy","name":"destroy","apis":[{"api_url":"/api/v1/templates/:id","http_method":"DELETE","short_description":"Delete Template"}],"formats":["json"],"full_description":"Destroy a Template.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Template Not Found","sample":null}],"successes":[{"code":200,"description":"Deleted","sample":null}],"params":[{"name":"id","full_name":"id","description":"Template ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i -X DELETE https://api.passdock.com/api/v1/templates/106?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/families/fields","name":"fields","apis":[{"api_url":"/api/v1/templates/:id/fields","http_method":"GET","short_description":"Get Editable Fields"}],"formats":["json"],"full_description":"Get editable fields for a desired Template.
\n\nYou will get an array of editable fields. Each field is named with the key of the field. For each field you get an array of editable options:
value means that you can set the value for each Pass;label means that you can set the lable for each Pass;changeMessage means that you can set a different change message for each pass.In the same array you get the field type if it isn't a String:
\n\ndate means that the field is a date and you must write the value in the ISO8601 format;time means that the field is a time and you must write the value in the ISO8601 format;currency means that the field represent money and you must write the value in the ISO4217 format;number means that the field is a number.Besides the array fields you can get another array with the images that can be set for each Pass:
\n\nthumbnail means that you can upload a thumbnail for each Pass.Template ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/templates/fields?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null}]},"lists":{"doc_url":"/doc/lists","api_url":"/api","name":"Lists","short_description":"","full_description":"","version":"1","formats":[],"methods":[{"doc_url":"/doc/lists/index","name":"index","apis":[{"api_url":"/api/v1/lists","http_method":"GET","short_description":"Get all lists"}],"formats":["json"],"full_description":"Returns the lists in your address book.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null},{"code":414,"description":"You don't have an address book","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n[\n {\n id: \"5342a521434236f5e7000007\",\n name: \"Work\"\n },\n {\n id: \"5342a521434236f5e7023007\",\n name: \"Home\"\n }\n]"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/lists?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/lists/show","name":"show","apis":[{"api_url":"/api/v1/lists/:id","http_method":"GET","short_description":"Show a list"}],"formats":["json"],"full_description":"Returns a List from your address book
\n","errors":[{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Not Found","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n{\n id: \"5342a521434236f5e7000007\",\n name: \"Work\",\n person_ids: [\n \"5342a53e86d256f5e7000006\",\n \"5342a53e86d256f5e7000016\"\n ]\n}"}],"params":[{"name":"id","full_name":"id","description":"List ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/lists/511e5ce039078c08d8000033?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/lists/create","name":"create","apis":[{"api_url":"/api/v1/lists","http_method":"POST","short_description":"Create a List"}],"formats":["json"],"full_description":"Create a new list in your address book.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":201,"description":"Created","sample":"\n{\n id: \"5342a521434236f5e7000007\",\n name: \"Work\",\n person_ids: [\n \"5342a53e86d256f5e7000006\",\n \"5342a53e86d256f5e7000016\"\n ]\n}"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"list","full_name":"list","description":"Object that contains List's informations
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"list[name]","description":"List's name
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"list_ids","full_name":"list[list_ids]","description":"IDs of people that belongs to list
\n","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"}]}],"examples":["curl -i -H \"Content-Type: application/json\" -d '{\"list\":{\"name\":\"Work\", \"person_ids\":[\"12ab8e008f0d0c8a090f9c0b\"]}}' https://api.passdock.com/api/v1/lists?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/lists/update","name":"update","apis":[{"api_url":"/api/v1/lists/:id","http_method":"PUT","short_description":"Update List"}],"formats":["json"],"full_description":"Update a List.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":""}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"List ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"list","full_name":"list","description":"Object that contains List's informations
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"list[name]","description":"List's name
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"list_ids","full_name":"list[list_ids]","description":"IDs of people that belongs to list
\n","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"}]}],"examples":["curl -i -X PUT -H \"Content-Type: application/json\" -d '{\"list\":{\"name\":\"Work\", \"person_ids\":[\"12ab8e008f0d0c8a090f9c0b\"]}}' https://api.passdock.com/api/v1/lists/511e5ce039078c08d8000035?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/lists/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lists/:id","http_method":"DELETE","short_description":"Delete List"}],"formats":["json"],"full_description":"Destroy a List.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"List Not Found","sample":null}],"successes":[{"code":200,"description":"Deleted","sample":null}],"params":[{"name":"id","full_name":"id","description":"List ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i -X DELETE https://api.passdock.com/api/v1/lists/106?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null}]},"passes":{"doc_url":"/doc/passes","api_url":"/api","name":"Passes","short_description":"","full_description":"","version":"1","formats":[],"methods":[{"doc_url":"/doc/passes/index","name":"index","apis":[{"api_url":"/api/v1/templates/:template_id/passes","http_method":"GET","short_description":"Get All Passes"}],"formats":["json"],"full_description":"Returns a JSON of the Passes for a given Template.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"[\n {\n \"auxiliary\": [\n {\n \"changeMessage\": \"Departure time changed to %@\",\n \"dateStyle\": \"PKDateStyleMedium\",\n \"key\": \"departure\",\n \"label\": \"DEPARTURE\",\n \"timeStyle\": \"PKDateStyleMedium\",\n \"value\": \"2012-11-12T10:12:20-08:00\"\n }\n ],\n \"back\": [\n {\n \"changeMessage\": \"\",\n \"key\": \"passport\",\n \"label\": \"PASSPORT\",\n \"value\": \"United States of America.\"\n }\n ],\n \"bar\": {\n \"format\": \"PKBarcodeFormatQR\",\n \"message\": \"1350551026\",\n \"messageEncoding\": \"iso-8859-1\"\n },\n \"created_at\": \"2012-10-18T09:03:47Z\",\n \"custom\": [\n {\n \"transitType\": \"PKTransitTypeAir\"\n }\n ],\n \"family_id\": 106,\n \"header\": [\n {\n \"changeMessage\": \"Gate changed to %@\",\n \"key\": \"gate\",\n \"label\": \"GATE\",\n \"value\": \"56\"\n }\n ],\n \"id\": 199,\n \"download\": \"https://api.passdock.com/passes/199/cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9.pkpass\",\n \"primary\": [\n {\n \"changeMessage\": \"Departure changed in %@\",\n \"key\": \"from\",\n \"label\": \"FROM\",\n \"value\": \"NYC\"\n },\n {\n \"changeMessage\": \"Destination changed to %@\",\n \"key\": \"to\",\n \"label\": \"TO\",\n \"value\": \"SFO\"\n }\n ],\n \"relevance\": {\n \"locations\": [\n ]\n },\n \"secondary\": [\n {\n \"changeMessage\": \"Passenger name changed to %@\",\n \"key\": \"name\",\n \"label\": \"NAME\",\n \"value\": \"James Smith\"\n }\n ],\n \"serial_number\": \"serial-1350551026\",\n \"updated_at\": \"2012-10-18T09:15:31Z\",\n \"visual\": {\n \"backgroundColor\": \"rgb(237,184,61)\",\n \"foregroundColor\": \"rgb(255,255,255)\",\n \"labelColor\": \"\",\n \"logoText\": \"Passdock Airways\"\n },\n \"web_token\": \"cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9\"\n }\n ]"},{"code":200,"description":"Good Request in compact mode","sample":"[\n {\n \"download\": \"https://api.passdock.com/passes/199/cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9.pkpass\",\n \"family_id\": 106,\n \"id\": 199,\n \"redeemed_at\": null,\n \"web_token\": \"cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9\"\n },\n {\n \"download\": \"https://api.passdock.com/passes/200/793a4b7f81e9a7ee27746f3104d97fe0638d05c3.pkpass\",\n \"family_id\": 106,\n \"id\": 200,\n \"redeemed_at\": null,\n \"web_token\": \"793a4b7f81e9a7ee27746f3104d97fe0638d05c3\"\n },\n {\n \"download\": \"https://api.passdock.com/passes/201/b48c646805c50fdf04a6ffa5d187687e4f578522.pkpass\",\n \"family_id\": 106,\n \"id\": 201,\n \"redeemed_at\": null,\n \"web_token\": \"b48c646805c50fdf04a6ffa5d187687e4f578522\"\n }\n ]"}],"params":[{"name":"template_id","full_name":"template_id","description":"Template ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"compact","full_name":"compact","description":"Choose to get the Pass list and not the full Pass json file
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"page","full_name":"page","description":"Page of results, currently the param is optional, but will be required soon. Each page contains 50 Passes ordered date (more recents first)
\n","required":false,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"}],"examples":["curl -i https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780&compact=true","curl -i https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780&compact=true&page=1"],"see":null,"see_url":null},{"doc_url":"/doc/passes/show","name":"show","apis":[{"api_url":"/api/v1/templates/:template_id/passes/:id","http_method":"GET","short_description":"Show Pass"}],"formats":["json"],"full_description":"Returns a JSON of the Pass for a given Template
\n","errors":[{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Not Found","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"{\n \"auxiliary\": [\n {\n \"changeMessage\": \"Departure time changed to %@\",\n \"dateStyle\": \"PKDateStyleMedium\",\n \"key\": \"departure\",\n \"label\": \"DEPARTURE\",\n \"timeStyle\": \"PKDateStyleMedium\",\n \"value\": \"2012-11-12T10:12:20-08:00\"\n }\n ],\n \"back\": [\n {\n \"changeMessage\": \"\",\n \"key\": \"passport\",\n \"label\": \"PASSPORT\",\n \"value\": \"United States of America.\"\n }\n ],\n \"bar\": {\n \"format\": \"PKBarcodeFormatQR\",\n \"message\": \"1350551026\",\n \"messageEncoding\": \"iso-8859-1\"\n },\n \"created_at\": \"2012-10-18T09:03:47Z\",\n \"custom\": [\n {\n \"transitType\": \"PKTransitTypeAir\"\n }\n ],\n \"download\": \"https://api.passdock.com/passes/199/cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9.pkpass\",\n \"family_id\": 106,\n \"header\": [\n {\n \"changeMessage\": \"Gate changed to %@\",\n \"key\": \"gate\",\n \"label\": \"GATE\",\n \"value\": \"56\"\n }\n ],\n \"id\": 199,\n \"primary\": [\n {\n \"changeMessage\": \"Departure changed in %@\",\n \"key\": \"from\",\n \"label\": \"FROM\",\n \"value\": \"NYC\"\n },\n {\n \"changeMessage\": \"Destination changed to %@\",\n \"key\": \"to\",\n \"label\": \"TO\",\n \"value\": \"SFO\"\n }\n ],\n \"relevance\": {\n \"locations\": [\n ]\n },\n \"secondary\": [\n {\n \"changeMessage\": \"Passenger name changed to %@\",\n \"key\": \"name\",\n \"label\": \"NAME\",\n \"value\": \"James Smith\"\n }\n ],\n \"serial_number\": \"serial-1350551026\",\n \"updated_at\": \"2012-10-18T09:15:31Z\",\n \"visual\": {\n \"backgroundColor\": \"rgb(237,184,61)\",\n \"foregroundColor\": \"rgb(255,255,255)\",\n \"labelColor\": \"\",\n \"logoText\": \"Passdock Airways\"\n },\n \"web_token\": \"cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9\",\n \"render_html_url\": \"http://api.passdock.com/p/ID/TOKEN\"\n }"}],"params":[{"name":"template_id","full_name":"template_id","description":"Template ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"id","full_name":"id","description":"Pass ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/templates/106/passes/199?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/passes/create","name":"create","apis":[{"api_url":"/api/v1/templates/:template_id/passes","http_method":"POST","short_description":"Create Pass"}],"formats":["json"],"full_description":"Create a new Pass from a pre-defined Template with the given keys/values pairs.\n In the Pass' json you can use these shortcuts:
\n\nkey just pass "gate":"53"key pass "gate":{"value":"53","label":"GATE"}Template ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"pass","full_name":"pass","description":"A JSON dictionary containing the pass keys and values
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"serial_number","full_name":"pass[serial_number]","description":"The serial number for the Pass, must be unique and cannot be changed
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"redeemed","full_name":"pass[redeemed]","description":"If the Pass has been redeemed or not.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"KEY","full_name":"pass[KEY]","description":"The desired keys that are present in the template and left empty.
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"label","full_name":"pass[KEY][label]","description":"The label for the field, usually placed above the value.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"pass[KEY][value]","description":"The value of the field, usually placed below the label.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"changeMessage","full_name":"pass[KEY][changeMessage]","description":"The change message that will be shown in the lock screen and as notification when the value for the field is changed remotely.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]},{"name":"bar","full_name":"pass[bar]","description":"An hash containing the Bar Section informations
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"message","full_name":"pass[bar][message]","description":"The message to be put in the 2D code
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"altText","full_name":"pass[bar][altText]","description":"The alternative text that will be put below the bar code.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]},{"name":"relevance","full_name":"pass[relevance]","description":"An hash containing the relevance informations like date, time and positions.
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"locations","full_name":"pass[relevance][locations]","description":"Array of locations where the pass will appear on the lockscreen
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"latitude","full_name":"pass[relevance][locations][latitude]","description":"Latitude
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"longitude","full_name":"pass[relevance][locations][longitude]","description":"Longitude
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"altitude","full_name":"pass[relevance][locations][altitude]","description":"Altitude
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"relevantText","full_name":"pass[relevance][locations][relevantText]","description":"Text that will appear on the lockscreen when the place is reached.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]},{"name":"relevantDate","full_name":"pass[relevance][relevantDate]","description":"Date and Time when the pass will appear on the lockscreen. Use ISO8601 format.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}]},{"name":"thumbnail","full_name":"thumbnail","description":"Thumbnail image for the Pass, can be set only if the category is Event Ticket and Generic (kind_id = 2 or 5).
Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"thumbnail[data]","description":"Content of the image in base64 format.
You get in response a JSON with the created object.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"errors","full_name":"errors","description":"If an error occurs you get the messages and not only the code.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"}],"examples":["curl -i -d 'pass={\"serial_number\":\"1234567\", \"gate\":\"53\", \"departure\":\"2012-12-18T14:34:10-02:00\"}' https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i -H \"Content-Type: application/json\" -d '{\"pass\":{\"serial_number\":\"1234567\", \"gate\":\"53\", \"departure\":\"2012-12-18T14:34:10-02:00\"}}' https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i -d 'pass={\"redeemed\":false,\"serial_number\":\"1234567\", \"gate\":\"53\", \"departure\":\"2012-12-18T14:34:10-02:00\"}' https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i -d 'debug=true&pass={\"serial_number\":\"4567891\", \"bar\":{\"message\":\"QRRSNDKAIUDS923\", \"altText\":\"QRRSNDKAIUDS923\"}, \"gate\":{\"value\":\"53\"},\"departure\":\"2012-11-14T08:12:19-08:00\"}' https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i -d 'debug=true&pass={\"serial_number\":\"7891234\", \"relevance\":{\"locations\":[{\"latitude\":12.122342, \"longitude\":64.123353}]}, \"gate\":{\"value\":\"98\"},\"departure\":\"2012-11-14T08:12:19-08:00\"}' https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i -d 'pass={\"serial_number\":\"1234567\", \"gate\":\"53\", \"departure\":\"2012-12-18T14:34:10-02:00\"}&thumbnail={\"filename\":\"test.png\",\"data\":\"THE_BASE_64_ENCODED_IMAGE\"}' https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/passes/update","name":"update","apis":[{"api_url":"/api/v1/templates/:template_id/passes/:id","http_method":"PUT","short_description":"Update Pass"}],"formats":["json"],"full_description":"Update an existing Pass with the given Template and, changing the keys contained in the pass JSON dictionary.\n In the Pass' json you can use these shortcuts:
key just pass "gate":"53"key pass "gate":{"value":"53","label":"GATE"}Pass ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"template_id","full_name":"template_id","description":"Template ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"pass","full_name":"pass","description":"A JSON dictionary containing the pass keys and values
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"redeemed","full_name":"pass[redeemed]","description":"If the Pass has been redeemed or not.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"KEY","full_name":"pass[KEY]","description":"The desired keys that are present in the template and left empty.
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"label","full_name":"pass[KEY][label]","description":"The label for the field, usually placed above the value.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"pass[KEY][value]","description":"The value of the field, usually placed below the label.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"changeMessage","full_name":"pass[KEY][changeMessage]","description":"The change message that will be shown in the lock screen and as notification when the value for the field is changed remotely.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]},{"name":"bar","full_name":"pass[bar]","description":"An hash containing the Bar Section informations
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"message","full_name":"pass[bar][message]","description":"The message to be put in the 2D code
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"altText","full_name":"pass[bar][altText]","description":"The alternative text that will be put below the bar code.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]},{"name":"relevance","full_name":"pass[relevance]","description":"An hash containing the relevance informations like date, time and positions.
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"locations","full_name":"pass[relevance][locations]","description":"Array of locations where the pass will appear on the lockscreen
\n","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"latitude","full_name":"pass[relevance][locations][latitude]","description":"Latitude
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"longitude","full_name":"pass[relevance][locations][longitude]","description":"Longitude
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"altitude","full_name":"pass[relevance][locations][altitude]","description":"Altitude
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"relevantText","full_name":"pass[relevance][locations][relevantText]","description":"Text that will appear on the lockscreen when the place is reached.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]},{"name":"relevantDate","full_name":"pass[relevance][relevantDate]","description":"Date and Time when the pass will appear on the lockscreen. Use ISO8601 format.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}]},{"name":"thumbnail","full_name":"thumbnail","description":"Thumbnail image for the Pass, can be set only if the category is Event Ticket and Generic (kind_id = 2 or 5).
Name of the file.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"data","full_name":"thumbnail[data]","description":"Content of the image in base64 format.
You get in response a JSON with the updated object.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"errors","full_name":"errors","description":"If an error occurs you get the messages and not only the code.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"}],"examples":["curl -i -X PUT -d 'pass={\"gate\":\"53\", \"departure\":\"2012-12-18T14:34:10-02:00\"}' https://api.passdock.com/api/v1/templates/106/passes/203?api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i -X PUT -H \"Content-Type: application/json\" -d '{\"pass\":{\"gate\":\"53\", \"departure\":\"2012-12-18T14:34:10-02:00\"}}' https://api.passdock.com/api/v1/templates/106/passes/203?api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i -X PUT -d 'pass={\"redeemed\":true}' https://api.passdock.com/api/v1/templates/106/passes/203?api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i -X PUT -d 'debug=true&pass={\"bar\":{\"message\":\"QRRSNDKAIUDS923\", \"altText\":\"QRRSNDKAIUDS923\"}, \"gate\":{\"value\":\"53\"},\"departure\":\"2012-11-14T08:12:19-08:00\"}' https://api.passdock.com/api/v1/templates/106/passes/203?api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i -X PUT -d 'debug=true&pass={\"relevance\":{\"locations\":[{\"latitude\":12.122342, \"longitude\":64.123353}]}, \"gate\":{\"value\":\"98\"},\"departure\":\"2012-11-14T08:12:19-08:00\"}' https://api.passdock.com/api/v1/templates/106/passes/203?api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i -X PUT -d 'pass={\"gate\":\"53\", \"departure\":\"2012-12-18T14:34:10-02:00\"}&thumbnail={\"filename\":\"test.png\",\"data\":\"THE_BASE_64_ENCODED_IMAGE\"}' https://api.passdock.com/api/v1/templates/106/passes/203?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/passes/redeem","name":"redeem","apis":[{"api_url":"/api/v1/templates/:template_id/passes/:id/redeem","http_method":"PUT","short_description":"Redeem a Pass"}],"formats":["json"],"full_description":"Redeem an existing Pass with the given Template.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Pass Not Found","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"{\n \"family_id\": 217,\n \"id\": 324,\n \"web_token\": \"5d16ecabb1d961a3aecd9eeaa2ddec9f45d43875\",\n \"download\": \"https://api.passdock.com/passes/217/5d16ecabb1d961a3aecd9eeaa2ddec9f45d43875.pkpass\"\n }"}],"params":[{"name":"id","full_name":"id","description":"Pass ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"template_id","full_name":"template_id","description":"Template ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"redeemed","full_name":"redeemed","description":"If the Pass should be reedeemed or unredeemed
\n","required":true,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"debug","full_name":"debug","description":"You get in response a JSON with the updated object.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"errors","full_name":"errors","description":"If an error occurs you get the messages and not only the code.
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"}],"examples":["curl -i -X PUT https://api.passdock.com/api/v1/templates/106/passes/203/redeem?redeemed=true&api_token=75778a65dfdae310a107d2ef0bbd3780","curl -i -X PUT https://api.passdock.com/api/v1/templates/106/passes/203/redeem?redeemed=false&api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/passes/destroy","name":"destroy","apis":[{"api_url":"/api/v1/templates/:template_id/passes/:id","http_method":"DELETE","short_description":"Delete Pass"}],"formats":["json"],"full_description":"Destroy a Pass with the given Template.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Pass Not Found","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":null}],"params":[{"name":"template_id","full_name":"template_id","description":"Template ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"id","full_name":"id","description":"Pass ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i -X DELETE https://api.passdock.com/api/v1/templates/106/passes/203?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/passes/search","name":"search","apis":[{"api_url":"/api/v1/templates/:template_id/passes/search","http_method":"GET","short_description":"Search for a Pass"}],"formats":["json"],"full_description":"Search a Pass with a serial number
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Pass Not Found","sample":null},{"code":423,"description":"Serial number too short (at least 3 chars)","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"{\n \"auxiliary\": [\n {\n \"changeMessage\": \"Departure time changed to %@\",\n \"dateStyle\": \"PKDateStyleMedium\",\n \"key\": \"departure\",\n \"label\": \"DEPARTURE\",\n \"timeStyle\": \"PKDateStyleMedium\",\n \"value\": \"2012-11-12T10:12:20-08:00\"\n }\n ],\n \"back\": [\n {\n \"changeMessage\": \"\",\n \"key\": \"passport\",\n \"label\": \"PASSPORT\",\n \"value\": \"United States of America.\"\n }\n ],\n \"bar\": {\n \"format\": \"PKBarcodeFormatQR\",\n \"message\": \"1350551026\",\n \"messageEncoding\": \"iso-8859-1\"\n },\n \"created_at\": \"2012-10-18T09:03:47Z\",\n \"custom\": [\n {\n \"transitType\": \"PKTransitTypeAir\"\n }\n ],\n \"download\": \"https://api.passdock.com/passes/199/cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9.pkpass\",\n \"family_id\": 106,\n \"header\": [\n {\n \"changeMessage\": \"Gate changed to %@\",\n \"key\": \"gate\",\n \"label\": \"GATE\",\n \"value\": \"56\"\n }\n ],\n \"id\": 199,\n \"primary\": [\n {\n \"changeMessage\": \"Departure changed in %@\",\n \"key\": \"from\",\n \"label\": \"FROM\",\n \"value\": \"NYC\"\n },\n {\n \"changeMessage\": \"Destination changed to %@\",\n \"key\": \"to\",\n \"label\": \"TO\",\n \"value\": \"SFO\"\n }\n ],\n \"relevance\": {\n \"locations\": [\n ]\n },\n \"secondary\": [\n {\n \"changeMessage\": \"Passenger name changed to %@\",\n \"key\": \"name\",\n \"label\": \"NAME\",\n \"value\": \"James Smith\"\n }\n ],\n \"serial_number\": \"serial-1350551026\",\n \"updated_at\": \"2012-10-18T09:15:31Z\",\n \"visual\": {\n \"backgroundColor\": \"rgb(237,184,61)\",\n \"foregroundColor\": \"rgb(255,255,255)\",\n \"labelColor\": \"\",\n \"logoText\": \"Passdock Airways\"\n },\n \"web_token\": \"cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9\"\n }"},{"code":200,"description":"Good Request with Many paramenter.","sample":"[\n {\n \"code\": \"This is the message inside the QR Code.\",\n \"download\": \"https://api.passdock.com/passes/34/0e21273510a9bc18fc05572842f461970583e3de.pkpass\",\n \"family_id\": 25,\n \"id\": 34,\n \"redeemed_at\": null,\n \"serial_number\": \"ObjC-API-65\",\n \"type\": 1,\n \"web_token\": \"0e21273510a9bc18fc05572842f461970583e3de\"\n },\n {\n \"code\": \"This is the message inside the QR Code.\",\n \"download\": \"https://api.passdock.com/passes/35/89b8cd9af2a98cc9bf21dd6050acc56fe43426f6.pkpass\",\n \"family_id\": 25,\n \"id\": 35,\n \"redeemed_at\": null,\n \"serial_number\": \"ObjC-API-78\",\n \"type\": 1,\n \"web_token\": \"89b8cd9af2a98cc9bf21dd6050acc56fe43426f6\"\n },\n {\n \"code\": \"This is the message inside the QR Code.\",\n \"download\": \"https://api.passdock.com/passes/36/9fb8daf956a1de6095e9a4f3cd0c97526701834c.pkpass\",\n \"family_id\": 25,\n \"id\": 36,\n \"redeemed_at\": null,\n \"serial_number\": \"ObjC-API-78\",\n \"type\": 1,\n \"web_token\": \"9fb8daf956a1de6095e9a4f3cd0c97526701834c\"\n }\n ]"}],"params":[{"name":"template_id","full_name":"template_id","description":"Template ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"many","full_name":"many","description":"Get an array of Passes instead of the just one, but in compact mode
\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"serial_number","full_name":"serial_number","description":"Serial Number
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i \"https://api.passdock.com/api/v1/templates/106/passes/search?api_token=75778a65dfdae310a107d2ef0bbd3780&serial_number=serial-1351766860&many=true\""],"see":null,"see_url":null},{"doc_url":"/doc/passes/code","name":"code","apis":[{"api_url":"/api/v1/passes/search","http_method":"GET","short_description":"Search for a Pass by the 2D code in every Template owned by the User"}],"formats":["json"],"full_description":"Search a Pass with the bar code for the current user. Replace spaces on the code with %20.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Pass Not Found","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"{\n \"auxiliary\": [\n {\n \"changeMessage\": \"Departure time changed to %@\",\n \"dateStyle\": \"PKDateStyleMedium\",\n \"key\": \"departure\",\n \"label\": \"DEPARTURE\",\n \"timeStyle\": \"PKDateStyleMedium\",\n \"value\": \"2012-11-12T10:12:20-08:00\"\n }\n ],\n \"back\": [\n {\n \"changeMessage\": \"\",\n \"key\": \"passport\",\n \"label\": \"PASSPORT\",\n \"value\": \"United States of America.\"\n }\n ],\n \"bar\": {\n \"format\": \"PKBarcodeFormatQR\",\n \"message\": \"1350551026\",\n \"messageEncoding\": \"iso-8859-1\"\n },\n \"created_at\": \"2012-10-18T09:03:47Z\",\n \"custom\": [\n {\n \"transitType\": \"PKTransitTypeAir\"\n }\n ],\n \"download\": \"https://api.passdock.com/passes/199/cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9.pkpass\",\n \"family_id\": 106,\n \"header\": [\n {\n \"changeMessage\": \"Gate changed to %@\",\n \"key\": \"gate\",\n \"label\": \"GATE\",\n \"value\": \"56\"\n }\n ],\n \"id\": 199,\n \"primary\": [\n {\n \"changeMessage\": \"Departure changed in %@\",\n \"key\": \"from\",\n \"label\": \"FROM\",\n \"value\": \"NYC\"\n },\n {\n \"changeMessage\": \"Destination changed to %@\",\n \"key\": \"to\",\n \"label\": \"TO\",\n \"value\": \"SFO\"\n }\n ],\n \"relevance\": {\n \"locations\": [\n ]\n },\n \"secondary\": [\n {\n \"changeMessage\": \"Passenger name changed to %@\",\n \"key\": \"name\",\n \"label\": \"NAME\",\n \"value\": \"James Smith\"\n }\n ],\n \"serial_number\": \"serial-1350551026\",\n \"updated_at\": \"2012-10-18T09:15:31Z\",\n \"visual\": {\n \"backgroundColor\": \"rgb(237,184,61)\",\n \"foregroundColor\": \"rgb(255,255,255)\",\n \"labelColor\": \"\",\n \"logoText\": \"Passdock Airways\"\n },\n \"web_token\": \"cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9\"\n }"}],"params":[{"name":"code","full_name":"code","description":"2D code message
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i \"https://api.passdock.com/api/v1/passes/search?code=XADESA%20FKKA-CAD&api_token=75778a65dfdae310a107d2ef0bbd3780\""],"see":null,"see_url":null}]},"people":{"doc_url":"/doc/people","api_url":"/api","name":"People","short_description":"","full_description":"","version":"1","formats":[],"methods":[{"doc_url":"/doc/people/index","name":"index","apis":[{"api_url":"/api/v1/people","http_method":"GET","short_description":"Get People list"}],"formats":["json"],"full_description":"Returns the list of People in your address book.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null},{"code":414,"description":"You don't have an address book","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n[\n {\n id: \"5342a521434236f5e7000007\",\n name: \"Mark\",\n surname: \"Twain\",\n email: \"mark.twain@example.com\",\n telephone: \"555-123-4567\",\n birthday: \"1835/11/30 00:00:00\",\n custom_field: \"Custom Value\",\n image: \"http://url/of/avatar\",\n list_ids: [\n \"5342a53e86d256f5e7000006\",\n \"5342a53e86d256f5e7000016\"\n ]\n },\n {\n id: \"5342a521434236f5e7023007\",\n name: \"Henry\",\n surname: \"Longfellow\",\n email: \"henry.longfellow@example.com\",\n telephone: \"555-123-4567\",\n birthday: \"1807/02/27 00:00:00\",\n custom_field: \"Custom Value\",\n image: \"http://url/of/avatar\",\n list_ids: [\n \"5342a53e86d256f5e7000006\"\n ]\n }\n]"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"Page of results. Each page contains 50 people ordered by date (more recents first)
\n","required":false,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"}],"examples":["curl -i https://api.passdock.com/api/v1/people?api_token=75778a65dfdae310a107d2ef0bbd3780&page=1"],"see":null,"see_url":null},{"doc_url":"/doc/people/show","name":"show","apis":[{"api_url":"/api/v1/people/:id","http_method":"GET","short_description":"Show a Person"}],"formats":["json"],"full_description":"Returns a Person from your address book
\n","errors":[{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Not Found","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n{\n id: \"5342a521434236f5e7000007\",\n name: \"Mark\",\n surname: \"Twain\",\n email: \"mark.twain@example.com\",\n telephone: \"555-123-4567\",\n birthday: \"1835/11/30 00:00:00\",\n custom_field: \"Custom Value\",\n image: \"http://url/of/avatar\",\n list_ids: [\n \"5342a53e86d256f5e7000006\",\n \"5342a53e86d256f5e7000016\"\n ]\n}"}],"params":[{"name":"id","full_name":"id","description":"Person ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/people/511e5ce039078c08d8000033?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/people/create","name":"create","apis":[{"api_url":"/api/v1/people","http_method":"POST","short_description":"Create a Person"}],"formats":["json"],"full_description":"Create a new person in your address book.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":201,"description":"Created","sample":"\n{\n id: \"5342a521434236f5e7000007\",\n name: \"Mark\",\n surname: \"Twain\",\n email: \"mark.twain@example.com\",\n telephone: \"555-123-4567\",\n birthday: \"1835/11/30 00:00:00\",\n custom_field: \"Custom Value\",\n image: \"http://url/of/avatar\",\n list_ids: [\n \"5342a53e86d256f5e7000006\",\n \"5342a53e86d256f5e7000016\"\n ]\n}\n"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"person","full_name":"person","description":"Object that contains Person's informations
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"person[name]","description":"Person's name
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"surname","full_name":"person[surname]","description":"Person's surname
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"remote_thumbnail_url","full_name":"person[remote_thumbnail_url]","description":"Remote image address for a person
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"list_ids","full_name":"person[list_ids]","description":"Lists the person belongs to
\n","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"},{"name":"FIELD","full_name":"person[FIELD]","description":"Other fields specified for the person
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["curl -i -H \"Content-Type: application/json\" -d '{\"person\":{\"name\":\"Jeff\",\"surname\":\"Star\", \"list_ids\":[\"12ab8e008f0d0c8a090f9c0b\"]}}' https://api.passdock.com/api/v1/people?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/people/update","name":"update","apis":[{"api_url":"/api/v1/people/:id","http_method":"PUT","short_description":"Update Person"}],"formats":["json"],"full_description":"Update a desired Person.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":""},{"code":200,"description":"Updated with Debug Enabled","sample":""}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"Person ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"person","full_name":"person","description":"Object that contains Person's informations
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"person[name]","description":"Person's name
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"surname","full_name":"person[surname]","description":"Person's surname
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"remote_thumbnail_url","full_name":"person[remote_thumbnail_url]","description":"Remote image address for a person
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"list_ids","full_name":"person[list_ids]","description":"Lists the person belongs to
\n","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"},{"name":"FIELD","full_name":"person[FIELD]","description":"Other fields specified for the person
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["curl -i -X PUT -H \"Content-Type: application/json\" -d '{\"person\":{\"name\":\"Jeff\",\"surname\":\"Star\"}}' https://api.passdock.com/api/v1/people/511e5ce039078c08d8000035?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/people/destroy","name":"destroy","apis":[{"api_url":"/api/v1/people/:id","http_method":"DELETE","short_description":"Delete Person"}],"formats":["json"],"full_description":"Destroy a Person.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null},{"code":404,"description":"Person Not Found","sample":null}],"successes":[{"code":200,"description":"Deleted","sample":null}],"params":[{"name":"id","full_name":"id","description":"Person ID
\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric"},{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i -X DELETE https://api.passdock.com/api/v1/people/106?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null},{"doc_url":"/doc/people/fields","name":"fields","apis":[{"api_url":"/api/v1/people/fields","http_method":"GET","short_description":"Get available fields"}],"formats":["json"],"full_description":"Returns the list of fields you can assign when creating/updating a person.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Good Request","sample":"\n[\n \"name\",\n \"surname\",\n \"email\",\n \"telephone\",\n \"birthday\",\n \"custom_field\",\n \"list_ids\"\n]"}],"params":[{"name":"api_token","full_name":"api_token","description":"Your Passdock API key
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["curl -i https://api.passdock.com/api/v1/people/fields?api_token=75778a65dfdae310a107d2ef0bbd3780"],"see":null,"see_url":null}]},"registrations":{"doc_url":"/doc/registrations","api_url":"/api","name":"Registrations","short_description":"","full_description":"","version":"1","formats":[],"methods":[{"doc_url":"/doc/registrations/create","name":"create","apis":[{"api_url":"/api/v1/registrations","http_method":"POST","short_description":"Create User"}],"formats":["json"],"full_description":"Create a new Passdock User.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":422,"description":"Unauthorized","sample":null}],"successes":[{"code":200,"description":"Created","sample":"{\n \"api_token\": \"0161851792e6fe45816488bbfc709c50\",\n \"email\": \"matteo@passdock.com\",\n \"success\": true\n }"}],"params":[{"name":"user","full_name":"user","description":"The JSON containing the user informations.
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"user[name]","description":"Complete User name
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"email","full_name":"user[email]","description":"Email used for every login
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"password","full_name":"user[password]","description":"Desired password
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"password_confirmation","full_name":"user[password_confirmation]","description":"Confirmation of desired password
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["curl -i -d 'user={\"email\":\"matteo@passdock.com\",\"password\":\"the_secure_password\",\"password_confirmation\":\"the_secure_password\",\"name\":\"Matteo Gavagnin\"}' https://api.passdock.com/api/v1/registrations"],"see":null,"see_url":null}]},"sessions":{"doc_url":"/doc/sessions","api_url":"/api","name":"Sessions","short_description":"","full_description":"","version":"1","formats":[],"methods":[{"doc_url":"/doc/sessions/create","name":"create","apis":[{"api_url":"/api/v1/sessions","http_method":"POST","short_description":"Authenticate User"}],"formats":["json"],"full_description":"Create a new User session and get the api_token.
\n","errors":[{"code":400,"description":"Bad Request","sample":null},{"code":401,"description":"Invalid login or password","sample":null},{"code":422,"description":"Missing parameters","sample":null}],"successes":[{"code":200,"description":"Authenticated","sample":"{\n \"api_token\": \"0161851792e6fe45816488bbfc709c50\",\n \"email\": \"matteo@passdock.com\",\n \"success\": true\n }"}],"params":[{"name":"user","full_name":"user","description":"The JSON containing the login informations.
\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"email","full_name":"user[email]","description":"Email used for every login
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"password","full_name":"user[password]","description":"Desired password
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["curl -i -d '{\"user\": {\"email\":\"matteo@passdock.com\",\"password\":\"the_secure_password\"}}' https://api.passdock.com/api/v1/sessions"],"see":null,"see_url":null}]}}}}