POST api/institutes?childObjects={childObjects}
Search institutes
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| childObjects |
Child object collections to return |
string |
None. |
Body Parameters
InstituteCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| SiteIds | Collection of string |
None. |
|
| PassId | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"siteIds": [
"sample string 1",
"sample string 2"
],
"passId": "sample string 1"
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Promega Site from default model store instance
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
{
"siteId": "sample string 1",
"pppCode": "sample string 2",
"partnershipId": "sample string 3",
"partnership": {
"name": "sample string 1",
"company": "sample string 2",
"soldToId": "sample string 3",
"salesOrganizationId": "sample string 4",
"type": 0,
"approvalMethod": "sample string 5",
"allowCreditCard": true,
"imageFileName": "sample string 7",
"paymentEntryType": "sample string 8",
"requirePassAddress": true,
"defaultBillingAddress": {
"sapCustomerNumber": "sample string 1",
"soldTo": {
"companyName": "sample string 1",
"soldToId": "sample string 2",
"salesOrganizationId": "sample string 3",
"partnershipId": "sample string 4",
"customerGroup2": "sample string 5",
"id": "sample string 6",
"description": "sample string 7",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"soldToId": "sample string 2",
"salesOrganizationId": "sample string 3",
"addressType": 0,
"partnerFunction": "sample string 4",
"isLinked": true,
"addressLine1": "sample string 6",
"addressLine2": "sample string 7",
"city": "sample string 8",
"regionCode": "sample string 9",
"postalCode": "sample string 10",
"countryCode": "sample string 11",
"department": "sample string 12",
"companyName": "sample string 13",
"buildingAndRoom": "sample string 14",
"name": "sample string 15",
"smtpAddress": "sample string 16",
"dateCreated": "2026-04-22T14:49:35.1079049+00:00",
"dateLastChanged": "2026-04-22T14:49:35.1079049+00:00",
"createdBy": "sample string 19",
"changedBy": "sample string 20",
"id": "sample string 21",
"description": "sample string 22",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"defaultBillingAddressId": "sample string 10",
"defaultCreditCard": {
"sapCustomerNumber": "sample string 1",
"sapCustomerType": 0,
"paymetricToken": "sample string 2",
"lastFourDigits": "sample string 3",
"nameOnCard": "sample string 4",
"creditCardType": 0,
"authorizationDate": "2026-04-22T14:49:35.1079049+00:00",
"expirationMonth": "sample string 6",
"expirationYear": "sample string 7",
"internalReferenceNumber": "sample string 8",
"dateCreated": "2026-04-22T14:49:35.1079049+00:00",
"dateLastChanged": "2026-04-22T14:49:35.1079049+00:00",
"createdBy": "sample string 11",
"changedBy": "sample string 12",
"id": "sample string 13",
"description": "sample string 14",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"defaultPurchaseOrder": {
"purchaseOrderNumber": "sample string 1",
"sapCustomerNumber": "sample string 2",
"sapCustomerType": 0,
"expirationMonth": "sample string 3",
"expirationYear": "sample string 4",
"internalReferenceNumber": "sample string 5",
"dateCreated": "2026-04-22T14:49:35.1079049+00:00",
"dateLastChanged": "2026-04-22T14:49:35.1079049+00:00",
"createdBy": "sample string 8",
"changedBy": "sample string 9",
"id": "sample string 10",
"description": "sample string 11",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"billingAddresses": [
{
"sapCustomerNumber": "sample string 1",
"soldTo": {
"companyName": "sample string 1",
"soldToId": "sample string 2",
"salesOrganizationId": "sample string 3",
"partnershipId": "sample string 4",
"customerGroup2": "sample string 5",
"id": "sample string 6",
"description": "sample string 7",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"soldToId": "sample string 2",
"salesOrganizationId": "sample string 3",
"addressType": 0,
"partnerFunction": "sample string 4",
"isLinked": true,
"addressLine1": "sample string 6",
"addressLine2": "sample string 7",
"city": "sample string 8",
"regionCode": "sample string 9",
"postalCode": "sample string 10",
"countryCode": "sample string 11",
"department": "sample string 12",
"companyName": "sample string 13",
"buildingAndRoom": "sample string 14",
"name": "sample string 15",
"smtpAddress": "sample string 16",
"dateCreated": "2026-04-22T14:49:35.1079049+00:00",
"dateLastChanged": "2026-04-22T14:49:35.1079049+00:00",
"createdBy": "sample string 19",
"changedBy": "sample string 20",
"id": "sample string 21",
"description": "sample string 22",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
{
"sapCustomerNumber": "sample string 1",
"soldTo": {
"companyName": "sample string 1",
"soldToId": "sample string 2",
"salesOrganizationId": "sample string 3",
"partnershipId": "sample string 4",
"customerGroup2": "sample string 5",
"id": "sample string 6",
"description": "sample string 7",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"soldToId": "sample string 2",
"salesOrganizationId": "sample string 3",
"addressType": 0,
"partnerFunction": "sample string 4",
"isLinked": true,
"addressLine1": "sample string 6",
"addressLine2": "sample string 7",
"city": "sample string 8",
"regionCode": "sample string 9",
"postalCode": "sample string 10",
"countryCode": "sample string 11",
"department": "sample string 12",
"companyName": "sample string 13",
"buildingAndRoom": "sample string 14",
"name": "sample string 15",
"smtpAddress": "sample string 16",
"dateCreated": "2026-04-22T14:49:35.1079049+00:00",
"dateLastChanged": "2026-04-22T14:49:35.1079049+00:00",
"createdBy": "sample string 19",
"changedBy": "sample string 20",
"id": "sample string 21",
"description": "sample string 22",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
}
],
"creditCards": [
{
"sapCustomerNumber": "sample string 1",
"sapCustomerType": 0,
"paymetricToken": "sample string 2",
"lastFourDigits": "sample string 3",
"nameOnCard": "sample string 4",
"creditCardType": 0,
"authorizationDate": "2026-04-22T14:49:35.1079049+00:00",
"expirationMonth": "sample string 6",
"expirationYear": "sample string 7",
"internalReferenceNumber": "sample string 8",
"dateCreated": "2026-04-22T14:49:35.1079049+00:00",
"dateLastChanged": "2026-04-22T14:49:35.1079049+00:00",
"createdBy": "sample string 11",
"changedBy": "sample string 12",
"id": "sample string 13",
"description": "sample string 14",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
{
"sapCustomerNumber": "sample string 1",
"sapCustomerType": 0,
"paymetricToken": "sample string 2",
"lastFourDigits": "sample string 3",
"nameOnCard": "sample string 4",
"creditCardType": 0,
"authorizationDate": "2026-04-22T14:49:35.1079049+00:00",
"expirationMonth": "sample string 6",
"expirationYear": "sample string 7",
"internalReferenceNumber": "sample string 8",
"dateCreated": "2026-04-22T14:49:35.1079049+00:00",
"dateLastChanged": "2026-04-22T14:49:35.1079049+00:00",
"createdBy": "sample string 11",
"changedBy": "sample string 12",
"id": "sample string 13",
"description": "sample string 14",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
}
],
"purchaseOrders": [
{
"purchaseOrderNumber": "sample string 1",
"sapCustomerNumber": "sample string 2",
"sapCustomerType": 0,
"expirationMonth": "sample string 3",
"expirationYear": "sample string 4",
"internalReferenceNumber": "sample string 5",
"dateCreated": "2026-04-22T14:49:35.1079049+00:00",
"dateLastChanged": "2026-04-22T14:49:35.1079049+00:00",
"createdBy": "sample string 8",
"changedBy": "sample string 9",
"id": "sample string 10",
"description": "sample string 11",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
{
"purchaseOrderNumber": "sample string 1",
"sapCustomerNumber": "sample string 2",
"sapCustomerType": 0,
"expirationMonth": "sample string 3",
"expirationYear": "sample string 4",
"internalReferenceNumber": "sample string 5",
"dateCreated": "2026-04-22T14:49:35.1079049+00:00",
"dateLastChanged": "2026-04-22T14:49:35.1079049+00:00",
"createdBy": "sample string 8",
"changedBy": "sample string 9",
"id": "sample string 10",
"description": "sample string 11",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
}
],
"institutes": [],
"defaultPaymentId": "sample string 11",
"defaultPaymentType": 0,
"initialOrderConfirmationNotificationList": {
"sendToManager": 0,
"sendToHelixTeam": 0,
"sendToPassholder": 0,
"sendToOther1": [
"sample string 1",
"sample string 2"
],
"sendToOther2": [
"sample string 1",
"sample string 2"
],
"sendToOther3": [
"sample string 1",
"sample string 2"
],
"sendToOther4": [
"sample string 1",
"sample string 2"
],
"id": "sample string 1",
"description": "sample string 2",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"finalOrderConfirmationNotificationList": {
"sendToManager": 0,
"sendToHelixTeam": 0,
"sendToPassholder": 0,
"sendToOther1": [
"sample string 1",
"sample string 2"
],
"sendToOther2": [
"sample string 1",
"sample string 2"
],
"sendToOther3": [
"sample string 1",
"sample string 2"
],
"sendToOther4": [
"sample string 1",
"sample string 2"
],
"id": "sample string 1",
"description": "sample string 2",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"orderRejectionNotificationList": {
"sendToManager": 0,
"sendToHelixTeam": 0,
"sendToPassholder": 0,
"sendToOther1": [
"sample string 1",
"sample string 2"
],
"sendToOther2": [
"sample string 1",
"sample string 2"
],
"sendToOther3": [
"sample string 1",
"sample string 2"
],
"sendToOther4": [
"sample string 1",
"sample string 2"
],
"id": "sample string 1",
"description": "sample string 2",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"dateCreated": "2026-04-22T14:49:35.1079049+00:00",
"dateLastChanged": "2026-04-22T14:49:35.1079049+00:00",
"createdBy": "sample string 14",
"changedBy": "sample string 15",
"id": "sample string 16",
"description": "sample string 17",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"instituteCustomerPriceDisplayMode": 0,
"initialOrderConfirmationNotificationList": {
"sendToManager": 0,
"sendToHelixTeam": 0,
"sendToPassholder": 0,
"sendToOther1": [
"sample string 1",
"sample string 2"
],
"sendToOther2": [
"sample string 1",
"sample string 2"
],
"sendToOther3": [
"sample string 1",
"sample string 2"
],
"sendToOther4": [
"sample string 1",
"sample string 2"
],
"id": "sample string 1",
"description": "sample string 2",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"finalOrderConfirmationNotificationList": {
"sendToManager": 0,
"sendToHelixTeam": 0,
"sendToPassholder": 0,
"sendToOther1": [
"sample string 1",
"sample string 2"
],
"sendToOther2": [
"sample string 1",
"sample string 2"
],
"sendToOther3": [
"sample string 1",
"sample string 2"
],
"sendToOther4": [
"sample string 1",
"sample string 2"
],
"id": "sample string 1",
"description": "sample string 2",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"orderRejectionNotificationList": {
"sendToManager": 0,
"sendToHelixTeam": 0,
"sendToPassholder": 0,
"sendToOther1": [
"sample string 1",
"sample string 2"
],
"sendToOther2": [
"sample string 1",
"sample string 2"
],
"sendToOther3": [
"sample string 1",
"sample string 2"
],
"sendToOther4": [
"sample string 1",
"sample string 2"
],
"id": "sample string 1",
"description": "sample string 2",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
},
"customerCommunicationSendToInstituteManager": 0,
"dateCreated": "2026-04-22T14:49:35.1079049+00:00",
"dateLastChanged": "2026-04-22T14:49:35.1079049+00:00",
"createdBy": "sample string 6",
"changedBy": "sample string 7",
"id": "sample string 8",
"description": "sample string 9",
"returnMessages": [
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
},
{
"resultCode": 0,
"id": "sample string 1",
"number": "sample string 2",
"message": "sample string 3",
"message1": "sample string 4",
"message2": "sample string 5",
"message3": "sample string 6",
"message4": "sample string 7"
}
]
}