| POST | /membership/{SubscriptionId}/{CendynPropertyId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProfileContainer | body | ProfileContainer | No | |
| SubscriptionId | path | string | No | |
| CendynPropertyId | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EchoToken | form | string | No | |
| ChangeAction | form | string | No | |
| Profiles | form | List<Profile> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CendynPropertyID | form | string | No | |
| PropertyName | form | string | No | |
| UniqueIDs | form | List<UniqueIDType> | No | |
| ProfileTypeCode | form | string | No | |
| ProfileTypeDescription | form | string | No | |
| NameCode | form | string | No | |
| ProfileTypeCategory | form | string | No | |
| JobTitle | form | string | No | |
| Salutation | form | string | No | |
| FirstName | form | string | No | |
| FamiliarName | form | string | No | |
| MiddleName | form | string | No | |
| LastName | form | string | No | |
| FullName | form | string | No | |
| NameSuffix | form | string | No | |
| VIPID | form | string | No | |
| VIPCode | form | string | No | |
| PrimaryLanguage | form | string | No | |
| GenderCode | form | string | No | |
| DOBYear | form | string | No | |
| DOBMonth | form | string | No | |
| DOBDayOfMonth | form | string | No | |
| CompanyName | form | string | No | |
| ARNumber | form | string | No | |
| AllowMail | form | bool? | No | |
| AllowEMail | form | bool? | No | |
| GuestPriv | form | bool? | No | |
| AllowPhone | form | bool? | No | |
| AllowSMS | form | bool? | No | |
| AllowHistory | form | bool? | No | |
| AllowMarketResearch | form | bool? | No | |
| AllowThirdParty | form | bool? | No | |
| AllowLoyaltyProgram | form | bool? | No | |
| CreatorCode | form | string | No | |
| LastUpdaterCode | form | string | No | |
| DateProfileCreated | form | DateTime? | No | |
| DateProfileUpdated | form | DateTime? | No | |
| InactiveDate | form | DateTime? | No | |
| Nationality | form | string | No | |
| ResortCode | form | string | No | |
| RetiredProfileId | form | string | No | |
| TransferredSubscriptionId | form | string | No | |
| SourceName | form | string | No | |
| SourceID | form | string | No | |
| OptOutMarketing | form | bool? | No | |
| OptOutDate | form | DateTime? | No | |
| ProfileExtension | form | ProfileExtension | No | |
| Addresses | form | List<Address> | No | |
| Memberships | form | List<Membership> | No | |
| ContactMethods | form | List<ContactMethod> | No | |
| ActionComments | form | List<ActionComment> | No | |
| SpecialRequests | form | List<SpecialRequest> | No | |
| UDFDataCollection | form | List<UDFDataType> | No | |
| Lead | form | Lead | No | |
| RelatedTravelers | form | List<RelatedTraveler> | No | |
| Documents | form | List<Document> | No | |
| Vouchers | form | List<Voucher> | No | |
| ProfilePolicies | form | List<ProfilePolicy> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | string | No | |
| Type | form | string | No | |
| Context | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LanguageCode | form | string | No | |
| SalutationExt | form | string | No | |
| FirstNameExt | form | string | No | |
| FamiliarNameExt | form | string | No | |
| MiddleNameExt | form | string | No | |
| LastNameExt | form | string | No | |
| NameSuffixExt | form | string | No | |
| CompanyNameExt | form | string | No | |
| Blacklist | form | string | No | |
| BlackListMessage | form | string | No | |
| AnonymizationStatus | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AddressTypeCode | form | string | No | |
| AddressTypeDescription | form | string | No | |
| AddressStatus | form | string | No | |
| Attn | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| StateProvince | form | string | No | |
| PostalCode | form | string | No | |
| CountryCode | form | string | No | |
| IsPrimary | form | bool? | No | |
| AddressLanguage | form | string | No | |
| AddressCleansed | form | bool? | No | |
| OptOutMarketing | form | bool? | No | |
| OptOutDate | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExternalID | form | string | No | |
| ProgramCode | form | string | No | |
| MembershipID | form | string | No | |
| MembershipCategory | form | string | No | |
| MembershipName | form | string | No | |
| MembershipLevel | form | string | No | |
| MembershipStatus | form | string | No | |
| EnrollmentCode | form | string | No | |
| DateMembershipStarts | form | DateTime? | No | |
| DateMembershipExpires | form | DateTime? | No | |
| TotalStays | form | int? | No | |
| AwardCredits | form | int? | No | |
| AwardAvailable | form | int? | No | |
| PrimaryAirline | form | bool? | No | |
| DisplaySequence | form | int? | No | |
| SourceName | form | string | No | |
| SourceID | form | string | No | |
| IsActive | form | bool | No | |
| InactiveDate | form | DateTime? | No | |
| PointsIndicator | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No | |
| Category | form | string | No | |
| DataValue | form | string | No | |
| ExtraData | form | string | No | |
| OptOut | form | bool? | No | |
| SourceDate | form | DateTime? | No | |
| IsPrimary | form | bool? | No | |
| Confirmation | form | bool? | No | |
| InactiveDate | form | DateTime? | No | |
| OptOutMarketing | form | bool? | No | |
| OptOutDate | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExternalID | form | string | No | |
| CommentType | form | string | No | |
| CommentTitle | form | string | No | |
| CommentClass | form | string | No | |
| ActionType | form | string | No | |
| Comment | form | string | No | |
| ActionDate | form | DateTime? | No | |
| InactiveDate | form | DateTime? | No | |
| GuestViewable | form | bool? | No | |
| CreatorCode | form | string | No | |
| DateCommentCreated | form | DateTime? | No | |
| ResortCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExternalID | form | string | No | |
| RequestType | form | string | No | |
| RequestCode | form | string | No | |
| RequestComments | form | string | No | |
| ResortField | form | string | No | |
| ActionTypeCode | form | string | No | |
| ActionType | form | string | No | |
| InactiveDate | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CendynPropertyID | form | string | No | |
| ModuleName | form | string | No | |
| TableName | form | string | No | |
| ColumnName | form | string | No | |
| UDFValue | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FK_Reservation | form | Guid? | No | |
| ExternalLeadID | form | string | No | |
| ExternalLeadSource | form | string | No | |
| LeadStatus | form | string | No | |
| LeadAcquired | form | DateTime? | No | |
| TentativeStartDate | form | DateTime? | No | |
| TentativeEndDate | form | DateTime? | No | |
| AssignedAgent | form | string | No | |
| AssignedDate | form | DateTime? | No | |
| ContactMethod | form | string | No | |
| ContactAgent | form | string | No | |
| ContactDate | form | DateTime? | No | |
| LastFollowupMethod | form | string | No | |
| LastFollowupAgent | form | string | No | |
| LastFollowupDate | form | DateTime? | No | |
| BookingMethod | form | string | No | |
| BookingAgent | form | string | No | |
| BookingDate | form | DateTime? | No | |
| ReasonforStay | form | string | No | |
| MarketCode | form | string | No | |
| CampaignCode | form | string | No | |
| CampaignName | form | string | No | |
| PriceEstimate | form | decimal? | No | |
| FlaggedForAttention | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CendynPropertyID | form | string | No | |
| PropertyName | form | string | No | |
| UniqueIDs | form | List<UniqueIDType> | No | |
| Salutation | form | string | No | |
| FirstName | form | string | No | |
| FamiliarName | form | string | No | |
| MiddleName | form | string | No | |
| LastName | form | string | No | |
| FullName | form | string | No | |
| Suffix | form | string | No | |
| Relation | form | string | No | |
| IsPrimary | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentID | form | string | No | |
| DocumentType | form | string | No | |
| DocumentSource | form | string | No | |
| CodeOnDocument | form | string | No | |
| DocumentNotes | form | string | No | |
| NameOnDocument | form | string | No | |
| NationalityOnDocument | form | string | No | |
| EffectiveDate | form | DateTime? | No | |
| ExpirationDate | form | DateTime? | No | |
| Issuer | form | string | No | |
| IssuerCountry | form | string | No | |
| IsPrimary | form | bool? | No | |
| PII_StoredAs | form | string | No | |
| InactiveDate | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HotelCode | form | string | No | |
| VoucherID | form | string | No | |
| VoucherID2 | form | string | No | |
| AppliedToResort | form | string | No | |
| ReservationID | form | string | No | |
| ProfileIDRecipient | form | string | No | |
| SubscriberIDRecipient | form | string | No | |
| RecipientName | form | string | No | |
| Emailaddress | form | string | No | |
| ProfileIDPurchaser | form | string | No | |
| PurchaserName | form | string | No | |
| VoucherStatus | form | string | No | |
| VoucherType | form | string | No | |
| MembershipType | form | string | No | |
| CertCode | form | string | No | |
| CertNo | form | string | No | |
| ShortDescription | form | string | No | |
| GiftMessage | form | string | No | |
| Comments | form | string | No | |
| VoucherAmount | form | decimal? | No | |
| CurrencyCode | form | string | No | |
| IssueType | form | string | No | |
| DateConsumed | form | DateTime? | No | |
| ExpirationDate | form | DateTime? | No | |
| AwardPoints | form | int? | No | |
| RuleType | form | string | No | |
| RuleValue | form | string | No | |
| CancelAllowed | form | bool? | No | |
| MaxExtensions | form | int? | No | |
| ReferenceType | form | string | No | |
| ReferenceID | form | string | No | |
| PromotionCode | form | string | No | |
| ReservationConsumed | form | bool? | No | |
| WebConsumed | form | bool? | No | |
| PMSConsumed | form | bool? | No | |
| VerifyCertNo | form | bool? | No | |
| GenerateInLieu | form | bool? | No | |
| CreatorCode | form | string | No | |
| LastUpdaterCode | form | string | No | |
| FolioID | form | string | No | |
| InactiveDate | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PolicyType | form | string | No | |
| AttributeName | form | string | No | |
| IntegerValue | form | int? | No | |
| StringValue | form | string | No | |
| EffectiveDate | form | DateTime? | No | |
| ExpirationDate | form | DateTime? | No | |
| Comments | form | string | No | |
| ExternalID | form | string | No | |
| AppliesTo | form | string | No | |
| AppliesToDescriptor | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | form | string | No | |
| RecordCount | form | int | No | |
| ErrorCount | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /membership/{SubscriptionId}/{CendynPropertyId} HTTP/1.1
Host: cert.cendyn.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"profileContainer":{"echoToken":"String","changeAction":"String","profiles":[{"cendynPropertyID":"String","propertyName":"String","uniqueIDs":[{"id":"String","type":"String","context":"String"}],"profileTypeCode":"String","profileTypeDescription":"String","nameCode":"String","profileTypeCategory":"String","jobTitle":"String","salutation":"String","firstName":"String","familiarName":"String","middleName":"String","lastName":"String","fullName":"String","nameSuffix":"String","vipid":"String","vipCode":"String","primaryLanguage":"String","genderCode":"String","dobYear":"String","dobMonth":"String","dobDayOfMonth":"String","companyName":"String","arNumber":"String","allowMail":false,"allowEMail":false,"guestPriv":false,"allowPhone":false,"allowSMS":false,"allowHistory":false,"allowMarketResearch":false,"allowThirdParty":false,"allowLoyaltyProgram":false,"creatorCode":"String","lastUpdaterCode":"String","dateProfileCreated":"0001-01-01T00:00:00.0000000","dateProfileUpdated":"0001-01-01T00:00:00.0000000","inactiveDate":"0001-01-01T00:00:00.0000000","nationality":"String","resortCode":"String","retiredProfileId":"String","transferredSubscriptionId":"String","sourceName":"String","sourceID":"String","optOutMarketing":false,"optOutDate":"0001-01-01T00:00:00.0000000","profileExtension":{"languageCode":"String","salutationExt":"String","firstNameExt":"String","familiarNameExt":"String","middleNameExt":"String","lastNameExt":"String","nameSuffixExt":"String","companyNameExt":"String","blacklist":"String","blackListMessage":"String","anonymizationStatus":"String"},"addresses":[{"addressTypeCode":"String","addressTypeDescription":"String","addressStatus":"String","attn":"String","address1":"String","address2":"String","city":"String","stateProvince":"String","postalCode":"String","countryCode":"String","isPrimary":false,"addressLanguage":"String","addressCleansed":false,"optOutMarketing":false,"optOutDate":"0001-01-01T00:00:00.0000000"}],"memberships":[{"externalID":"String","programCode":"String","membershipID":"String","membershipCategory":"String","membershipName":"String","membershipLevel":"String","membershipStatus":"String","enrollmentCode":"String","dateMembershipStarts":"0001-01-01T00:00:00.0000000","dateMembershipExpires":"0001-01-01T00:00:00.0000000","totalStays":0,"awardCredits":0,"awardAvailable":0,"primaryAirline":false,"displaySequence":0,"sourceName":"String","sourceID":"String","isActive":false,"inactiveDate":"0001-01-01T00:00:00.0000000","pointsIndicator":false}],"contactMethods":[{"type":"String","category":"String","dataValue":"String","extraData":"String","optOut":false,"sourceDate":"0001-01-01T00:00:00.0000000","isPrimary":false,"confirmation":false,"inactiveDate":"0001-01-01T00:00:00.0000000","optOutMarketing":false,"optOutDate":"0001-01-01T00:00:00.0000000"}],"actionComments":[{"externalID":"String","commentType":"String","commentTitle":"String","commentClass":"String","actionType":"String","comment":"String","actionDate":"0001-01-01T00:00:00.0000000","inactiveDate":"0001-01-01T00:00:00.0000000","guestViewable":false,"creatorCode":"String","dateCommentCreated":"0001-01-01T00:00:00.0000000","resortCode":"String"}],"specialRequests":[{"externalID":"String","requestType":"String","requestCode":"String","requestComments":"String","resortField":"String","actionTypeCode":"String","actionType":"String","inactiveDate":"0001-01-01T00:00:00.0000000"}],"udfDataCollection":[{"cendynPropertyID":"String","moduleName":"String","tableName":"String","columnName":"String","udfValue":"String"}],"lead":{"fK_Reservation":"00000000000000000000000000000000","externalLeadID":"String","externalLeadSource":"String","leadStatus":"String","leadAcquired":"0001-01-01T00:00:00.0000000","tentativeStartDate":"0001-01-01T00:00:00.0000000","tentativeEndDate":"0001-01-01T00:00:00.0000000","assignedAgent":"String","assignedDate":"0001-01-01T00:00:00.0000000","contactMethod":"String","contactAgent":"String","contactDate":"0001-01-01T00:00:00.0000000","lastFollowupMethod":"String","lastFollowupAgent":"String","lastFollowupDate":"0001-01-01T00:00:00.0000000","bookingMethod":"String","bookingAgent":"String","bookingDate":"0001-01-01T00:00:00.0000000","reasonforStay":"String","marketCode":"String","campaignCode":"String","campaignName":"String","priceEstimate":0,"flaggedForAttention":false},"relatedTravelers":[{"cendynPropertyID":"String","propertyName":"String","uniqueIDs":[{"id":"String","type":"String","context":"String"}],"salutation":"String","firstName":"String","familiarName":"String","middleName":"String","lastName":"String","fullName":"String","suffix":"String","relation":"String","isPrimary":false}],"documents":[{"documentID":"String","documentType":"String","documentSource":"String","codeOnDocument":"String","documentNotes":"String","nameOnDocument":"String","nationalityOnDocument":"String","effectiveDate":"0001-01-01T00:00:00.0000000","expirationDate":"0001-01-01T00:00:00.0000000","issuer":"String","issuerCountry":"String","isPrimary":false,"piI_StoredAs":"String","inactiveDate":"0001-01-01T00:00:00.0000000"}],"vouchers":[{"hotelCode":"String","voucherID":"String","voucherID2":"String","appliedToResort":"String","reservationID":"String","profileIDRecipient":"String","subscriberIDRecipient":"String","recipientName":"String","emailaddress":"String","profileIDPurchaser":"String","purchaserName":"String","voucherStatus":"String","voucherType":"String","membershipType":"String","certCode":"String","certNo":"String","shortDescription":"String","giftMessage":"String","comments":"String","voucherAmount":0,"currencyCode":"String","issueType":"String","dateConsumed":"0001-01-01T00:00:00.0000000","expirationDate":"0001-01-01T00:00:00.0000000","awardPoints":0,"ruleType":"String","ruleValue":"String","cancelAllowed":false,"maxExtensions":0,"referenceType":"String","referenceID":"String","promotionCode":"String","reservationConsumed":false,"webConsumed":false,"pmsConsumed":false,"verifyCertNo":false,"generateInLieu":false,"creatorCode":"String","lastUpdaterCode":"String","folioID":"String","inactiveDate":"0001-01-01T00:00:00.0000000"}],"profilePolicies":[{"policyType":"String","attributeName":"String","integerValue":0,"stringValue":"String","effectiveDate":"0001-01-01T00:00:00.0000000","expirationDate":"0001-01-01T00:00:00.0000000","comments":"String","externalID":"String","appliesTo":"String","appliesToDescriptor":"String"}]}]},"subscriptionId":"String","cendynPropertyId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"statusCode":"String","recordCount":0,"errorCount":0}