POST api/{programid}/Authorizations/ConsumerUpdate

Description : Calling Consumer/Update

Request Information

URI Parameters

Name	Description	Type	Additional information
programid	Program Id	string	Required

Body Parameters

program code, ppl id, start date

UpdateConsumerParams

Name	Type	Additional information
ProgramCode	string	None.
PPLId	string	None.
StartDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "ProgramCode": "sample string 1",
  "PPLId": "sample string 2",
  "StartDate": "2024-11-16T09:32:00.3789794+00:00"
}

application/xml, text/xml

Sample:

<UpdateConsumerParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Consumer">
  <PPLId>sample string 2</PPLId>
  <ProgramCode>sample string 1</ProgramCode>
  <StartDate>2024-11-16T09:32:00.3789794+00:00</StartDate>
</UpdateConsumerParams>

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

Response Information

Resource Description

AuthorizedServices

Name	Type	Additional information
ServiceCode	string	None.
Description	string	None.
DescriptionOnCheck	string	None.
AuthBeginDate	date	None.
AuthEndDate	date	None.
ExternalData1	string	None.
ExternalData2	string	None.
ValuedOutcome	string	None.
Comment	string	None.
ExternalReferenceId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ServiceCode": "sample string 1",
  "Description": "sample string 2",
  "DescriptionOnCheck": "sample string 3",
  "AuthBeginDate": "2024-11-16T09:32:00.3789794+00:00",
  "AuthEndDate": "2024-11-16T09:32:00.3789794+00:00",
  "ExternalData1": "sample string 6",
  "ExternalData2": "sample string 7",
  "ValuedOutcome": "sample string 8",
  "Comment": "sample string 9",
  "ExternalReferenceId": "sample string 10"
}

application/xml, text/xml

Sample:

<AuthorizedServices xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.NavisionData.CommonClasses.Authorization">
  <AuthBeginDate>2024-11-16T09:32:00.3789794+00:00</AuthBeginDate>
  <AuthEndDate>2024-11-16T09:32:00.3789794+00:00</AuthEndDate>
  <Comment>sample string 9</Comment>
  <Description>sample string 2</Description>
  <DescriptionOnCheck>sample string 3</DescriptionOnCheck>
  <ExternalData1>sample string 6</ExternalData1>
  <ExternalData2>sample string 7</ExternalData2>
  <ExternalReferenceId>sample string 10</ExternalReferenceId>
  <ServiceCode>sample string 1</ServiceCode>
  <ValuedOutcome>sample string 8</ValuedOutcome>
</AuthorizedServices>