{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"21dd6a66-8428-4eb9-bc5a-6a32362e0895","name":"External Card Issuers API ZČU","description":"# ENUMS\n\n## Cardholder\n\n### \\[ENUM\\] Gender\n\n| Value | Description |\n| --- | --- |\n| MALE | Male |\n| FEMALE | Female |\n| OTHER | Other |\n\n### \\[ENUM\\] Language\n\n| Value | Description |\n| --- | --- |\n| cs | Czech |\n| en | English |\n\n### \\[ENUM\\] Role\n\n| Value | Description |\n| --- | --- |\n| GRADUATE | Successfully graduated person. |\n| STUDENT | Active student with all student priviledges granted by local law. |\n\n### \\[ENUM\\] Student Status\n\n| Value | Description |\n| --- | --- |\n| FULL_TIME | Full time student |\n| PART_TIME | Part time student |\n\n### \\[ENUM\\] Address\n\n| Value | Description |\n| --- | --- |\n| REGISTERED | Registered address |\n\n### \\[ENUM\\] District (State/Province/County)\n\nDependent on a country where the card issuer's profile is created. For list of available values call NCDB's REST2 API endpoint *GET {{ncdbBaseUrl}}/rest/2.0/administrativeUnits*.\n\n### \\[ENUM\\] Country\n\nISO 3166-1 alpha-3 country codes ([https://www.iso.org/iso-3166-country-codes.html](https://www.iso.org/iso-3166-country-codes.html)).\n\n## Card\n\n### \\[ENUM\\] Type\n\n| Value | Description |\n| --- | --- |\n| ISIC | ISIC card (for full-time students). |\n| ISIC_SCHOLAR | ISIC SCHOLAR card (in the Czech Republic it’s also known as ISIC Školák). |\n| ITIC | ITIC card (for teachers). |\n| IYTC | IYTC card (for youth people). |\n| ALIVE | ALIVE card (for members of sport associations, issued only in the Czech Republic). |\n| ALIVE_STUDENT | ALIVE Student card (for part-time students, issued only in the Czech Republic). |\n| ALIVE_STAFF | ALIVE Staff card (for non-teaching staff of schools, issued only in the Czech Republic). |\n| ALIVE_ID_ALUMNI | ALIVE ID Alumni card (for university graduates). |\n\n### \\[ENUM\\] Form\n\n| Value | Description |\n| --- | --- |\n| DIGITAL | Digital card |\n| DIGITAL_PLASTIC | Digital and plastic card |\n\n### \\[ENUM\\] Status\n\n| Value | Description |\n| --- | --- |\n| ACTIVE | Active card (doesn’t inform about card validity period!) |\n| CANCELLED | Cancelled card (e.g. damaged, lost, stolen) |\n| RETURNED | Returned card (its number will be used for new cardholder) |\n\n### \\[ENUM\\] Smart Technology\n\n| Value | Description |\n| --- | --- |\n| CONTACT_CHIP | Contact chip |\n| MAGNETIC_STRIPE | Magnetic stripe |\n| CONTACTLESS_MIFARE | Contactless RFID Mifare chip |\n| CONTACTLESS_EM_MARINE | Contactless RFID EM-Marine chip |\n| CONTACTLESS_BLUETOOTH_NFC | Digital key used by mobile phone's NFC or Bluetooth |\n\n# MODELS\n\n## Cardholder\n\n### \\[MODEL\\] Cardholder\n\n``` json\n    {\n        \"cardholder_id\": 1,\n        \"external_id\": \"ST44211\",\n        \"academic_degree_before_name\": \"Mgr.\",\n        \"first_name\": \"Petr\",\n        \"last_name\": \"Janík\",\n        \"academic_degree_after_name\": \"CSc.\",\n        \"date_of_birth\": \"1994-04-15\",\n        \"birth_number\": \"940415/0123\",\n        \"gender\": \"MALE\",\n        \"email\": \"petr.janik@test.cz\",\n        \"phone_number\": \"+420123456789\",\n        \"language\": \"en\",\n        \"personal_id\": \"4844V2\",\n        \"class_name\": \"7.B\",\n        \"grade\": 7,\n        \"roles\": {\n            \"student\": true,\n            \"graduate\": false\n        },\n        \"student_status\": \"FULL_TIME\",\n        \"addresses\": Address[],\n        \"legal_representatives\": Legal Representative[],\n        \"custom_fields\": Custom Field[]\n    }\n\n```\n\n### \\[MODEL\\] Role\n\nRoles which are not included in the request are considered as the client doesn't know such information.\n\n``` json\n    {\n        \"student\": true,\n        \"teacher\": false,\n        \"graduate\": false\n    }\n\n```\n\n### \\[MODEL\\] Address\n\n``` json\n    {\n        \"type\": \"BILLING\",\n        \"address_line_1\": \"High Street 10B\",\n        \"address_line_2\": \"Level 6\",\n        \"city\": \"Praha 7\",\n        \"district\": \"Svitavy\",\n        \"postal_code\": \"13000\",\n        \"country\": \"CZE\"\n    }\n\n```\n\n### \\[MODEL\\] Custom Field\n\n``` json\n    {\n        \"name\": \"personal_id\",\n        \"value\": \"abc123\"\n    }\n\n```\n\n## Card\n\n### \\[MODEL\\] Card\n\n``` json\n    {\n        \"card_id\": 665132,\n        \"cardholder_id\": 445562,\n        \"number\": \"H420123456789A\",\n        \"type\": \"ISIC_SCHOLAR\",\n        \"form\": \"DIGITAL_PLASTIC\",\n        \"status\": \"ACTIVE\",\n        \"valid_from\": \"2019-09-01\",\n        \"valid_to\": \"2020-12-31\",\n        \"valid_to_plastic\": \"2020-12-31\",\n        \"design\": \"HA-420-145\",\n        \"design_plastic\": \"HA-420-145\",\n        \"institution_id\": 19888,\n        \"institution_name_line_1\": \"Základní škola Kladrubská,\",\n        \"institution_name_line_2\": \"Praha 10\",\n        \"smart_technologies\": Smart Technology[],\n        \"custom_fields\": Custom Field[]\n    }\n\n```\n\n### \\[MODEL\\] Smart Technology\n\n``` json\n    {\n        \"type\": \"CONTACTLESS_MIFARE\",\n        \"value\": \"A14E5D5F\"\n    }\n\n```\n\n### \\[MODEL\\] Custom Field\n\n``` json\n    {\n        \"name\": \"personal_id\",\n        \"value\": \"abc123\"\n    }\n\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9581463","team":591863,"collectionId":"21dd6a66-8428-4eb9-bc5a-6a32362e0895","publishedId":"UzJLPbsT","public":true,"publicUrl":"https://apidocs.aliveplatform.com","privateUrl":"https://go.postman.co/documentation/9581463-21dd6a66-8428-4eb9-bc5a-6a32362e0895","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-07-07T17:02:15.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Public Testing ZCU","id":"47390e8a-924c-41b2-b8c2-aa63478ffc65","owner":"9581463","values":[{"key":"apiGatewayUrl","value":"https://fe7f8015-d81a-4690-916c-6f489ac447c1.mock.pstmn.io","enabled":true},{"key":"apiGatewayVersion","value":"v1","enabled":true},{"key":"apiGatewayUsername","value":"zcu.issuing-api.test","enabled":true},{"key":"apiGatewayPassword","value":"cHfVLyJpF%zGW@6A","enabled":true},{"key":"cardholderId","value":"445562","enabled":true},{"key":"cardId","value":"2736541","enabled":true},{"key":"cardType","value":"ISIC","enabled":true},{"key":"cardStatus","value":"ACTIVE","enabled":true},{"key":"cardForm","value":"DIGITAL","enabled":true},{"key":"cardNumber","value":"S420001033344H","enabled":true},{"key":"token","value":"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJkdkk5STU4WkVIRmdCV2FlajJqb29LMEl0OG1wV2pZOFIyakd2cThQTHNVIn0.eyJleHAiOjE2MzA2NTU4NDcsImlhdCI6MTYzMDY1NTU0NywianRpIjoiMWNlOTYyZGQtZDJmMy00YjBlLTljYTYtYmYyZWMwNzk0NDY0IiwiaXNzIjoiaHR0cHM6Ly9pYW0udGVzdC5hbGl2ZXBsYXRmb3JtLmNvbS9hdXRoL3JlYWxtcy9BbGl2ZVBsYXRmb3JtQXBpIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImI3NDQ5NjJkLTg5ZWUtNDYyOC04NDM1LWIwMzkxYTVhMGEwMCIsInR5cCI6IkJlYXJlciIsImF6cCI6ImFwaS1nYXRld2F5Iiwic2Vzc2lvbl9zdGF0ZSI6ImEwMDVlZjE0LTlhMjAtNGMyZi1iOWRkLTBhZGJiN2RjZmY2MiIsImFjciI6IjEiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFwaS1nYXRld2F5Ijp7InJvbGVzIjpbIlJPTEVfQ0FSRF9GVUxMX0FDQ0VTUyIsIlJPTEVfQ0FSREhPTERFUl9GVUxMX0FDQ0VTUyIsIlJPTEVfRElHSVRBTF9DQVJEX0ZVTExfQUNDRVNTIl19LCJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6ImVtYWlsIHByb2ZpbGUiLCJpc3N1ZXJfaWQiOjEyNzY5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInJvbGVzIjpbIlJPTEVfQ0FSRF9GVUxMX0FDQ0VTUyIsIlJPTEVfQ0FSREhPTERFUl9GVUxMX0FDQ0VTUyIsIlJPTEVfRElHSVRBTF9DQVJEX0ZVTExfQUNDRVNTIl0sInByZWZlcnJlZF91c2VybmFtZSI6InpzX3JvaGFjb3ZreV9pc3N1aW5nX2FwaV90ZXN0IiwidGVuYW50X2NvZGUiOiJDWiJ9.S3L85pf4Jg1uAfs8Yo4j2GtRRYSohyMNt7c7343aPIl6qw3ZG-39jT6jJCcRl1VIdQSzqmFPqBS3e2E-S5Vt1U64T7N_pGCJly3ur6cnczSdNj-m40oO753kUNgM8bqO-2yL51u3na6tY4sll3PyWbHXhDH38J1DFH8mtrlu8MJRvgazS3_7U6U4k1fZ7-MH-9gedYnEk1K6x_CcbnW4UxUKvuj9aINMpayPsGKoP4p4Ksx-2PusRyNrvvEvd4Xjb8DuksDce5VzTd4xNBe8hrKIBhl48lx6EYHTw0IRt0F8Nau2iwBGBU2mjMV8TgFuuGTXauK_PFIW9O6A8A-QAg","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/a359d6c0ef03d9f2efbe01627a191ed096d1442cd4f36115a50e08f7624b56c3","favicon":"https://aliveplatform.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Public Testing ZCU","value":"9581463-47390e8a-924c-41b2-b8c2-aa63478ffc65"}],"canonicalUrl":"https://apidocs.aliveplatform.com/view/metadata/UzJLPbsT"}