B-Com API
Allows you to interact with B-Com entities
Version: 5.0.6.0
BasePath:
Commercial
https://b-com.psideo.com
Access
[ Jump to Models ]
Table of Contents
Up
post /API/AddParticipantArbitraryClassification
(aPIAddParticipantArbitraryClassification)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter —
eventCode (required)
Query Parameter —
participantIdentifier (required)
Query Parameter —
arbitraryClassificationCode (required)
Query Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Authenticates with the B-Com API using username and password. The password is encrypted using the parameters in
the external application with ID applicationId (aPIAuthenticate)
Consumes
This API call consumes the following media types via the request header:
Query parameters
applicationId (required)
Query Parameter — the code of the external application that you will be authenticating with
userName (required)
Query Parameter — the user name to use
password (required)
Query Parameter — the encrypted password
eventCodeList (optional)
Query Parameter — the list of event codes (comma separated) you want access to
communityCodeList (optional)
Query Parameter — the list of community codes (comma separated) you want access to
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
String
Up
post /API/CheckBooking
Check whether the participant has the booking specified (aPICheckBooking)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
authenticationToken (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"ServiceCode" : "ServiceCode",
"AllowedParticipantIdentifier" : [ "AllowedParticipantIdentifier", "AllowedParticipantIdentifier" ],
"EventCode" : "EventCode"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
ServiceAccessCheckResponse
Up
post /API/CreateContactTagForContact
Creates a contact tag and assigns it to the given contact (aPICreateContactTagForContact)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — a list of contact tag values for the specified contact tag type and contact code
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization
contactTagTypeCode (required)
Query Parameter — The code of the contact tag type
contactCode (required)
Query Parameter — The identifier of the contact for which to create a contact tag
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
String "success" in case of success, otherwise web exception will be thrown
String
Up
post /API/CreateContactTagForParticipant
Creates a contact tag and assigns it to the given participant (aPICreateContactTagForParticipant)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — A list of contact tag values to be set for the specified participant identifier and contact tag type
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization
contactTagTypeCode (required)
Query Parameter — The code of the contact tag type
eventCode (required)
Query Parameter — The code of the B-Com Event for which participant is registered
participantIdentifier (required)
Query Parameter — The identifier of the participant for which to create a contact tag
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
String "success" in case of success, otherwise web exception will be thrown
String
Up
get /API/GetAbstractContent
Gets the content of an abstract identified by abstract submission identifier, generating
the report with code reportCode and of the indicated format (pdf or html) (aPIGetAbstractContent)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
applicationId (required)
Query Parameter —
eventCode (required)
Query Parameter —
abstractSubmissionIdentifier (required)
Query Parameter —
reportCode (required)
Query Parameter —
format (required)
Query Parameter —
languageISO (optional)
Query Parameter — default: en
Return type
File
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
File
Up
get /API/GetAbstractList
Gets a page of abstracts for the event that were last modified since last modification UTC date (aPIGetAbstractList)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter —
pageIndex (required)
Query Parameter — format: int32
pageSize (required)
Query Parameter — format: int32
lastModificationUTCDate (optional)
Query Parameter — format: date-time
Return type
Example data
Content-Type: application/json
[ {
"Order" : 0,
"Status" : "Status",
"LastModifiedDate" : "LastModifiedDate",
"Title" : "Title",
"TopicCode" : "TopicCode",
"TopicName" : "TopicName",
"AbstractFinalIdentifier" : "AbstractFinalIdentifier",
"SubmissionTypeCode" : "SubmissionTypeCode",
"AbstractFinalAcceptanceStatusCommaSeparatedList" : "AbstractFinalAcceptanceStatusCommaSeparatedList",
"SubmissionTypeName" : "SubmissionTypeName",
"CreatedDate" : "CreatedDate",
"AuthorList" : [ {
"Order" : 6,
"IsCoAuthor" : true,
"Email" : "Email",
"IsPresentingAuthor" : true,
"CountryName" : "CountryName",
"FirstName" : "FirstName",
"Title" : "Title",
"Gender" : "Gender",
"MiddleName" : "MiddleName",
"IsSubmittingAuthor" : true,
"IsSeniorAuthor" : true,
"OnBehalfOfWorkingGroup" : "OnBehalfOfWorkingGroup",
"LastName" : "LastName",
"ContactCode" : "ContactCode"
}, {
"Order" : 6,
"IsCoAuthor" : true,
"Email" : "Email",
"IsPresentingAuthor" : true,
"CountryName" : "CountryName",
"FirstName" : "FirstName",
"Title" : "Title",
"Gender" : "Gender",
"MiddleName" : "MiddleName",
"IsSubmittingAuthor" : true,
"IsSeniorAuthor" : true,
"OnBehalfOfWorkingGroup" : "OnBehalfOfWorkingGroup",
"LastName" : "LastName",
"ContactCode" : "ContactCode"
} ],
"AbstractSubmissionIdentifier" : "AbstractSubmissionIdentifier"
}, {
"Order" : 0,
"Status" : "Status",
"LastModifiedDate" : "LastModifiedDate",
"Title" : "Title",
"TopicCode" : "TopicCode",
"TopicName" : "TopicName",
"AbstractFinalIdentifier" : "AbstractFinalIdentifier",
"SubmissionTypeCode" : "SubmissionTypeCode",
"AbstractFinalAcceptanceStatusCommaSeparatedList" : "AbstractFinalAcceptanceStatusCommaSeparatedList",
"SubmissionTypeName" : "SubmissionTypeName",
"CreatedDate" : "CreatedDate",
"AuthorList" : [ {
"Order" : 6,
"IsCoAuthor" : true,
"Email" : "Email",
"IsPresentingAuthor" : true,
"CountryName" : "CountryName",
"FirstName" : "FirstName",
"Title" : "Title",
"Gender" : "Gender",
"MiddleName" : "MiddleName",
"IsSubmittingAuthor" : true,
"IsSeniorAuthor" : true,
"OnBehalfOfWorkingGroup" : "OnBehalfOfWorkingGroup",
"LastName" : "LastName",
"ContactCode" : "ContactCode"
}, {
"Order" : 6,
"IsCoAuthor" : true,
"Email" : "Email",
"IsPresentingAuthor" : true,
"CountryName" : "CountryName",
"FirstName" : "FirstName",
"Title" : "Title",
"Gender" : "Gender",
"MiddleName" : "MiddleName",
"IsSubmittingAuthor" : true,
"IsSeniorAuthor" : true,
"OnBehalfOfWorkingGroup" : "OnBehalfOfWorkingGroup",
"LastName" : "LastName",
"ContactCode" : "ContactCode"
} ],
"AbstractSubmissionIdentifier" : "AbstractSubmissionIdentifier"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Up
get /API/GetApplicableQuestionnaires
Gets the questionnaires applicable to a given community. (aPIGetApplicableQuestionnaires)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
communityCode (required)
Query Parameter — the community code for which to get the questionnaires
Return type
Example data
Content-Type: application/json
[ {
"IsEventQuestionnaire" : true,
"Description" : "Description",
"Questions" : [ {
"FieldTypeCode" : "FieldTypeCode",
"Text" : "Text",
"Code" : "Code",
"QuestionnaireCode" : "QuestionnaireCode"
}, {
"FieldTypeCode" : "FieldTypeCode",
"Text" : "Text",
"Code" : "Code",
"QuestionnaireCode" : "QuestionnaireCode"
} ],
"Code" : "Code",
"Name" : "Name"
}, {
"IsEventQuestionnaire" : true,
"Description" : "Description",
"Questions" : [ {
"FieldTypeCode" : "FieldTypeCode",
"Text" : "Text",
"Code" : "Code",
"QuestionnaireCode" : "QuestionnaireCode"
}, {
"FieldTypeCode" : "FieldTypeCode",
"Text" : "Text",
"Code" : "Code",
"QuestionnaireCode" : "QuestionnaireCode"
} ],
"Code" : "Code",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
a list of applicable questionnaires
Up
get /API/GetCommunities
Gets a list of communities (aPIGetCommunities)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — the authentication token obtained from the Authenticate method
parentCommunityCode (optional)
Query Parameter — if set, only returns communities at or below the communtiy with this code
includeGroupCommunities (optional)
Query Parameter — whether to include group communities default: false
Return type
Example data
Content-Type: application/json
[ {
"Organizer" : {
"Code" : "Code",
"Name" : "Name"
},
"CommunityTypeCode" : "CommunityTypeCode",
"ShortName" : "ShortName",
"Children" : [ null, null ],
"Code" : "Code",
"Name" : "Name"
}, {
"Organizer" : {
"Code" : "Code",
"Name" : "Name"
},
"CommunityTypeCode" : "CommunityTypeCode",
"ShortName" : "ShortName",
"Children" : [ null, null ],
"Code" : "Code",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
a list of communities
Up
get /API/GetCommunityMemberClassifications
Gets requested APICommunityMemberClassification based on the community code and the member's identifier (aPIGetCommunityMemberClassifications)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
communityCode (required)
Query Parameter — The code of the B-Com community for which to retrieve data
communityMemberIdentifier (required)
Query Parameter — The identifier of the community member for which to retrieve detailed information
Return type
Example data
Content-Type: application/json
[ {
"Description" : "Description",
"Code" : "Code",
"Name" : "Name"
}, {
"Description" : "Description",
"Code" : "Code",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of APICommunityMemberClassification for the corresponding community member
Up
get /API/GetCommunityMemberContactProfilePicture
Gets the profile picture APIFile for the specified community code and the member's identifier. (aPIGetCommunityMemberContactProfilePicture)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
communityCode (required)
Query Parameter — The code of the B-Com community for which to retrieve data
communityMemberIdentifier (required)
Query Parameter — The identifier of the community member for which to retrieve the profile picture
Return type
Example data
Content-Type: application/json
{
"FileTypeName" : "FileTypeName",
"Base64Data" : "Base64Data"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The profile picture APIFile for the corresponding community member
APIFile
Up
get /API/GetCommunityMemberCustomFields
Gets requested APICommunityMemberCustomField based on the community code and the member's identifier.
Custom fields are returned in the requested language if specified, in English otherwise (aPIGetCommunityMemberCustomFields)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
communityCode (required)
Query Parameter — The code of the B-Com community for which to retrieve data
communityMemberIdentifier (required)
Query Parameter — The identifier of the community member for which to retrieve detailed information
languageISO (optional)
Query Parameter — The ISO of the language in which to retrieve the community member's answers (i.e EN, FR, CH...) - Default is EN
Return type
Example data
Content-Type: application/json
[ {
"ValueText" : "ValueText",
"CustomFieldCode" : "CustomFieldCode",
"CustomFieldName" : "CustomFieldName",
"FieldType" : "FieldType"
}, {
"ValueText" : "ValueText",
"CustomFieldCode" : "CustomFieldCode",
"CustomFieldName" : "CustomFieldName",
"FieldType" : "FieldType"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of APICommunityMemberCustomField for the corresponding community member
Up
get /API/GetCommunityMemberDetails
Gets detailed APICommunityMember based on the community code and the community member's identifier (aPIGetCommunityMemberDetails)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
communityCode (required)
Query Parameter — The code of the B-Com community for which to retrieve data
communityMemberIdentifier (required)
Query Parameter — The identifier of the community member for which to retrieve detailed information
Return type
Example data
Content-Type: application/json
{
"Email" : "Email",
"CountryISO" : "CountryISO",
"Gender" : "Gender",
"StatusCode" : "StatusCode",
"MobilePhone" : "MobilePhone",
"CompanyName" : "CompanyName",
"Identifier" : "Identifier",
"CompanyDepartment" : "CompanyDepartment",
"Biography" : "Biography",
"PreferredLanguage" : "PreferredLanguage",
"Street" : "Street",
"MemberSince" : "MemberSince",
"ContactCode" : "ContactCode",
"PaymentStatus" : "PaymentStatus",
"MembershipServiceCode" : "MembershipServiceCode",
"FirstName" : "FirstName",
"ZipCode" : "ZipCode",
"DirectPhone" : "DirectPhone",
"HasProfilePicture" : true,
"Title" : "Title",
"City" : "City",
"MiddleName" : "MiddleName",
"MemberTo" : "MemberTo",
"PreferredLanguageISO" : "PreferredLanguageISO",
"State" : "State",
"CreatedDate" : "CreatedDate",
"LastModificationDate" : "LastModificationDate",
"Country" : "Country",
"Summary" : "Summary",
"BusinessPhone" : "BusinessPhone",
"LastName" : "LastName",
"Fax" : "Fax",
"CommunityCode" : "CommunityCode"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The APICommunityMember corresponding to the requested Community Member
APICommunityMember
Up
get /API/GetCommunityMemberList
Gets a list of APICommunityMember registered under the requested community.
The list is a chunk of community embers from index (PageIndex * PageSize) to (PageIndex * PageSize + PageSize) (aPIGetCommunityMemberList)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
communityCode (required)
Query Parameter — The code of the B-Com community for which to retrieve data
pageIndex (required)
Query Parameter — The index of the page used for record paging handling format: int32
pageSize (required)
Query Parameter — The maximum number of records that can be returned through one call (Maximum is 5000 - see: pageIndex) format: int32
lastModificationUTCDate (optional)
Query Parameter — The date on which to filter the community member list based on their last modification date format: date-time
Return type
Example data
Content-Type: application/json
[ {
"Email" : "Email",
"CountryISO" : "CountryISO",
"Gender" : "Gender",
"StatusCode" : "StatusCode",
"MobilePhone" : "MobilePhone",
"CompanyName" : "CompanyName",
"Identifier" : "Identifier",
"CompanyDepartment" : "CompanyDepartment",
"Biography" : "Biography",
"PreferredLanguage" : "PreferredLanguage",
"Street" : "Street",
"MemberSince" : "MemberSince",
"ContactCode" : "ContactCode",
"PaymentStatus" : "PaymentStatus",
"MembershipServiceCode" : "MembershipServiceCode",
"FirstName" : "FirstName",
"ZipCode" : "ZipCode",
"DirectPhone" : "DirectPhone",
"HasProfilePicture" : true,
"Title" : "Title",
"City" : "City",
"MiddleName" : "MiddleName",
"MemberTo" : "MemberTo",
"PreferredLanguageISO" : "PreferredLanguageISO",
"State" : "State",
"CreatedDate" : "CreatedDate",
"LastModificationDate" : "LastModificationDate",
"Country" : "Country",
"Summary" : "Summary",
"BusinessPhone" : "BusinessPhone",
"LastName" : "LastName",
"Fax" : "Fax",
"CommunityCode" : "CommunityCode"
}, {
"Email" : "Email",
"CountryISO" : "CountryISO",
"Gender" : "Gender",
"StatusCode" : "StatusCode",
"MobilePhone" : "MobilePhone",
"CompanyName" : "CompanyName",
"Identifier" : "Identifier",
"CompanyDepartment" : "CompanyDepartment",
"Biography" : "Biography",
"PreferredLanguage" : "PreferredLanguage",
"Street" : "Street",
"MemberSince" : "MemberSince",
"ContactCode" : "ContactCode",
"PaymentStatus" : "PaymentStatus",
"MembershipServiceCode" : "MembershipServiceCode",
"FirstName" : "FirstName",
"ZipCode" : "ZipCode",
"DirectPhone" : "DirectPhone",
"HasProfilePicture" : true,
"Title" : "Title",
"City" : "City",
"MiddleName" : "MiddleName",
"MemberTo" : "MemberTo",
"PreferredLanguageISO" : "PreferredLanguageISO",
"State" : "State",
"CreatedDate" : "CreatedDate",
"LastModificationDate" : "LastModificationDate",
"Country" : "Country",
"Summary" : "Summary",
"BusinessPhone" : "BusinessPhone",
"LastName" : "LastName",
"Fax" : "Fax",
"CommunityCode" : "CommunityCode"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An array of APICommunityMember objects APICommunityMember
Up
get /API/GetCommunityMemberPositions
Gets requested APICommunityMemberPosition based on the community code and the member's identifier.
Positions are returned in the requested language if specified, in English otherwise (aPIGetCommunityMemberPositions)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
communityCode (required)
Query Parameter — The code of the B-Com community for which to retrieve data
communityMemberIdentifier (required)
Query Parameter — The identifier of the community member for which to retrieve detailed information
languageISO (optional)
Query Parameter — The ISO of the language in which to retrieve the community member's answers (i.e EN, FR, CH...) - Default is EN
Return type
Example data
Content-Type: application/json
[ {
"Code" : "Code",
"Name" : "Name"
}, {
"Code" : "Code",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of APICommunityMemberPosition for the corresponding community member
Up
get /API/GetCommunityMemberQuestionAnswers
Gets requested APICommunityMemberQuestionAnswer based on the community code and the member's identifier.
Question answers are returned in the requested language if specified, in English otherwise (aPIGetCommunityMemberQuestionAnswers)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
communityCode (required)
Query Parameter — The code of the B-Com community for which to retrieve data
communityMemberIdentifier (required)
Query Parameter — The identifier of the community member for which to retrieve detailed information
languageISO (optional)
Query Parameter — The ISO of the language in which to retrieve the community member's answers (i.e EN, FR, CH...) - Default is EN
Return type
Example data
Content-Type: application/json
[ {
"QuestionCode" : "QuestionCode",
"Question" : "Question",
"QuestionAnswer" : "QuestionAnswer",
"QuestionnaireCode" : "QuestionnaireCode"
}, {
"QuestionCode" : "QuestionCode",
"Question" : "Question",
"QuestionAnswer" : "QuestionAnswer",
"QuestionnaireCode" : "QuestionnaireCode"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of APICommunityMemberQuestionAnswer for the corresponding community member
Up
get /API/GetCommunityMemberReservations
Gets requested APICommunityMemberReservation based on the community code and the member's identifier (aPIGetCommunityMemberReservations)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
communityCode (required)
Query Parameter — The code of the B-Com community for which to retrieve data
communityMemberIdentifier (required)
Query Parameter — The identifier of the community member for which to retrieve detailed information
Return type
Example data
Content-Type: application/json
[ {
"ReservationDate" : "ReservationDate",
"ServiceProvider" : "ServiceProvider",
"Service" : "Service",
"Quantity" : 0,
"Module" : "Module"
}, {
"ReservationDate" : "ReservationDate",
"ServiceProvider" : "ServiceProvider",
"Service" : "Service",
"Quantity" : 0,
"Module" : "Module"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of APICommunityMemberReservation booked by the corresponding community member
Up
get /API/GetCommunityMemberSubCommunityMembers
Gets a list of APICommunityMember representing the sub-community members for the specified community code and the member's identifier. (aPIGetCommunityMemberSubCommunityMembers)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
communityCode (required)
Query Parameter — The code of the B-Com community for which to retrieve data
communityMemberIdentifier (required)
Query Parameter — The identifier of the community member for which to retrieve detailed information
Return type
Example data
Content-Type: application/json
[ {
"Email" : "Email",
"CountryISO" : "CountryISO",
"Gender" : "Gender",
"StatusCode" : "StatusCode",
"MobilePhone" : "MobilePhone",
"CompanyName" : "CompanyName",
"Identifier" : "Identifier",
"CompanyDepartment" : "CompanyDepartment",
"Biography" : "Biography",
"PreferredLanguage" : "PreferredLanguage",
"Street" : "Street",
"MemberSince" : "MemberSince",
"ContactCode" : "ContactCode",
"PaymentStatus" : "PaymentStatus",
"MembershipServiceCode" : "MembershipServiceCode",
"FirstName" : "FirstName",
"ZipCode" : "ZipCode",
"DirectPhone" : "DirectPhone",
"HasProfilePicture" : true,
"Title" : "Title",
"City" : "City",
"MiddleName" : "MiddleName",
"MemberTo" : "MemberTo",
"PreferredLanguageISO" : "PreferredLanguageISO",
"State" : "State",
"CreatedDate" : "CreatedDate",
"LastModificationDate" : "LastModificationDate",
"Country" : "Country",
"Summary" : "Summary",
"BusinessPhone" : "BusinessPhone",
"LastName" : "LastName",
"Fax" : "Fax",
"CommunityCode" : "CommunityCode"
}, {
"Email" : "Email",
"CountryISO" : "CountryISO",
"Gender" : "Gender",
"StatusCode" : "StatusCode",
"MobilePhone" : "MobilePhone",
"CompanyName" : "CompanyName",
"Identifier" : "Identifier",
"CompanyDepartment" : "CompanyDepartment",
"Biography" : "Biography",
"PreferredLanguage" : "PreferredLanguage",
"Street" : "Street",
"MemberSince" : "MemberSince",
"ContactCode" : "ContactCode",
"PaymentStatus" : "PaymentStatus",
"MembershipServiceCode" : "MembershipServiceCode",
"FirstName" : "FirstName",
"ZipCode" : "ZipCode",
"DirectPhone" : "DirectPhone",
"HasProfilePicture" : true,
"Title" : "Title",
"City" : "City",
"MiddleName" : "MiddleName",
"MemberTo" : "MemberTo",
"PreferredLanguageISO" : "PreferredLanguageISO",
"State" : "State",
"CreatedDate" : "CreatedDate",
"LastModificationDate" : "LastModificationDate",
"Country" : "Country",
"Summary" : "Summary",
"BusinessPhone" : "BusinessPhone",
"LastName" : "LastName",
"Fax" : "Fax",
"CommunityCode" : "CommunityCode"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of APICommunityMember representing sub-community members of the corresponding community member
Up
get /API/GetContactCustomFieldValues
Gets the custom field values of a given contact. (aPIGetContactCustomFieldValues)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter —
contactCode (required)
Query Parameter —
languageISO (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
[ {
"EntityCustomFieldCode" : "EntityCustomFieldCode",
"EntityCustomFieldName" : "EntityCustomFieldName",
"Value" : "Value",
"ContactCode" : "ContactCode"
}, {
"EntityCustomFieldCode" : "EntityCustomFieldCode",
"EntityCustomFieldName" : "EntityCustomFieldName",
"Value" : "Value",
"ContactCode" : "ContactCode"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Up
get /API/GetContactTagForContact
Gets the list of contact tags associated to the contact (aPIGetContactTagForContact)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization
contactTagTypeCode (required)
Query Parameter — The code of the contact tag type for which to retrive list
contactCode (required)
Query Parameter — The identifier of the contact for which to retrieve list of assigned contact tags
Return type
Example data
Content-Type: application/json
[ {
"Values" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"TagTypeCode" : "TagTypeCode"
}, {
"Values" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"TagTypeCode" : "TagTypeCode"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The array of APIContactTag
Up
get /API/GetContactTagForParticipant
Gets the list of contact tags associated to the participant (aPIGetContactTagForParticipant)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization
contactTagTypeCode (required)
Query Parameter — The code of the contact tag type for which to retrive list
eventCode (required)
Query Parameter — The code of the B-Com Event for which participant is registered
participantIdentifier (required)
Query Parameter — The identifier of the participant for which to retrieve list of assigned contact tags
Return type
Example data
Content-Type: application/json
[ {
"Values" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"TagTypeCode" : "TagTypeCode"
}, {
"Values" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"TagTypeCode" : "TagTypeCode"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The array of APIContactTag
Up
get /API/GetContactTagTypes
Gets the list of contact tag types that are applicable in the given context. (aPIGetContactTagTypes)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (optional)
Query Parameter — the context of the event under which to fetch the contact tag types default:
communityCode (optional)
Query Parameter — the context of the community under which to fetch the contact tag types
Return type
Example data
Content-Type: application/json
[ {
"Description" : "Description",
"ValueKeyNames" : [ "ValueKeyNames", "ValueKeyNames" ],
"AllowMultipleValuesPerContact" : true,
"Code" : "Code",
"Name" : "Name"
}, {
"Description" : "Description",
"ValueKeyNames" : [ "ValueKeyNames", "ValueKeyNames" ],
"AllowMultipleValuesPerContact" : true,
"Code" : "Code",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Up
get /API/GetCustomFields
Gets the custom fields that are available in the context of the given community. (aPIGetCustomFields)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
communityCode (required)
Query Parameter — fetch the custom fields in the context of this community
Return type
Example data
Content-Type: application/json
[ {
"WebPlacementOrder" : 0,
"Description" : "Description",
"EntityName" : "EntityName",
"FieldTypeCode" : "FieldTypeCode",
"WebPlacementCategory" : "WebPlacementCategory",
"Code" : "Code",
"Name" : "Name"
}, {
"WebPlacementOrder" : 0,
"Description" : "Description",
"EntityName" : "EntityName",
"FieldTypeCode" : "FieldTypeCode",
"WebPlacementCategory" : "WebPlacementCategory",
"Code" : "Code",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
a list of entity custom fields that are available for the given community
Gets a list of APIEvent.
The list is a chunk of events from index (PageIndex * PageSize) to (PageIndex * PageSize + PageSize) (aPIGetEventList)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
onlyOpenEvents (required)
Query Parameter — True to get only events which are currently open
excludePastEvents (required)
Query Parameter — Whether to exclude events that have and end date in the past
pageIndex (required)
Query Parameter — The index of the page used for record paging handling format: int32
pageSize (required)
Query Parameter — The maximum number of records that can be returned through one call (Maximum is 1000 - see: pageIndex) format: int32
customFieldCodeList (optional)
Query Parameter — A comma separated list of custom field codes to retrieve for the event
lastModificationUTCDate (optional)
Query Parameter — The date on which to filter the event list based on their last modification date format: date-time
Return type
Example data
Content-Type: application/json
[ {
"LastModifiedDate" : "LastModifiedDate",
"VenueZipCode" : "VenueZipCode",
"VenueCountryISO" : "VenueCountryISO",
"VenueState" : "VenueState",
"EndDateLocal" : "EndDateLocal",
"TimeZoneName" : "TimeZoneName",
"VenueCountryName" : "VenueCountryName",
"ShortName" : "ShortName",
"CustomFieldList" : [ {
"Value" : "Value",
"Code" : "Code"
}, {
"Value" : "Value",
"Code" : "Code"
} ],
"Code" : "Code",
"EndDate" : "EndDate",
"VenueCity" : "VenueCity",
"Name" : "Name",
"StartDate" : "StartDate",
"CreatedDate" : "CreatedDate",
"VenueStreet" : "VenueStreet",
"IsOpen" : true,
"StartDateLocal" : "StartDateLocal"
}, {
"LastModifiedDate" : "LastModifiedDate",
"VenueZipCode" : "VenueZipCode",
"VenueCountryISO" : "VenueCountryISO",
"VenueState" : "VenueState",
"EndDateLocal" : "EndDateLocal",
"TimeZoneName" : "TimeZoneName",
"VenueCountryName" : "VenueCountryName",
"ShortName" : "ShortName",
"CustomFieldList" : [ {
"Value" : "Value",
"Code" : "Code"
}, {
"Value" : "Value",
"Code" : "Code"
} ],
"Code" : "Code",
"EndDate" : "EndDate",
"VenueCity" : "VenueCity",
"Name" : "Name",
"StartDate" : "StartDate",
"CreatedDate" : "CreatedDate",
"VenueStreet" : "VenueStreet",
"IsOpen" : true,
"StartDateLocal" : "StartDateLocal"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An array of APIEvent objects APIEvent
Up
get /API/GetExhibitorList
Gets the list of APIExhibitor for the requested Event.
The list is a chunk of exhibitors from index (PageIndex * PageSize) to (PageIndex * PageSize + PageSize) (aPIGetExhibitorList)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter — The code of the B-Com Event for which to retrieve data
pageIndex (required)
Query Parameter — The index of the page used for record paging handling format: int32
pageSize (required)
Query Parameter — The maximum number of records that can be returned through one call (Maximum is 1000 - see: pageIndex) format: int32
lastModificationUTCDate (optional)
Query Parameter — only return exhibitors modified after this date format: date-time
Return type
Example data
Content-Type: application/json
[ {
"HTMLDescription" : "HTMLDescription",
"CompanyName" : "CompanyName",
"Description" : "Description",
"ContactEmail" : "ContactEmail",
"ContactFirstName" : "ContactFirstName",
"Code" : "Code",
"Name" : "Name",
"ContactLastName" : "ContactLastName",
"Location" : "Location"
}, {
"HTMLDescription" : "HTMLDescription",
"CompanyName" : "CompanyName",
"Description" : "Description",
"ContactEmail" : "ContactEmail",
"ContactFirstName" : "ContactFirstName",
"Code" : "Code",
"Name" : "Name",
"ContactLastName" : "ContactLastName",
"Location" : "Location"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Up
get /API/GetExhibitorLogo
Gets the binary content of the logo of an event exhibitor (aPIGetExhibitorLogo)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter — The code of the B-Com Event for which to retrieve data
exhibitorCode (required)
Query Parameter — The code of the B-Com Exhibitor for which to retrieve data
Return type
File
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
File
Up
get /API/GetGroupClassifications
Returns a list of group classifications of the given group. (aPIGetGroupClassifications)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter —
groupIdentifier (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
[ {
"Description" : "Description",
"Code" : "Code",
"Name" : "Name"
}, {
"Description" : "Description",
"Code" : "Code",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Up
get /API/GetGroupDetails
Gets the details of the given group in the event. (aPIGetGroupDetails)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter —
groupIdentifier (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"PONumber" : "PONumber",
"VATNumber" : "VATNumber",
"LeaderBusinessPhone" : "LeaderBusinessPhone",
"LeaderStreet2" : "LeaderStreet2",
"LeaderStreet1" : "LeaderStreet1",
"LeaderZipCode" : "LeaderZipCode",
"LeaderCountry" : "LeaderCountry",
"PickupStatus" : "PickupStatus",
"LeaderFirstName" : "LeaderFirstName",
"MembersCount" : 0,
"BillingAddressZipCode" : "BillingAddressZipCode",
"LeaderDirectPhone" : "LeaderDirectPhone",
"StatusCode" : "StatusCode",
"CompanyZipCode" : "CompanyZipCode",
"Name" : "Name",
"LeaderState" : "LeaderState",
"BillingAddressCity" : "BillingAddressCity",
"CompanyName" : "CompanyName",
"IsSmallGroup" : true,
"Identifier" : "Identifier",
"LeaderMobilePhone" : "LeaderMobilePhone",
"LeaderFaxPhone" : "LeaderFaxPhone",
"ShippingAddressCity" : "ShippingAddressCity",
"PickupStatusCode" : "PickupStatusCode",
"LeaderMiddleName" : "LeaderMiddleName",
"PaymentStatus" : "PaymentStatus",
"Status" : "Status",
"BillingAddressState" : "BillingAddressState",
"ShippingAddressState" : "ShippingAddressState",
"ShippingAddressZipCode" : "ShippingAddressZipCode",
"CompanyState" : "CompanyState",
"LeaderEmail" : "LeaderEmail",
"ShippingAddressStreet2" : "ShippingAddressStreet2",
"ShippingAddressStreet1" : "ShippingAddressStreet1",
"BillingAddressStreet1" : "BillingAddressStreet1",
"BillingAddressStreet2" : "BillingAddressStreet2",
"CompanyStreet1" : "CompanyStreet1",
"CompanyStreet2" : "CompanyStreet2",
"LeaderLastName" : "LeaderLastName",
"ShippingAddressCountry" : "ShippingAddressCountry",
"LeaderCity" : "LeaderCity",
"BillingAddressCountry" : "BillingAddressCountry",
"CompanyCity" : "CompanyCity",
"PaymentStatusCode" : "PaymentStatusCode",
"CompanyCountry" : "CompanyCountry"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
APIGroup
Gets a page of groups from the given event, filtered by the status codes (aPIGetGroupList)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter —
pageIndex (required)
Query Parameter — format: int32
pageSize (required)
Query Parameter — format: int32
orderByClause (optional)
Query Parameter —
lastModificationUTCDate (optional)
Query Parameter — format: date-time
statusCodes (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
[ {
"PONumber" : "PONumber",
"VATNumber" : "VATNumber",
"LeaderBusinessPhone" : "LeaderBusinessPhone",
"LeaderStreet2" : "LeaderStreet2",
"LeaderStreet1" : "LeaderStreet1",
"LeaderZipCode" : "LeaderZipCode",
"LeaderCountry" : "LeaderCountry",
"PickupStatus" : "PickupStatus",
"LeaderFirstName" : "LeaderFirstName",
"MembersCount" : 0,
"BillingAddressZipCode" : "BillingAddressZipCode",
"LeaderDirectPhone" : "LeaderDirectPhone",
"StatusCode" : "StatusCode",
"CompanyZipCode" : "CompanyZipCode",
"Name" : "Name",
"LeaderState" : "LeaderState",
"BillingAddressCity" : "BillingAddressCity",
"CompanyName" : "CompanyName",
"IsSmallGroup" : true,
"Identifier" : "Identifier",
"LeaderMobilePhone" : "LeaderMobilePhone",
"LeaderFaxPhone" : "LeaderFaxPhone",
"ShippingAddressCity" : "ShippingAddressCity",
"PickupStatusCode" : "PickupStatusCode",
"LeaderMiddleName" : "LeaderMiddleName",
"PaymentStatus" : "PaymentStatus",
"Status" : "Status",
"BillingAddressState" : "BillingAddressState",
"ShippingAddressState" : "ShippingAddressState",
"ShippingAddressZipCode" : "ShippingAddressZipCode",
"CompanyState" : "CompanyState",
"LeaderEmail" : "LeaderEmail",
"ShippingAddressStreet2" : "ShippingAddressStreet2",
"ShippingAddressStreet1" : "ShippingAddressStreet1",
"BillingAddressStreet1" : "BillingAddressStreet1",
"BillingAddressStreet2" : "BillingAddressStreet2",
"CompanyStreet1" : "CompanyStreet1",
"CompanyStreet2" : "CompanyStreet2",
"LeaderLastName" : "LeaderLastName",
"ShippingAddressCountry" : "ShippingAddressCountry",
"LeaderCity" : "LeaderCity",
"BillingAddressCountry" : "BillingAddressCountry",
"CompanyCity" : "CompanyCity",
"PaymentStatusCode" : "PaymentStatusCode",
"CompanyCountry" : "CompanyCountry"
}, {
"PONumber" : "PONumber",
"VATNumber" : "VATNumber",
"LeaderBusinessPhone" : "LeaderBusinessPhone",
"LeaderStreet2" : "LeaderStreet2",
"LeaderStreet1" : "LeaderStreet1",
"LeaderZipCode" : "LeaderZipCode",
"LeaderCountry" : "LeaderCountry",
"PickupStatus" : "PickupStatus",
"LeaderFirstName" : "LeaderFirstName",
"MembersCount" : 0,
"BillingAddressZipCode" : "BillingAddressZipCode",
"LeaderDirectPhone" : "LeaderDirectPhone",
"StatusCode" : "StatusCode",
"CompanyZipCode" : "CompanyZipCode",
"Name" : "Name",
"LeaderState" : "LeaderState",
"BillingAddressCity" : "BillingAddressCity",
"CompanyName" : "CompanyName",
"IsSmallGroup" : true,
"Identifier" : "Identifier",
"LeaderMobilePhone" : "LeaderMobilePhone",
"LeaderFaxPhone" : "LeaderFaxPhone",
"ShippingAddressCity" : "ShippingAddressCity",
"PickupStatusCode" : "PickupStatusCode",
"LeaderMiddleName" : "LeaderMiddleName",
"PaymentStatus" : "PaymentStatus",
"Status" : "Status",
"BillingAddressState" : "BillingAddressState",
"ShippingAddressState" : "ShippingAddressState",
"ShippingAddressZipCode" : "ShippingAddressZipCode",
"CompanyState" : "CompanyState",
"LeaderEmail" : "LeaderEmail",
"ShippingAddressStreet2" : "ShippingAddressStreet2",
"ShippingAddressStreet1" : "ShippingAddressStreet1",
"BillingAddressStreet1" : "BillingAddressStreet1",
"BillingAddressStreet2" : "BillingAddressStreet2",
"CompanyStreet1" : "CompanyStreet1",
"CompanyStreet2" : "CompanyStreet2",
"LeaderLastName" : "LeaderLastName",
"ShippingAddressCountry" : "ShippingAddressCountry",
"LeaderCity" : "LeaderCity",
"BillingAddressCountry" : "BillingAddressCountry",
"CompanyCity" : "CompanyCity",
"PaymentStatusCode" : "PaymentStatusCode",
"CompanyCountry" : "CompanyCountry"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Gets a list of APIHotelServiceProvider for the requested Event.
The list is a chunk of hotels from index (PageIndex * PageSize) to (PageIndex * PageSize + PageSize) (aPIGetHotelList)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter — The code of the B-Com Event for which to retrieve data
pageIndex (required)
Query Parameter — The index of the page used for record paging handling format: int32
pageSize (required)
Query Parameter — The maximum number of records that can be returned through one call (Maximum is 200 - see: pageIndex) format: int32
Return type
Example data
Content-Type: application/json
[ {
"RoomTypeList" : [ {
"CurrencyCode" : "CurrencyCode",
"TotalBookingAmountTaxExcluded" : 6.02745618307040320615897144307382404804229736328125,
"NightList" : [ {
"CurrencyCode" : "CurrencyCode",
"DateLocal" : "DateLocal",
"QuantityBooked" : 5,
"UnitAmountTaxExcluded" : 2.3021358869347654518833223846741020679473876953125,
"CityTax" : {
"CurrencyISO" : "CurrencyISO",
"Percentage" : 3.61607674925191080461672754609026014804840087890625,
"FixedAmount" : 2.027123023002321833274663731572218239307403564453125
},
"VATPercentage" : 9.301444243932575517419536481611430644989013671875,
"Allotment" : 5,
"UnitAmountTaxIncluded" : 7.061401241503109105224211816675961017608642578125,
"Date" : "Date"
}, {
"CurrencyCode" : "CurrencyCode",
"DateLocal" : "DateLocal",
"QuantityBooked" : 5,
"UnitAmountTaxExcluded" : 2.3021358869347654518833223846741020679473876953125,
"CityTax" : {
"CurrencyISO" : "CurrencyISO",
"Percentage" : 3.61607674925191080461672754609026014804840087890625,
"FixedAmount" : 2.027123023002321833274663731572218239307403564453125
},
"VATPercentage" : 9.301444243932575517419536481611430644989013671875,
"Allotment" : 5,
"UnitAmountTaxIncluded" : 7.061401241503109105224211816675961017608642578125,
"Date" : "Date"
} ],
"TotalBookingAmountTaxIncluded" : 1.46581298050294517310021547018550336360931396484375,
"Code" : "Code",
"MasterRoomTypeCode" : "MasterRoomTypeCode",
"Name" : "Name"
}, {
"CurrencyCode" : "CurrencyCode",
"TotalBookingAmountTaxExcluded" : 6.02745618307040320615897144307382404804229736328125,
"NightList" : [ {
"CurrencyCode" : "CurrencyCode",
"DateLocal" : "DateLocal",
"QuantityBooked" : 5,
"UnitAmountTaxExcluded" : 2.3021358869347654518833223846741020679473876953125,
"CityTax" : {
"CurrencyISO" : "CurrencyISO",
"Percentage" : 3.61607674925191080461672754609026014804840087890625,
"FixedAmount" : 2.027123023002321833274663731572218239307403564453125
},
"VATPercentage" : 9.301444243932575517419536481611430644989013671875,
"Allotment" : 5,
"UnitAmountTaxIncluded" : 7.061401241503109105224211816675961017608642578125,
"Date" : "Date"
}, {
"CurrencyCode" : "CurrencyCode",
"DateLocal" : "DateLocal",
"QuantityBooked" : 5,
"UnitAmountTaxExcluded" : 2.3021358869347654518833223846741020679473876953125,
"CityTax" : {
"CurrencyISO" : "CurrencyISO",
"Percentage" : 3.61607674925191080461672754609026014804840087890625,
"FixedAmount" : 2.027123023002321833274663731572218239307403564453125
},
"VATPercentage" : 9.301444243932575517419536481611430644989013671875,
"Allotment" : 5,
"UnitAmountTaxIncluded" : 7.061401241503109105224211816675961017608642578125,
"Date" : "Date"
} ],
"TotalBookingAmountTaxIncluded" : 1.46581298050294517310021547018550336360931396484375,
"Code" : "Code",
"MasterRoomTypeCode" : "MasterRoomTypeCode",
"Name" : "Name"
} ],
"PrimaryAddressCity" : "PrimaryAddressCity",
"PrimaryAddressZipCode" : "PrimaryAddressZipCode",
"StarRating" : 0.80082819046101150206595775671303272247314453125,
"PrimaryAddressCountryName" : "PrimaryAddressCountryName",
"Code" : "Code",
"HotelChainName" : "HotelChainName",
"PrimrayAddressState" : "PrimrayAddressState",
"PrimaryAddressStreet" : "PrimaryAddressStreet",
"PrimaryAddressCountryISO" : "PrimaryAddressCountryISO",
"Name" : "Name"
}, {
"RoomTypeList" : [ {
"CurrencyCode" : "CurrencyCode",
"TotalBookingAmountTaxExcluded" : 6.02745618307040320615897144307382404804229736328125,
"NightList" : [ {
"CurrencyCode" : "CurrencyCode",
"DateLocal" : "DateLocal",
"QuantityBooked" : 5,
"UnitAmountTaxExcluded" : 2.3021358869347654518833223846741020679473876953125,
"CityTax" : {
"CurrencyISO" : "CurrencyISO",
"Percentage" : 3.61607674925191080461672754609026014804840087890625,
"FixedAmount" : 2.027123023002321833274663731572218239307403564453125
},
"VATPercentage" : 9.301444243932575517419536481611430644989013671875,
"Allotment" : 5,
"UnitAmountTaxIncluded" : 7.061401241503109105224211816675961017608642578125,
"Date" : "Date"
}, {
"CurrencyCode" : "CurrencyCode",
"DateLocal" : "DateLocal",
"QuantityBooked" : 5,
"UnitAmountTaxExcluded" : 2.3021358869347654518833223846741020679473876953125,
"CityTax" : {
"CurrencyISO" : "CurrencyISO",
"Percentage" : 3.61607674925191080461672754609026014804840087890625,
"FixedAmount" : 2.027123023002321833274663731572218239307403564453125
},
"VATPercentage" : 9.301444243932575517419536481611430644989013671875,
"Allotment" : 5,
"UnitAmountTaxIncluded" : 7.061401241503109105224211816675961017608642578125,
"Date" : "Date"
} ],
"TotalBookingAmountTaxIncluded" : 1.46581298050294517310021547018550336360931396484375,
"Code" : "Code",
"MasterRoomTypeCode" : "MasterRoomTypeCode",
"Name" : "Name"
}, {
"CurrencyCode" : "CurrencyCode",
"TotalBookingAmountTaxExcluded" : 6.02745618307040320615897144307382404804229736328125,
"NightList" : [ {
"CurrencyCode" : "CurrencyCode",
"DateLocal" : "DateLocal",
"QuantityBooked" : 5,
"UnitAmountTaxExcluded" : 2.3021358869347654518833223846741020679473876953125,
"CityTax" : {
"CurrencyISO" : "CurrencyISO",
"Percentage" : 3.61607674925191080461672754609026014804840087890625,
"FixedAmount" : 2.027123023002321833274663731572218239307403564453125
},
"VATPercentage" : 9.301444243932575517419536481611430644989013671875,
"Allotment" : 5,
"UnitAmountTaxIncluded" : 7.061401241503109105224211816675961017608642578125,
"Date" : "Date"
}, {
"CurrencyCode" : "CurrencyCode",
"DateLocal" : "DateLocal",
"QuantityBooked" : 5,
"UnitAmountTaxExcluded" : 2.3021358869347654518833223846741020679473876953125,
"CityTax" : {
"CurrencyISO" : "CurrencyISO",
"Percentage" : 3.61607674925191080461672754609026014804840087890625,
"FixedAmount" : 2.027123023002321833274663731572218239307403564453125
},
"VATPercentage" : 9.301444243932575517419536481611430644989013671875,
"Allotment" : 5,
"UnitAmountTaxIncluded" : 7.061401241503109105224211816675961017608642578125,
"Date" : "Date"
} ],
"TotalBookingAmountTaxIncluded" : 1.46581298050294517310021547018550336360931396484375,
"Code" : "Code",
"MasterRoomTypeCode" : "MasterRoomTypeCode",
"Name" : "Name"
} ],
"PrimaryAddressCity" : "PrimaryAddressCity",
"PrimaryAddressZipCode" : "PrimaryAddressZipCode",
"StarRating" : 0.80082819046101150206595775671303272247314453125,
"PrimaryAddressCountryName" : "PrimaryAddressCountryName",
"Code" : "Code",
"HotelChainName" : "HotelChainName",
"PrimrayAddressState" : "PrimrayAddressState",
"PrimaryAddressStreet" : "PrimaryAddressStreet",
"PrimaryAddressCountryISO" : "PrimaryAddressCountryISO",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An array of APIHotelServiceProvider objects APIHotelServiceProvider
Up
get /API/GetLeadRetrievalParticipant
Gets detailed APILeadRetrievalParticipant based on the Event Code and the participant's barcode (aPIGetLeadRetrievalParticipant)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
applicationID (required)
Query Parameter — The external application ID provided to use this API
participantIDProofKey (required)
Query Parameter — The participantIDProofKey extracted from the scanned participant's badge
eventCode (required)
Query Parameter — The code of the event the participant belongs to
Return type
Example data
Content-Type: application/json
{
"Email" : "Email",
"CountryISO" : "CountryISO",
"Gender" : "Gender",
"StatusCode" : "StatusCode",
"JobTitle" : "JobTitle",
"MobilePhone" : "MobilePhone",
"CompanyName" : "CompanyName",
"Identifier" : "Identifier",
"CompanyDepartment" : "CompanyDepartment",
"Street" : "Street",
"PreferredLanguage" : "PreferredLanguage",
"ContactCode" : "ContactCode",
"Classifications" : [ {
"Code" : "Code",
"Name" : "Name"
}, {
"Code" : "Code",
"Name" : "Name"
} ],
"QuestionAnswers" : [ {
"QuestionCode" : "QuestionCode",
"Question" : "Question",
"QuestionAnswer" : "QuestionAnswer",
"QuestionnaireCode" : "QuestionnaireCode"
}, {
"QuestionCode" : "QuestionCode",
"Question" : "Question",
"QuestionAnswer" : "QuestionAnswer",
"QuestionnaireCode" : "QuestionnaireCode"
} ],
"FirstName" : "FirstName",
"ZipCode" : "ZipCode",
"DirectPhone" : "DirectPhone",
"Title" : "Title",
"City" : "City",
"MiddleName" : "MiddleName",
"State" : "State",
"NationalityISO" : "NationalityISO",
"Country" : "Country",
"BusinessPhone" : "BusinessPhone",
"LastName" : "LastName",
"ClassificationsAllowedToDisplay" : [ {
"Code" : "Code",
"Name" : "Name"
}, {
"Code" : "Code",
"Name" : "Name"
} ],
"Fax" : "Fax",
"BirthDate" : "BirthDate"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Participant details APILeadRetrievalParticipant
APILeadRetrievalParticipant
Up
get /API/GetLeadRetrievalParticipantByID
Gets specified participant details encrypted ProofKeyEncryptedAPILeadRetrievalParticipant (aPIGetLeadRetrievalParticipantByID)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
applicationID (required)
Query Parameter — The external application ID provided to use this API
eventCode (required)
Query Parameter — The code of the event the participant belongs to
participantID (required)
Query Parameter — The participant's ID to get details for format: int64
Return type
Example data
Content-Type: application/json
{
"ParticipantID" : 0,
"LastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
"EncryptedContent" : "EncryptedContent"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Encrypted Participant details ProofKeyEncryptedAPILeadRetrievalParticipant
ProofKeyEncryptedAPILeadRetrievalParticipant
Up
post /API/GetLeadRetrievalParticipantsByIDs
Gets a list of encrypted lead retrieval participants ProofKeyEncryptedAPILeadRetrievalParticipant returned participants based on the specified participantIDs (aPIGetLeadRetrievalParticipantsByIDs)
Consumes
This API call consumes the following media types via the request header:
Request body
participantIDs
long (required)
Body Parameter — List of partiicpant IDs to return participant details for
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
applicationID (required)
Query Parameter — The external application ID provided to use this API
eventCode (required)
Query Parameter — The code of the event the participant belongs to
Return type
Example data
Content-Type: application/json
[ {
"ParticipantID" : 0,
"LastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
"EncryptedContent" : "EncryptedContent"
}, {
"ParticipantID" : 0,
"LastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
"EncryptedContent" : "EncryptedContent"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of encrypted participants List Type: ProofKeyEncryptedAPILeadRetrievalParticipant
Up
get /API/GetModuleList
(aPIGetModuleList)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter —
eventCode (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
[ {
"ServiceProviders" : [ {
"Services" : [ {
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
}, {
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
} ],
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
}, {
"Services" : [ {
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
}, {
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
} ],
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
} ],
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
}, {
"ServiceProviders" : [ {
"Services" : [ {
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
}, {
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
} ],
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
}, {
"Services" : [ {
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
}, {
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
} ],
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
} ],
"Code" : "Code",
"QuestionnaireCodes" : [ "QuestionnaireCodes", "QuestionnaireCodes" ],
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Up
get /API/GetParticipantClassifications
Gets requested APIParticipantClassification based on the Event Code and the participant's Identifier (aPIGetParticipantClassifications)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter —
participantIdentifier (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
[ {
"Description" : "Description",
"Code" : "Code",
"Name" : "Name"
}, {
"Description" : "Description",
"Code" : "Code",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Up
get /API/GetParticipantDetails
Gets detailed APIParticipant based on the Event Code and the participant's Identifier (aPIGetParticipantDetails)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter — the code of the event the participant belongs to
participantIdentifier (required)
Query Parameter — the identifier of the participant that we want details from
Return type
Example data
Content-Type: application/json
{
"Email" : "Email",
"CountryISO" : "CountryISO",
"Gender" : "Gender",
"StatusCode" : "StatusCode",
"MobilePhone" : "MobilePhone",
"CompanyName" : "CompanyName",
"Identifier" : "Identifier",
"CompanyDepartment" : "CompanyDepartment",
"Street" : "Street",
"PreferredLanguage" : "PreferredLanguage",
"ContactCode" : "ContactCode",
"PaymentStatus" : "PaymentStatus",
"IsAbstractSubmitter" : true,
"FirstName" : "FirstName",
"ZipCode" : "ZipCode",
"DirectPhone" : "DirectPhone",
"Title" : "Title",
"City" : "City",
"MiddleName" : "MiddleName",
"ParentParticipantIdentifier" : "ParentParticipantIdentifier",
"ParentGroupIdentifier" : "ParentGroupIdentifier",
"State" : "State",
"NationalityISO" : "NationalityISO",
"CreatedDate" : "CreatedDate",
"LastModificationDate" : "LastModificationDate",
"Country" : "Country",
"BusinessPhone" : "BusinessPhone",
"LastName" : "LastName",
"Fax" : "Fax",
"BirthDate" : "BirthDate"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
the participant details
APIParticipant
Up
get /API/GetParticipantList
Gets a list of APIParticipant registered under the requested Event.
The list is a chunk of Participants from index (PageIndex * PageSize) to (PageIndex * PageSize + PageSize) (aPIGetParticipantList)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter — The code of the B-Com Event for which to retrieve data
pageIndex (required)
Query Parameter — The index of the page used for record paging handling format: int32
pageSize (required)
Query Parameter — The maximum number of records that can be returned through one call (Maximum is 5000 - see: pageIndex) format: int32
orderByClause (optional)
Query Parameter — The name of the column on which to order the returned records
lastModificationUTCDate (optional)
Query Parameter — only return participants modified after this date format: date-time
statusCodes (optional)
Query Parameter — only return participants with these status codes
Return type
Example data
Content-Type: application/json
[ {
"Email" : "Email",
"CountryISO" : "CountryISO",
"Gender" : "Gender",
"StatusCode" : "StatusCode",
"MobilePhone" : "MobilePhone",
"CompanyName" : "CompanyName",
"Identifier" : "Identifier",
"CompanyDepartment" : "CompanyDepartment",
"Street" : "Street",
"PreferredLanguage" : "PreferredLanguage",
"ContactCode" : "ContactCode",
"PaymentStatus" : "PaymentStatus",
"IsAbstractSubmitter" : true,
"FirstName" : "FirstName",
"ZipCode" : "ZipCode",
"DirectPhone" : "DirectPhone",
"Title" : "Title",
"City" : "City",
"MiddleName" : "MiddleName",
"ParentParticipantIdentifier" : "ParentParticipantIdentifier",
"ParentGroupIdentifier" : "ParentGroupIdentifier",
"State" : "State",
"NationalityISO" : "NationalityISO",
"CreatedDate" : "CreatedDate",
"LastModificationDate" : "LastModificationDate",
"Country" : "Country",
"BusinessPhone" : "BusinessPhone",
"LastName" : "LastName",
"Fax" : "Fax",
"BirthDate" : "BirthDate"
}, {
"Email" : "Email",
"CountryISO" : "CountryISO",
"Gender" : "Gender",
"StatusCode" : "StatusCode",
"MobilePhone" : "MobilePhone",
"CompanyName" : "CompanyName",
"Identifier" : "Identifier",
"CompanyDepartment" : "CompanyDepartment",
"Street" : "Street",
"PreferredLanguage" : "PreferredLanguage",
"ContactCode" : "ContactCode",
"PaymentStatus" : "PaymentStatus",
"IsAbstractSubmitter" : true,
"FirstName" : "FirstName",
"ZipCode" : "ZipCode",
"DirectPhone" : "DirectPhone",
"Title" : "Title",
"City" : "City",
"MiddleName" : "MiddleName",
"ParentParticipantIdentifier" : "ParentParticipantIdentifier",
"ParentGroupIdentifier" : "ParentGroupIdentifier",
"State" : "State",
"NationalityISO" : "NationalityISO",
"CreatedDate" : "CreatedDate",
"LastModificationDate" : "LastModificationDate",
"Country" : "Country",
"BusinessPhone" : "BusinessPhone",
"LastName" : "LastName",
"Fax" : "Fax",
"BirthDate" : "BirthDate"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Up
get /API/GetParticipantQuestionAnswers
Gets requested APIParticipantQuestionAnswer based on the Event Code and the participant's Identifier.
Question answers are returned in the requested language if existing, in English otherwise (aPIGetParticipantQuestionAnswers)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter —
participantIdentifier (required)
Query Parameter —
languageISO (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
[ {
"QuestionCode" : "QuestionCode",
"Question" : "Question",
"QuestionAnswer" : "QuestionAnswer",
"QuestionnaireCode" : "QuestionnaireCode"
}, {
"QuestionCode" : "QuestionCode",
"Question" : "Question",
"QuestionAnswer" : "QuestionAnswer",
"QuestionnaireCode" : "QuestionnaireCode"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Up
get /API/GetParticipantReservations
Gets requested APIParticipantReservation based on the Event Code and the participant's Identifier (aPIGetParticipantReservations)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter —
participantIdentifier (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
[ {
"Email" : "Email",
"FirstName" : "FirstName",
"Service" : "Service",
"Quantity" : 0,
"Identifier" : "Identifier",
"ReservationDate" : "ReservationDate",
"ServiceCode" : "ServiceCode",
"ModuleCode" : "ModuleCode",
"OccurrenceDateTime" : "OccurrenceDateTime",
"ServiceProvider" : "ServiceProvider",
"ServiceProviderCode" : "ServiceProviderCode",
"LastName" : "LastName",
"Module" : "Module"
}, {
"Email" : "Email",
"FirstName" : "FirstName",
"Service" : "Service",
"Quantity" : 0,
"Identifier" : "Identifier",
"ReservationDate" : "ReservationDate",
"ServiceCode" : "ServiceCode",
"ModuleCode" : "ModuleCode",
"OccurrenceDateTime" : "OccurrenceDateTime",
"ServiceProvider" : "ServiceProvider",
"ServiceProviderCode" : "ServiceProviderCode",
"LastName" : "LastName",
"Module" : "Module"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Up
get /API/GetSessionActorContactProfile
Gets the contact profile of the session actor identified by the session actor code. (aPIGetSessionActorContactProfile)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter —
sessionActorCode (required)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"LastModifiedDate" : "LastModifiedDate",
"Base64ProfilePicture" : "Base64ProfilePicture",
"Biography" : "Biography",
"CreatedDate" : "CreatedDate",
"Summary" : "Summary",
"ProfilePictureFileType" : "ProfilePictureFileType"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
APIContactProfile
Up
get /API/GetSessionList
Gets the sessions of the event identified by its code, paged, and only if changed after laste modification UTC date (aPIGetSessionList)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter —
pageIndex (required)
Query Parameter — format: int32
pageSize (required)
Query Parameter — format: int32
lastModificationUTCDate (optional)
Query Parameter — format: date-time
Return type
Example data
Content-Type: application/json
[ {
"SessionTypeCode" : "SessionTypeCode",
"LastModifiedDate" : "LastModifiedDate",
"SessionType" : "SessionType",
"Description" : "Description",
"AccessLimitationOnClassifications" : [ "AccessLimitationOnClassifications", "AccessLimitationOnClassifications" ],
"CheckAccessOnServices" : true,
"ActorList" : [ {
"Order" : 6,
"TitleName" : "TitleName",
"LastModifiedDate" : "LastModifiedDate",
"EventSessionCode" : "EventSessionCode",
"Email" : "Email",
"CountryISO" : "CountryISO",
"CountryName" : "CountryName",
"FirstName" : "FirstName",
"RoleDescription" : "RoleDescription",
"TitleShortName" : "TitleShortName",
"City" : "City",
"MiddleName" : "MiddleName",
"Code" : "Code",
"RoleCode" : "RoleCode",
"GenderShortName" : "GenderShortName",
"RoleName" : "RoleName",
"Biography" : "Biography",
"CreatedDate" : "CreatedDate",
"LastName" : "LastName",
"ContactCode" : "ContactCode",
"GenderName" : "GenderName"
}, {
"Order" : 6,
"TitleName" : "TitleName",
"LastModifiedDate" : "LastModifiedDate",
"EventSessionCode" : "EventSessionCode",
"Email" : "Email",
"CountryISO" : "CountryISO",
"CountryName" : "CountryName",
"FirstName" : "FirstName",
"RoleDescription" : "RoleDescription",
"TitleShortName" : "TitleShortName",
"City" : "City",
"MiddleName" : "MiddleName",
"Code" : "Code",
"RoleCode" : "RoleCode",
"GenderShortName" : "GenderShortName",
"RoleName" : "RoleName",
"Biography" : "Biography",
"CreatedDate" : "CreatedDate",
"LastName" : "LastName",
"ContactCode" : "ContactCode",
"GenderName" : "GenderName"
} ],
"Name" : "Name",
"StartDate" : "StartDate",
"AccessLimitationOnServices" : [ "AccessLimitationOnServices", "AccessLimitationOnServices" ],
"SessionTopicCode" : "SessionTopicCode",
"SessionTopicBackgroundColor" : "SessionTopicBackgroundColor",
"SessionTypeBackgroundColor" : "SessionTypeBackgroundColor",
"CheckAccessOnClassifications" : true,
"ParentSessionCode" : "ParentSessionCode",
"SessionTopic" : "SessionTopic",
"Order" : 0,
"IsBookable" : true,
"LocationCode" : "LocationCode",
"Code" : "Code",
"EndDate" : "EndDate",
"CategoryList" : [ {
"Order" : 1,
"LastModifiedDate" : "LastModifiedDate",
"Description" : "Description",
"CreatedDate" : "CreatedDate",
"Code" : "Code",
"Name" : "Name"
}, {
"Order" : 1,
"LastModifiedDate" : "LastModifiedDate",
"Description" : "Description",
"CreatedDate" : "CreatedDate",
"Code" : "Code",
"Name" : "Name"
} ],
"ReplayList" : [ {
"LastModifiedDate" : "LastModifiedDate",
"MediaUrl" : "MediaUrl",
"Description" : "Description",
"ThumbnailUrl" : "ThumbnailUrl",
"CreatedDate" : "CreatedDate",
"Code" : "Code",
"Name" : "Name"
}, {
"LastModifiedDate" : "LastModifiedDate",
"MediaUrl" : "MediaUrl",
"Description" : "Description",
"ThumbnailUrl" : "ThumbnailUrl",
"CreatedDate" : "CreatedDate",
"Code" : "Code",
"Name" : "Name"
} ],
"SessionTypeDescription" : "SessionTypeDescription",
"PresentedAbstractFinalIdentifier" : "PresentedAbstractFinalIdentifier",
"Location" : "Location"
}, {
"SessionTypeCode" : "SessionTypeCode",
"LastModifiedDate" : "LastModifiedDate",
"SessionType" : "SessionType",
"Description" : "Description",
"AccessLimitationOnClassifications" : [ "AccessLimitationOnClassifications", "AccessLimitationOnClassifications" ],
"CheckAccessOnServices" : true,
"ActorList" : [ {
"Order" : 6,
"TitleName" : "TitleName",
"LastModifiedDate" : "LastModifiedDate",
"EventSessionCode" : "EventSessionCode",
"Email" : "Email",
"CountryISO" : "CountryISO",
"CountryName" : "CountryName",
"FirstName" : "FirstName",
"RoleDescription" : "RoleDescription",
"TitleShortName" : "TitleShortName",
"City" : "City",
"MiddleName" : "MiddleName",
"Code" : "Code",
"RoleCode" : "RoleCode",
"GenderShortName" : "GenderShortName",
"RoleName" : "RoleName",
"Biography" : "Biography",
"CreatedDate" : "CreatedDate",
"LastName" : "LastName",
"ContactCode" : "ContactCode",
"GenderName" : "GenderName"
}, {
"Order" : 6,
"TitleName" : "TitleName",
"LastModifiedDate" : "LastModifiedDate",
"EventSessionCode" : "EventSessionCode",
"Email" : "Email",
"CountryISO" : "CountryISO",
"CountryName" : "CountryName",
"FirstName" : "FirstName",
"RoleDescription" : "RoleDescription",
"TitleShortName" : "TitleShortName",
"City" : "City",
"MiddleName" : "MiddleName",
"Code" : "Code",
"RoleCode" : "RoleCode",
"GenderShortName" : "GenderShortName",
"RoleName" : "RoleName",
"Biography" : "Biography",
"CreatedDate" : "CreatedDate",
"LastName" : "LastName",
"ContactCode" : "ContactCode",
"GenderName" : "GenderName"
} ],
"Name" : "Name",
"StartDate" : "StartDate",
"AccessLimitationOnServices" : [ "AccessLimitationOnServices", "AccessLimitationOnServices" ],
"SessionTopicCode" : "SessionTopicCode",
"SessionTopicBackgroundColor" : "SessionTopicBackgroundColor",
"SessionTypeBackgroundColor" : "SessionTypeBackgroundColor",
"CheckAccessOnClassifications" : true,
"ParentSessionCode" : "ParentSessionCode",
"SessionTopic" : "SessionTopic",
"Order" : 0,
"IsBookable" : true,
"LocationCode" : "LocationCode",
"Code" : "Code",
"EndDate" : "EndDate",
"CategoryList" : [ {
"Order" : 1,
"LastModifiedDate" : "LastModifiedDate",
"Description" : "Description",
"CreatedDate" : "CreatedDate",
"Code" : "Code",
"Name" : "Name"
}, {
"Order" : 1,
"LastModifiedDate" : "LastModifiedDate",
"Description" : "Description",
"CreatedDate" : "CreatedDate",
"Code" : "Code",
"Name" : "Name"
} ],
"ReplayList" : [ {
"LastModifiedDate" : "LastModifiedDate",
"MediaUrl" : "MediaUrl",
"Description" : "Description",
"ThumbnailUrl" : "ThumbnailUrl",
"CreatedDate" : "CreatedDate",
"Code" : "Code",
"Name" : "Name"
}, {
"LastModifiedDate" : "LastModifiedDate",
"MediaUrl" : "MediaUrl",
"Description" : "Description",
"ThumbnailUrl" : "ThumbnailUrl",
"CreatedDate" : "CreatedDate",
"Code" : "Code",
"Name" : "Name"
} ],
"SessionTypeDescription" : "SessionTypeDescription",
"PresentedAbstractFinalIdentifier" : "PresentedAbstractFinalIdentifier",
"Location" : "Location"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Up
get /API/GetUpdatedLeadRetrievalParticipantIDs
Gets a list of participantIDs that have been updated after the specified lastModificationUTCDate
If lastModificationUTCDate is not supplied all participant's IDs will be fetched (aPIGetUpdatedLeadRetrievalParticipantIDs)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
applicationID (required)
Query Parameter — The external application ID provided to use this API
eventCode (required)
Query Parameter — The code of the event the participant belongs to
lastModificationUtcDate (optional)
Query Parameter — If supplied filteres the result to participants that have been modified after this date format: date-time
Return type
array[Long]
Example data
Content-Type: application/json
[ 0, 0 ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of participantIDs type long
Up
post /API/RemoveParticipantArbitraryClassification
Removes the arbitrary classification with the given code from the participant (aPIRemoveParticipantArbitraryClassification)
Consumes
This API call consumes the following media types via the request header:
Query parameters
authenticationToken (required)
Query Parameter — The token returned by the API "Authenticate" method. Used to check API access authorization.
eventCode (required)
Query Parameter —
participantIdentifier (required)
Query Parameter —
arbitraryClassificationCode (required)
Query Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
[ Jump to Methods ]
Table of Contents
APIAbstract - APIAbstractAuthor - APICommunity - APICommunityCustomFieldValue - APICommunityMember - APICommunityMemberClassification - APICommunityMemberCustomField - APICommunityMemberPosition - APICommunityMemberQuestionAnswer - APICommunityMemberReservation - APIContactCustomFieldValue - APIContactProfile - APIContactTag - APIContactTagType - APIContactTagValue - APIEntityCustomField - APIEvent - APIExhibitor - APIFile - APIGroup - APIGroupClassification - APIHotelService - APIHotelServiceOccurrence - APIHotelServiceProvider - APILeadRetrievalParticipant - APILeadRetrievalParticipantClassification - APILeadRetrievalParticipantQuestionAnswer - APIModule - APIOrganizer - APIParticipant - APIParticipantClassification - APIParticipantQuestionAnswer - APIParticipantReservation - APIQuestion - APIQuestionnaire - APIService - APIServicePvd - APISession - APISessionActor - APISessionCategory - APISessionReplay - APITaxCodeComponent - ProofKeyEncryptedAPILeadRetrievalParticipant - ServiceAccessCheckRequest - ServiceAccessCheckResponse -
AbstractSubmissionIdentifier (optional)
AbstractFinalIdentifier (optional)
Order
SubmissionTypeCode (optional)
SubmissionTypeName (optional)
Title (optional)
Status (optional)
TopicCode (optional)
TopicName (optional)
CreatedDate (optional)
LastModifiedDate (optional)
AbstractFinalAcceptanceStatusCommaSeparatedList (optional)
AuthorList (optional)
ContactCode (optional)
FirstName (optional)
MiddleName (optional)
LastName (optional)
Email (optional)
Gender (optional)
Title (optional)
Order
IsSubmittingAuthor
IsPresentingAuthor
IsCoAuthor
IsSeniorAuthor
OnBehalfOfWorkingGroup (optional)
CountryName (optional)
Code (optional)
ShortName (optional)
Name (optional)
Children (optional)
CommunityTypeCode (optional)
Organizer (optional)
Code (optional)
Value (optional)
CommunityCode (optional)
Identifier (optional)
StatusCode (optional)
MembershipServiceCode (optional)
MemberSince (optional)
MemberTo (optional)
ContactCode (optional)
FirstName (optional)
MiddleName (optional)
LastName (optional)
Email (optional)
Title (optional)
CompanyName (optional)
CompanyDepartment (optional)
Gender (optional)
MobilePhone (optional)
DirectPhone (optional)
BusinessPhone (optional)
Fax (optional)
PaymentStatus (optional)
PreferredLanguageISO (optional)
PreferredLanguage (optional)
Street (optional)
ZipCode (optional)
City (optional)
State (optional)
CountryISO (optional)
Country (optional)
CreatedDate (optional)
LastModificationDate (optional)
HasProfilePicture
Summary (optional)
Biography (optional)
Code (optional)
Name (optional)
Description (optional)
CustomFieldCode (optional)
CustomFieldName (optional)
ValueText (optional)
FieldType (optional)
Code (optional)
Name (optional)
QuestionnaireCode (optional)
QuestionCode (optional)
Question (optional)
QuestionAnswer (optional)
ReservationDate (optional)
Module (optional)
ServiceProvider (optional)
Service (optional)
Quantity
EntityCustomFieldCode (optional)
EntityCustomFieldName (optional)
ContactCode (optional)
Value (optional)
Summary (optional)
Biography (optional)
Base64ProfilePicture (optional)
ProfilePictureFileType (optional)
CreatedDate (optional)
LastModifiedDate (optional)
TagTypeCode (optional)
Values (optional)
Code (optional)
Name (optional)
Description (optional)
ValueKeyNames (optional)
AllowMultipleValuesPerContact
Key (optional)
Value (optional)
EntityName (optional)
Description (optional)
Code (optional)
Name (optional)
WebPlacementCategory (optional)
WebPlacementOrder (optional)
FieldTypeCode (optional)
Code (optional)
ShortName (optional)
Name (optional)
IsOpen
StartDate (optional)
EndDate (optional)
StartDateLocal (optional)
EndDateLocal (optional)
TimeZoneName (optional)
VenueStreet (optional)
VenueZipCode (optional)
VenueCity (optional)
VenueState (optional)
VenueCountryName (optional)
VenueCountryISO (optional)
CreatedDate (optional)
LastModifiedDate (optional)
CustomFieldList (optional)
Code (optional)
Name (optional)
Description (optional)
HTMLDescription (optional)
CompanyName (optional)
ContactFirstName (optional)
ContactLastName (optional)
ContactEmail (optional)
Location (optional)
Base64Data (optional)
FileTypeName (optional)
Identifier (optional)
Name (optional)
StatusCode (optional)
Status (optional)
PaymentStatusCode (optional)
PaymentStatus (optional)
PickupStatusCode (optional)
PickupStatus (optional)
CompanyName (optional)
CompanyStreet1 (optional)
CompanyStreet2 (optional)
CompanyZipCode (optional)
CompanyCity (optional)
CompanyState (optional)
CompanyCountry (optional)
LeaderFirstName (optional)
LeaderMiddleName (optional)
LeaderLastName (optional)
LeaderEmail (optional)
LeaderBusinessPhone (optional)
LeaderMobilePhone (optional)
LeaderDirectPhone (optional)
LeaderFaxPhone (optional)
LeaderStreet1 (optional)
LeaderStreet2 (optional)
LeaderZipCode (optional)
LeaderCity (optional)
LeaderState (optional)
LeaderCountry (optional)
MembersCount
PONumber (optional)
VATNumber (optional)
BillingAddressStreet1 (optional)
BillingAddressStreet2 (optional)
BillingAddressZipCode (optional)
BillingAddressCity (optional)
BillingAddressState (optional)
BillingAddressCountry (optional)
ShippingAddressStreet1 (optional)
ShippingAddressStreet2 (optional)
ShippingAddressZipCode (optional)
ShippingAddressCity (optional)
ShippingAddressState (optional)
ShippingAddressCountry (optional)
IsSmallGroup
Code (optional)
Name (optional)
Description (optional)
Code (optional)
Name (optional)
MasterRoomTypeCode (optional)
TotalBookingAmountTaxExcluded
TotalBookingAmountTaxIncluded
CurrencyCode (optional)
NightList (optional)
Date (optional)
DateLocal (optional)
Allotment (optional)
QuantityBooked
CurrencyCode (optional)
UnitAmountTaxExcluded
UnitAmountTaxIncluded
VATPercentage (optional)
CityTax (optional)
Code (optional)
Name (optional)
HotelChainName (optional)
StarRating (optional)
PrimaryAddressStreet (optional)
PrimaryAddressZipCode (optional)
PrimaryAddressCity (optional)
PrimrayAddressState (optional)
PrimaryAddressCountryName (optional)
PrimaryAddressCountryISO (optional)
RoomTypeList (optional)
Identifier (optional)
ContactCode (optional)
FirstName (optional)
LastName (optional)
MiddleName (optional)
Email (optional)
StatusCode (optional)
Gender (optional)
Title (optional)
CompanyName (optional)
CompanyDepartment (optional)
JobTitle (optional)
Street (optional)
ZipCode (optional)
City (optional)
State (optional)
CountryISO (optional)
Country (optional)
NationalityISO (optional)
PreferredLanguage (optional)
BusinessPhone (optional)
DirectPhone (optional)
MobilePhone (optional)
Fax (optional)
BirthDate (optional)
Classifications (optional)
ClassificationsAllowedToDisplay (optional)
QuestionAnswers (optional)
Code (optional)
Name (optional)
QuestionnaireCode (optional)
QuestionCode (optional)
Question (optional)
QuestionAnswer (optional)
QuestionnaireCodes (optional)
ServiceProviders (optional)
Name (optional)
Code (optional)
Code (optional)
Name (optional)
ParentOrganizer (optional)
Identifier (optional)
ContactCode (optional)
FirstName (optional)
LastName (optional)
MiddleName (optional)
Email (optional)
StatusCode (optional)
ParentParticipantIdentifier (optional)
ParentGroupIdentifier (optional)
Gender (optional)
Title (optional)
CompanyName (optional)
CompanyDepartment (optional)
Street (optional)
ZipCode (optional)
City (optional)
State (optional)
CountryISO (optional)
Country (optional)
NationalityISO (optional)
PreferredLanguage (optional)
PaymentStatus (optional)
CreatedDate (optional)
LastModificationDate (optional)
IsAbstractSubmitter
BusinessPhone (optional)
DirectPhone (optional)
MobilePhone (optional)
Fax (optional)
BirthDate (optional)
Code (optional)
Name (optional)
Description (optional)
QuestionnaireCode (optional)
QuestionCode (optional)
Question (optional)
QuestionAnswer (optional)
Identifier (optional)
LastName (optional)
FirstName (optional)
Email (optional)
ReservationDate (optional)
ModuleCode (optional)
Module (optional)
ServiceProviderCode (optional)
ServiceProvider (optional)
ServiceCode (optional)
Service (optional)
Quantity
OccurrenceDateTime (optional)
Code (optional)
QuestionnaireCode (optional)
Text (optional)
FieldTypeCode (optional)
Code (optional)
Name (optional)
Description (optional)
IsEventQuestionnaire
Questions (optional)
QuestionnaireCodes (optional)
Name (optional)
Code (optional)
QuestionnaireCodes (optional)
Services (optional)
Name (optional)
Code (optional)
SessionTypeCode (optional)
SessionType (optional)
SessionTypeDescription (optional)
SessionTypeBackgroundColor (optional)
SessionTopicCode (optional)
SessionTopic (optional)
SessionTopicBackgroundColor (optional)
Code (optional)
ParentSessionCode (optional)
Name (optional)
Description (optional)
Order
IsBookable
PresentedAbstractFinalIdentifier (optional)
LocationCode (optional)
Location (optional)
StartDate (optional)
EndDate (optional)
CheckAccessOnServices
AccessLimitationOnServices (optional)
CheckAccessOnClassifications
AccessLimitationOnClassifications (optional)
ActorList (optional)
CategoryList (optional)
ReplayList (optional)
LastModifiedDate (optional)
Code (optional)
ContactCode (optional)
FirstName (optional)
MiddleName (optional)
LastName (optional)
Email (optional)
GenderShortName (optional)
GenderName (optional)
TitleShortName (optional)
TitleName (optional)
Order
City (optional)
CountryISO (optional)
CountryName (optional)
RoleCode (optional)
RoleName (optional)
RoleDescription (optional)
EventSessionCode (optional)
Biography (optional)
CreatedDate (optional)
LastModifiedDate (optional)
Code (optional)
Name (optional)
Description (optional)
Order
CreatedDate (optional)
LastModifiedDate (optional)
Code (optional)
Name (optional)
Description (optional)
ThumbnailUrl (optional)
MediaUrl (optional)
CreatedDate (optional)
LastModifiedDate (optional)
Percentage (optional)
FixedAmount
CurrencyISO (optional)
ParticipantID
Long The participant identifier format: int64
LastModifiedDate (optional)
Date The Partcipants Last Modified Date format: date-time
EncryptedContent (optional)
byte[] Encrypted lead retrieval participant data format: byte
EventCode (optional)
String The code of the current working event
ServiceCode (optional)
String The code of the service for which to check the booking.
For the sake of simplicity, the value can contain multiple Service codes separated by a "broken vertical bar" char (¦).
The check will then be done on each of the given service codes
AllowNonConfirmedParticipant
Boolean A boolean value defining whether the Participant must be fully condirmed or not
AllowNonConfirmedReservation
Boolean A boolean value defining whether the corresponding service reservation must be fully confirmed (paid) or not
ParticipantIdentifierList (optional)
array[String] The list of participant identifiers for which to check the reservation status
EventCode (optional)
String The code of the current working event
ServiceCode (optional)
String The code of the service for which to check the booking.
This property can contain a list of service codes separated by a "broken vertical bar" (¦) depending on the request.
AllowedParticipantIdentifier (optional)
array[String] The list of participant identifier for which to check the reservation status