HTTP + JSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /Ams/{ClientID}/People HTTP/1.1
Host: ws.yourmembership.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ProfileID: 0,
IsMember: False,
MemberAccountInfo:
{
ImportID: String,
Approved: False,
Suspended: False,
Featured: False,
FeatureText: String,
MasterID: String,
ApprovalDate: 0001-01-01,
LastModifiedDate: 0001-01-01,
QueuedForDelete: False,
QueuedForDeleteDate: 0001-01-01,
MembershipEffectiveExpiresDate: 0001-01-01,
EmailBounced: False,
HasConsented: False,
DateConsented: 0001-01-01,
ConsentIPAddress: String,
HasRevokedConsent: False,
DateConsentRevoked: 0001-01-01,
MasterProfileID: String,
UserName: String,
Password: String,
MembershipID: 0,
MembershipExpires: False,
MembershipExpiresDate: 0001-01-01,
SubordinateSeats: 0,
JobPostings: 0,
MemberPageMax: 0,
ConstituentID: String,
InternalComments: String,
MemberTypeCode: String,
ProfileID: 0,
Registered: 0001-01-01,
CdbGUID: String,
Membership: String,
LastRenewalDate: 0001-01-01,
LastRenewalReminderSent: 0001-01-01,
MemberProfilePublic: False,
PrimaryGroupName: String,
PrimaryGroupID: 0,
PrimaryGroupCode: String,
LastUpdated: 0001-01-01
},
MemberPersonalInfo:
{
HomeAddrLines: String,
Gender: String,
Prefix: String,
FirstName: String,
MiddleName: String,
MiddleInitial: String,
LastName: String,
Suffix: String,
NickName: String,
MaidenName: String,
SpouseName: String,
MaritalStatus: String,
AnniversaryDate: 0001-01-01,
BirthdayDate: 0001-01-01,
HomeUrl: String,
HomeAddressLine1: String,
HomeAddressLine2: String,
HomeAddressCity: String,
HomeAddressLocation: String,
HomeAddressPostalCode: String,
HomeAddressCountry: String,
HomePhoneCountryCode: String,
HomePhoneAreaCode: String,
HomePhoneNumber: String,
HomeFaxNumber: String,
HomeFaxCountryCode: String,
HomeFaxAreaCode: String,
Email: String,
EmailAlt: String,
IMName: String,
IMType: String,
HeadshotImage: String,
HeadshotImageURI: String,
FullName: String
},
MemberProfessionalInfo:
{
EmpAddrLines: String,
EmployerName: String,
SelfEmployed: False,
WorkTitle: String,
WorkType: String,
WorkUrl: String,
WorkAddressLine1: String,
WorkAddressLine2: String,
WorkAddressCity: String,
WorkAddressLocation: String,
WorkAddressPostalCode: String,
WorkAddressCountry: String,
WorkPhoneCountryCode: String,
WorkPhoneNumber: String,
WorkPhoneAreaCode: String,
WorkFaxCountryCode: String,
WorkFaxNumber: String,
WorkFaxAreaCode: String,
CustomFieldValues:
[
{
FieldCode: String,
Fields:
[
{
ClientID: 0,
FieldType: Textbox,
GroupCode: String,
GroupCodeFriendly: String,
Required: False,
Visible: 0,
MemberCanOverride: False,
Editable: 0,
Searchable: False,
Ordinal: 0,
MaxLength: 0,
IsMultiSelect: False,
IsFIB: True,
IsFileUpload: False,
Label: String,
Code: String,
ExportLabel: String,
SearchLabel: String,
SearchInfo: String,
Description: String,
ValidationExpression: String,
MemberTypes:
[
{
MemberTypeID: String
}
],
DonationFunds:
[
{
DonationFundID: String
}
],
MemberTypesProxy:
[
{
MemberTypeID: String
}
],
Values:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
ValuesProxy:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
HelpTopic:
{
ID: 0,
ClientID: 0,
Label: String,
Content: String,
Width: 0,
Height: 0
},
FieldDataType: String
}
],
Visibility: String,
VisibilityInt: 2,
Values:
[
{
Value: String,
Text: String
}
],
ValuesProxy:
[
{
Value: String,
Text: String
}
],
MetaValue:
{
Value: String,
Text: String
},
ClientID: 0
}
]
},
MemberAdditionalInfo:
{
PersonalComments: String,
AdditionalEdu: String,
SocialOrgs: String,
ConnectionStatus: None,
IsAmbassador: False,
GamificationPoints: 0,
PreferredAddressLatitude: 0,
PreferredAddressLongitude: 0
},
MemberReadOnlyProperties:
{
AccessFolder: 0,
AccessGranular: 0,
canMemberMaintainFileLibrary: False,
CanAdminMembers: False,
CanMaintainNetworks: False,
CanMaintainMyNetworks: False,
CanUploadMedia: False,
CanHaveWeblog: False,
CanHavePermEmail: False,
CanHaveBuddyList: False,
CanPostToForum: False,
CanPostGroupNote: False,
CanBulkEmailGroup: False,
CanHaveResume: False,
CanUseMessaging: False,
CanAdminContacts: False,
CanAdminBlogs: False,
CanPostJobOpenings: False,
CanSearchResumes: False,
CanSearchJobs: False,
CanDetachSubAccounts: False,
CanMaintainFileLibrary: False,
CanUploadHeadshot: False,
CanHaveFavorites: False,
CanMaintainWall: False,
CanHaveProfilePages: False,
CanViewMembership: False,
CanHaveSubscriptions: False,
HasAccessToGroups: False,
HasWall: False,
PrimaryAddressType: String,
NameFormatShort: 0,
NameFormatNormal: 0,
NameFormatLong: 0,
NameFormatDirSort: 0,
GameLevel: String,
DaysUntilMembershipExpires: 0,
DaysSinceMembershipExpired: 0,
MembershipEffectiveExpiresDate: 0001-01-01,
MembershipEffectiveExpires: False,
AddressOptionListForPerson: String,
CustomFieldValues:
[
{
FieldCode: String,
Fields:
[
{
ClientID: 0,
FieldType: Textbox,
GroupCode: String,
GroupCodeFriendly: String,
Required: False,
Visible: 0,
MemberCanOverride: False,
Editable: 0,
Searchable: False,
Ordinal: 0,
MaxLength: 0,
IsMultiSelect: False,
IsFIB: True,
IsFileUpload: False,
Label: String,
Code: String,
ExportLabel: String,
SearchLabel: String,
SearchInfo: String,
Description: String,
ValidationExpression: String,
MemberTypes:
[
{
MemberTypeID: String
}
],
DonationFunds:
[
{
DonationFundID: String
}
],
MemberTypesProxy:
[
{
MemberTypeID: String
}
],
Values:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
ValuesProxy:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
HelpTopic:
{
ID: 0,
ClientID: 0,
Label: String,
Content: String,
Width: 0,
Height: 0
},
FieldDataType: String
}
],
Visibility: String,
VisibilityInt: 2,
Values:
[
{
Value: String,
Text: String
}
],
ValuesProxy:
[
{
Value: String,
Text: String
}
],
MetaValue:
{
Value: String,
Text: String
},
ClientID: 0
}
],
SubAccounts: 0,
PendingConnections: 0,
UnreadMessages: 0
},
MemberCustomFieldResponses:
[
{
FieldCode: String,
Fields:
[
{
ClientID: 0,
FieldType: Textbox,
GroupCode: String,
GroupCodeFriendly: String,
Required: False,
Visible: 0,
MemberCanOverride: False,
Editable: 0,
Searchable: False,
Ordinal: 0,
MaxLength: 0,
IsMultiSelect: False,
IsFIB: True,
IsFileUpload: False,
Label: String,
Code: String,
ExportLabel: String,
SearchLabel: String,
SearchInfo: String,
Description: String,
ValidationExpression: String,
MemberTypes:
[
{
MemberTypeID: String
}
],
DonationFunds:
[
{
DonationFundID: String
}
],
MemberTypesProxy:
[
{
MemberTypeID: String
}
],
Values:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
ValuesProxy:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
HelpTopic:
{
ID: 0,
ClientID: 0,
Label: String,
Content: String,
Width: 0,
Height: 0
},
FieldDataType: String
}
],
Visibility: String,
VisibilityInt: 2,
Values:
[
{
Value: String,
Text: String
}
],
ValuesProxy:
[
{
Value: String,
Text: String
}
],
MetaValue:
{
Value: String,
Text: String
},
ClientID: 0
}
],
NonMemberAccountInfo:
{
PrimaryGroupCode: String,
LastUpdated: 0001-01-01,
ImportID: String,
ConstituentID: String,
Membership: String,
MembershipExpires: False,
MembershipExpiresDate: 0001-01-01,
RegData1: String,
RegData2: String,
RegData3: String,
RegData4: String,
RegData5: String,
EmailBounced: False
},
NonMemberPersonalInfo:
{
Email: String,
Prefix: String,
FirstName: String,
MiddleName: String,
LastName: String,
Suffix: String,
NickName: String,
Gender: String,
BirthdayDate: 0001-01-01,
MaritalStatus: String,
MaidenName: String,
SpouseName: String,
AnniversaryDate: 0001-01-01,
HomeUrl: String,
Deceased: False,
Lost: False,
HomeAddressLines: String,
HomeAddressLine1: String,
HomeAddressLine2: String,
HomeAddressCity: String,
HomeAddressLocation: String,
HomeAddressPostalCode: String,
HomeAddressCountry: String,
HomePhoneCountryCode: String,
HomePhoneAreaCode: String,
HomePhoneNumber: String,
HomeFaxCountryCode: String,
HomeFaxAreaCode: String,
HomeFaxNumber: String
},
NonMemberProfessionalInfo:
{
EmployerName: String,
SelfEmployed: False,
WorkTitle: String,
WorkType: String,
WorkUrl: String,
WorkAddressLines: String,
WorkAddressLine1: String,
WorkAddressLine2: String,
WorkAddressCity: String,
WorkAddressLocation: String,
WorkAddressPostalCode: String,
WorkAddressCountry: String,
WorkPhoneCountryCode: String,
WorkPhoneNumber: String,
WorkPhoneAreaCode: String,
WorkFaxCountryCode: String,
WorkFaxNumber: String,
WorkFaxAreaCode: String
},
NonMemberAdditionalInfo:
{
LostMemNotes: String
},
UsingRedis: True,
AppInitTime: 2025-01-22T18:17:17.8967626-05:00,
ServerID: WS-5-72-995,
ClientID: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
BypassCache: False,
DateCached: 2025-01-22T21:08:34.9023891-05:00,
Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ProfileID: 0,
IsMember: False,
MemberAccountInfo:
{
ImportID: String,
Approved: False,
Suspended: False,
Featured: False,
FeatureText: String,
MasterID: String,
ApprovalDate: 0001-01-01,
LastModifiedDate: 0001-01-01,
QueuedForDelete: False,
QueuedForDeleteDate: 0001-01-01,
MembershipEffectiveExpiresDate: 0001-01-01,
EmailBounced: False,
HasConsented: False,
DateConsented: 0001-01-01,
ConsentIPAddress: String,
HasRevokedConsent: False,
DateConsentRevoked: 0001-01-01,
MasterProfileID: String,
UserName: String,
Password: String,
MembershipID: 0,
MembershipExpires: False,
MembershipExpiresDate: 0001-01-01,
SubordinateSeats: 0,
JobPostings: 0,
MemberPageMax: 0,
ConstituentID: String,
InternalComments: String,
MemberTypeCode: String,
ProfileID: 0,
Registered: 0001-01-01,
CdbGUID: String,
Membership: String,
LastRenewalDate: 0001-01-01,
LastRenewalReminderSent: 0001-01-01,
MemberProfilePublic: False,
PrimaryGroupName: String,
PrimaryGroupID: 0,
PrimaryGroupCode: String,
LastUpdated: 0001-01-01
},
MemberPersonalInfo:
{
HomeAddrLines: String,
Gender: String,
Prefix: String,
FirstName: String,
MiddleName: String,
MiddleInitial: String,
LastName: String,
Suffix: String,
NickName: String,
MaidenName: String,
SpouseName: String,
MaritalStatus: String,
AnniversaryDate: 0001-01-01,
BirthdayDate: 0001-01-01,
HomeUrl: String,
HomeAddressLine1: String,
HomeAddressLine2: String,
HomeAddressCity: String,
HomeAddressLocation: String,
HomeAddressPostalCode: String,
HomeAddressCountry: String,
HomePhoneCountryCode: String,
HomePhoneAreaCode: String,
HomePhoneNumber: String,
HomeFaxNumber: String,
HomeFaxCountryCode: String,
HomeFaxAreaCode: String,
Email: String,
EmailAlt: String,
IMName: String,
IMType: String,
HeadshotImage: String,
HeadshotImageURI: String,
FullName: String
},
MemberProfessionalInfo:
{
EmpAddrLines: String,
EmployerName: String,
SelfEmployed: False,
WorkTitle: String,
WorkType: String,
WorkUrl: String,
WorkAddressLine1: String,
WorkAddressLine2: String,
WorkAddressCity: String,
WorkAddressLocation: String,
WorkAddressPostalCode: String,
WorkAddressCountry: String,
WorkPhoneCountryCode: String,
WorkPhoneNumber: String,
WorkPhoneAreaCode: String,
WorkFaxCountryCode: String,
WorkFaxNumber: String,
WorkFaxAreaCode: String,
CustomFieldValues:
[
{
FieldCode: String,
Fields:
[
{
ClientID: 0,
FieldType: Textbox,
GroupCode: String,
GroupCodeFriendly: String,
Required: False,
Visible: 0,
MemberCanOverride: False,
Editable: 0,
Searchable: False,
Ordinal: 0,
MaxLength: 0,
IsMultiSelect: False,
IsFIB: True,
IsFileUpload: False,
Label: String,
Code: String,
ExportLabel: String,
SearchLabel: String,
SearchInfo: String,
Description: String,
ValidationExpression: String,
MemberTypes:
[
{
MemberTypeID: String
}
],
DonationFunds:
[
{
DonationFundID: String
}
],
MemberTypesProxy:
[
{
MemberTypeID: String
}
],
Values:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
ValuesProxy:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
HelpTopic:
{
ID: 0,
ClientID: 0,
Label: String,
Content: String,
Width: 0,
Height: 0
},
FieldDataType: String
}
],
Visibility: String,
VisibilityInt: 2,
Values:
[
{
Value: String,
Text: String
}
],
ValuesProxy:
[
{
Value: String,
Text: String
}
],
MetaValue:
{
Value: String,
Text: String
},
ClientID: 0
}
]
},
MemberAdditionalInfo:
{
PersonalComments: String,
AdditionalEdu: String,
SocialOrgs: String,
ConnectionStatus: None,
IsAmbassador: False,
GamificationPoints: 0,
PreferredAddressLatitude: 0,
PreferredAddressLongitude: 0
},
MemberReadOnlyProperties:
{
AccessFolder: 0,
AccessGranular: 0,
canMemberMaintainFileLibrary: False,
CanAdminMembers: False,
CanMaintainNetworks: False,
CanMaintainMyNetworks: False,
CanUploadMedia: False,
CanHaveWeblog: False,
CanHavePermEmail: False,
CanHaveBuddyList: False,
CanPostToForum: False,
CanPostGroupNote: False,
CanBulkEmailGroup: False,
CanHaveResume: False,
CanUseMessaging: False,
CanAdminContacts: False,
CanAdminBlogs: False,
CanPostJobOpenings: False,
CanSearchResumes: False,
CanSearchJobs: False,
CanDetachSubAccounts: False,
CanMaintainFileLibrary: False,
CanUploadHeadshot: False,
CanHaveFavorites: False,
CanMaintainWall: False,
CanHaveProfilePages: False,
CanViewMembership: False,
CanHaveSubscriptions: False,
HasAccessToGroups: False,
HasWall: False,
PrimaryAddressType: String,
NameFormatShort: 0,
NameFormatNormal: 0,
NameFormatLong: 0,
NameFormatDirSort: 0,
GameLevel: String,
DaysUntilMembershipExpires: 0,
DaysSinceMembershipExpired: 0,
MembershipEffectiveExpiresDate: 0001-01-01,
MembershipEffectiveExpires: False,
AddressOptionListForPerson: String,
CustomFieldValues:
[
{
FieldCode: String,
Fields:
[
{
ClientID: 0,
FieldType: Textbox,
GroupCode: String,
GroupCodeFriendly: String,
Required: False,
Visible: 0,
MemberCanOverride: False,
Editable: 0,
Searchable: False,
Ordinal: 0,
MaxLength: 0,
IsMultiSelect: False,
IsFIB: True,
IsFileUpload: False,
Label: String,
Code: String,
ExportLabel: String,
SearchLabel: String,
SearchInfo: String,
Description: String,
ValidationExpression: String,
MemberTypes:
[
{
MemberTypeID: String
}
],
DonationFunds:
[
{
DonationFundID: String
}
],
MemberTypesProxy:
[
{
MemberTypeID: String
}
],
Values:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
ValuesProxy:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
HelpTopic:
{
ID: 0,
ClientID: 0,
Label: String,
Content: String,
Width: 0,
Height: 0
},
FieldDataType: String
}
],
Visibility: String,
VisibilityInt: 2,
Values:
[
{
Value: String,
Text: String
}
],
ValuesProxy:
[
{
Value: String,
Text: String
}
],
MetaValue:
{
Value: String,
Text: String
},
ClientID: 0
}
],
SubAccounts: 0,
PendingConnections: 0,
UnreadMessages: 0
},
MemberCustomFieldResponses:
[
{
FieldCode: String,
Fields:
[
{
ClientID: 0,
FieldType: Textbox,
GroupCode: String,
GroupCodeFriendly: String,
Required: False,
Visible: 0,
MemberCanOverride: False,
Editable: 0,
Searchable: False,
Ordinal: 0,
MaxLength: 0,
IsMultiSelect: False,
IsFIB: True,
IsFileUpload: False,
Label: String,
Code: String,
ExportLabel: String,
SearchLabel: String,
SearchInfo: String,
Description: String,
ValidationExpression: String,
MemberTypes:
[
{
MemberTypeID: String
}
],
DonationFunds:
[
{
DonationFundID: String
}
],
MemberTypesProxy:
[
{
MemberTypeID: String
}
],
Values:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
ValuesProxy:
[
{
Ordinal: 0,
Text: String,
Value: String
}
],
HelpTopic:
{
ID: 0,
ClientID: 0,
Label: String,
Content: String,
Width: 0,
Height: 0
},
FieldDataType: String
}
],
Visibility: String,
VisibilityInt: 2,
Values:
[
{
Value: String,
Text: String
}
],
ValuesProxy:
[
{
Value: String,
Text: String
}
],
MetaValue:
{
Value: String,
Text: String
},
ClientID: 0
}
],
NonMemberAccountInfo:
{
PrimaryGroupCode: String,
LastUpdated: 0001-01-01,
ImportID: String,
ConstituentID: String,
Membership: String,
MembershipExpires: False,
MembershipExpiresDate: 0001-01-01,
RegData1: String,
RegData2: String,
RegData3: String,
RegData4: String,
RegData5: String,
EmailBounced: False
},
NonMemberPersonalInfo:
{
Email: String,
Prefix: String,
FirstName: String,
MiddleName: String,
LastName: String,
Suffix: String,
NickName: String,
Gender: String,
BirthdayDate: 0001-01-01,
MaritalStatus: String,
MaidenName: String,
SpouseName: String,
AnniversaryDate: 0001-01-01,
HomeUrl: String,
Deceased: False,
Lost: False,
HomeAddressLines: String,
HomeAddressLine1: String,
HomeAddressLine2: String,
HomeAddressCity: String,
HomeAddressLocation: String,
HomeAddressPostalCode: String,
HomeAddressCountry: String,
HomePhoneCountryCode: String,
HomePhoneAreaCode: String,
HomePhoneNumber: String,
HomeFaxCountryCode: String,
HomeFaxAreaCode: String,
HomeFaxNumber: String
},
NonMemberProfessionalInfo:
{
EmployerName: String,
SelfEmployed: False,
WorkTitle: String,
WorkType: String,
WorkUrl: String,
WorkAddressLines: String,
WorkAddressLine1: String,
WorkAddressLine2: String,
WorkAddressCity: String,
WorkAddressLocation: String,
WorkAddressPostalCode: String,
WorkAddressCountry: String,
WorkPhoneCountryCode: String,
WorkPhoneNumber: String,
WorkPhoneAreaCode: String,
WorkFaxCountryCode: String,
WorkFaxNumber: String,
WorkFaxAreaCode: String
},
NonMemberAdditionalInfo:
{
LostMemNotes: String
},
UsingRedis: True,
AppInitTime: 2025-01-22T18:17:17.8967626-05:00,
ServerID: WS-5-72-995,
ClientID: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
BypassCache: False,
DateCached: 2025-01-22T21:08:34.9210822-05:00,
Device: Desktop
}