keyper.API.App (v1)
Download OpenAPI specification:Download
Container_ContainerBase
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainersResultOld": {
- "synchronization_info": {
- "has_synchronized": true,
- "last_synchronization": "2019-08-24T14:15:22Z"
}, - "containers": [
- {
- "type": 0,
- "ticket_data_type": 0,
- "ticket_system_type": "string",
- "type_name": "string",
- "is_special": true,
- "id": "string",
- "name": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "count": 0,
- "process_info": {
- "payment_state": 0,
- "send_type": 0,
- "permission_state": 0,
- "offer_state": 0,
- "to_user": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}
}, - "external_reference_id": "string",
- "suppress_notification": true,
- "shopping_cart_id": "string",
- "gtc_link": "string",
- "gtc_last_update": "2019-08-24T14:15:22Z",
- "privacy_policy_url": "string",
- "has_invalid_barcode": true,
- "create_offer_without_registration": true,
- "use_explicit_opt_in": true,
- "events_imported_separately": true,
- "additional_name": "string",
- "allowed_send_types": [
- 0
], - "allowed_payment_states": [
- 0
], - "default_send_type": 0,
- "default_payment_state": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "order_id": 0,
- "order_sent_state": 0,
- "order_state": 0,
- "order_partner": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}, - "order_utc_created_date": "2019-08-24T14:15:22Z",
- "order_price": 0.1,
- "order_fee": 0.1,
- "original_order_price": 0.1,
- "currency": "string",
- "show_payment_view": true,
- "order_event_id": 0,
- "register_to_accept": true,
- "accepted_gtc": true,
- "message": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 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"
}
]
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerBase
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainersResultOld": {
- "synchronization_info": {
- "has_synchronized": true,
- "last_synchronization": "2019-08-24T14:15:22Z"
}, - "containers": [
- {
- "type": 0,
- "ticket_data_type": 0,
- "ticket_system_type": "string",
- "type_name": "string",
- "is_special": true,
- "id": "string",
- "name": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "count": 0,
- "process_info": {
- "payment_state": 0,
- "send_type": 0,
- "permission_state": 0,
- "offer_state": 0,
- "to_user": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}
}, - "external_reference_id": "string",
- "suppress_notification": true,
- "shopping_cart_id": "string",
- "gtc_link": "string",
- "gtc_last_update": "2019-08-24T14:15:22Z",
- "privacy_policy_url": "string",
- "has_invalid_barcode": true,
- "create_offer_without_registration": true,
- "use_explicit_opt_in": true,
- "events_imported_separately": true,
- "additional_name": "string",
- "allowed_send_types": [
- 0
], - "allowed_payment_states": [
- 0
], - "default_send_type": 0,
- "default_payment_state": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "order_id": 0,
- "order_sent_state": 0,
- "order_state": 0,
- "order_partner": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}, - "order_utc_created_date": "2019-08-24T14:15:22Z",
- "order_price": 0.1,
- "order_fee": 0.1,
- "original_order_price": 0.1,
- "currency": "string",
- "show_payment_view": true,
- "order_event_id": 0,
- "register_to_accept": true,
- "accepted_gtc": true,
- "message": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 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"
}
]
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerTemplates
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainerTemplateResult": {
- "event_templates": {
- "property1": {
- "template_id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "data": [
- {
- "data_type": 0,
- "value_type": 0,
- "value": "string"
}
]
}, - "property2": {
- "template_id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "data": [
- {
- "data_type": 0,
- "value_type": 0,
- "value": "string"
}
]
}
}, - "subscription_templates": {
- "property1": {
- "template_id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "data": [
- {
- "data_type": 0,
- "value_type": 0,
- "value": "string"
}
]
}, - "property2": {
- "template_id": 0,
- "type": 0,
- "name": "string",
- "description": "string",
- "data": [
- {
- "data_type": 0,
- "value_type": 0,
- "value": "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"
}
]
}
}Container_ContainerOrganizers
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
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,
- "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerLocations
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
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,
- "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerFriends Deprecated
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainerFriendResult": {
- "container_friends": [
- "string"
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerCategories Deprecated
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainerCategoryResult": {
- "container_categories": [
- {
- "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"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerTags Deprecated
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainerTagResult": {
- "container_tags": [
- {
- "tag_id": "string",
- "name": "string"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerEvents
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
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,
- "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerNextEvent
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainerNextEventResult": {
- "next_event": {
- "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
}, - "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerActions
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainerActionResult": {
- "container_action_sections": [
- {
- "container_actions": [
- {
- "action": 0,
- "name": "string",
- "allowed": true
}
], - "section_name": "string",
- "external_ticket_id": "string",
- "ticket_id": "string"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerAreas
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainerAreaResult": {
- "container_areas": [
- {
- "name": "string",
- "sub_area": {
- "name": "string",
- "sub_area": { }
}, - "area_id": "string",
- "external_area_id": "string"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerSeats
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainerSeatResult": {
- "container_seats": [
- {
- "entrance": "string",
- "category": "string",
- "seat_id": "string",
- "external_seat_id": "string",
- "row": "string",
- "seat": "string",
- "last_modified": "string"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerEventTicketData
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainerEventTicketDataResult": {
- "container_event_ticket_data": [
- {
- "external_event_id": "string",
- "event_id": "string",
- "external_ticket_id": "string",
- "external_subticket_id": "string",
- "ticket_id": "string",
- "external_area_id": "string",
- "area_id": "string",
- "external_seat_id": "string",
- "seat_id": "string",
- "price": 0.1,
- "currency": 0,
- "ticket_condition": 0,
- "is_personalized": true,
- "personalization_data": {
- "first_name": "string",
- "last_name": "string"
}
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_GenerateBarcode
path Parameters
| containerID required | string |
| type required | string |
Request Body schema: required
Array of objects (Ticket) | |
| barcode_state | integer <int32> Enum: 0 1 2 4 |
| user_ip | string |
Responses
Request samples
- Payload
Content type
{- "tickets": [
- {
- "ticket_id": "string",
- "external_ticket_id": "string",
- "external_member_id": "string",
- "barcode": "string",
- "visual_ticket_code": "string",
- "external_sales_type_id": "string",
- "sales_type": "string",
- "is_default_sales_type": true,
- "price": 0.1,
- "has_pdf": true,
- "external_access_system_reference": "string",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_till": "2019-08-24T14:15:22Z",
- "currency": 0,
- "barcode_type": 0,
- "ticket_system_barcode_state": 0,
- "pdf_downloaded": true,
- "wallet_downloaded": true,
- "has_ticketsystem": true,
- "apple_wallet_is_active": true,
- "save_apple_wallet_allowed": true,
- "save_google_pay_allowed": true,
- "nfc_code": "string",
- "permission": 0,
- "member": "string",
- "isViewedByOwner": true,
- "ticket_conditions": {
- "property1": "string",
- "property2": "string"
}
}
], - "barcode_state": 0,
- "user_ip": "string"
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerTickets
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainerTicketResult": {
- "container_tickets": [
- {
- "ticket_id": "string",
- "external_ticket_id": "string",
- "external_member_id": "string",
- "barcode": "string",
- "visual_ticket_code": "string",
- "external_sales_type_id": "string",
- "sales_type": "string",
- "is_default_sales_type": true,
- "price": 0.1,
- "has_pdf": true,
- "external_access_system_reference": "string",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_till": "2019-08-24T14:15:22Z",
- "currency": 0,
- "barcode_type": 0,
- "ticket_system_barcode_state": 0,
- "pdf_downloaded": true,
- "wallet_downloaded": true,
- "has_ticketsystem": true,
- "apple_wallet_is_active": true,
- "save_apple_wallet_allowed": true,
- "save_google_pay_allowed": true,
- "nfc_code": "string",
- "permission": 0,
- "member": "string",
- "isViewedByOwner": true,
- "ticket_conditions": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_ContainerSubscription
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainerSubscriptionResult": {
- "container_subscription": {
- "external_subscription_id": "string",
- "website": "string",
- "description": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "name": "string",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_till": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Container_Container
query Parameters
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filterType | integer <int32> Enum: 0 1 |
| filterInParameter.ticketStateFilter | integer <int32> Enum: 0 1 2 5 6 7 8 9 10 11 12 15 |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.iD | integer <int64> |
| filterInParameter.ticketID | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.userDeviceTimestamp | string <date-time> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.fetchStream | boolean |
| filterInParameter.showIsCancelledToo | boolean |
| filterInParameter.memberID | integer <int64> |
| filterInParameter.suppressBarcode | boolean |
| filterInParameter.getNfcCode | boolean |
Responses
Response samples
- 200
Content type
{- "ContainersResultOld": {
- "synchronization_info": {
- "has_synchronized": true,
- "last_synchronization": "2019-08-24T14:15:22Z"
}, - "containers": [
- {
- "type": 0,
- "ticket_data_type": 0,
- "ticket_system_type": "string",
- "type_name": "string",
- "is_special": true,
- "id": "string",
- "name": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "count": 0,
- "process_info": {
- "payment_state": 0,
- "send_type": 0,
- "permission_state": 0,
- "offer_state": 0,
- "to_user": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}
}, - "external_reference_id": "string",
- "suppress_notification": true,
- "shopping_cart_id": "string",
- "gtc_link": "string",
- "gtc_last_update": "2019-08-24T14:15:22Z",
- "privacy_policy_url": "string",
- "has_invalid_barcode": true,
- "create_offer_without_registration": true,
- "use_explicit_opt_in": true,
- "events_imported_separately": true,
- "additional_name": "string",
- "allowed_send_types": [
- 0
], - "allowed_payment_states": [
- 0
], - "default_send_type": 0,
- "default_payment_state": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "order_id": 0,
- "order_sent_state": 0,
- "order_state": 0,
- "order_partner": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}, - "order_utc_created_date": "2019-08-24T14:15:22Z",
- "order_price": 0.1,
- "order_fee": 0.1,
- "original_order_price": 0.1,
- "currency": "string",
- "show_payment_view": true,
- "order_event_id": 0,
- "register_to_accept": true,
- "accepted_gtc": true,
- "message": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 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"
}
]
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "SearchUsersResult": {
- "users": [
- {
- "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
}
], - "total_found_count": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}CreateUser_Users
Request Body schema: required
object (KeyperUserInfosInParameter) | |||||||||||||||||||
| |||||||||||||||||||
Responses
Request samples
- Payload
Content type
{- "user": {
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "timezone": "string",
- "language": "string",
- "phone_country_code": "string",
- "country_code": "string",
- "isNotify": true,
- "phone": "string"
}
}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
}, - "tfa": {
- "second_factor_required": true,
- "type": 1,
- "verification_code": "00000000-0000-0000-0000-000000000000",
- "has_backup_phone": true,
- "is_setup_completed": 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"
}
]
}, - "reference_id": "string",
- "auth_token": "00000000-0000-0000-0000-000000000000",
- "expiration": "2019-08-24T14:15:22Z",
- "current_time": "2019-08-24T14:15:22Z",
- "route_identifier": "string",
- "container_id": 0,
- "container_type": 0,
- "facebook_user_created": 0,
- "single_sign_on_user_state": 0,
- "signin_options": [
- {
- "name": "string",
- "facebook_email_address": "string"
}
], - "verification_code": "string",
- "email_verification_type": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}CreateUser_Users
Request Body schema: required
| passwordHash | string |
| sign_name | string |
| first_name | string |
| last_name | string |
string | |
| password | string |
| MD5Password | string |
| RawPassword | string |
| registration_type | integer <int32> Enum: 0 1 |
| language | string |
| domain | string |
| scope | integer <int64> |
| route_identifier | string |
Responses
Request samples
- Payload
Content type
{- "passwordHash": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "password": "string",
- "MD5Password": "string",
- "RawPassword": "string",
- "registration_type": 0,
- "language": "string",
- "domain": "string",
- "scope": 0,
- "route_identifier": "string"
}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
}, - "tfa": {
- "second_factor_required": true,
- "type": 1,
- "verification_code": "00000000-0000-0000-0000-000000000000",
- "has_backup_phone": true,
- "is_setup_completed": 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"
}
]
}, - "reference_id": "string",
- "auth_token": "00000000-0000-0000-0000-000000000000",
- "expiration": "2019-08-24T14:15:22Z",
- "current_time": "2019-08-24T14:15:22Z",
- "route_identifier": "string",
- "container_id": 0,
- "container_type": 0,
- "facebook_user_created": 0,
- "single_sign_on_user_state": 0,
- "signin_options": [
- {
- "name": "string",
- "facebook_email_address": "string"
}
], - "verification_code": "string",
- "email_verification_type": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "SearchUsersResult": {
- "users": [
- {
- "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
}
], - "total_found_count": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}CreateUser_Users
Request Body schema: required
object (KeyperUserInfosInParameter) | |||||||||||||||||||
| |||||||||||||||||||
Responses
Request samples
- Payload
Content type
{- "user": {
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "timezone": "string",
- "language": "string",
- "phone_country_code": "string",
- "country_code": "string",
- "isNotify": true,
- "phone": "string"
}
}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
}, - "tfa": {
- "second_factor_required": true,
- "type": 1,
- "verification_code": "00000000-0000-0000-0000-000000000000",
- "has_backup_phone": true,
- "is_setup_completed": 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"
}
]
}, - "reference_id": "string",
- "auth_token": "00000000-0000-0000-0000-000000000000",
- "expiration": "2019-08-24T14:15:22Z",
- "current_time": "2019-08-24T14:15:22Z",
- "route_identifier": "string",
- "container_id": 0,
- "container_type": 0,
- "facebook_user_created": 0,
- "single_sign_on_user_state": 0,
- "signin_options": [
- {
- "name": "string",
- "facebook_email_address": "string"
}
], - "verification_code": "string",
- "email_verification_type": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}CreateUser_Users
Request Body schema: required
| passwordHash | string |
| sign_name | string |
| first_name | string |
| last_name | string |
string | |
| password | string |
| MD5Password | string |
| RawPassword | string |
| registration_type | integer <int32> Enum: 0 1 |
| language | string |
| domain | string |
| scope | integer <int64> |
| route_identifier | string |
Responses
Request samples
- Payload
Content type
{- "passwordHash": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "password": "string",
- "MD5Password": "string",
- "RawPassword": "string",
- "registration_type": 0,
- "language": "string",
- "domain": "string",
- "scope": 0,
- "route_identifier": "string"
}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
}, - "tfa": {
- "second_factor_required": true,
- "type": 1,
- "verification_code": "00000000-0000-0000-0000-000000000000",
- "has_backup_phone": true,
- "is_setup_completed": 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"
}
]
}, - "reference_id": "string",
- "auth_token": "00000000-0000-0000-0000-000000000000",
- "expiration": "2019-08-24T14:15:22Z",
- "current_time": "2019-08-24T14:15:22Z",
- "route_identifier": "string",
- "container_id": 0,
- "container_type": 0,
- "facebook_user_created": 0,
- "single_sign_on_user_state": 0,
- "signin_options": [
- {
- "name": "string",
- "facebook_email_address": "string"
}
], - "verification_code": "string",
- "email_verification_type": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "TestUserResult": {
- "user_id": "string",
- "first_name": "string",
- "last_name": "string",
- "auth_token": "00000000-0000-0000-0000-000000000000",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_till": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}CreateUser_TestUserTickets
path Parameters
| memberID required | integer <int64> |
query Parameters
| routeIdentifier | string |
| numberTickets | integer <int32> |
Responses
Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Email_Get
path Parameters
| email_address_url_encoded required | string |
| scopeID required | integer <int64> |
Responses
Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Email_Put
path Parameters
| email_address_url_encoded required | string |
| scopeID required | integer <int64> |
Responses
Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Email_Delete
path Parameters
| email_address_url_encoded required | string |
| scopeID required | integer <int64> |
Responses
Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Email_Post
Request Body schema: required
| HttpMethod | integer <int32> Enum: 0 1 2 3 4 5 |
string | |
| registration_type | integer <int32> Enum: 0 1 |
| domain | string |
| scope | integer <int64> |
Responses
Request samples
- Payload
Content type
{- "HttpMethod": 0,
- "email": "string",
- "registration_type": 0,
- "domain": "string",
- "scope": 0
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Email_Get
path Parameters
| email_address_url_encoded required | string |
| scopeID required | integer <int64> |
Responses
Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Email_Put
path Parameters
| email_address_url_encoded required | string |
| scopeID required | integer <int64> |
Responses
Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Email_Delete
path Parameters
| email_address_url_encoded required | string |
| scopeID required | integer <int64> |
Responses
Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Email_Post
Request Body schema: required
| HttpMethod | integer <int32> Enum: 0 1 2 3 4 5 |
string | |
| registration_type | integer <int32> Enum: 0 1 |
| domain | string |
| scope | integer <int64> |
Responses
Request samples
- Payload
Content type
{- "HttpMethod": 0,
- "email": "string",
- "registration_type": 0,
- "domain": "string",
- "scope": 0
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "FacebookFriendResult": {
- "friends_at_keyper": [
- {
- "user_id": "string",
- "facebook_user_id": "string",
- "first_name": "string",
- "last_name": "string",
- "facebook_first_name": "string",
- "middle_name": "string",
- "facebook_last_name": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "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"
}
]
}, - "FacebookAccessToken": "string",
- "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "FavoritesResult": {
- "favorites": [
- {
- "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
}
], - "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
{- "FavoritesResult": {
- "favorites": [
- {
- "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
}
], - "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"
}
]
}
}Feedback_Post
Request Body schema: required
string | |
| subject | string |
| text | string |
| valuation | integer <int32> |
Responses
Request samples
- Payload
Content type
{- "email": "string",
- "subject": "string",
- "text": "string",
- "valuation": 0
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}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"
}
]
}
}LoginUser_Post
Request Body schema: required
| passwordHash | string |
string | |
| password | string |
| KeyperUserMD5Password | string |
| scope | integer <int64> |
Responses
Request samples
- Payload
Content type
{- "passwordHash": "string",
- "email": "string",
- "password": "string",
- "KeyperUserMD5Password": "string",
- "scope": 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
}, - "tfa": {
- "second_factor_required": true,
- "type": 1,
- "verification_code": "00000000-0000-0000-0000-000000000000",
- "has_backup_phone": true,
- "is_setup_completed": 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"
}
]
}, - "reference_id": "string",
- "auth_token": "00000000-0000-0000-0000-000000000000",
- "expiration": "2019-08-24T14:15:22Z",
- "current_time": "2019-08-24T14:15:22Z",
- "route_identifier": "string",
- "container_id": 0,
- "container_type": 0,
- "facebook_user_created": 0,
- "single_sign_on_user_state": 0,
- "signin_options": [
- {
- "name": "string",
- "facebook_email_address": "string"
}
], - "verification_code": "string",
- "email_verification_type": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "DeviceSettingsResult": {
- "device_setting_id": 0,
- "send_my_tickets_as_push": true
}, - "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
{- "send_my_tickets_as_push": true
}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"
}
]
}
}Response samples
- 200
Content type
{- "NotificationResult": {
- "notifications": [
- {
- "notification_type": 1,
- "reference_id": 0,
- "user_id": "string",
- "offer_id": "string",
- "event_id": "string",
- "keyper_id": "string",
- "organizer_id": "string",
- "operator_id": "string",
- "subscription_id": "string",
- "scope_id": "string",
- "notification_id": "string",
- "notification_state": 0,
- "created_date": "2019-08-24T14:15:22Z",
- "payload": {
- "html_text": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "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"
}
]
}
}Notifications_UserNotification
Request Body schema: required
| notification_id | integer <int64> |
| notification_state | integer <int32> Enum: 0 1 2 3 |
Responses
Request samples
- Payload
Content type
{- "notification_id": 0,
- "notification_state": 0
}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"
}
]
}
}Offer_OfferOrganizersOld Deprecated
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
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,
- "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferOrganizersOld Deprecated
query Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
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,
- "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferLocationsOld Deprecated
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
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,
- "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferLocations
path Parameters
| orderID required | integer <int64> |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
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,
- "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferCategories Deprecated
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerCategoryResult": {
- "container_categories": [
- {
- "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"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferTags Deprecated
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerTagResult": {
- "container_tags": [
- {
- "tag_id": "string",
- "name": "string"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferFriends
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerFriendResult": {
- "container_friends": [
- "string"
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferEventsOld Deprecated
path Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
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,
- "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferSubscription Deprecated
query Parameters
| containerID required | integer <int64> |
| type required | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerSubscriptionResult": {
- "container_subscription": {
- "external_subscription_id": "string",
- "website": "string",
- "description": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "name": "string",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_till": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferSubscription
path Parameters
| orderID required | integer <int64> |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerSubscriptionResult": {
- "container_subscription": {
- "external_subscription_id": "string",
- "website": "string",
- "description": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "name": "string",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_till": "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"
}
]
}
}, - "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"
}
]
}
}Offer_OfferNextEvent
path Parameters
| orderID required | integer <int64> |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerNextEventResult": {
- "next_event": {
- "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
}, - "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferEventTicketData
path Parameters
| orderID required | integer <int64> |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerEventTicketDataResult": {
- "container_event_ticket_data": [
- {
- "external_event_id": "string",
- "event_id": "string",
- "external_ticket_id": "string",
- "external_subticket_id": "string",
- "ticket_id": "string",
- "external_area_id": "string",
- "area_id": "string",
- "external_seat_id": "string",
- "seat_id": "string",
- "price": 0.1,
- "currency": 0,
- "ticket_condition": 0,
- "is_personalized": true,
- "personalization_data": {
- "first_name": "string",
- "last_name": "string"
}
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferSeats
path Parameters
| orderID required | integer <int64> |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerSeatResult": {
- "container_seats": [
- {
- "entrance": "string",
- "category": "string",
- "seat_id": "string",
- "external_seat_id": "string",
- "row": "string",
- "seat": "string",
- "last_modified": "string"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferAreas
path Parameters
| orderID required | integer <int64> |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerAreaResult": {
- "container_areas": [
- {
- "name": "string",
- "sub_area": {
- "name": "string",
- "sub_area": { }
}, - "area_id": "string",
- "external_area_id": "string"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferTickets
path Parameters
| orderID required | integer <int64> |
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerTicketResult": {
- "container_tickets": [
- {
- "ticket_id": "string",
- "external_ticket_id": "string",
- "external_member_id": "string",
- "barcode": "string",
- "visual_ticket_code": "string",
- "external_sales_type_id": "string",
- "sales_type": "string",
- "is_default_sales_type": true,
- "price": 0.1,
- "has_pdf": true,
- "external_access_system_reference": "string",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_till": "2019-08-24T14:15:22Z",
- "currency": 0,
- "barcode_type": 0,
- "ticket_system_barcode_state": 0,
- "pdf_downloaded": true,
- "wallet_downloaded": true,
- "has_ticketsystem": true,
- "apple_wallet_is_active": true,
- "save_apple_wallet_allowed": true,
- "save_google_pay_allowed": true,
- "nfc_code": "string",
- "permission": 0,
- "member": "string",
- "isViewedByOwner": true,
- "ticket_conditions": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_Transfer
path Parameters
| orderID required | integer <int64> |
Request Body schema: required
| order_id | integer <int64> |
| authtoken_from_link | string <uuid> |
| UserIP | string |
Responses
Request samples
- Payload
Content type
{- "order_id": 0,
- "authtoken_from_link": "00000000-0000-0000-0000-000000000000",
- "UserIP": "string"
}Response samples
- 200
Content type
{- "TransferOfferResult": {
- "id": 0,
- "is_pending_offer": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "OfferHistoryResult": {
- "history": [
- {
- "order_state": 0,
- "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferArchives
path Parameters
| orderID required | integer <int64> |
query Parameters
| is_archived | boolean |
Responses
Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_OfferBase
query Parameters
| orderID required | integer <int64> |
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerOffersResult": {
- "containers_received": [
- {
- "type": 0,
- "ticket_data_type": 0,
- "ticket_system_type": "string",
- "type_name": "string",
- "is_special": true,
- "id": "string",
- "name": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "count": 0,
- "process_info": {
- "payment_state": 0,
- "send_type": 0,
- "permission_state": 0,
- "offer_state": 0,
- "to_user": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}
}, - "external_reference_id": "string",
- "suppress_notification": true,
- "shopping_cart_id": "string",
- "gtc_link": "string",
- "gtc_last_update": "2019-08-24T14:15:22Z",
- "privacy_policy_url": "string",
- "has_invalid_barcode": true,
- "create_offer_without_registration": true,
- "use_explicit_opt_in": true,
- "events_imported_separately": true,
- "additional_name": "string",
- "allowed_send_types": [
- 0
], - "allowed_payment_states": [
- 0
], - "default_send_type": 0,
- "default_payment_state": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "order_id": 0,
- "order_sent_state": 0,
- "order_state": 0,
- "order_partner": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}, - "order_utc_created_date": "2019-08-24T14:15:22Z",
- "order_price": 0.1,
- "order_fee": 0.1,
- "original_order_price": 0.1,
- "currency": "string",
- "show_payment_view": true,
- "order_event_id": 0,
- "register_to_accept": true,
- "accepted_gtc": true,
- "message": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 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"
}
]
}
], - "containers_sent": [
- {
- "type": 0,
- "ticket_data_type": 0,
- "ticket_system_type": "string",
- "type_name": "string",
- "is_special": true,
- "id": "string",
- "name": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "count": 0,
- "process_info": {
- "payment_state": 0,
- "send_type": 0,
- "permission_state": 0,
- "offer_state": 0,
- "to_user": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}
}, - "external_reference_id": "string",
- "suppress_notification": true,
- "shopping_cart_id": "string",
- "gtc_link": "string",
- "gtc_last_update": "2019-08-24T14:15:22Z",
- "privacy_policy_url": "string",
- "has_invalid_barcode": true,
- "create_offer_without_registration": true,
- "use_explicit_opt_in": true,
- "events_imported_separately": true,
- "additional_name": "string",
- "allowed_send_types": [
- 0
], - "allowed_payment_states": [
- 0
], - "default_send_type": 0,
- "default_payment_state": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "order_id": 0,
- "order_sent_state": 0,
- "order_state": 0,
- "order_partner": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}, - "order_utc_created_date": "2019-08-24T14:15:22Z",
- "order_price": 0.1,
- "order_fee": 0.1,
- "original_order_price": 0.1,
- "currency": "string",
- "show_payment_view": true,
- "order_event_id": 0,
- "register_to_accept": true,
- "accepted_gtc": true,
- "message": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 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"
}
]
}
], - "total_number_received_items": 0,
- "total_number_sent_items": 0,
- "total_number_pending_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_Offer
query Parameters
| filterInParameter.filter | integer <int32> Enum: 0 1 2 |
| filterInParameter.order_ID | integer <int64> |
| filterInParameter.orderID | integer <int64> |
| filterInParameter.completed | boolean |
| filterInParameter.type | integer <int32> Enum: 0 1 2 4 8 |
| filterInParameter.iD | integer <int64> |
| filterInParameter.operator_ID | integer <int64> |
| filterInParameter.operatorID | integer <int64> |
| filterInParameter.page | integer <int32> |
| filterInParameter.pageSize | integer <int32> |
| filterInParameter.usePaging | boolean |
| filterInParameter.user_Search | string |
| filterInParameter.container_Search | string |
Responses
Response samples
- 200
Content type
{- "ContainerOffersResult": {
- "containers_received": [
- {
- "type": 0,
- "ticket_data_type": 0,
- "ticket_system_type": "string",
- "type_name": "string",
- "is_special": true,
- "id": "string",
- "name": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "count": 0,
- "process_info": {
- "payment_state": 0,
- "send_type": 0,
- "permission_state": 0,
- "offer_state": 0,
- "to_user": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}
}, - "external_reference_id": "string",
- "suppress_notification": true,
- "shopping_cart_id": "string",
- "gtc_link": "string",
- "gtc_last_update": "2019-08-24T14:15:22Z",
- "privacy_policy_url": "string",
- "has_invalid_barcode": true,
- "create_offer_without_registration": true,
- "use_explicit_opt_in": true,
- "events_imported_separately": true,
- "additional_name": "string",
- "allowed_send_types": [
- 0
], - "allowed_payment_states": [
- 0
], - "default_send_type": 0,
- "default_payment_state": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "order_id": 0,
- "order_sent_state": 0,
- "order_state": 0,
- "order_partner": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}, - "order_utc_created_date": "2019-08-24T14:15:22Z",
- "order_price": 0.1,
- "order_fee": 0.1,
- "original_order_price": 0.1,
- "currency": "string",
- "show_payment_view": true,
- "order_event_id": 0,
- "register_to_accept": true,
- "accepted_gtc": true,
- "message": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 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"
}
]
}
], - "containers_sent": [
- {
- "type": 0,
- "ticket_data_type": 0,
- "ticket_system_type": "string",
- "type_name": "string",
- "is_special": true,
- "id": "string",
- "name": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "count": 0,
- "process_info": {
- "payment_state": 0,
- "send_type": 0,
- "permission_state": 0,
- "offer_state": 0,
- "to_user": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}
}, - "external_reference_id": "string",
- "suppress_notification": true,
- "shopping_cart_id": "string",
- "gtc_link": "string",
- "gtc_last_update": "2019-08-24T14:15:22Z",
- "privacy_policy_url": "string",
- "has_invalid_barcode": true,
- "create_offer_without_registration": true,
- "use_explicit_opt_in": true,
- "events_imported_separately": true,
- "additional_name": "string",
- "allowed_send_types": [
- 0
], - "allowed_payment_states": [
- 0
], - "default_send_type": 0,
- "default_payment_state": 0,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "order_id": 0,
- "order_sent_state": 0,
- "order_state": 0,
- "order_partner": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}, - "order_utc_created_date": "2019-08-24T14:15:22Z",
- "order_price": 0.1,
- "order_fee": 0.1,
- "original_order_price": 0.1,
- "currency": "string",
- "show_payment_view": true,
- "order_event_id": 0,
- "register_to_accept": true,
- "accepted_gtc": true,
- "message": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 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"
}
]
}
], - "total_number_received_items": 0,
- "total_number_sent_items": 0,
- "total_number_pending_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Offer_Offer
Request Body schema: required
| OperatorID | integer <int64> |
| UserIP | string |
Array of objects (ContainerOfferReact) |
Responses
Request samples
- Payload
Content type
{- "OperatorID": 0,
- "UserIP": "string",
- "containers": [
- {
- "order_id": 0,
- "order_state": 0,
- "accepted_gtc": true
}
]
}Response samples
- 200
Content type
{- "ModifyOfferResult": {
- "verification_code": "string",
- "email_verification_type": 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"
}
]
}, - "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"
}
]
}
}Offer_Offer
Request Body schema: required
Array of objects (ContainerOffer) | |
| OperatorID | integer <int64> |
Responses
Request samples
- Payload
Content type
{- "containers": [
- {
- "tickets": [
- {
- "ticket_id": "string",
- "external_ticket_id": "string",
- "external_member_id": "string",
- "barcode": "string",
- "visual_ticket_code": "string",
- "external_sales_type_id": "string",
- "sales_type": "string",
- "is_default_sales_type": true,
- "price": 0.1,
- "has_pdf": true,
- "external_access_system_reference": "string",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_till": "2019-08-24T14:15:22Z",
- "currency": 0,
- "barcode_type": 0,
- "ticket_system_barcode_state": 0,
- "pdf_downloaded": true,
- "wallet_downloaded": true,
- "has_ticketsystem": true,
- "apple_wallet_is_active": true,
- "save_apple_wallet_allowed": true,
- "save_google_pay_allowed": true,
- "nfc_code": "string",
- "permission": 0,
- "member": "string",
- "isViewedByOwner": true,
- "ticket_conditions": {
- "property1": "string",
- "property2": "string"
}
}
], - "process_info": {
- "payment_state": 0,
- "send_type": 0,
- "permission_state": 0,
- "offer_state": 0,
- "to_user": {
- "user_id": "string",
- "sign_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "language": "string",
- "external_customer_id": "string",
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "facebook_user_id": "string",
- "scope_member_id": "string"
}
}, - "order_event_id": 0,
- "order_fee": 0.1,
- "attachments": [
- {
- "attachmentid": 0,
- "attachto": 0
}
], - "message": "string",
- "language": "string"
}
], - "OperatorID": 0
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}PasswordUser_Put
Request Body schema: required
object (UserPasswordInfosInParameter) | |||||
| |||||
Responses
Request samples
- Payload
Content type
{- "user": {
- "old_password": "string",
- "new_password": "string"
}
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}PasswordUser_ResetPassword
path Parameters
| email_address_url_encoded required | string |
Request Body schema: required
| HttpMethod | integer <int32> Enum: 0 1 2 3 4 5 |
string | |
| registration_type | integer <int32> Enum: 0 1 |
| domain | string |
| scope | integer <int64> |
Responses
Request samples
- Payload
Content type
{- "HttpMethod": 0,
- "email": "string",
- "registration_type": 0,
- "domain": "string",
- "scope": 0
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "PaymentUserResult": {
- "country_code": "string",
- "email": "string",
- "street": "string",
- "zip": "string",
- "city": "string",
- "first_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "operator_name": "string",
- "operator_email": "string",
- "operator_phone": "string",
- "amount": 0.1,
- "currency_pending": "string",
- "amount_pending": 0.1,
- "currency": "string",
- "account_state": 0,
- "account_verification_state": 0,
- "account_state_info": "string",
- "payout_account": {
- "info": "string",
- "additional_info": "string",
- "id": 0
}, - "payment_methods": [
- {
- "info": "string",
- "additional_info": "string",
- "id": 0
}
], - "stripe_user": {
- "tos_ipaddress": "string",
- "account_id": "string",
- "tos_datetime": "2019-08-24T14:15:22Z",
- "payout_interval_id": 0,
- "payout_delay_days": 0,
- "payout_weelky_anchor": 1,
- "payout_monthly_anchor": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Payment_PaymentUser
Request Body schema: required
| account_id | string |
| country_code | string |
string | |
| street | string |
| zip | string |
| city | string |
| first_name | string |
| last_name | string |
| date_of_birth | string <date-time> |
| tos_datetime | string <date-time> |
| bank_account_token | string |
| card_token | string |
Responses
Request samples
- Payload
Content type
{- "account_id": "string",
- "country_code": "string",
- "email": "string",
- "street": "string",
- "zip": "string",
- "city": "string",
- "first_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "tos_datetime": "2019-08-24T14:15:22Z",
- "bank_account_token": "string",
- "card_token": "string"
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Payment_PaymentUser
Request Body schema: required
| account_id | string |
| country_code | string |
string | |
| street | string |
| zip | string |
| city | string |
| first_name | string |
| last_name | string |
| date_of_birth | string <date-time> |
| tos_datetime | string <date-time> |
| bank_account_token | string |
| card_token | string |
Responses
Request samples
- Payload
Content type
{- "account_id": "string",
- "country_code": "string",
- "email": "string",
- "street": "string",
- "zip": "string",
- "city": "string",
- "first_name": "string",
- "last_name": "string",
- "date_of_birth": "2019-08-24T14:15:22Z",
- "tos_datetime": "2019-08-24T14:15:22Z",
- "bank_account_token": "string",
- "card_token": "string"
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Payment_PaymentCharges
path Parameters
| orderID required | integer <int64> |
Request Body schema: required
| payment_id | string |
| payment_token | string |
| accepted_gtc | boolean |
| UserIP | string |
Responses
Request samples
- Payload
Content type
{- "payment_id": "string",
- "payment_token": "string",
- "accepted_gtc": true,
- "UserIP": "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"
}
]
}
}Response samples
- 200
Content type
{- "PaymentMethodResult": {
- "cards": [
- {
- "payment_id": "string",
- "country_code": "string",
- "last_four": "string",
- "expired_month": 0,
- "expired_year": 0,
- "brand": "string"
}
], - "is_apple_pay_active": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Payment_PaymentMethods
Request Body schema: required
| token | string |
| payment_method_type | integer <int32> Enum: 1 2 |
string |
Responses
Request samples
- Payload
Content type
{- "token": "string",
- "payment_method_type": 1,
- "email": "string"
}Response samples
- 200
Content type
{- "PaymentMethodResult": {
- "cards": [
- {
- "payment_id": "string",
- "country_code": "string",
- "last_four": "string",
- "expired_month": 0,
- "expired_year": 0,
- "brand": "string"
}
], - "is_apple_pay_active": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Payment_Transactions
query Parameters
| paymentTransactionsInParameter.filter | integer <int32> Enum: 0 1 2 |
| paymentTransactionsInParameter.page | integer <int32> |
| paymentTransactionsInParameter.page_size | integer <int32> |
Responses
Response samples
- 200
Content type
{- "PaymentTransactionsResult": {
- "transactions": [
- {
- "order_id": 0,
- "direction": 0,
- "created_date": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "fee": 0.1,
- "currency": "string",
- "count_tickets": 0,
- "full_name": "string",
- "last_four": "string",
- "brand": "string"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "PaymentUserSettingsResult": {
- "stripe_publishable_key": "string",
- "stripe_account_id": "string",
- "payment_methods": {
- "property1": true,
- "property2": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "PaymentLimitResult": {
- "currency": "string",
- "price_changes": {
- "subtract_price_max_amount": 0.1,
- "add_price_max_amount": 0.1,
- "subtract_price_percent": 0.1,
- "add_price_percent": 0.1
}, - "fees": {
- "fixed_amount_fee": 0.1,
- "percentage_fee": 0.1,
- "minimum_fee": 0.1,
- "maximum_fee": 0.1
}, - "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "PaymentCurrencyResult": {
- "default_currency": "string",
- "currencies": [
- "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "CountryResult": {
- "user_country_by_ip": {
- "country_code": "string",
- "name": "string"
}, - "countries": [
- {
- "country_code": "string",
- "name": "string"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Personalization_PersonalizeTicket
path Parameters
| ticketID required | integer <int64> |
| eventID required | integer <int64> |
query Parameters
| prefillUserData | boolean |
Responses
Response samples
- 200
Content type
{- "Result": {
- "auto_delete_enabled": true,
- "auto_delete_interval": 0,
- "sections": [
- {
- "title": "string",
- "fields": [
- {
- "id": "string",
- "label": "string",
- "type": 1,
- "component": 1,
- "value": "string",
- "options": [
- {
- "key": "string",
- "value": "string"
}
], - "readonly": true,
- "required": true,
- "placeholder": "string"
}
]
}
], - "privacy_policy_url": "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"
}
]
}
}Personalization_PersonalizeTicket
path Parameters
| ticketID required | integer <int64> |
| eventID required | integer <int64> |
Request Body schema: required
| property name* additional property | string |
Responses
Request samples
- Payload
Content type
{- "property1": "string",
- "property2": "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"
}
]
}
}Request samples
- Payload
Content type
{- "phone": "string"
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "PollingPendingTicketResult": {
- "pending_tickets": [
- {
- "ticket_id": "string",
- "utc_valid_until": "2019-08-24T14:15:22Z",
- "utc_valid_until_formated": "2019-08-24T14:15:22Z"
}
], - "total_number_items": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}PushNotifications_Old
Request Body schema: required
| device_token | string |
| device_type | integer <int32> Enum: 0 1 2 3 |
Responses
Request samples
- Payload
Content type
{- "device_token": "string",
- "device_type": 0
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}PushNotifications_New
Request Body schema: required
| device_token | string |
| device_type | integer <int32> Enum: 0 1 2 3 |
Responses
Request samples
- Payload
Content type
{- "device_token": "string",
- "device_type": 0
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}PushNotifications_New
Request Body schema: required
| device_token | string |
| device_type | integer <int32> Enum: 0 1 2 3 |
Responses
Request samples
- Payload
Content type
{- "device_token": "string",
- "device_type": 0
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}SingleSignOn_AuthenticateUser
path Parameters
| route_identifier required | string |
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"
}
]
}
}SingleSignOn_LinkUser
path Parameters
| route_identifier required | string |
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
{- "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"
}
]
}
}SingleSignOn_Login
path Parameters
| route_identifier required | string |
Request Body schema: required
| username | string |
| password | string |
Responses
Request samples
- Payload
Content type
{- "username": "string",
- "password": "string"
}Response samples
- 200
Content type
{- "AuthenticationResult": {
- "access_token": "string"
}, - "SingleSignOnSettings": { },
- "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"
}
]
}
}SingleSignOn_Signup
path Parameters
| route_identifier required | string |
Request Body schema: required
string | |
| password | string |
| first_name | string |
| last_name | string |
Responses
Request samples
- Payload
Content type
{- "email": "string",
- "password": "string",
- "first_name": "string",
- "last_name": "string"
}Response samples
- 200
Content type
{- "AuthenticationResult": {
- "access_token": "string"
}, - "SingleSignOnSettings": { },
- "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
{- "UserProfilResult": {
- "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
}
], - "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
}, - "signin_options": [
- {
- "name": "string",
- "facebook_email_address": "string"
}
], - "visited_events_count": 0,
- "favorites_count": 0,
- "friends_count": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}UserProfil_events
path Parameters
| referenceID required | integer <int64> |
| pageIndex required | integer <int32> |
query Parameters
| page_size | integer <int32> |
Responses
Response samples
- 200
Content type
{- "UserProfilResult": {
- "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
}
], - "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
}, - "signin_options": [
- {
- "name": "string",
- "facebook_email_address": "string"
}
], - "visited_events_count": 0,
- "favorites_count": 0,
- "friends_count": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "UserProfileSettingsResult": {
- "languages": [
- {
- "id": "string",
- "description": "string"
}
], - "timezones": [
- {
- "id": "string",
- "description": "string",
- "timezone": "string",
- "offset": "string",
- "offset_in_minutes": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "UserSessionResult": {
- "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,
- "tfa_required": true,
- "tfa_setup_completed": 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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Verification_phones
query Parameters
| verificationInParameter.password | string |
| verificationInParameter.passwordHash | string |
| verificationInParameter.verificationCode | string |
| verificationInParameter.mailVerificationCode | string <uuid> |
| verificationInParameter.sMSVerificationCode | string |
| verificationInParameter.eMail | string |
| verificationInParameter.inPassword | string |
| verificationInParameter.password | string |
| verificationInParameter.mD5Password | string |
| verificationInParameter.mailingTemplate | integer <int32> Enum: 0 1 2 3 4 5 6 7 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
| verificationInParameter.registration_type | integer <int32> Enum: 0 1 |
| verificationInParameter.domain | string |
| verificationInParameter.member_id | integer <int64> |
Responses
Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Verification_email
path Parameters
| VerificationCode required | string |
Request Body schema: required
| password | string |
| passwordHash | string |
| VerificationCode | string |
| MailVerificationCode | string <uuid> |
| SMSVerificationCode | string |
string | |
| InPassword | string |
| Password | string |
| MD5Password | string |
| MailingTemplate | integer <int32> Enum: 0 1 2 3 4 5 6 7 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
| registration_type | integer <int32> Enum: 0 1 |
| domain | string |
| member_id | integer <int64> |
Responses
Request samples
- Payload
Content type
{- "password": "string",
- "passwordHash": "string",
- "VerificationCode": "string",
- "MailVerificationCode": "00000000-0000-0000-0000-000000000000",
- "SMSVerificationCode": "string",
- "eMail": "string",
- "InPassword": "string",
- "Password": "string",
- "MD5Password": "string",
- "MailingTemplate": 0,
- "registration_type": 0,
- "domain": "string",
- "member_id": 0
}Response samples
- 200
Content type
{- "SimpleResult": {
- "picture": {
- "picture_id": "string",
- "picture_alt_text": "string",
- "picture_url": "string"
}, - "authentication_token": "00000000-0000-0000-0000-000000000000",
- "phone_id": 0,
- "member_id": "string",
- "external_passbook_resource_link": "string",
- "external_passbook_resource_links": [
- "string"
], - "html_template": "string",
- "domain": "string",
- "tracking_domain": "string",
- "is_dkim_setting_valid": true,
- "is_spf_setting_valid": true,
- "is_valid_signing": true,
- "file_url": "string",
- "info": [
- {
- "external_reference_id": "string",
- "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0
}
], - "email_link": "string",
- "verification_code": "string",
- "email_verification_type": 0,
- "textmessage_verification_type": 0,
- "sms_message": "string",
- "sms_long_link": "string",
- "organizer_name": "string",
- "notification_users": [
- {
- "name": "string",
- "email": "string",
- "unsubscribe_link": "string"
}
], - "count_notified_users": 0,
- "is_ticketsystem_accessable": true,
- "country_code": "string",
- "page_access_token": "string",
- "encrypted_payload": "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"
}
]
}, - "TIsTrustedApplication": true,
- "TIsAuthorizedUser": true,
- "TIsEmailUnique": true,
- "TIsSuccessful": true,
- "TIsTrustedService": true,
- "TIsSecondFactorNeeded": true,
- "TIsSecondFactorSetupCompleted": true,
- "TAdminUserAuthorisationReturnEnum": 0,
- "TWalletUserIsAuthorized": true,
- "TMailingTemplateTypeEnum": 0,
- "KeyperDatabaseSetting": {
- "TAmazonS3UserCredentials": {
- "ImageBucket": "string",
- "DataBucket": "string",
- "LogoBucket": "string",
- "PDFPartialKey": "string",
- "PKPASSPartialKey": "string",
- "PKCSSPartialKey": "string",
- "CertificatePartialKey": "string",
- "PartialKey": "string"
}, - "TFacebookSettings": {
- "AppID": "string",
- "AppSecret": "string"
}, - "TStatusPageSettings": {
- "AuthToken": "string",
- "PageID": "string"
}, - "AppleWalletSettings": {
- "TeamIdentifier": "string",
- "PassTypeIdentifier": "string",
- "PassOrganizationName": "string",
- "WebServiceUrl": "string",
- "AppleIDKeyperApp": "string",
- "CertPassbookThumbprint": "string",
- "CertPassbookPwd": "string",
- "CertLocation": "string"
}, - "TCustomizationSettings": {
- "SPFInfo": "string",
- "DKIMInfo": "string"
}, - "TConnectSettings": {
- "NumberListItems": 0
}, - "TDBVersion": "string",
- "TDBType": "string",
- "TWebAccessPrefix": "string",
- "TAdminWebAccessPrefix": "string",
- "TPicturePrefix": "string",
- "TDefaultDataPath": "string",
- "TIPLocationKey": "string"
}, - "TWebSMSSettings": {
- "UserName": "string",
- "Password": "string",
- "URL": "string",
- "ApiID": "string",
- "SenderName": "string",
- "WebSMSProvider": 0
}, - "TApplicationID": 0,
- "TOperatorID": 0,
- "TOrganizerID": 0,
- "TMemberID": 0,
- "TExternalID": "string",
- "TCreatedFilePrefix": "string",
- "TCreatedFileURL": "string",
- "TCreatedFileType": 0,
- "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
- "TValidFrom": "2019-08-24T14:15:22Z",
- "TValidTill": "2019-08-24T14:15:22Z",
- "THttpMethod": 0,
- "THttpMethodAction": "string",
- "TTextMessageID": 0,
- "TTextMessage": "string",
- "VerificationCode": "string",
- "EmailVerificationType": 0,
- "SMSVerificationType": 0,
- "IsTestEnvironment": true,
- "TIsNew": true
}Wallet_WalletLink
path Parameters
| ticket_id required | integer <int64> |
| provider required | string |
query Parameters
| platform required | integer <int32> Enum: 0 1 2 |
| lang | string |
Responses
Response samples
- 200
Content type
{- "WalletLinkResult": {
- "file_url": "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"
}
]
}
}Wallet_GenerateWallet
path Parameters
| ticket_id required | integer <int64> |
query Parameters
| token required | string <uuid> |
| lang | string |
Responses
Response samples
- 200
Content type
{- "StreamResult": {
- "stream": "string",
- "link": "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"
}
]
}
}Wallet_GenerateWallet
path Parameters
| ticket_id required | integer <int64> |
query Parameters
| lang | string |
| fetchFile | boolean |
Responses
Response samples
- 200
Content type
{- "StreamResult": {
- "stream": "string",
- "link": "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"
}
]
}
}Wallet_GenerateWallet
query Parameters
| ticket_id required | integer <int64> |
| token required | string <uuid> |
| lang | string |
Responses
Response samples
- 200
Content type
{- "StreamResult": {
- "stream": "string",
- "link": "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"
}
]
}
}Wallet_GenerateWallet
query Parameters
| ticket_id required | integer <int64> |
| lang | string |
| fetchFile | boolean |
Responses
Response samples
- 200
Content type
{- "StreamResult": {
- "stream": "string",
- "link": "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"
}
]
}
}