APIs to onboard and manage users.
User details.
List of user identity documents.
An image with meta data. Either the data
or url
property must be supplied to load the image.
Pronoun preferred by user.
Full name containing first, middle, last (family) names, and suffix.
Persona of the user
Tier of User. Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP.
Notification preferences of a user for different notification types.
curl -i -X POST \ https://developer.spotnana.com/_mock/openapi/usersapi/v2/users \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "personalInfo": { "addresses": [ { "addressLines": [ "Golden Gate Bridge" ], "administrativeArea": "CA", "administrativeAreaName": "California", "description": "San Francisco Home", "isDefault": true, "languageCode": "en", "locality": "San Francisco", "locationCode": "LAX", "organization": "Spotnana", "postalCode": "94130", "continentCode": "AF", "recipients": [ "string" ], "regionCode": "US", "regionName": "America", "revision": 1, "sortingCode": "Jamaica", "sublocality": "string", "timezone": "America/Los_Angeles", "coordinates": { "latitude": 77.1025, "longitude": 28.7041 } } ], "dob": { "iso8601": "2017-07-21" }, "email": "example@email.com", "emergencyContactInfo": { "address": { "addressLines": [ "Golden Gate Bridge" ], "administrativeArea": "CA", "administrativeAreaName": "California", "description": "San Francisco Home", "isDefault": true, "languageCode": "en", "locality": "San Francisco", "locationCode": "LAX", "organization": "Spotnana", "postalCode": "94130", "continentCode": "AF", "recipients": [ "string" ], "regionCode": "US", "regionName": "America", "revision": 1, "sortingCode": "Jamaica", "sublocality": "string", "timezone": "America/Los_Angeles", "coordinates": { "latitude": 77.1025, "longitude": 28.7041 } }, "designation": "MANAGER", "email": "emergency-contact@email.com", "name": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "phoneNumber": { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" }, "userOrgId": { "organizationAgencyId": { "id": "string" }, "organizationId": { "id": "string" }, "userId": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "tmcInfo": { "id": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" }, "primaryServiceProviderTmc": { "tmcId": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" } }, "secondaryServiceProviderTmcs": [ { "tmcId": {}, "supplier": "SABRE", "travelType": "AIR" } ], "partnerTmcId": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" } }, "tmcBasicInfo": { "contractingTmc": { "id": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" }, "name": "string", "logo": { "data": "6935813e12584abda0e43d71cd2ea260", "dimensions": {}, "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" } }, "bookingTmc": { "id": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" }, "name": "string", "logo": { "data": "6935813e12584abda0e43d71cd2ea260", "dimensions": {}, "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" } } } } }, "gender": "FEMALE", "identityDocs": [ { "passport": { "docId": "PASSPORTID", "expiryDate": { "iso8601": "2017-07-21" }, "issueCountry": "IN", "issuedDate": { "iso8601": "2017-07-21" }, "nationalityCountry": "IN", "type": "REGULAR" } }, { "ktn": { "number": "123456", "issueCountry": "US" } } ], "name": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "phoneNumbers": [ { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" } ], "profilePicture": { "data": "6935813e12584abda0e43d71cd2ea260", "dimensions": { "height": 120, "width": 240 }, "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" }, "nationality": "Indian", "title": "MR", "preferredLanguage": "en-US", "preferredPronoun": "SHE_HER_HERS", "travelerName": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "emergencyContact": { "name": "John Smith", "email": "emergency-contact@email.com", "designation": "MANAGER", "relation": "SPOUSE", "phoneNumbers": [ { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" } ], "preferredLanguage": "en-US" } }, "businessInfo": { "departmentRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "designation": "MANAGER", "email": "user@business.com", "employeeId": "101", "gradeRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "legalEntityRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "managerRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "officeRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "organizationRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "phoneNumbers": [ { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" } ], "costCenterRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "countryCode": "USA", "workerType": "EMPLOYEE", "accountingCode": "123", "companySpecifiedAttributes": [ { "fixedColumnName": "contingentType", "value": "FSTV" } ], "designatedApproverRefs": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" } ], "authorizerEmail": "example@email.com" }, "persona": "EMPLOYEE", "isActive": true, "relativeOf": { "userRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "relation": "SPOUSE" }, "billingCurrency": "INR", "tier": "SEAT1A", "externalId": "string", "travelPreferences": { "preferences": { "airPref": { "airlinePrefs": [ { "airlines": [ "Indigo" ], "flightType": "DOMESTIC" } ], "alliancePref": { "alliances": [ "STAR_ALLIANCE" ] }, "farePref": { "fareTypes": [ "CHANGEABLE" ] }, "homeAirport": "NEW YORK", "mealPref": { "exclMealPrefs": [ "VGML" ], "inclMealPrefs": [ "VGML" ], "specialMealDescription": "Veg only meal" }, "numStopPref": { "numOfStops": 34 }, "seatAmenityPref": { "seatAmenityTypes": [ "WIFI" ] }, "seatLocationPrefs": [ { "cabins": [ "FIRST" ], "isBulkHeadPref": false, "maxFlightDurationInHours": 3, "position": "WINDOW" } ], "preferredAirports": [ { "airportName": "San Francisco International Airport", "airportCode": "SFO", "label": "HOME" } ] }, "preferredCurrency": "USD", "railCards": [ { "cardNumber": "string", "expiryDate": { "iso8601": "2017-07-21" }, "name": "Veterans Railcard", "spotnanaCode": "VET", "vendor": "ATOC" } ], "railPref": { "preferredRailStations": [ { "stationName": "Chicago Union Station", "stationCode": "CHI", "cityName": "Chicago", "countryCode": "string", "label": "HOME" } ], "seatPreference": { "hasAccessibility": false, "seatTypes": [ "NORMAL" ], "seatLocations": [ "AISLE" ], "deckLevels": [ "UPPER_DECK" ], "seatDirections": [ "FORWARD" ] }, "travelClasses": [ "FIRST" ], "coachPreferences": [ "NON_SMOKING" ], "conditionalRates": [ "AAA" ] }, "carPref": { "vendors": [ { "code": "ZE", "name": "HERTZ", "isPresentInPreferredVendors": true } ], "carTypes": [ "ECONOMY" ], "engineTypes": [ "PETROL" ], "transmissionTypes": [ "AUTOMATIC" ], "conditionalRates": [ "AAA" ] }, "hotelPref": { "hotelParentChains": [ { "chainCode": "EM", "chainName": "Mariott" } ], "hotelBrands": [ { "brandCode": "HY", "brandName": "Global Hytt Corp." } ], "hotelAmenityTypes": [ "PARKING" ], "roomPreference": { "isMobilityAccessible": false, "bedCount": "ONE_BED", "roomType": "SMOKING", "mostImportantFact": "BED_COUNT", "roomLocation": "HIGH_FLOOR", "pillowType": "FOAM", "roomAmenityPrefs": [ "EXTRA_TOWELS" ] }, "conditionalRates": [ "AAA" ] } } }, "membershipInfo": { "membershipInfos": [ { "appliedTo": [ "TAJ" ], "id": "firstId", "issuedBy": "firstIssuedBy", "type": "AIR" } ] }, "notificationPreferences": { "preferences": [ { "notificationType": "FLIGHT_NOTIFICATION", "emailPreference": { "enabled": true, "ccEmails": [ "user@example.com" ] } } ] }, "travelArrangers": { "travelArrangers": [ { "name": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "email": "example@email.com", "phoneNumbers": [ { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" } ], "userId": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "status": "PENDING" } ] }, "adhocUserInfo": { "profileOwner": { "userId": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }, "isSaved": false }, "roles": [ { "roleType": "COMPANY_ADMIN", "roleMetadata": { "travelArrangerMetadata": { "arrangerFor": [ { "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "sendConfirmationEmail": false, "sendFlightStatsNotificationEmail": false } ] } }, "metadata": { "roleType": "TRAVEL_ARRANGER", "arrangerFor": [ { "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "sendConfirmationEmail": false, "sendFlightStatsNotificationEmail": false } ] } } ] }'
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users?companyId=497f6eca-6276-4993-bfeb-53cbbbba6f08&email=user%40example.com&externalId=string&includeInactive=false' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "length": 0, "elements": [ { … } ] }
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}?includeInactive=true' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "personalInfo": { "addresses": [ … ], "dob": { … }, "email": "example@email.com", "emergencyContactInfo": { … }, "gender": "FEMALE", "identityDocs": [ … ], "name": { … }, "phoneNumbers": [ … ], "profilePicture": { … }, "nationality": "Indian", "title": "MR", "preferredLanguage": "en-US", "preferredPronoun": "SHE_HER_HERS", "travelerName": { … }, "emergencyContact": { … } }, "businessInfo": { "departmentRef": { … }, "designation": "MANAGER", "email": "user@business.com", "employeeId": "101", "gradeRef": { … }, "legalEntityRef": { … }, "managerRef": { … }, "officeRef": { … }, "organizationRef": { … }, "phoneNumbers": [ … ], "costCenterRef": { … }, "countryCode": "USA", "workerType": "EMPLOYEE", "accountingCode": "123", "companySpecifiedAttributes": [ … ], "designatedApproverRefs": [ … ], "authorizerEmail": "example@email.com" }, "persona": "EMPLOYEE", "isActive": true, "tier": "SEAT1A", "relativeOf": { "userRef": { … }, "relation": "SPOUSE" }, "travelPreferences": { "preferences": { … } }, "membershipInfo": { "membershipInfos": [ … ] }, "notificationPreferences": { "preferences": [ … ] }, "travelArrangers": { "travelArrangers": [ … ] }, "adhocUserInfo": { "profileOwner": { … }, "isSaved": false }, "externalId": "string" }
curl -i -X DELETE \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "debugIdentifier": "string", "errorMessages": [ { … } ] }
User details.
List of user identity documents.
An image with meta data. Either the data
or url
property must be supplied to load the image.
Pronoun preferred by user.
Full name containing first, middle, last (family) names, and suffix.
User business information.
Unique employee id. Can use email if a company don't use employee ids.
Reference of an entity
Reference of an entity
The type of worker.
Persona of the user
Tier of User. Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP.
Notification preferences of a user for different notification types.
curl -i -X PUT \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "personalInfo": { "addresses": [ { "addressLines": [ "Golden Gate Bridge" ], "administrativeArea": "CA", "administrativeAreaName": "California", "description": "San Francisco Home", "isDefault": true, "languageCode": "en", "locality": "San Francisco", "locationCode": "LAX", "organization": "Spotnana", "postalCode": "94130", "continentCode": "AF", "recipients": [ "string" ], "regionCode": "US", "regionName": "America", "revision": 1, "sortingCode": "Jamaica", "sublocality": "string", "timezone": "America/Los_Angeles", "coordinates": { "latitude": 77.1025, "longitude": 28.7041 } } ], "dob": { "iso8601": "2017-07-21" }, "email": "example@email.com", "emergencyContactInfo": { "address": { "addressLines": [ "Golden Gate Bridge" ], "administrativeArea": "CA", "administrativeAreaName": "California", "description": "San Francisco Home", "isDefault": true, "languageCode": "en", "locality": "San Francisco", "locationCode": "LAX", "organization": "Spotnana", "postalCode": "94130", "continentCode": "AF", "recipients": [ "string" ], "regionCode": "US", "regionName": "America", "revision": 1, "sortingCode": "Jamaica", "sublocality": "string", "timezone": "America/Los_Angeles", "coordinates": { "latitude": 77.1025, "longitude": 28.7041 } }, "designation": "MANAGER", "email": "emergency-contact@email.com", "name": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "phoneNumber": { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" }, "userOrgId": { "organizationAgencyId": { "id": "string" }, "organizationId": { "id": "string" }, "userId": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "tmcInfo": { "id": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" }, "primaryServiceProviderTmc": { "tmcId": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" } }, "secondaryServiceProviderTmcs": [ { "tmcId": {}, "supplier": "SABRE", "travelType": "AIR" } ], "partnerTmcId": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" } }, "tmcBasicInfo": { "contractingTmc": { "id": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" }, "name": "string", "logo": { "data": "6935813e12584abda0e43d71cd2ea260", "dimensions": {}, "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" } }, "bookingTmc": { "id": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" }, "name": "string", "logo": { "data": "6935813e12584abda0e43d71cd2ea260", "dimensions": {}, "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" } } } } }, "gender": "FEMALE", "identityDocs": [ { "passport": { "docId": "PASSPORTID", "expiryDate": { "iso8601": "2017-07-21" }, "issueCountry": "IN", "issuedDate": { "iso8601": "2017-07-21" }, "nationalityCountry": "IN", "type": "REGULAR" } }, { "ktn": { "number": "123456", "issueCountry": "US" } } ], "name": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "phoneNumbers": [ { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" } ], "profilePicture": { "data": "6935813e12584abda0e43d71cd2ea260", "dimensions": { "height": 120, "width": 240 }, "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" }, "nationality": "Indian", "title": "MR", "preferredLanguage": "en-US", "preferredPronoun": "SHE_HER_HERS", "travelerName": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "emergencyContact": { "name": "John Smith", "email": "emergency-contact@email.com", "designation": "MANAGER", "relation": "SPOUSE", "phoneNumbers": [ { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" } ], "preferredLanguage": "en-US" } }, "businessInfo": { "departmentRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "designation": "MANAGER", "email": "user@business.com", "employeeId": "101", "gradeRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "legalEntityRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "managerRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "officeRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "organizationRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "phoneNumbers": [ { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" } ], "costCenterRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "countryCode": "USA", "workerType": "EMPLOYEE", "accountingCode": "123", "companySpecifiedAttributes": [ { "fixedColumnName": "contingentType", "value": "FSTV" } ], "designatedApproverRefs": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" } ], "authorizerEmail": "example@email.com" }, "persona": "EMPLOYEE", "tier": "SEAT1A", "relativeOf": { "userRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "relation": "SPOUSE" }, "travelPreferences": { "preferences": { "airPref": { "airlinePrefs": [ { "airlines": [ "Indigo" ], "flightType": "DOMESTIC" } ], "alliancePref": { "alliances": [ "STAR_ALLIANCE" ] }, "farePref": { "fareTypes": [ "CHANGEABLE" ] }, "homeAirport": "NEW YORK", "mealPref": { "exclMealPrefs": [ "VGML" ], "inclMealPrefs": [ "VGML" ], "specialMealDescription": "Veg only meal" }, "numStopPref": { "numOfStops": 34 }, "seatAmenityPref": { "seatAmenityTypes": [ "WIFI" ] }, "seatLocationPrefs": [ { "cabins": [ "FIRST" ], "isBulkHeadPref": false, "maxFlightDurationInHours": 3, "position": "WINDOW" } ], "preferredAirports": [ { "airportName": "San Francisco International Airport", "airportCode": "SFO", "label": "HOME" } ] }, "preferredCurrency": "USD", "railCards": [ { "cardNumber": "string", "expiryDate": { "iso8601": "2017-07-21" }, "name": "Veterans Railcard", "spotnanaCode": "VET", "vendor": "ATOC" } ], "railPref": { "preferredRailStations": [ { "stationName": "Chicago Union Station", "stationCode": "CHI", "cityName": "Chicago", "countryCode": "string", "label": "HOME" } ], "seatPreference": { "hasAccessibility": false, "seatTypes": [ "NORMAL" ], "seatLocations": [ "AISLE" ], "deckLevels": [ "UPPER_DECK" ], "seatDirections": [ "FORWARD" ] }, "travelClasses": [ "FIRST" ], "coachPreferences": [ "NON_SMOKING" ], "conditionalRates": [ "AAA" ] }, "carPref": { "vendors": [ { "code": "ZE", "name": "HERTZ", "isPresentInPreferredVendors": true } ], "carTypes": [ "ECONOMY" ], "engineTypes": [ "PETROL" ], "transmissionTypes": [ "AUTOMATIC" ], "conditionalRates": [ "AAA" ] }, "hotelPref": { "hotelParentChains": [ { "chainCode": "EM", "chainName": "Mariott" } ], "hotelBrands": [ { "brandCode": "HY", "brandName": "Global Hytt Corp." } ], "hotelAmenityTypes": [ "PARKING" ], "roomPreference": { "isMobilityAccessible": false, "bedCount": "ONE_BED", "roomType": "SMOKING", "mostImportantFact": "BED_COUNT", "roomLocation": "HIGH_FLOOR", "pillowType": "FOAM", "roomAmenityPrefs": [ "EXTRA_TOWELS" ] }, "conditionalRates": [ "AAA" ] } } }, "membershipInfo": { "membershipInfos": [ { "appliedTo": [ "TAJ" ], "id": "firstId", "issuedBy": "firstIssuedBy", "type": "AIR" } ] }, "notificationPreferences": { "preferences": [ { "notificationType": "FLIGHT_NOTIFICATION", "emailPreference": { "enabled": true, "ccEmails": [ "user@example.com" ] } } ] }, "adhocUserInfo": { "profileOwner": { "userId": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }, "isSaved": false }, "externalId": "string", "travelArrangers": { "travelArrangers": [ { "name": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "email": "example@email.com", "phoneNumbers": [ { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" } ], "userId": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "status": "PENDING" } ] } }'
{ "debugIdentifier": "string", "errorMessages": [ { … } ] }
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/business-info?includeInactive=true' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "departmentRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "designation": "MANAGER", "email": "user@business.com", "employeeId": "101", "gradeRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "legalEntityRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "managerRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "officeRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "organizationRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "phoneNumbers": [ { … } ], "costCenterRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "countryCode": "USA", "workerType": "EMPLOYEE", "accountingCode": "123", "companySpecifiedAttributes": [ { … } ], "designatedApproverRefs": [ { … } ], "authorizerEmail": "example@email.com" }
Unique employee id. Can use email if a company don't use employee ids.
Reference of an entity
Reference of an entity
A list of references for designated approvers.
curl -i -X PUT \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/business-info?includeInactive=true' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "departmentRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "designation": "MANAGER", "email": "user@business.com", "employeeId": "101", "gradeRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "legalEntityRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "managerRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "officeRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "organizationRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "phoneNumbers": [ { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" } ], "costCenterRef": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "countryCode": "USA", "workerType": "EMPLOYEE", "accountingCode": "123", "companySpecifiedAttributes": [ { "fixedColumnName": "contingentType", "value": "FSTV" } ], "designatedApproverRefs": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" } ], "authorizerEmail": "example@email.com" }'
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/personal-info?includeInactive=true' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
OK
List of user identity documents.
An image with meta data. Either the data
or url
property must be supplied to load the image.
Pronoun preferred by user.
{ "addresses": [ { … } ], "dob": { "iso8601": "2017-07-21" }, "email": "example@email.com", "emergencyContactInfo": { "address": { … }, "designation": "MANAGER", "email": "emergency-contact@email.com", "name": { … }, "phoneNumber": { … }, "userOrgId": { … } }, "gender": "FEMALE", "identityDocs": [ { … }, { … } ], "name": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "phoneNumbers": [ { … } ], "profilePicture": { "data": "6935813e12584abda0e43d71cd2ea260", "dimensions": { … }, "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" }, "nationality": "Indian", "title": "MR", "preferredLanguage": "en-US", "preferredPronoun": "SHE_HER_HERS", "travelerName": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "emergencyContact": { "name": "John Smith", "email": "emergency-contact@email.com", "designation": "MANAGER", "relation": "SPOUSE", "phoneNumbers": [ … ], "preferredLanguage": "en-US" } }
List of user identity documents.
An image with meta data. Either the data
or url
property must be supplied to load the image.
Pronoun preferred by user.
curl -i -X PUT \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/personal-info?includeInactive=true' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "addresses": [ { "addressLines": [ "Golden Gate Bridge" ], "administrativeArea": "CA", "administrativeAreaName": "California", "description": "San Francisco Home", "isDefault": true, "languageCode": "en", "locality": "San Francisco", "locationCode": "LAX", "organization": "Spotnana", "postalCode": "94130", "continentCode": "AF", "recipients": [ "string" ], "regionCode": "US", "regionName": "America", "revision": 1, "sortingCode": "Jamaica", "sublocality": "string", "timezone": "America/Los_Angeles", "coordinates": { "latitude": 77.1025, "longitude": 28.7041 } } ], "dob": { "iso8601": "2017-07-21" }, "email": "example@email.com", "emergencyContactInfo": { "address": { "addressLines": [ "Golden Gate Bridge" ], "administrativeArea": "CA", "administrativeAreaName": "California", "description": "San Francisco Home", "isDefault": true, "languageCode": "en", "locality": "San Francisco", "locationCode": "LAX", "organization": "Spotnana", "postalCode": "94130", "continentCode": "AF", "recipients": [ "string" ], "regionCode": "US", "regionName": "America", "revision": 1, "sortingCode": "Jamaica", "sublocality": "string", "timezone": "America/Los_Angeles", "coordinates": { "latitude": 77.1025, "longitude": 28.7041 } }, "designation": "MANAGER", "email": "emergency-contact@email.com", "name": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "phoneNumber": { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" }, "userOrgId": { "organizationAgencyId": { "id": "string" }, "organizationId": { "id": "string" }, "userId": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "tmcInfo": { "id": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" }, "primaryServiceProviderTmc": { "tmcId": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" } }, "secondaryServiceProviderTmcs": [ { "tmcId": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" }, "supplier": "SABRE", "travelType": "AIR" } ], "partnerTmcId": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" } }, "tmcBasicInfo": { "contractingTmc": { "id": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" }, "name": "string", "logo": { "data": "6935813e12584abda0e43d71cd2ea260", "dimensions": { "height": 120, "width": 240 }, "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" } }, "bookingTmc": { "id": { "id": "f49d00fe-1eda-4304-ba79-a980f565281d" }, "name": "string", "logo": { "data": "6935813e12584abda0e43d71cd2ea260", "dimensions": { "height": 120, "width": 240 }, "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" } } } } }, "gender": "FEMALE", "identityDocs": [ { "passport": { "docId": "PASSPORTID", "expiryDate": { "iso8601": "2017-07-21" }, "issueCountry": "IN", "issuedDate": { "iso8601": "2017-07-21" }, "nationalityCountry": "IN", "type": "REGULAR" } }, { "ktn": { "number": "123456", "issueCountry": "US" } } ], "name": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "phoneNumbers": [ { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" } ], "profilePicture": { "data": "6935813e12584abda0e43d71cd2ea260", "dimensions": { "height": 120, "width": 240 }, "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" }, "nationality": "Indian", "title": "MR", "preferredLanguage": "en-US", "preferredPronoun": "SHE_HER_HERS", "travelerName": { "family1": "Gandas", "family2": "FamilyTwo", "given": "Vichitr", "middle": "Kumar", "suffix": "SR", "preferred": "Don" }, "emergencyContact": { "name": "John Smith", "email": "emergency-contact@email.com", "designation": "MANAGER", "relation": "SPOUSE", "phoneNumbers": [ { "countryCode": 91, "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "extension": "222", "isoCountryCode": "IN", "italianLeadingZero": true, "nationalNumber": 8150, "numberOfLeadingZeros": 1, "preferredDomesticCarrierCode": "7", "rawInput": "77777", "type": "MOBILE" } ], "preferredLanguage": "en-US" } }'
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/travel-preferences' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "preferences": { "airPref": { … }, "preferredCurrency": "USD", "railCards": [ … ], "railPref": { … }, "carPref": { … }, "hotelPref": { … } } }
curl -i -X PUT \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/travel-preferences' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "preferences": { "airPref": { "airlinePrefs": [ { "airlines": [ "Indigo" ], "flightType": "DOMESTIC" } ], "alliancePref": { "alliances": [ "STAR_ALLIANCE" ] }, "farePref": { "fareTypes": [ "CHANGEABLE" ] }, "homeAirport": "NEW YORK", "mealPref": { "exclMealPrefs": [ "VGML" ], "inclMealPrefs": [ "VGML" ], "specialMealDescription": "Veg only meal" }, "numStopPref": { "numOfStops": 34 }, "seatAmenityPref": { "seatAmenityTypes": [ "WIFI" ] }, "seatLocationPrefs": [ { "cabins": [ "FIRST" ], "isBulkHeadPref": false, "maxFlightDurationInHours": 3, "position": "WINDOW" } ], "preferredAirports": [ { "airportName": "San Francisco International Airport", "airportCode": "SFO", "label": "HOME" } ] }, "preferredCurrency": "USD", "railCards": [ { "cardNumber": "string", "expiryDate": { "iso8601": "2017-07-21" }, "name": "Veterans Railcard", "spotnanaCode": "VET", "vendor": "ATOC" } ], "railPref": { "preferredRailStations": [ { "stationName": "Chicago Union Station", "stationCode": "CHI", "cityName": "Chicago", "countryCode": "string", "label": "HOME" } ], "seatPreference": { "hasAccessibility": false, "seatTypes": [ "NORMAL" ], "seatLocations": [ "AISLE" ], "deckLevels": [ "UPPER_DECK" ], "seatDirections": [ "FORWARD" ] }, "travelClasses": [ "FIRST" ], "coachPreferences": [ "NON_SMOKING" ], "conditionalRates": [ "AAA" ] }, "carPref": { "vendors": [ { "code": "ZE", "name": "HERTZ", "isPresentInPreferredVendors": true } ], "carTypes": [ "ECONOMY" ], "engineTypes": [ "PETROL" ], "transmissionTypes": [ "AUTOMATIC" ], "conditionalRates": [ "AAA" ] }, "hotelPref": { "hotelParentChains": [ { "chainCode": "EM", "chainName": "Mariott" } ], "hotelBrands": [ { "brandCode": "HY", "brandName": "Global Hytt Corp." } ], "hotelAmenityTypes": [ "PARKING" ], "roomPreference": { "isMobilityAccessible": false, "bedCount": "ONE_BED", "roomType": "SMOKING", "mostImportantFact": "BED_COUNT", "roomLocation": "HIGH_FLOOR", "pillowType": "FOAM", "roomAmenityPrefs": [ "EXTRA_TOWELS" ] }, "conditionalRates": [ "AAA" ] } } }'
{ "debugIdentifier": "string", "errorMessages": [ { … } ] }
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/membership-info' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "membershipInfos": [ { … } ] }
curl -i -X PUT \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/membership-info' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "membershipInfos": [ { "appliedTo": [ "TAJ" ], "id": "firstId", "issuedBy": "firstIssuedBy", "type": "AIR" } ] }'
{ "debugIdentifier": "string", "errorMessages": [ { … } ] }
curl -i -X PUT \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/roles' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "roles": [ { "roleType": "COMPANY_ADMIN", "roleMetadata": { "travelArrangerMetadata": { "arrangerFor": [ { "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "sendConfirmationEmail": false, "sendFlightStatsNotificationEmail": false } ] } }, "metadata": { "roleType": "TRAVEL_ARRANGER", "arrangerFor": [ { "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "sendConfirmationEmail": false, "sendFlightStatsNotificationEmail": false } ] } } ] }'
{ "debugIdentifier": "string", "errorMessages": [ { … } ] }
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/roles' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "roles": [ { … } ] }
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/notification-preferences' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "preferences": [ { … } ] }
curl -i -X PUT \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/notification-preferences' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "preferences": [ { "notificationType": "FLIGHT_NOTIFICATION", "emailPreference": { "enabled": true, "ccEmails": [ "user@example.com" ] } } ] }'
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/travel-arrangers' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "travelArrangers": [ { … } ] }
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/external-id?includeInactive=true' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "externalId": "user-1" }
curl -i -X PUT \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/external-id?includeInactive=true' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "externalId": "user-1" }'
curl -i -X POST \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/activate' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/usersapi/v2/users/{userId}/applicable-policies' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "policies": [ { … } ] }