POST BusinessPartner/GetBusinessPartnerDetails_3

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
name	string	None.
pointOfSale	globally unique identifier	None.
stateCode	string	None.
city	string	None.
postalCode	string	None.
country	string	None.

Request Formats

application/json, text/json

Sample:

{
  "name": "sample string 1",
  "pointOfSale": "9ccc6863-ad4b-423a-aa71-b87713b1a8e7",
  "stateCode": "sample string 3",
  "city": "sample string 4",
  "postalCode": "sample string 5",
  "country": "sample string 6"
}

application/xml, text/xml

Sample:

<BusinessPartnerController.GetBusinessPartnerDetails_3Input xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pioneer.Trials.Domain.TrialsAPIServices.Controllers">
  <city>sample string 4</city>
  <country>sample string 6</country>
  <name>sample string 1</name>
  <pointOfSale>9ccc6863-ad4b-423a-aa71-b87713b1a8e7</pointOfSale>
  <postalCode>sample string 5</postalCode>
  <stateCode>sample string 3</stateCode>
</BusinessPartnerController.GetBusinessPartnerDetails_3Input>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of PartnerDetail

Name	Type	Additional information
un	Collection of UserCompanyBrand	None.
i	boolean	None.
p	globally unique identifier	None.
r	integer	None.
n	string	None.
a	globally unique identifier	None.
m	string	None.
f	integer	None.
c	string	None.
t	string	None.
d	string	None.
u	string	None.
o	string	None.
e	string	None.
h	Collection of PartnerRoleShipTo	None.
l	Collection of PartnerRoleCompliance	None.
b	Collection of PartnerRoleTrait	None.
g	Collection of integer	None.
j	Collection of Territory	None.
k	Collection of District	None.
q	globally unique identifier	None.
w	integer	None.
x	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "un": [
      {
        "$id": "2",
        "CompanyCode": "sample string 1",
        "UserName": "sample string 2",
        "CountryCode": "sample string 3",
        "BrandId": 4.0,
        "Region": "sample string 5",
        "ChangeTracker": {
          "$id": "3",
          "State": 2,
          "ObjectsRemovedFromCollectionProperties": {},
          "OriginalValues": {},
          "ExtendedProperties": {},
          "ObjectsAddedToCollectionProperties": {}
        }
      },
      {
        "$ref": "2"
      }
    ],
    "i": true,
    "p": "999a0142-1575-403b-a897-d5226c341fce",
    "r": 3,
    "n": "sample string 4",
    "a": "dc88efab-4507-435a-8e38-3162a4723109",
    "m": "sample string 6",
    "f": 1,
    "c": "sample string 7",
    "t": "sample string 8",
    "d": "sample string 9",
    "u": "sample string 10",
    "o": "sample string 11",
    "e": "sample string 12",
    "h": [
      {
        "$id": "4",
        "ShipToId": "6b265c41-cb02-41c6-b871-814a7fbee0ba",
        "PartnerRoleId": "8a432f44-8db8-4b7b-92eb-46b80a74a169",
        "Name": "sample string 3",
        "Type": "sample string 4",
        "LastMaintenanceName": "sample string 5",
        "LastMaintenanceDate": "2024-09-11T19:46:36.125039+00:00",
        "FISId": 1,
        "TerritoryCode": "sample string 7",
        "InEffDate": "2024-09-11T19:46:36.1406615+00:00",
        "ChangeTracker": {
          "$ref": "3"
        }
      },
      {
        "$ref": "4"
      }
    ],
    "l": [
      {
        "$id": "5",
        "PartnerRoleId": "66f7358e-8203-4d7e-82d5-465b2d47f27c",
        "Documentid": 2,
        "Needed": true,
        "DocumentSignatureReasonId": 1,
        "ChangeTracker": {
          "$ref": "3"
        }
      },
      {
        "$ref": "5"
      }
    ],
    "b": [
      {
        "$id": "6",
        "PartnerRoleId": "94ef67bb-dced-4de1-b26c-8fbb2ebadc6f",
        "Value": "sample string 2",
        "TraitId": 3,
        "PartnerRoleTraitId": "37d14ac2-78f3-4728-82db-4cd0da3a56af",
        "AddedOn": "2024-09-11T19:46:36.1587506+00:00",
        "SalesYear": 1,
        "ChangeTracker": {
          "$ref": "3"
        }
      },
      {
        "$ref": "6"
      }
    ],
    "g": [
      1,
      2
    ],
    "j": [
      {
        "$id": "7",
        "TerritoryCode": "sample string 1",
        "Name": "sample string 2",
        "AreaCode": "sample string 3",
        "BusinessUnitCode": "sample string 1",
        "LastMaintenanceName": "sample string 5",
        "LastMaintenanceDate": "2024-09-11T19:46:36.1719136+00:00",
        "Region": "sample string 7",
        "ManagerName": "sample string 8",
        "DistrictCode": "sample string 9",
        "CountryCode": "sample string 10",
        "CompanyCode": "sample string 11",
        "BusinessUnit": {
          "$id": "8",
          "BusinessUnitCode": "sample string 1",
          "Name": "sample string 2",
          "LastMaintenanceName": "sample string 3",
          "LastMaintenanceDate": "2024-09-11T19:46:36.1719136+00:00",
          "LegalEntityId": 1.0,
          "SortOrder": 1,
          "CompanyCode": "sample string 5",
          "CountryCode": "sample string 6",
          "Area": [],
          "ExperimentBusinessUnitArea": [],
          "SeedRequest": [],
          "Territory": [
            {
              "$ref": "7"
            }
          ],
          "ChangeTracker": {
            "$id": "9",
            "State": 2,
            "ObjectsRemovedFromCollectionProperties": {},
            "OriginalValues": {},
            "ExtendedProperties": {},
            "ObjectsAddedToCollectionProperties": {
              "Territory": [
                {
                  "$ref": "7"
                }
              ]
            }
          }
        },
        "ChangeTracker": {
          "$ref": "3"
        }
      },
      {
        "$ref": "7"
      }
    ],
    "k": [
      {
        "$id": "10",
        "DistrictCode": "sample string 1",
        "Name": "sample string 2",
        "AreaCode": "sample string 3",
        "BusinessUnitCode": "sample string 4",
        "LastMaintenanceName": "sample string 5",
        "LastMaintenanceDate": "2024-09-11T19:46:36.187535+00:00",
        "Region": "sample string 7",
        "ManagerName": "sample string 8",
        "CompanyCode": "sample string 9",
        "ChangeTracker": {
          "$ref": "3"
        }
      },
      {
        "$ref": "10"
      }
    ],
    "q": "64ee8ad8-ff0a-457b-87a4-3564d970265b",
    "w": 1,
    "x": true
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPartnerDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pioneer.Trials.Domain.Model">
  <PartnerDetail z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
    <a>dc88efab-4507-435a-8e38-3162a4723109</a>
    <b>
      <PartnerRoleTrait z:Id="i2">
        <AddedOn>2024-09-11T19:46:36.1587506+00:00</AddedOn>
        <ChangeTracker z:Id="i3">
          <ExtendedProperties />
          <ObjectsAddedToCollectionProperties />
          <ObjectsRemovedFromCollectionProperties />
          <OriginalValues />
          <State>Added</State>
        </ChangeTracker>
        <PartnerRoleId>94ef67bb-dced-4de1-b26c-8fbb2ebadc6f</PartnerRoleId>
        <PartnerRoleTraitId>37d14ac2-78f3-4728-82db-4cd0da3a56af</PartnerRoleTraitId>
        <SalesYear>1</SalesYear>
        <TraitId>3</TraitId>
        <Value>sample string 2</Value>
      </PartnerRoleTrait>
      <PartnerRoleTrait z:Ref="i2" />
    </b>
    <c>sample string 7</c>
    <d>sample string 9</d>
    <e>sample string 12</e>
    <f>1</f>
    <g xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </g>
    <h>
      <PartnerRoleShipTo z:Id="i4">
        <ChangeTracker z:Ref="i3" />
        <FISId>1</FISId>
        <InEffDate>2024-09-11T19:46:36.1406615+00:00</InEffDate>
        <LastMaintenanceDate>2024-09-11T19:46:36.125039+00:00</LastMaintenanceDate>
        <LastMaintenanceName>sample string 5</LastMaintenanceName>
        <Name>sample string 3</Name>
        <PartnerRoleId>8a432f44-8db8-4b7b-92eb-46b80a74a169</PartnerRoleId>
        <ShipToId>6b265c41-cb02-41c6-b871-814a7fbee0ba</ShipToId>
        <TerritoryCode>sample string 7</TerritoryCode>
        <Type>sample string 4</Type>
      </PartnerRoleShipTo>
      <PartnerRoleShipTo z:Ref="i4" />
    </h>
    <i>true</i>
    <j>
      <Territory z:Id="i5">
        <Area i:nil="true" />
        <AreaCode>sample string 3</AreaCode>
        <BusinessUnit z:Id="i6">
          <Area />
          <BusinessUnitCode>sample string 1</BusinessUnitCode>
          <ChangeTracker z:Id="i7">
            <ExtendedProperties />
            <ObjectsAddedToCollectionProperties>
              <AddedObjectsForProperty>
                <CollectionPropertyName>Territory</CollectionPropertyName>
                <AddedObjects>
                  <ObjectValue z:Ref="i5" />
                </AddedObjects>
              </AddedObjectsForProperty>
            </ObjectsAddedToCollectionProperties>
            <ObjectsRemovedFromCollectionProperties />
            <OriginalValues />
            <State>Added</State>
          </ChangeTracker>
          <CompanyCode>sample string 5</CompanyCode>
          <CountryCode>sample string 6</CountryCode>
          <ExperimentBusinessUnitArea />
          <LastMaintenanceDate>2024-09-11T19:46:36.1719136+00:00</LastMaintenanceDate>
          <LastMaintenanceName>sample string 3</LastMaintenanceName>
          <LegalEntityId>1</LegalEntityId>
          <Name>sample string 2</Name>
          <SeedRequest />
          <SortOrder>1</SortOrder>
          <Territory>
            <Territory z:Ref="i5" />
          </Territory>
        </BusinessUnit>
        <BusinessUnitCode>sample string 1</BusinessUnitCode>
        <ChangeTracker z:Ref="i3" />
        <CompanyCode>sample string 11</CompanyCode>
        <CountryCode>sample string 10</CountryCode>
        <DistrictCode>sample string 9</DistrictCode>
        <LastMaintenanceDate>2024-09-11T19:46:36.1719136+00:00</LastMaintenanceDate>
        <LastMaintenanceName>sample string 5</LastMaintenanceName>
        <ManagerName>sample string 8</ManagerName>
        <Name>sample string 2</Name>
        <Region>sample string 7</Region>
        <TerritoryCode>sample string 1</TerritoryCode>
      </Territory>
      <Territory z:Ref="i5" />
    </j>
    <k>
      <District z:Id="i8">
        <AreaCode>sample string 3</AreaCode>
        <BusinessUnitCode>sample string 4</BusinessUnitCode>
        <ChangeTracker z:Ref="i3" />
        <CompanyCode>sample string 9</CompanyCode>
        <DistrictCode>sample string 1</DistrictCode>
        <LastMaintenanceDate>2024-09-11T19:46:36.187535+00:00</LastMaintenanceDate>
        <LastMaintenanceName>sample string 5</LastMaintenanceName>
        <ManagerName>sample string 8</ManagerName>
        <Name>sample string 2</Name>
        <Region>sample string 7</Region>
      </District>
      <District z:Ref="i8" />
    </k>
    <l>
      <PartnerRoleCompliance z:Id="i9">
        <ChangeTracker z:Ref="i3" />
        <DocumentSignatureReasonId>1</DocumentSignatureReasonId>
        <Documentid>2</Documentid>
        <Needed>true</Needed>
        <PartnerRoleId>66f7358e-8203-4d7e-82d5-465b2d47f27c</PartnerRoleId>
      </PartnerRoleCompliance>
      <PartnerRoleCompliance z:Ref="i9" />
    </l>
    <m>sample string 6</m>
    <n>sample string 4</n>
    <o>sample string 11</o>
    <p>999a0142-1575-403b-a897-d5226c341fce</p>
    <q>64ee8ad8-ff0a-457b-87a4-3564d970265b</q>
    <r>3</r>
    <t>sample string 8</t>
    <u>sample string 10</u>
    <un>
      <UserCompanyBrand z:Id="i10">
        <BrandId>4</BrandId>
        <ChangeTracker z:Ref="i3" />
        <CompanyCode>sample string 1</CompanyCode>
        <CountryCode>sample string 3</CountryCode>
        <Region>sample string 5</Region>
        <UserName>sample string 2</UserName>
      </UserCompanyBrand>
      <UserCompanyBrand z:Ref="i10" />
    </un>
    <w>1</w>
    <x>true</x>
  </PartnerDetail>
  <PartnerDetail z:Ref="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />
</ArrayOfPartnerDetail>