GET EnterpriseParticipant?itaidentifier={itaidentifier}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
itaidentifier

string

Required

Body Parameters

None.

Response Information

Resource Description

ParticipantHalRepresentation
NameDescriptionTypeAdditional information
Participant

Participant

None.

Platform

string

None.

Program

string

None.

ProgramFriendlyName

string

None.

EnterpriseServicesIdentifier

string

None.

IdentityMapped

boolean

None.

MappedToMasterPlatform

boolean

None.

MasterPlatform

string

None.

SupportingPlatform

string

None.

MasterPlatformName

string

None.

SupportingPlatformName

string

None.

Links

Collection of Link

None.

Response Formats

application/json, text/json

Sample:
{
  "Participant": {
    "EntityHierarchy": {
      "$id": "2"
    },
    "ProviderPlatform": "sample string 1",
    "ProviderPlatformDetail": [
      {
        "$id": "3",
        "ProviderPlatform": "sample string 1",
        "Primary": true
      },
      {
        "$ref": "3"
      }
    ],
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "BusinessName": "sample string 4",
    "City": "sample string 5",
    "Region": "sample string 6",
    "PostalCode": "sample string 7",
    "Phone": "sample string 8",
    "CountryCode": "sample string 9",
    "Email": "sample string 10",
    "AccountNumber": "sample string 11",
    "Active": true,
    "PSuiteAttribute": "sample string 13",
    "ParticipantIdentifier": "sample string 14",
    "SystemParticipantIdentifier": "sample string 15",
    "ITAIdentifier": "sample string 16",
    "CatalogIdent": "sample string 17"
  },
  "Platform": "sample string 1",
  "Program": "sample string 2",
  "ProgramFriendlyName": "sample string 3",
  "EnterpriseServicesIdentifier": "sample string 4",
  "IdentityMapped": true,
  "MappedToMasterPlatform": true,
  "MasterPlatform": "sample string 7",
  "SupportingPlatform": "sample string 8",
  "MasterPlatformName": "sample string 9",
  "SupportingPlatformName": "sample string 10",
  "_links": [
    {
      "$id": "4",
      "Curie": null,
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "Type": "sample string 4",
      "Deprecation": "sample string 5",
      "Name": "sample string 6",
      "Profile": "sample string 7",
      "HrefLang": "sample string 8",
      "IsTemplated": false
    },
    {
      "$ref": "4"
    }
  ],
  "_embedded": null
}

application/xml, text/xml

