GET api/Accounts?domainName={domainName}
Retrieve Account by domain name.
Possible Service Responses:
200/OK - match found and account record is in the body of the response.
404/Account Not Found - no match found for the specified account id.
500/Internal Server - unexpected server error, details in the body of the response.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| domainName |
Domain Name |
System.String |
Required |
Body Parameters
None.
Response Information
Resource Description
Account
Altai.Web.Services.Models.Account| Name | Description | Type | Additional information |
|---|---|---|---|
| MemberId | System.String |
None. |
|
| Id | System.String |
None. |
|
| NumberOfEmployees | System.Int32 |
None. |
|
| Name | System.String |
None. |
|
| Website | System.String |
None. |
|
| PrimaryContact | Altai.Web.Services.Models.Contact |
None. |
|
| Participations | System.Collections.Generic.IEnumerable`1[Altai.Web.Services.Models.Participation] |
None. |
|
| MembershipEndDate | System.String |
None. |
|
| AddressLine1 | System.String |
None. |
|
| AddressLine2 | System.String |
None. |
|
| AddressLine3 | System.String |
None. |
|
| BusinessCounty | System.String |
None. |
|
| Municipality | System.String |
None. |
|
| City | System.String |
None. |
|
| CityLookup | Altai.Web.Services.Models.City |
None. |
|
| State | System.String |
None. |
|
| StateLU | Microsoft.Xrm.Sdk.EntityReference |
None. |
|
| Country | System.String |
None. |
|
| CountryInfo | Altai.Web.Services.Models.Country |
None. |
|
| Zip | System.String |
None. |
|
| Telephone1 | System.String |
None. |
|
| StatusCode | System.String |
None. |
|
| QAProgramNumber | System.String |
None. |
|
| ExcludeFromHL | System.Boolean |
None. |
|
| ExcludeFromHLDirectory | System.Boolean |
None. |
|
| Base64Image | System.String |
None. |
Response Formats
application/json, text/json
Sample:
{
"MemberId": "sample string 1",
"Id": "sample string 2",
"NumberOfEmployees": 3,
"Name": "sample string 4",
"Website": "sample string 5",
"PrimaryContact": {
"WebCompanyName": "sample string 1",
"AddressLine3": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine1": "sample string 4",
"City": "sample string 5",
"Country": "sample string 6",
"CountryInfo": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
"DietaryRestriction": "sample string 7",
"Email": "sample string 8",
"EmergencyContactName": "sample string 9",
"EmergencyContactPhone": "sample string 10",
"EmploymentStatus": "sample string 11",
"District": {
"Id": "5dde76b8-3ec8-40bb-aa6c-3c4331e6fcbf",
"LogicalName": "sample string 2",
"Name": "sample string 3",
"KeyAttributes": [],
"RowVersion": "sample string 4"
},
"FirstName": "sample string 12",
"FullName": "sample string 13",
"Gender": "sample string 14",
"GraduateSchool": "sample string 15",
"GraduationYear": "sample string 16",
"Industry": "sample string 17",
"Id": "sample string 18",
"JobTitle": "sample string 19",
"Telephone1": "sample string 20",
"LastName": "sample string 21",
"MemberId": "sample string 22",
"OwnerAssociate": "sample string 23",
"Password": "sample string 24",
"PortalId": "sample string 25",
"CanRegisterOthers": true,
"ExcludeFromHL": true,
"ExcludeFromHLDirectory": true,
"PracticeType1": "sample string 29",
"School": "sample string 30",
"SpecialtyBoardsDiplomatsText": "sample string 31",
"State": "sample string 32",
"StateDetails": {
"Id": "98faf806-23b7-4cf0-a346-1a7eb98a987f",
"Code": "sample string 2",
"Name": "sample string 3",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
},
"PostalCode": "sample string 33",
"UniversityAlumni": "sample string 34",
"LicenseNumber": "sample string 35",
"Username": "sample string 36",
"Base64Image": "sample string 37",
"SelectedPosition": {
"Id": "5dde76b8-3ec8-40bb-aa6c-3c4331e6fcbf",
"LogicalName": "sample string 2",
"Name": "sample string 3",
"KeyAttributes": [],
"RowVersion": "sample string 4"
},
"Participations": [
{
"Id": "sample string 1",
"CycleStartDate": "sample string 2",
"CycleEndDate": "sample string 3",
"StartDate": "sample string 4",
"EndDate": "sample string 5",
"PaidThruDate": "sample string 6",
"BillThruDate": "sample string 7",
"Status": "sample string 8",
"Program": {
"Id": "sample string 1",
"Name": "sample string 2",
"ShortName": "sample string 3",
"Type": "sample string 4",
"ProgramGroup": "sample string 5",
"BillingTermLength": 6,
"ActivePriceListId": "sample string 7",
"BachelorsDegreeMonthsRequired": 8,
"DoctorateDegreeMonthsRequired": 9,
"HighSchoolMonthsRequired": 10,
"MastersDegreeMonthsRequired": 11
},
"CurrentInvoice": {
"ShoppingCartId": "sample string 1",
"BalanceDue": 2.0,
"TotalAmount": 3.0,
"Number": "sample string 4",
"Id": "sample string 5",
"Date": "sample string 6",
"StatusReason": 7,
"BillToAddress": {
"Name": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"EmailAddress": "sample string 4",
"Telephone": "sample string 5",
"Address": {
"Id": "sample string 1",
"Street1": "sample string 2",
"Street2": "sample string 3",
"City": "sample string 4",
"PostalCode": "sample string 5",
"StateOrProvince": {
"Id": "98faf806-23b7-4cf0-a346-1a7eb98a987f",
"Code": "sample string 2",
"Name": "sample string 3",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
},
"StateOrProvinceString": "sample string 6",
"NormilizedStateOrProvince": "sample string 6",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
"AddressType": "sample string 7"
}
},
"ShipToAddress": {
"Name": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"EmailAddress": "sample string 4",
"Telephone": "sample string 5",
"Address": {
"Id": "sample string 1",
"Street1": "sample string 2",
"Street2": "sample string 3",
"City": "sample string 4",
"PostalCode": "sample string 5",
"StateOrProvince": {
"Id": "98faf806-23b7-4cf0-a346-1a7eb98a987f",
"Code": "sample string 2",
"Name": "sample string 3",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
},
"StateOrProvinceString": "sample string 6",
"NormilizedStateOrProvince": "sample string 6",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
"AddressType": "sample string 7"
}
}
},
"ParticipationType": "sample string 9",
"WebProductNextCategoryId": "sample string 10",
"WebCategoryFilterId": "sample string 11",
"AvailableForRenewal": true,
"International": true
},
{
"Id": "sample string 1",
"CycleStartDate": "sample string 2",
"CycleEndDate": "sample string 3",
"StartDate": "sample string 4",
"EndDate": "sample string 5",
"PaidThruDate": "sample string 6",
"BillThruDate": "sample string 7",
"Status": "sample string 8",
"Program": {
"Id": "sample string 1",
"Name": "sample string 2",
"ShortName": "sample string 3",
"Type": "sample string 4",
"ProgramGroup": "sample string 5",
"BillingTermLength": 6,
"ActivePriceListId": "sample string 7",
"BachelorsDegreeMonthsRequired": 8,
"DoctorateDegreeMonthsRequired": 9,
"HighSchoolMonthsRequired": 10,
"MastersDegreeMonthsRequired": 11
},
"CurrentInvoice": {
"ShoppingCartId": "sample string 1",
"BalanceDue": 2.0,
"TotalAmount": 3.0,
"Number": "sample string 4",
"Id": "sample string 5",
"Date": "sample string 6",
"StatusReason": 7,
"BillToAddress": {
"Name": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"EmailAddress": "sample string 4",
"Telephone": "sample string 5",
"Address": {
"Id": "sample string 1",
"Street1": "sample string 2",
"Street2": "sample string 3",
"City": "sample string 4",
"PostalCode": "sample string 5",
"StateOrProvince": {
"Id": "98faf806-23b7-4cf0-a346-1a7eb98a987f",
"Code": "sample string 2",
"Name": "sample string 3",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
},
"StateOrProvinceString": "sample string 6",
"NormilizedStateOrProvince": "sample string 6",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
"AddressType": "sample string 7"
}
},
"ShipToAddress": {
"Name": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"EmailAddress": "sample string 4",
"Telephone": "sample string 5",
"Address": {
"Id": "sample string 1",
"Street1": "sample string 2",
"Street2": "sample string 3",
"City": "sample string 4",
"PostalCode": "sample string 5",
"StateOrProvince": {
"Id": "98faf806-23b7-4cf0-a346-1a7eb98a987f",
"Code": "sample string 2",
"Name": "sample string 3",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
},
"StateOrProvinceString": "sample string 6",
"NormilizedStateOrProvince": "sample string 6",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
"AddressType": "sample string 7"
}
}
},
"ParticipationType": "sample string 9",
"WebProductNextCategoryId": "sample string 10",
"WebCategoryFilterId": "sample string 11",
"AvailableForRenewal": true,
"International": true
}
],
"ContactRoles": [
{
"IsWebAdmin": true,
"CanRegisterOthers": true,
"AdHocRoleName": "sample string 3"
},
{
"IsWebAdmin": true,
"CanRegisterOthers": true,
"AdHocRoleName": "sample string 3"
}
],
"Positions": [
{
"Name": "sample string 1",
"Id": "sample string 2",
"ContactId": "sample string 3",
"AccountId": "sample string 4",
"PositionTitleId": "sample string 5",
"PositionTitle": "sample string 6",
"Program": {
"Id": "sample string 1",
"Name": "sample string 2",
"ShortName": "sample string 3",
"Type": "sample string 4",
"ProgramGroup": "sample string 5",
"BillingTermLength": 6,
"ActivePriceListId": "sample string 7",
"BachelorsDegreeMonthsRequired": 8,
"DoctorateDegreeMonthsRequired": 9,
"HighSchoolMonthsRequired": 10,
"MastersDegreeMonthsRequired": 11
},
"PortalAdminType": "sample string 7",
"StartDate": "sample string 8",
"EndDate": "sample string 9"
},
{
"Name": "sample string 1",
"Id": "sample string 2",
"ContactId": "sample string 3",
"AccountId": "sample string 4",
"PositionTitleId": "sample string 5",
"PositionTitle": "sample string 6",
"Program": {
"Id": "sample string 1",
"Name": "sample string 2",
"ShortName": "sample string 3",
"Type": "sample string 4",
"ProgramGroup": "sample string 5",
"BillingTermLength": 6,
"ActivePriceListId": "sample string 7",
"BachelorsDegreeMonthsRequired": 8,
"DoctorateDegreeMonthsRequired": 9,
"HighSchoolMonthsRequired": 10,
"MastersDegreeMonthsRequired": 11
},
"PortalAdminType": "sample string 7",
"StartDate": "sample string 8",
"EndDate": "sample string 9"
}
],
"PriceLevelId": "6ce46539-62e1-47c4-abc7-c04e064c5eb7",
"PriceListName": "sample string 38",
"IsSiteAdmin": true,
"ShipToAddressLine2": "sample string 40",
"ShipToEmail": "sample string 41",
"ShipToTelephone1": "sample string 42",
"ShipToState": "sample string 43",
"ShipToCity": "sample string 44",
"ShipToAddressLine1": "sample string 45",
"ShipToPostalCode": "sample string 46",
"ShipToLastName": "sample string 47",
"ShipToCountry": "sample string 48",
"ShipToFirstName": "sample string 49",
"EligibleToApply": {
"aPHR": "2025-04-04T08:45:45.5160136-04:00",
"aPHRi": "2025-04-04T08:45:45.5160136-04:00",
"GPHR": "2025-04-04T08:45:45.5160136-04:00",
"PHR": "2025-04-04T08:45:45.5160136-04:00",
"PHRca": "2025-04-04T08:45:45.5160136-04:00",
"PHRi": "2025-04-04T08:45:45.5160136-04:00",
"SPHR": "2025-04-04T08:45:45.5160136-04:00",
"SPHRi": "2025-04-04T08:45:45.5160136-04:00"
},
"Embargo": true,
"EmbargoOverride": true,
"Preferences": {
"Phone": true,
"Mail": true,
"MarketingEmails": true,
"SmsMessaging": true,
"HrciNews": true,
"HrciAlert": true
},
"IndDesignation": "sample string 52",
"Education": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
"Participations": [
{
"Id": "sample string 1",
"CycleStartDate": "sample string 2",
"CycleEndDate": "sample string 3",
"StartDate": "sample string 4",
"EndDate": "sample string 5",
"PaidThruDate": "sample string 6",
"BillThruDate": "sample string 7",
"Status": "sample string 8",
"Program": {
"Id": "sample string 1",
"Name": "sample string 2",
"ShortName": "sample string 3",
"Type": "sample string 4",
"ProgramGroup": "sample string 5",
"BillingTermLength": 6,
"ActivePriceListId": "sample string 7",
"BachelorsDegreeMonthsRequired": 8,
"DoctorateDegreeMonthsRequired": 9,
"HighSchoolMonthsRequired": 10,
"MastersDegreeMonthsRequired": 11
},
"CurrentInvoice": {
"ShoppingCartId": "sample string 1",
"BalanceDue": 2.0,
"TotalAmount": 3.0,
"Number": "sample string 4",
"Id": "sample string 5",
"Date": "sample string 6",
"StatusReason": 7,
"BillToAddress": {
"Name": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"EmailAddress": "sample string 4",
"Telephone": "sample string 5",
"Address": {
"Id": "sample string 1",
"Street1": "sample string 2",
"Street2": "sample string 3",
"City": "sample string 4",
"PostalCode": "sample string 5",
"StateOrProvince": {
"Id": "98faf806-23b7-4cf0-a346-1a7eb98a987f",
"Code": "sample string 2",
"Name": "sample string 3",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
},
"StateOrProvinceString": "sample string 6",
"NormilizedStateOrProvince": "sample string 6",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
"AddressType": "sample string 7"
}
},
"ShipToAddress": {
"Name": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"EmailAddress": "sample string 4",
"Telephone": "sample string 5",
"Address": {
"Id": "sample string 1",
"Street1": "sample string 2",
"Street2": "sample string 3",
"City": "sample string 4",
"PostalCode": "sample string 5",
"StateOrProvince": {
"Id": "98faf806-23b7-4cf0-a346-1a7eb98a987f",
"Code": "sample string 2",
"Name": "sample string 3",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
},
"StateOrProvinceString": "sample string 6",
"NormilizedStateOrProvince": "sample string 6",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
"AddressType": "sample string 7"
}
}
},
"ParticipationType": "sample string 9",
"WebProductNextCategoryId": "sample string 10",
"WebCategoryFilterId": "sample string 11",
"AvailableForRenewal": true,
"International": true
},
{
"Id": "sample string 1",
"CycleStartDate": "sample string 2",
"CycleEndDate": "sample string 3",
"StartDate": "sample string 4",
"EndDate": "sample string 5",
"PaidThruDate": "sample string 6",
"BillThruDate": "sample string 7",
"Status": "sample string 8",
"Program": {
"Id": "sample string 1",
"Name": "sample string 2",
"ShortName": "sample string 3",
"Type": "sample string 4",
"ProgramGroup": "sample string 5",
"BillingTermLength": 6,
"ActivePriceListId": "sample string 7",
"BachelorsDegreeMonthsRequired": 8,
"DoctorateDegreeMonthsRequired": 9,
"HighSchoolMonthsRequired": 10,
"MastersDegreeMonthsRequired": 11
},
"CurrentInvoice": {
"ShoppingCartId": "sample string 1",
"BalanceDue": 2.0,
"TotalAmount": 3.0,
"Number": "sample string 4",
"Id": "sample string 5",
"Date": "sample string 6",
"StatusReason": 7,
"BillToAddress": {
"Name": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"EmailAddress": "sample string 4",
"Telephone": "sample string 5",
"Address": {
"Id": "sample string 1",
"Street1": "sample string 2",
"Street2": "sample string 3",
"City": "sample string 4",
"PostalCode": "sample string 5",
"StateOrProvince": {
"Id": "98faf806-23b7-4cf0-a346-1a7eb98a987f",
"Code": "sample string 2",
"Name": "sample string 3",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
},
"StateOrProvinceString": "sample string 6",
"NormilizedStateOrProvince": "sample string 6",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
"AddressType": "sample string 7"
}
},
"ShipToAddress": {
"Name": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"EmailAddress": "sample string 4",
"Telephone": "sample string 5",
"Address": {
"Id": "sample string 1",
"Street1": "sample string 2",
"Street2": "sample string 3",
"City": "sample string 4",
"PostalCode": "sample string 5",
"StateOrProvince": {
"Id": "98faf806-23b7-4cf0-a346-1a7eb98a987f",
"Code": "sample string 2",
"Name": "sample string 3",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
},
"StateOrProvinceString": "sample string 6",
"NormilizedStateOrProvince": "sample string 6",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
"AddressType": "sample string 7"
}
}
},
"ParticipationType": "sample string 9",
"WebProductNextCategoryId": "sample string 10",
"WebCategoryFilterId": "sample string 11",
"AvailableForRenewal": true,
"International": true
}
],
"MembershipEndDate": "sample string 6",
"AddressLine1": "sample string 7",
"AddressLine2": "sample string 8",
"AddressLine3": "sample string 9",
"BusinessCounty": "sample string 10",
"Municipality": "sample string 11",
"City": "sample string 12",
"CityLookup": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"State": "sample string 13",
"StateLU": {
"Id": "5dde76b8-3ec8-40bb-aa6c-3c4331e6fcbf",
"LogicalName": "sample string 2",
"Name": "sample string 3",
"KeyAttributes": [],
"RowVersion": "sample string 4"
},
"Country": "sample string 14",
"CountryInfo": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
"Zip": "sample string 15",
"Telephone1": "sample string 16",
"StatusCode": "sample string 17",
"QAProgramNumber": "sample string 18",
"ExcludeFromHL": true,
"ExcludeFromHLDirectory": true,
"Base64Image": "sample string 21"
}
application/xml
Sample:
text/xml
Sample: