PUT PlanName/PutPlanName

Updates a PlanName record

Request Information

URI Parameters

Body Parameters

PlanName object used to update an existing record in the database.

ClsPlanNameUpdate
NameDescriptionTypeAdditional Information
PlanNameGUID

The globally unique identifier for the PlanName record

 globally unique identifier

Required

(Hexadecimal 8-4-4-4-12)
PlanName

The Name of the PlanName record

 string

Required

Max length: 80
Inactive

Indicates the PlanName is inactive

 boolean

Must be 0, 1, True, or False

Request Formats

application/json, text/json

Sample: 
{
  "PlanNameGUID": "8cf2a6bf-62b0-4eaa-87aa-19c4bf23186f",
  "PlanName": "sample string 5",
  "Inactive": true
}

application/xml, text/xml

Sample: 
<PlanNameUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.plbl">
  <Inactive>true</Inactive>
  <PlanName>sample string 5</PlanName>
  <PlanNameGUID>8cf2a6bf-62b0-4eaa-87aa-19c4bf23186f</PlanNameGUID>
</PlanNameUpdate>

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

Response Information

Resource Description

Updates a PlanName record

AgvPlanName
NameDescriptionTypeAdditional Information
Status

Status of the API call.

 string
Message

Message of the API call.

 string
Count

Count of how many PlanName JSON dictionaries.

 string
PlanNames

JSON dictionary of PlanNames.

 Collection of ClsPlanName

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "PlanNames": [
    {
      "PlanNameGUID": "1b60562b-eb77-42a9-8176-4c155a45c4b5",
      "PlanName": "sample string 6",
      "Inactive": true
    },
    {
      "PlanNameGUID": "1b60562b-eb77-42a9-8176-4c155a45c4b5",
      "PlanName": "sample string 6",
      "Inactive": true
    }
  ]
}

application/xml, text/xml

Sample: 
<AgvPlanName xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Plan">
  <Message>sample string 2</Message>
  <PlanNames xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.plbl">
    <d2p1:PlanName>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:PlanName>sample string 6</d2p1:PlanName>
      <d2p1:PlanNameGUID>1b60562b-eb77-42a9-8176-4c155a45c4b5</d2p1:PlanNameGUID>
    </d2p1:PlanName>
    <d2p1:PlanName>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:PlanName>sample string 6</d2p1:PlanName>
      <d2p1:PlanNameGUID>1b60562b-eb77-42a9-8176-4c155a45c4b5</d2p1:PlanNameGUID>
    </d2p1:PlanName>
  </PlanNames>
  <Status>sample string 1</Status>
</AgvPlanName>