PUT Field/AddOrUpdateFieldClassification

Adds or Updates the Field Classifications.

Request Information

URI Parameters

Body Parameters

Object to use for the add or update of field classifications.

ClsFieldClassUpdate
NameDescriptionTypeAdditional Information
Data

List of fields and their classifications to be assigned

 Collection of ClsFieldClassUpdateItem

Required

List cannot be empty

Request Formats

application/json, text/json

Sample: 
{
  "Data": [
    {
      "FieldGuid": "a42b293e-e356-4280-9aa2-70117321a278",
      "ClassificationList": [
        1,
        2
      ]
    },
    {
      "FieldGuid": "a42b293e-e356-4280-9aa2-70117321a278",
      "ClassificationList": [
        1,
        2
      ]
    }
  ]
}

application/xml, text/xml

Sample: 
<ClsField.ClsFieldClassUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Field">
  <Data>
    <ClsField.ClsFieldClassUpdateItem>
      <ClassificationList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ClassificationList>
      <FieldGuid>a42b293e-e356-4280-9aa2-70117321a278</FieldGuid>
    </ClsField.ClsFieldClassUpdateItem>
    <ClsField.ClsFieldClassUpdateItem>
      <ClassificationList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ClassificationList>
      <FieldGuid>a42b293e-e356-4280-9aa2-70117321a278</FieldGuid>
    </ClsField.ClsFieldClassUpdateItem>
  </Data>
</ClsField.ClsFieldClassUpdate>

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

Response Information

Resource Description

Adds or Updates the Field Classifications.

AgvFieldClassification
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

 string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

 string
ErrorList

List of error messages of the API call.

 Collection of string
WarningList

List of warning messages of the API call.

 Collection of string

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<AgvFieldClassification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Field">
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvFieldClassification>