PATCH api/Opportunity

Usar Apenas Integration Key e o StatusObservations para atualizar Estado da Oportunidade

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
IntegrationKey	Hub Exponor Id (PK)	string	None.
Description	Opp Description	string	None.
Name	Name	string	None.
StateObservations	Opp State Observations	string	None.
CCNumber1	BI 1	boolean	None.
CCNumber2	BI 2	boolean	None.
OpportunityProducts	List of Opportunity Product	Collection of OpportunityProduct	None.
Account	Data of Account	Account	None.
Contacts	Data of Contact	Collection of Contact	None.
CampaignKey	Campain Integration Key	string	None.
Status	Opp Status Code	StatusCode	None.
Fronts	Fronts requested	string	None.
Area	Area	decimal number	None.
NameToComunicate	Name to Comunicate	string	None.
Representatives	List of Representatives	Collection of Representative	None.

Request Formats

application/json, text/json

Sample:

{
  "IntegrationKey": "sample string 1",
  "Description": "sample string 2",
  "Name": "sample string 3",
  "StateObservations": "sample string 4",
  "CCNumber1": true,
  "CCNumber2": true,
  "OpportunityProducts": [
    {
      "IntegrationKey": "sample string 1",
      "OpportunityKey": "sample string 2",
      "ProductReference": "sample string 3",
      "Quantity": 4.0,
      "PricePerUnit": 5.0
    },
    {
      "IntegrationKey": "sample string 1",
      "OpportunityKey": "sample string 2",
      "ProductReference": "sample string 3",
      "Quantity": 4.0,
      "PricePerUnit": 5.0
    }
  ],
  "Account": {
    "IntegrationKey": "sample string 1",
    "CAE3": "sample string 2",
    "Activity": "sample string 3",
    "EnumActivityCode": 261020000,
    "ActivityCodeOptionSelected": null,
    "Name": "sample string 4",
    "Email": "sample string 5",
    "CommercialName": "sample string 6",
    "EnumAccountCategoryCode": 1,
    "AccountCategoryCodeOptionSelected": 7,
    "AccountCategoryCode": "sample string 8",
    "VAT": "sample string 9",
    "Telephone": "sample string 10",
    "OtherTelephone": "sample string 11",
    "PrimaryContact": "sample string 12",
    "EnumTypeOfAddress": 1,
    "TypeOfAddressOptionSelected": 13,
    "TypeOfAddress": "sample string 14",
    "Address": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "Country": "sample string 18",
    "PostalBoxOffice": "sample string 19",
    "Website": "sample string 20",
    "EnumIndustryCode": 7,
    "IndustryCodeOptionSelected": 21,
    "IndustryCode": "sample string 22",
    "NumberCardAEP": "sample string 23",
    "Contact": {
      "IntegrationKey": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Telephone": "sample string 4",
      "Email": "sample string 5",
      "JobTitle": "sample string 6",
      "EnumType": 108640000
    }
  },
  "Contacts": [
    {
      "IntegrationKey": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Telephone": "sample string 4",
      "Email": "sample string 5",
      "JobTitle": "sample string 6",
      "EnumType": 108640000
    },
    {
      "IntegrationKey": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Telephone": "sample string 4",
      "Email": "sample string 5",
      "JobTitle": "sample string 6",
      "EnumType": 108640000
    }
  ],
  "CampaignKey": "sample string 7",
  "Status": 3,
  "Fronts": "sample string 8",
  "Area": 9.0,
  "NameToComunicate": "sample string 10",
  "Representatives": [
    {
      "RepresentedCompany": "sample string 1",
      "PrivateStaff": true,
      "CountryCompanyRepresented": "sample string 3",
      "OcupatedArea": 4.0
    },
    {
      "RepresentedCompany": "sample string 1",
      "PrivateStaff": true,
      "CountryCompanyRepresented": "sample string 3",
      "OcupatedArea": 4.0
    }
  ]
}

application/xml, text/xml

Sample:

