keyper.API.Showcase (v1)
Download OpenAPI specification:Download
Response samples
- 200
Content type
{- "ContainerOrganizerResult": {
- "container_organizers": [
- {
- "organizer_id": "string",
- "external_event_organizer_id": "string",
- "name": "string",
- "street": "string",
- "zip": "string",
- "city": "string",
- "country_code": "string",
- "support_email": "string",
- "support_phone_number": "string",
- "website": "string",
- "gtc_link": "string",
- "gtc_last_update": "2019-08-24T14:15:22Z",
- "contract": 0,
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "default_event_picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "last_modified": "string"
}
], - "total_number_items": 0
}, - "GlobalResult": {
- "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}
}Response samples
- 200
Content type
{- "ContainerLocationResult": {
- "container_locations": [
- {
- "location_id": "string",
- "external_location_id": "string",
- "name": "string",
- "street": "string",
- "zip": "string",
- "city": "string",
- "country_code": "string",
- "lat": "string",
- "lon": "string",
- "description": "string",
- "last_modified": "string"
}
], - "total_number_items": 0
}, - "GlobalResult": {
- "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}
}Response samples
- 200
Content type
{- "SalesTypeResult": {
- "sales_types": [
- {
- "sales_type_id": "string",
- "external_sales_type_id": "string",
- "name": "string",
- "is_default": true
}
], - "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}, - "GlobalResult": {
- "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}
}Response samples
- 200
Content type
{- "ContainerEventResult": {
- "container_events": [
- {
- "name": "string",
- "additional_text": "string",
- "tag_refs": [
- "string"
], - "event_set": {
- "name": "string",
- "event_set_overview_picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "event_set_picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "event_set_id": "string",
- "external_event_set_id": "string",
- "event_set_url": "string",
- "description": "string",
- "date_from": "2019-08-24T14:15:22Z",
- "date_to": "2019-08-24T14:15:22Z"
}, - "event_set_ref": "string",
- "event_organizer": {
- "event_organizer_id": "string",
- "external_event_organizer_id": "string",
- "name": "string",
- "street": "string",
- "zip": "string",
- "city": "string",
- "country_code": "string",
- "support_email": "string",
- "support_phone_number": "string",
- "website": "string",
- "gtc_link": "string",
- "gtc_last_update": "2019-08-24T14:15:22Z",
- "contract": 0,
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}
}, - "organizer_ref": "string",
- "organizer": {
- "organizer_id": "string",
- "external_event_organizer_id": "string",
- "name": "string",
- "street": "string",
- "zip": "string",
- "city": "string",
- "country_code": "string",
- "support_email": "string",
- "support_phone_number": "string",
- "website": "string",
- "gtc_link": "string",
- "gtc_last_update": "2019-08-24T14:15:22Z",
- "contract": 0,
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "default_event_picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "last_modified": "string"
}, - "location": {
- "location_id": "string",
- "external_location_id": "string",
- "name": "string",
- "street": "string",
- "zip": "string",
- "city": "string",
- "country_code": "string",
- "lat": "string",
- "lon": "string",
- "description": "string",
- "last_modified": "string"
}, - "event_category": [
- {
- "event_category_id": "string",
- "external_event_category_id": "string",
- "name": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "last_modified": "string"
}
], - "category_refs": [
- "string"
], - "state": 0,
- "subscription_state": 0,
- "event_id": "string",
- "external_event_id": "string",
- "event_url": "string",
- "tags": [
- "string"
], - "start_date": "2019-08-24T14:15:22Z",
- "entrance_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "location_ref": "string",
- "picture_overview": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "picture_banner": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "description": "string",
- "is_special": true,
- "do_personalization": true
}
], - "total_number_items": 0
}, - "GlobalResult": {
- "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}
}Showcase_Import
Request Body schema: required
| first_name | string |
| last_name | string |
string | |
| scope_id | integer <int64> |
| password | string |
Responses
Request samples
- Payload
Content type
{- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "scope_id": 0,
- "password": "string"
}Response samples
- 200
Content type
{- "GlobalResult": {
- "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}
}Showcase_Login
Request Body schema: required
| access_token | string |
| registration_type | integer <int32> Enum: 0 1 |
| ScopeID | integer <int64> |
Responses
Request samples
- Payload
Content type
{- "access_token": "string",
- "registration_type": 0,
- "ScopeID": 0
}Response samples
- 200
Content type
{- "AuthenticationResult": {
- "user": {
- "user_id": "string",
- "operator_id": "string",
- "organizer_id": "string",
- "facebook_user_id": "string",
- "sdk_member_id": "string",
- "is_verified": 0,
- "is_complete": 0,
- "has_organisation": 0,
- "is_facebook_support_member": true,
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "timezone": "string",
- "language": "string",
- "phone_country_code": "string",
- "country_code": "string",
- "phone": "string",
- "created_date": "2019-08-24T14:15:22Z",
- "primary_email": "string",
- "secondary_emails": [
- {
- "email": "string",
- "is_verified": 0
}
], - "phones": [
- {
- "id": 0,
- "number": "string",
- "is_primary": 0
}
], - "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "role": {
- "role_id": "string",
- "name": "string"
}, - "scope_id": "string",
- "isNotify": true
}, - "auth_token": "00000000-0000-0000-0000-000000000000",
- "expiration": "2019-08-24T14:15:22Z",
- "current_time": "2019-08-24T14:15:22Z",
- "single_sign_on_user_state": 0,
- "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}, - "SingleSignOnSettings": { },
- "SingleSignOnUser": {
- "sso_user": {
- "member_id": "string",
- "external_member_id": "string",
- "access_token": "string",
- "expires_in": "2019-08-24T14:15:22Z",
- "long_term_access_token": {
- "access_token": "string",
- "expires_at": "2019-08-24T14:15:22Z"
}, - "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "emails": [
- {
- "email": "string",
- "is_default": true,
- "is_verified": true,
- "source": "string"
}
], - "is_verified": true,
- "picture_uri": "string",
- "language": "string",
- "registration_type": 0,
- "profile_response": "string",
- "created_date": "2019-08-24T14:15:22Z",
- "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}, - "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}, - "GlobalResult": {
- "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}
}Request samples
- Payload
Content type
{- "email": "string",
- "password": "string"
}Response samples
- 200
Content type
{- "MemberOperatorResult": {
- "operators": [
- {
- "operator_name": "string",
- "scope_id": 0,
- "background_color": "string",
- "favicon_url": "string",
- "font_color": "string",
- "header_color": "string",
- "logo_url": "string",
- "main_color": "string",
- "operator_picture_url": "string"
}
], - "app_secret": "string",
- "route_identifier": "string",
- "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}, - "GlobalResult": {
- "error_type": 0,
- "error_number": 0,
- "error_message": "string",
- "error_stack_trance": "string",
- "ErrorLink": "string",
- "errors": [
- {
- "error_type": 0,
- "error_index": 0,
- "error_number": 0,
- "error_stack_trance": "string",
- "error_message": "string",
- "ErrorLink": "string",
- "csvFileValidationErrors": [
- {
- "line": 0,
- "field": "string",
- "value": "string",
- "errorType": "string"
}
]
}
], - "warnings": [
- {
- "warning_index": 0,
- "warning_number": 0,
- "warning_message": "string"
}
], - "field_errors": [
- {
- "error_type": 0,
- "field_name": "string",
- "external_reference_id": "string"
}
]
}
}