Sample:
<ParticipantHalRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.EnterpriseServices.Domain.Hal.Participant">
  <Href xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">~/enterpriseparticipant?itaidentifier=sample%20string%204</Href>
  <LinkName xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 11</LinkName>
  <Links xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">
    <Link>
      <Deprecation>sample string 5</Deprecation>
      <Href>sample string 2</Href>
      <HrefLang>sample string 8</HrefLang>
      <Name>sample string 6</Name>
      <Profile>sample string 7</Profile>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
      <Type>sample string 4</Type>
    </Link>
    <Link>
      <Deprecation>sample string 5</Deprecation>
      <Href>sample string 2</Href>
      <HrefLang>sample string 8</HrefLang>
      <Name>sample string 6</Name>
      <Profile>sample string 7</Profile>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
      <Type>sample string 4</Type>
    </Link>
  </Links>
  <Rel xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">participants</Rel>
  <EnterpriseServicesIdentifier>sample string 4</EnterpriseServicesIdentifier>
  <IdentityMapped>true</IdentityMapped>
  <MappedToMasterPlatform>true</MappedToMasterPlatform>
  <MasterPlatform>sample string 7</MasterPlatform>
  <MasterPlatformName>sample string 9</MasterPlatformName>
  <Participant xmlns:d2p1="http://schemas.datacontract.org/2004/07/ITAGroup.EnterpriseServices.Domain.Model">
    <d2p1:AccountNumber>sample string 11</d2p1:AccountNumber>
    <d2p1:Active>true</d2p1:Active>
    <d2p1:BusinessName>sample string 4</d2p1:BusinessName>
    <d2p1:CatalogIdent>sample string 17</d2p1:CatalogIdent>
    <d2p1:City>sample string 5</d2p1:City>
    <d2p1:CountryCode>sample string 9</d2p1:CountryCode>
    <d2p1:Email>sample string 10</d2p1:Email>
    <d2p1:EntityHierarchy xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:ITAIdentifier>sample string 16</d2p1:ITAIdentifier>
    <d2p1:LastName>sample string 3</d2p1:LastName>
    <d2p1:OrderHistory>
      <d2p1:EntityHierarchy xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
      <d2p1:Orders xmlns:d4p1="http://schemas.datacontract.org/2004/07/ITAGroup.EnterpriseServices.Domain.Model.Entities.Order">
        <d4p1:OrderHistory>
          <d4p1:Address1>sample string 14</d4p1:Address1>
          <d4p1:Address2>sample string 15</d4p1:Address2>
          <d4p1:AwardsValue>sample string 8</d4p1:AwardsValue>
          <d4p1:BOLDate>sample string 20</d4p1:BOLDate>
          <d4p1:BusinessName>sample string 13</d4p1:BusinessName>
          <d4p1:Carrier>sample string 10</d4p1:Carrier>
          <d4p1:City>sample string 16</d4p1:City>
          <d4p1:Description>sample string 5</d4p1:Description>
          <d4p1:EmailAddress>sample string 19</d4p1:EmailAddress>
          <d4p1:FirstName>sample string 11</d4p1:FirstName>
          <d4p1:Home>sample string 22</d4p1:Home>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:ItemCost>sample string 7</d4p1:ItemCost>
          <d4p1:LastName>sample string 12</d4p1:LastName>
          <d4p1:Mobile>sample string 24</d4p1:Mobile>
          <d4p1:ModelNumber>sample string 21</d4p1:ModelNumber>
          <d4p1:OrderDate>sample string 2</d4p1:OrderDate>
          <d4p1:OrderNumber>sample string 3</d4p1:OrderNumber>
          <d4p1:PONumber>sample string 4</d4p1:PONumber>
          <d4p1:ProgramNumber>sample string 25</d4p1:ProgramNumber>
          <d4p1:Qty>sample string 6</d4p1:Qty>
          <d4p1:Region>sample string 17</d4p1:Region>
          <d4p1:ShipStatus>sample string 9</d4p1:ShipStatus>
          <d4p1:TrackingUrlRepresentation>
            <d4p1:Href>sample string 2</d4p1:Href>
            <d4p1:Value>sample string 1</d4p1:Value>
          </d4p1:TrackingUrlRepresentation>
          <d4p1:Work>sample string 23</d4p1:Work>
          <d4p1:Zip>sample string 18</d4p1:Zip>
        </d4p1:OrderHistory>
        <d4p1:OrderHistory>
          <d4p1:Address1>sample string 14</d4p1:Address1>
          <d4p1:Address2>sample string 15</d4p1:Address2>
          <d4p1:AwardsValue>sample string 8</d4p1:AwardsValue>
          <d4p1:BOLDate>sample string 20</d4p1:BOLDate>
          <d4p1:BusinessName>sample string 13</d4p1:BusinessName>
          <d4p1:Carrier>sample string 10</d4p1:Carrier>
          <d4p1:City>sample string 16</d4p1:City>
          <d4p1:Description>sample string 5</d4p1:Description>
          <d4p1:EmailAddress>sample string 19</d4p1:EmailAddress>
          <d4p1:FirstName>sample string 11</d4p1:FirstName>
          <d4p1:Home>sample string 22</d4p1:Home>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:ItemCost>sample string 7</d4p1:ItemCost>
          <d4p1:LastName>sample string 12</d4p1:LastName>
          <d4p1:Mobile>sample string 24</d4p1:Mobile>
          <d4p1:ModelNumber>sample string 21</d4p1:ModelNumber>
          <d4p1:OrderDate>sample string 2</d4p1:OrderDate>
          <d4p1:OrderNumber>sample string 3</d4p1:OrderNumber>
          <d4p1:PONumber>sample string 4</d4p1:PONumber>
          <d4p1:ProgramNumber>sample string 25</d4p1:ProgramNumber>
          <d4p1:Qty>sample string 6</d4p1:Qty>
          <d4p1:Region>sample string 17</d4p1:Region>
          <d4p1:ShipStatus>sample string 9</d4p1:ShipStatus>
          <d4p1:TrackingUrlRepresentation>
            <d4p1:Href>sample string 2</d4p1:Href>
            <d4p1:Value>sample string 1</d4p1:Value>
          </d4p1:TrackingUrlRepresentation>
          <d4p1:Work>sample string 23</d4p1:Work>
          <d4p1:Zip>sample string 18</d4p1:Zip>
        </d4p1:OrderHistory>
      </d2p1:Orders>
    </d2p1:OrderHistory>
    <d2p1:PSuiteAttribute>sample string 13</d2p1:PSuiteAttribute>
    <d2p1:ParticipantIdentifier>sample string 14</d2p1:ParticipantIdentifier>
    <d2p1:Phone>sample string 8</d2p1:Phone>
    <d2p1:PostalCode>sample string 7</d2p1:PostalCode>
    <d2p1:ProgramInformation>
      <d2p1:Program>sample string 1</d2p1:Program>
      <d2p1:ProgramName>sample string 2</d2p1:ProgramName>
    </d2p1:ProgramInformation>
    <d2p1:ProviderPlatform>sample string 1</d2p1:ProviderPlatform>
    <d2p1:ProviderPlatformDetail>
      <d2p1:ProviderPlatformDetail>
        <d2p1:Primary>true</d2p1:Primary>
        <d2p1:ProviderPlatform>sample string 1</d2p1:ProviderPlatform>
      </d2p1:ProviderPlatformDetail>
      <d2p1:ProviderPlatformDetail>
        <d2p1:Primary>true</d2p1:Primary>
        <d2p1:ProviderPlatform>sample string 1</d2p1:ProviderPlatform>
      </d2p1:ProviderPlatformDetail>
    </d2p1:ProviderPlatformDetail>
    <d2p1:Region>sample string 6</d2p1:Region>
    <d2p1:SystemParticipantIdentifier>sample string 15</d2p1:SystemParticipantIdentifier>
  </Participant>
  <Platform>sample string 1</Platform>
  <Program>sample string 2</Program>
  <ProgramFriendlyName>sample string 3</ProgramFriendlyName>
  <SupportingPlatform>sample string 8</SupportingPlatform>
  <SupportingPlatformName>sample string 10</SupportingPlatformName>
