POST api/benefit-plan/{benefitPlanId}/vendor-contract/{vendorContractId}/attestations/vendor-file

Request Information

URI Parameters

Name	Description	Type	Additional information
benefitPlanId		integer	Required
vendorContractId		integer	Required

Body Parameters

VendorContractResult

Name	Type	Additional information
BenefitTypeId	integer	None.
BenefitType	string	None.
Vendor	string	None.
VendorRole	string	None.
Currency	string	None.
ServicesProvidedByVendorId	string	None.
VendorCompensationBasisId	string	None.
ServicesProvidedByVendor	Collection of FieldDataSourceResult	None.
VendorCompensationBasis	Collection of FieldDataSourceResult	None.
Company	CorporateCompanyResult	None.
VendorInformation	VendorResult	None.
Contacts	Collection of ContactVendorContractResult	None.
VendorContractId	integer	None.
BenefitCoverageId	integer	None.
VendorId	integer	None.
ServicesProvidedByVendor	string	None.
PolicyContractNumber	string	None.
ContractEffectiveDate	date	None.
NatureOfContract	integer	None.
MarketingExercise	boolean	None.
ContractDuration	decimal number	None.
NextRenewalDate	date	None.
TacitRenewal	boolean	None.
NoticePeriod	string	None.
FreeCoverLimit	string	None.
MaximumBenefit	decimal number	None.
LocalExperienceRating	boolean	None.
ExperienceRatingFormula	string	None.
CommunityRating	boolean	None.
VendorCompensationBasis	string	None.
VendorAnnualCompensation	decimal number	None.
VendorEmployeesDeployedToCompany	decimal number	None.
CurrencyId	integer	None.
OtherVendorContractDetails	string	None.
Active	boolean	None.
CommissionRate	decimal number	None.
CreatedBy	string	None.
CreatedByUserId	integer	None.
CreatedOn	date	None.
ModifiedBy	string	None.
ModifiedByUserId	integer	None.
ModifiedOn	date	None.

Request Formats

application/json, text/json

Sample:

