Object Mapping
This article maps each object in the SOAP API to its corresponding objects in REST API.
eMarketing Objects
EMarketingEmailHistory
SOAP Object | REST Object |
---|---|
EMarketingEmailHistory | Email Recipient Object found in Campaigns. |
FIELD NAME | TYPE | READ-ONLY | SEARCHABLE | REST FIELD NAME |
---|---|---|---|---|
CampaignID | GUID | X | X | N/A |
ContactId | GUID | X | recipientResponse object, id | |
EmailSentDate | DateTime | X | N/A | |
EmailStatus | String | X | status | |
FromEmailAddress | String | X | N/A | |
ToEmailAddress | String | X | N/A | |
EmailViewed | Boolean | X | N/A | |
EmailBounced | Boolean | X | N/A | |
LastModifiedDate | DateTime | X | X | lastModified |
Administration Objects
Approver
SOAP Object | REST Object |
---|---|
Approver | N/A |
User Group
SOAP Object | REST Object |
---|---|
UserGroup | N/A |
User Role
SOAP Object | REST Object |
---|---|
UserRole | User Group object found in User SCIM. |
FIELD NAME | TYPE | READ-ONLY | SEARCHABLE | REST FIELD NAME |
---|---|---|---|---|
UserRoleName | String | X | X | resources object, displayName |
Description | String | X | X | N/A |
UserRights | N/A | |||
UserRightName | String | X | N/A | |
UserRightCategory | String | X | N/A | |
AccessLevel | String | X | N/A |
Meeting Request
SOAP Object | REST Object |
---|---|
MeetingRequest | MeetingRequest object found in Meeting Request. |
FIELD NAME | TYPE | READ-ONLY | SEARCHABLE | REST FIELD NAME |
---|---|---|---|---|
Id | GUID | X | id | |
RequestName | String | X | name | |
RequestStatus | String | X | status | |
RequestCode | String | X | X | N/A |
FormId | GUID | X | meetingRequestForm object, id | |
FormName | String | X | N/A | |
FormDescription | String | N/A | ||
FormInternalNote | String | N/A | ||
RequesterId | GUID | N/A | ||
RequesterFirstName | String | X | N/A | |
RequesterLastName | String | X | N/A | |
RequesterEmailAddress | String | X | N/A | |
RequesterTitle | String | N/A | ||
RequesterCompany | String | N/A | ||
RequesterWorkPhone | String | N/A | ||
RequesterHomePhone | String | N/A | ||
RequesterWorkFax | String | N/A | ||
RequesterMobilePhone | String | N/A | ||
RequesterAddress1 | String | N/A | ||
RequesterAddress2 | String | N/A | ||
RequesterAddress3 | String | N/A | ||
RequesterCity | String | N/A | ||
RequesterState | String | N/A | ||
RequesterStateCode | String | N/A | ||
RequesterPostalCode | String | N/A | ||
RequesterCountry | String | N/A | ||
RequesterCountryCode | String | N/A | ||
Archived | Boolean | X | X | N/A |
ArchiveDate | DateTime | N/A | ||
CreatedBy | String | X | N/A | |
CreatedDate | DateTime | X | X | N/A |
LastModifiedBy | String | X | N/A | |
LastModifiedDate | DateTime | X | X | N/A |
EventRequestInfo | N/A, event object, id field identifies the associated event. | |||
EventTitle | String | N/A | ||
EventCategory | String | N/A | ||
EventDescription | String | N/A | ||
EventInternalNote | String | N/A | ||
EventLocation | String | N/A | ||
EventAddress1 | String | N/A | ||
EventAddress2 | String | N/A | ||
EventAddress3 | String | N/A | ||
EventCity | String | N/A | ||
EventState | String | N/A | ||
EventStateCode | String | N/A | ||
EventPostalCode | String | N/A | ||
EventCountry | String | N/A | ||
EventCountryCode | String | N/A | ||
EventPhone | String | N/A | ||
EventStartDate | DateTime | N/A | ||
EventEndDate | DateTime | N/A | ||
EventRSVPDate | DateTime | N/A | ||
EventTimeZone | String | N/A | ||
EventTimeZoneId | Integer | N/A | ||
EventCapacity | Integer | N/A | ||
EstimateAccomodation | Money | N/A | ||
EstimateCreativeAndDesign | Money | N/A | ||
EstimateEventProduction | Money | N/A | ||
EstimateFoodAndBeverage | Money | N/A | ||
EstimateGroundTransport | Money | N/A | ||
EstimateHotelAndVenueMisc | Money | N/A | ||
EstimateManagementFees | Money | N/A | ||
EstimateMerchandiseAndGifts | Money | N/A | ||
EstimateMiscellaneous | Money | N/A | ||
EstimatePrintAndWebsites | Money | N/A | ||
EstimateRoomRental | Money | N/A | ||
EstimateSetupAndEquipment | Money | N/A | ||
EstimateSiteInspection | Money | N/A | ||
EstimateSpecialEvents | Money | N/A | ||
EstimateTravel | Money | N/A | ||
StakeholderFirstName | String | N/A | ||
StakeholderLastName | String | N/A | ||
StakeholderEmailAddress | String | N/A | ||
StakeholderTitle | String | N/A | ||
StakeholderCompany | String | N/A | ||
StakeholderWorkPhone | String | N/A | ||
StakeholderHomePhone | String | N/A | ||
StakeholderWorkFax | String | N/A | ||
StakeholderMobilePhone | String | N/A | ||
StakeholderAddress1 | String | N/A | ||
StakeholderAddress2 | String | N/A | ||
StakeholderAddress3 | String | N/A | ||
StakeholderCity | String | N/A | ||
StakeholderState | String | N/A | ||
StakeholderStateCode | String | N/A | ||
StakeholderPostalCode | String | N/A | ||
StakeholderCountry | String | N/A | ||
StakeholderCountryCode | String | N/A | ||
MaximumEventCapacity | Integer | N/A | ||
NumberCancelledRegistrants | Integer | N/A | ||
NumberDeclinedRegistrants | Integer | N/A | ||
NumberParticipants | Integer | N/A | ||
NumberRegisteredAttendees | Integer | N/A | ||
NumberInvited | Integer | N/A | ||
RFPRequestInfo | N/A | |||
ExpectedAttendees | Integer | N/A | ||
AlternateStartDate1 | DateTime | N/A | ||
AlternateEndDate1 | DateTime | N/A | ||
AlternateDate1Note | String | N/A | ||
AlternateStartDate1 | DateTime | N/A | ||
AlternateEndDate1 | DateTime | N/A | ||
AlternateDate1Note | String | N/A | ||
TotalMeetingSpace | String | N/A | ||
LargestMeetingRoom | String | N/A | ||
BusinessObjectives | String | N/A | ||
DestinationsUnderConsideration | String | N/A | ||
BudgetedRoomRate | Money | N/A | ||
SleepRoomAdditionalInfo | String | N/A | ||
TotalMeetingRoomsNeeded | Integer | N/A | ||
MeetingRoomAdditionalInfo | String | N/A | ||
ConcessionAndContractual | String | N/A | ||
DecisionDate | DateTime | N/A | ||
ResponseDueDate | DateTime | N/A | ||
AVNeeds | String | N/A | ||
AttendeesPerDay | Integer | N/A | ||
EventType | String | N/A | ||
ContractSignatureLocation | String | N/A | ||
TotalBudget | Decimal | N/A | ||
EventDetailsAdditionalInformation | String | N/A | ||
FandBBudget | Decimal | N/A | ||
BillingInformation | String | N/A | ||
MeetingRoomAvailabilityDetail | N/A | |||
AgendaItem | String | N/A | ||
AgendaItemType | String | N/A | ||
DayNumber | Integer | N/A | ||
EndTime | DateTime | N/A | ||
MeetingRoomAdditionalInfo | String | N/A | ||
NumberOfPeople | Integer | N/A | ||
RoomSize | Integer | N/A | ||
SetupType | String | N/A | ||
StartTime | DateTime | N/A | ||
TwentyFourHourHold | Boolean | N/A | ||
SleepingRoomAvailabilityDetail | N/A | |||
AnyRoomQuantity | Integer | N/A | ||
Date | DateTime | N/A | ||
DayNumber | Integer | N/A | ||
DoubleRoomQuantity | Integer | N/A | ||
SingleRoomQuantity | Integer | N/A | ||
StaffRoomQuantity | Integer | N/A | ||
SuiteQuantity | Integer | N/A | ||
CustomFieldDetail | N/A | |||
FieldId | GUID | X | N/A | |
FieldName | String | X | N/A | |
FieldType | String | X | N/A | |
FieldValue | String | N/A | ||
DocumentDetail | N/A | |||
FileName | String | X | N/A | |
FileType | String | X | N/A | |
FileSize | Integer | X | N/A | |
UploadDate | DateTime | X | N/A | |
FileURL | String | X | N/A | |
EventSurveyDetail | N/A | |||
SurveyType | String | N/A | ||
QuestionId | GUID | questions object, id | ||
QuestionCode | String | N/A | ||
QuestionText | String | question object, value | ||
AnswerDetail | N/A | |||
AnswerPart | String | N/A | ||
AnswerColumn | String | N/A | ||
AnswerText | String | N/A | ||
AnswerOther | String | N/A | ||
AnswerComment | String | N/A |
Advanced Logic
SOAP Object | REST Object |
---|---|
AdvancedLogic | Advanced Logic object found in Update Advanced Logic endpoint. |
FIELD NAME | TYPE | READ-ONLY | SEARCHABLE | REST FIELD NAME |
---|---|---|---|---|
Id | GUID | N/A, id supplied in initial request. See List Custom Fields | ||
SourceField | GUID | sourceCustomFieldId | ||
AdvancedLogicChoices | Array | sourceChoices object |
Rate History
SOAP Object | REST Object |
---|---|
RateHistory | N/A |
User
SOAP Object | REST Object |
---|---|
User | Users object found in User SCIM. |
FIELD NAME | TYPE | READ-ONLY | SEARCHABLE | REST FIELD NAME |
---|---|---|---|---|
Username | String | X | userName | |
FederatedId | String | X | id | |
UserType | String | userType | ||
UserRole | String | X | X | groups object, display |
UserRoleId | GUID | X | groups object, value | |
Active | Boolean | active | ||
Password † | String | N/A | ||
ChangePasswordOnLogin † | Boolean | N/A | ||
Prefix | String | name object, honorificPrefix | ||
FirstName | String | name object, givenName | ||
LastName | String | name object, familyName | ||
String | X | emails object, value | ||
Company | String | N/A | ||
Title | String | title | ||
WorkPhone | String | phoneNumbers object, value field, where type is ‘work’ | ||
HomePhone | String | phoneNumbers object, value field, where type is ‘home’ | ||
MobilePhone | String | phoneNumbers object, value field, where type is ‘mobile’ | ||
WorkFax | String | N/A | ||
HomeFax | String | N/A | ||
Pager | String | N/A | ||
Address1 | String | addresses object, streetAddress | ||
Address2 | String | N/A | ||
Address3 | String | N/A | ||
City | String | addresses object, locality | ||
State | String | addresses object, region | ||
StateCode | String | N/A | ||
PostalCode | String | addresses object, postalCode | ||
Country | String | addresses. object, country | ||
CountryCode | String | N/A | ||
AllEventVisibility | Boolean | N/A | ||
AllSurveyVisibility | Boolean | N/A | ||
AllRFPVisibility | Boolean | N/A | ||
DefaultContactGroupId | GUID | N/A | ||
CreatedDate | DateTime | X | meta object, created | |
CreatedBy | String | X | N/A | |
LastModifiedDate | DateTime | X | meta object, lastModified | |
LastModifiedBy | String | X | N/A | |
CustomFieldDetail | N/A | |||
FieldId | GUID | X | N/A | |
FieldType | String | X | N/A | |
FieldName | String | X | N/A |
Last updated on