PUT api/Admin/ThirdPartyReferenceID

Pass a valid SubjectTypeID of 1 (Reps), 10 (Customers) or 3 (orders), along with the internal RepID/CustomerID/OrderID into the SubjectID column. The IntegrationProviderAccountID can be found in the corporate back office and ties this third party reference ID to a specific integration. This Creates a new Reference ID for the Subject ID provided. If one already exists for that Subject ID then this call will update it instead.

Request Information

URI Parameters

None.

Body Parameters

ThirdPartyReferenceInputViewModel
NameDescriptionTypeAdditional information
SubjectID

ByDesign Subject ID that this reference ID maps to.

 integer

Required
SubjectTypeID

ByDesign Subject Type ID that the Subject ID.

 integer

Required
IntegrationProviderAccountID

ID for the Integration Provider Account that this Reference ID is a type of.

 integer

Required
ThirdPartyReferenceID

TaxCodeID for the returned value.

 string

Required

Max length: 250

Request Formats

application/xml, text/xml

Sample: 
<ThirdPartyReferenceInputViewModel>
  <SubjectID>1</SubjectID>
  <SubjectTypeID>2</SubjectTypeID>
  <IntegrationProviderAccountID>3</IntegrationProviderAccountID>
  <ThirdPartyReferenceID>sample string 4</ThirdPartyReferenceID>
</ThirdPartyReferenceInputViewModel>

application/json, text/json

Sample: 
{
  "SubjectID": 1,
  "SubjectTypeID": 2,
  "IntegrationProviderAccountID": 3,
  "ThirdPartyReferenceID": "sample string 4"
}

application/x-www-form-urlencoded

Sample:

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

Response Information

Resource Description

IOperationResult
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.
ValidationErrors

Dictionary of string [key] and string [value]

None.
Value

Object

None.

Response Formats

application/xml, text/xml

Sample: 
<OperationResult>
  <IsSuccessful>False</IsSuccessful>
  <ValidationErrors />
  <Value />
</OperationResult>

application/json, text/json

Sample: 
{
  "IsSuccessful": false,
  "ValidationErrors": {}
}