{
  "BenefitTypeId": 1,
  "BenefitType": "sample string 2",
  "Vendor": "sample string 3",
  "VendorRole": "sample string 4",
  "Currency": "sample string 5",
  "ServicesProvidedByVendorId": "sample string 6",
  "VendorCompensationBasisId": "sample string 7",
  "ServicesProvidedByVendor": [
    {
      "Id": 1,
      "Description": "sample string 2"
    },
    {
      "Id": 1,
      "Description": "sample string 2"
    }
  ],
  "VendorCompensationBasis": [
    {
      "Id": 1,
      "Description": "sample string 2"
    },
    {
      "Id": 1,
      "Description": "sample string 2"
    }
  ],
  "Company": {
    "CorporateCompanyId": 1,
    "CorporateId": 2,
    "CountryCompanyName": "sample string 3",
    "LocalCompanyName": "sample string 4",
    "CountryId": 5,
    "CountryName": "sample string 6",
    "Flag": "sample string 7",
    "Alpha2Code": "sample string 8",
    "NumberOfPlants": 9,
    "CorporateBusinessId": "sample string 10",
    "CorporateLegalEntitiesId": "sample string 11",
    "Active": true,
    "Contact": {
      "ContactId": 1,
      "CorporateId": 1,
      "ContactTypeId": 2,
      "ContactType": "sample string 3",
      "CompleteName": "sample string 4",
      "UserName": "sample string 5",
      "FirstName": "sample string 6",
      "MiddleName": "sample string 7",
      "LastName": "sample string 8",
      "Email": "sample string 9",
      "Title": "sample string 10",
      "Department": "sample string 11",
      "EmployerName": "sample string 12",
      "VendorId": 1,
      "ClientRelationshipRole": "sample string 13",
      "IsBillingContact": true,
      "WorkPhone": "sample string 15",
      "CellPhone": "sample string 16",
      "Address": "sample string 17",
      "City": "sample string 18",
      "State": "sample string 19",
      "CountryId": 1,
      "CountryName": "sample string 20",
      "Region": "sample string 21",
      "ZipCode": "sample string 22",
      "Countries": "sample string 23",
      "Companies": "sample string 24",
      "BenefitLines": "sample string 25",
      "Businesses": "sample string 26",
      "Entities": "sample string 27",
      "ClientRelationshipStarted": "2025-12-22T02:01:15.0514311+00:00",
      "ClientRelationshipEnded": "2025-12-22T02:01:15.0514311+00:00",
      "TerminationFromCompany": "2025-12-22T02:01:15.0514311+00:00",
      "Active": true,
      "IsGlobal": true,
      "CreatedByUserId": 29
    }
  },
  "VendorInformation": {
    "VendorId": 1,
    "VendorCompanyName": "sample string 2",
    "CountryId": 3,
    "CountryName": "sample string 4",
    "TypeOfVendorId": 1,
    "TypeOfVendor": "sample string 5",
    "SpecializedHealthcareProvider": "sample string 6",
    "SourceName": "sample string 7",
    "SourceNameId": 1,
    "CorporateCompanyName": "sample string 8",
    "HeadquarterCountryId": 9,
    "HeadquarterCountryName": "sample string 10",
    "IsGlobal": true,
    "Active": true,
    "Status": true,
    "CanDelete": 14,
    "InternationalNetwork": "sample string 15",
    "VendorRoles": "sample string 16",
    "CorporateId": 17,
    "CorporateName": "sample string 18"
  },
  "Contacts": [
    {
      "ContactId": 1,
      "ContactVendorContractId": 2,
      "VendorContractId": 3,
      "ContactName": "sample string 4",
      "Email": "sample string 5",
      "Title": "sample string 6",
      "WorkPhone": "sample string 7"
    },
    {
      "ContactId": 1,
      "ContactVendorContractId": 2,
      "VendorContractId": 3,
      "ContactName": "sample string 4",
      "Email": "sample string 5",
      "Title": "sample string 6",
      "WorkPhone": "sample string 7"
    }
  ],
  "VendorContractId": 8,
  "BenefitCoverageId": 9,
  "VendorId": 10,
  "PolicyContractNumber": "sample string 12",
  "ContractEffectiveDate": "2025-12-22T02:01:15.0514311+00:00",
  "NatureOfContract": 1,
  "MarketingExercise": true,
  "ContractDuration": 1.0,
  "NextRenewalDate": "2025-12-22T02:01:15.0514311+00:00",
  "TacitRenewal": true,
  "NoticePeriod": "sample string 15",
  "FreeCoverLimit": "sample string 16",
  "MaximumBenefit": 1.0,
  "LocalExperienceRating": true,
  "ExperienceRatingFormula": "sample string 18",
  "CommunityRating": true,
  "VendorAnnualCompensation": 1.0,
  "VendorEmployeesDeployedToCompany": 1.0,
  "CurrencyId": 1,
  "OtherVendorContractDetails": "sample string 21",
  "Active": true,
  "CommissionRate": 1.0,
  "CreatedBy": "sample string 23",
  "CreatedByUserId": 24,
  "CreatedOn": "2025-12-22T02:01:15.0514311+00:00",
  "ModifiedBy": "sample string 26",
  "ModifiedByUserId": 27,
  "ModifiedOn": "2025-12-22T02:01:15.0514311+00:00"
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'System.Collections.Generic.List`1[[ALTAMBS.Business.Entities.Models.FieldDataSourceResult, ALTAMBS.Business.Entities, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' with data contract name 'ArrayOfFieldDataSourceResult:http://schemas.datacontract.org/2004/07/ALTAMBS.Business.Entities.Models' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'System.Collections.Generic.List`1[[ALTAMBS.Business.Entities.Models.FieldDataSourceResult, ALTAMBS.Business.Entities, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' with data contract name 'ArrayOfFieldDataSourceResult:http://schemas.datacontract.org/2004/07/ALTAMBS.Business.Entities.Models' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'VendorContractResult'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.