PUT PlanType/PutPlanType

Updates a PlanType record

Request Information

URI Parameters

Body Parameters

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

ClsPlanTypeUpdate
NameDescriptionTypeAdditional Information
PlanTypeGUID

The globally unique identifier for the PlanType record

globally unique identifier

Required

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

PlanType

The Name of the PlanType record

string

Required

Max length: 80

Inactive

Indicates the PlanType is inactive

boolean

Must be 0, 1, True, or False

Request Formats

application/json, text/json

Sample:
{
  "PlanTypeGUID": "9ed5f74b-77b3-4a8d-b9d0-7cfef14a9feb",
  "PlanType": "sample string 5",
  "Inactive": true
}

application/xml, text/xml

Sample:
<PlanTypeUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.plbl">
  <Inactive>true</Inactive>
  <PlanType>sample string 5</PlanType>
  <PlanTypeGUID>9ed5f74b-77b3-4a8d-b9d0-7cfef14a9feb</PlanTypeGUID>
</PlanTypeUpdate>

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

Response Information

Resource Description

Updates a PlanType record

AgvPlanType
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
Count

Count of how many PlanType JSON dictionaries.

string
PlanTypes

JSON dictionary of PlanTypes.

Collection of ClsPlanType

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "PlanTypes": [
    {
      "PlanTypeGUID": "eeccafaa-ac3f-413e-8078-b941d1664445",
      "PlanType": "sample string 6",
      "Inactive": true
    },
    {
      "PlanTypeGUID": "eeccafaa-ac3f-413e-8078-b941d1664445",
      "PlanType": "sample string 6",
      "Inactive": true
    }
  ]
}

application/xml, text/xml

Sample:
<AgvPlanType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Plan">
  <Message>sample string 2</Message>
  <PlanTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.plbl">
    <d2p1:PlanType>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:PlanType>sample string 6</d2p1:PlanType>
      <d2p1:PlanTypeGUID>eeccafaa-ac3f-413e-8078-b941d1664445</d2p1:PlanTypeGUID>
    </d2p1:PlanType>
    <d2p1:PlanType>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:PlanType>sample string 6</d2p1:PlanType>
      <d2p1:PlanTypeGUID>eeccafaa-ac3f-413e-8078-b941d1664445</d2p1:PlanTypeGUID>
    </d2p1:PlanType>
  </PlanTypes>
  <Status>sample string 1</Status>
</AgvPlanType>