</ParticipantHalRepresentation>

application/hal+json, application/hal+json.vnd.es.basic

Sample:
{
  "Participant": {
    "EntityHierarchy": {
      "$id": "2"
    },
    "ProviderPlatform": "sample string 1",
    "ProviderPlatformDetail": [
      {
        "$id": "3",
        "ProviderPlatform": "sample string 1",
        "Primary": true
      },
      {
        "$ref": "3"
      }
    ],
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "BusinessName": "sample string 4",
    "City": "sample string 5",
    "Region": "sample string 6",
    "PostalCode": "sample string 7",
    "Phone": "sample string 8",
    "CountryCode": "sample string 9",
    "Email": "sample string 10",
    "AccountNumber": "sample string 11",
    "Active": true,
    "PSuiteAttribute": "sample string 13",
    "ParticipantIdentifier": "sample string 14",
    "SystemParticipantIdentifier": "sample string 15",
    "ITAIdentifier": "sample string 16",
    "CatalogIdent": "sample string 17"
  },
  "Platform": "sample string 1",
  "Program": "sample string 2",
  "ProgramFriendlyName": "sample string 3",
  "EnterpriseServicesIdentifier": "sample string 4",
  "IdentityMapped": true,
  "MappedToMasterPlatform": true,
  "MasterPlatform": "sample string 7",
  "SupportingPlatform": "sample string 8",
  "MasterPlatformName": "sample string 9",
  "SupportingPlatformName": "sample string 10",
  "_links": {
    "self": {
      "href": "/enterpriseparticipant?itaidentifier=sample%20string%204"
    },
    "sample string 1": {
      "href": "sample string 2",
      "title": "sample string 3",
      "type": "sample string 4",
      "deprecation": "sample string 5",
      "name": "sample string 6",
      "profile": "sample string 7",
      "hreflang": "sample string 8"
    }
  }
}

application/hal+xml

Sample:
<resource rel="participants" href="~/enterpriseparticipant?itaidentifier=sample%20string%204" name="sample string 11">
  <link rel="sample string 1" href="sample string 2" />
  <Platform>sample string 1</Platform>
  <Program>sample string 2</Program>
  <ProgramFriendlyName>sample string 3</ProgramFriendlyName>
  <EnterpriseServicesIdentifier>sample string 4</EnterpriseServicesIdentifier>
  <IdentityMapped>True</IdentityMapped>
  <MappedToMasterPlatform>True</MappedToMasterPlatform>
  <MasterPlatform>sample string 7</MasterPlatform>
  <SupportingPlatform>sample string 8</SupportingPlatform>
  <MasterPlatformName>sample string 9</MasterPlatformName>
  <SupportingPlatformName>sample string 10</SupportingPlatformName>
</resource>