<Opportunity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hydra.Exponor.Dynamics365.WS.Models">
  <Account>
    <AccountCategoryCode>sample string 8</AccountCategoryCode>
    <AccountCategoryCodeOptionSelected>7</AccountCategoryCodeOptionSelected>
    <Activity>sample string 3</Activity>
    <ActivityCodeOptionSelected xmlns:d3p1="http://schemas.microsoft.com/xrm/9.0/Contracts" i:nil="true" />
    <Address>sample string 15</Address>
    <CAE3>sample string 2</CAE3>
    <City>sample string 17</City>
    <CommercialName>sample string 6</CommercialName>
    <Contact>
      <Email>sample string 5</Email>
      <EnumType>ContactoPreferencial</EnumType>
      <FirstName>sample string 2</FirstName>
      <IntegrationKey>sample string 1</IntegrationKey>
      <JobTitle>sample string 6</JobTitle>
      <LastName>sample string 3</LastName>
      <Telephone>sample string 4</Telephone>
    </Contact>
    <Country>sample string 18</Country>
    <Email>sample string 5</Email>
    <EnumAccountCategoryCode>SocioAEPPlus</EnumAccountCategoryCode>
    <EnumActivityCode>Produtor</EnumActivityCode>
    <EnumIndustryCode>Consultadoria</EnumIndustryCode>
    <EnumTypeOfAddress>FaturarPara</EnumTypeOfAddress>
    <IndustryCode>sample string 22</IndustryCode>
    <IndustryCodeOptionSelected>21</IndustryCodeOptionSelected>
    <IntegrationKey>sample string 1</IntegrationKey>
    <Name>sample string 4</Name>
    <NumberCardAEP>sample string 23</NumberCardAEP>
    <OtherTelephone>sample string 11</OtherTelephone>
    <PostalBoxOffice>sample string 19</PostalBoxOffice>
    <PostalCode>sample string 16</PostalCode>
    <PrimaryContact>sample string 12</PrimaryContact>
    <Telephone>sample string 10</Telephone>
    <TypeOfAddress>sample string 14</TypeOfAddress>
    <TypeOfAddressOptionSelected>13</TypeOfAddressOptionSelected>
    <VAT>sample string 9</VAT>
    <Website>sample string 20</Website>
  </Account>
  <Area>9</Area>
  <CCNumber1>true</CCNumber1>
  <CCNumber2>true</CCNumber2>
  <CampaignKey>sample string 7</CampaignKey>
  <Contacts>
    <Contact>
      <Email>sample string 5</Email>
      <EnumType>ContactoPreferencial</EnumType>
      <FirstName>sample string 2</FirstName>
      <IntegrationKey>sample string 1</IntegrationKey>
      <JobTitle>sample string 6</JobTitle>
      <LastName>sample string 3</LastName>
      <Telephone>sample string 4</Telephone>
    </Contact>
    <Contact>
      <Email>sample string 5</Email>
      <EnumType>ContactoPreferencial</EnumType>
      <FirstName>sample string 2</FirstName>
      <IntegrationKey>sample string 1</IntegrationKey>
      <JobTitle>sample string 6</JobTitle>
      <LastName>sample string 3</LastName>
      <Telephone>sample string 4</Telephone>
    </Contact>
  </Contacts>
  <Description>sample string 2</Description>
  <Fronts>sample string 8</Fronts>
  <IntegrationKey>sample string 1</IntegrationKey>
  <Name>sample string 3</Name>
  <NameToComunicate>sample string 10</NameToComunicate>
  <OpportunityProducts>
    <OpportunityProduct>
      <IntegrationKey>sample string 1</IntegrationKey>
      <OpportunityKey>sample string 2</OpportunityKey>
      <PricePerUnit>5</PricePerUnit>
      <ProductReference>sample string 3</ProductReference>
      <Quantity>4</Quantity>
    </OpportunityProduct>
    <OpportunityProduct>
      <IntegrationKey>sample string 1</IntegrationKey>
      <OpportunityKey>sample string 2</OpportunityKey>
      <PricePerUnit>5</PricePerUnit>
      <ProductReference>sample string 3</ProductReference>
      <Quantity>4</Quantity>
    </OpportunityProduct>
  </OpportunityProducts>
  <Representatives>
    <Representative>
      <CountryCompanyRepresented>sample string 3</CountryCompanyRepresented>
      <OcupatedArea>4</OcupatedArea>
      <PrivateStaff>true</PrivateStaff>
      <RepresentedCompany>sample string 1</RepresentedCompany>
    </Representative>
    <Representative>
      <CountryCompanyRepresented>sample string 3</CountryCompanyRepresented>
      <OcupatedArea>4</OcupatedArea>
      <PrivateStaff>true</PrivateStaff>
      <RepresentedCompany>sample string 1</RepresentedCompany>
    </Representative>
  </Representatives>
  <StateObservations>sample string 4</StateObservations>
  <Status>Ganha</Status>
</Opportunity>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResumeIntegration

Name	Type	Additional information
TotalRecords	integer	None.
TotalErrors	integer	None.
Date	string	None.
RecordsResume	Collection of RecordsResumeIntegration	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalRecords": 1,
  "TotalErrors": 2,
  "Date": "sample string 3",
  "RecordsResume": [
    {
      "RecordGuid": "sample string 1",
      "Code": "sample string 2",
      "Message": "sample string 3"
    },
    {
      "RecordGuid": "sample string 1",
      "Code": "sample string 2",
      "Message": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<ResumeIntegration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hydra.Extensions.ResumeIntegrations.Models">
  <Date>sample string 3</Date>
  <RecordsResume>
    <RecordsResumeIntegration>
      <Code>sample string 2</Code>
      <Message>sample string 3</Message>
      <RecordGuid>sample string 1</RecordGuid>
    </RecordsResumeIntegration>
    <RecordsResumeIntegration>
      <Code>sample string 2</Code>
      <Message>sample string 3</Message>
      <RecordGuid>sample string 1</RecordGuid>
    </RecordsResumeIntegration>
  </RecordsResume>
  <TotalErrors>2</TotalErrors>
  <TotalRecords>1</TotalRecords>
</ResumeIntegration>