POST api/SetAttribute

Request Information

URI Parameters

None.

Body Parameters

SetAttributeRequest
NameDescriptionTypeAdditional information
SessionKey

string

Required

ConstituentId

integer

Required

AttributeKeywordId

integer

Required

AttributeValue

string

Required

AttributeId

integer

Required

LastModifiedDate

date

Required

Request Formats

application/json, text/json

Sample:
{
  "SessionKey": "sample string 1",
  "ConstituentId": 2,
  "AttributeKeywordId": 3,
  "AttributeValue": "sample string 4",
  "AttributeId": 5,
  "LastModifiedDate": "2025-03-17T21:41:41.051951+00:00"
}

application/xml, text/xml

Sample:
<SetAttributeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Account">
  <AttributeId>5</AttributeId>
  <AttributeKeywordId>3</AttributeKeywordId>
  <AttributeValue>sample string 4</AttributeValue>
  <ConstituentId>2</ConstituentId>
  <LastModifiedDate>2025-03-17T21:41:41.051951+00:00</LastModifiedDate>
  <SessionKey>sample string 1</SessionKey>
</SetAttributeRequest>

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 'SetAttributeRequest'.

Response Information

Resource Description

ApiSuccessOfSetAttributeResult
NameDescriptionTypeAdditional information
Success

boolean
Data

SetAttributeResult

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "Attribute": {
      "Keyword": {
        "Description": "sample string 1",
        "Id": 2,
        "EditMask": "sample string 3",
        "DataType": "sample string 4",
        "MultipleValue": true,
        "ReferenceTable": "sample string 5",
        "DetailTable": "sample string 6",
        "PrimaryGroupDefault": "sample string 7",
        "Category": {
          "Description": "sample string 1",
          "Id": 1,
          "Inactive": true
        },
        "HelpText": "sample string 8",
        "ExtendedDescription": "sample string 9",
        "DetailColumn": "sample string 10",
        "ParentTable": "sample string 11",
        "CustomId": 1,
        "KeywordUse": "sample string 12"
      },
      "CreatedDateTime": "2025-03-17T21:41:41.051951+00:00",
      "CreateLocation": "sample string 1",
      "CreatedBy": "sample string 2",
      "Constituent": {
        "<Id>k__BackingField": 1
      },
      "Id": 1,
      "Value": "sample string 3",
      "UpdatedDateTime": "2025-03-17T21:41:41.051951+00:00",
      "UpdatedBy": "sample string 4",
      "KeywordConstituentType": {
        "Inactive": true,
        "Rank": 1
      },
      "EditIndicator": true
    }
  }
}

application/xml, text/xml

Sample:
<ApiSuccessOfSetAttributeResultgLC8bFpX xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Account">
    <d2p1:Attribute xmlns:d3p1="http://schemas.datacontract.org/2004/07/Tessitura.Service.Contract">
      <d3p1:Constituent>
        <d3p1:_x003C_Id_x003E_k__BackingField>1</d3p1:_x003C_Id_x003E_k__BackingField>
      </d3p1:Constituent>
      <d3p1:CreateLocation>sample string 1</d3p1:CreateLocation>
      <d3p1:CreatedBy>sample string 2</d3p1:CreatedBy>
      <d3p1:CreatedDateTime>2025-03-17T21:41:41.051951+00:00</d3p1:CreatedDateTime>
      <d3p1:EditIndicator>true</d3p1:EditIndicator>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Keyword>
        <d3p1:Category>
          <d3p1:Description>sample string 1</d3p1:Description>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:Inactive>true</d3p1:Inactive>
        </d3p1:Category>
        <d3p1:CustomId>1</d3p1:CustomId>
        <d3p1:DataType>sample string 4</d3p1:DataType>
        <d3p1:Description>sample string 1</d3p1:Description>
        <d3p1:DetailColumn>sample string 10</d3p1:DetailColumn>
        <d3p1:DetailTable>sample string 6</d3p1:DetailTable>
        <d3p1:EditMask>sample string 3</d3p1:EditMask>
        <d3p1:ExtendedDescription>sample string 9</d3p1:ExtendedDescription>
        <d3p1:HelpText>sample string 8</d3p1:HelpText>
        <d3p1:Id>2</d3p1:Id>
        <d3p1:KeywordUse>sample string 12</d3p1:KeywordUse>
        <d3p1:MultipleValue>true</d3p1:MultipleValue>
        <d3p1:ParentTable>sample string 11</d3p1:ParentTable>
        <d3p1:PrimaryGroupDefault>sample string 7</d3p1:PrimaryGroupDefault>
        <d3p1:ReferenceTable>sample string 5</d3p1:ReferenceTable>
      </d3p1:Keyword>
      <d3p1:KeywordConstituentType>
        <d3p1:Inactive>true</d3p1:Inactive>
        <d3p1:Rank>1</d3p1:Rank>
      </d3p1:KeywordConstituentType>
      <d3p1:UpdatedBy>sample string 4</d3p1:UpdatedBy>
      <d3p1:UpdatedDateTime>2025-03-17T21:41:41.051951+00:00</d3p1:UpdatedDateTime>
      <d3p1:Value>sample string 3</d3p1:Value>
    </d2p1:Attribute>
  </Data>
</ApiSuccessOfSetAttributeResultgLC8bFpX>