POST models/getprice
Get the price for a model (article) based on the GetPriceRequest object
Request Information
URI Parameters
None.
Body Parameters
The GetPriceRequest object describes the model (article). It contains: ModelId, a filled-in Checklist (with id of the check and a true/false value) and the IntakeType [0:Default, 1:Fast or 2:Demo].
GetPriceRequestName | Description | Type | Additional information |
---|---|---|---|
ModelId |
Sets the Model Id (=id of th article). |
integer |
Required |
Checklist |
List of checks (Id's) for the category of articles with their corresponding answer (true/false). See 'models/getchecks/{categoryKey}'. |
Dictionary of integer [key] and boolean [value] |
None. |
IntakeType |
Sets the type of the intake. |
IntakeType |
None. |
Request Formats
application/json, text/json
Sample:
{ "ModelId": 1, "Checklist": { "1": true, "3": true }, "IntakeType": "Default" }
application/xml, text/xml
Sample:
<GetPriceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrainscapeBuyBackApi.Classes"> <Checklist xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfintboolean> <d2p1:Key>1</d2p1:Key> <d2p1:Value>true</d2p1:Value> </d2p1:KeyValueOfintboolean> <d2p1:KeyValueOfintboolean> <d2p1:Key>3</d2p1:Key> <d2p1:Value>true</d2p1:Value> </d2p1:KeyValueOfintboolean> </Checklist> <IntakeType>Default</IntakeType> <ModelId>1</ModelId> </GetPriceRequest>
Response Information
Resource Description
Returns the ModelPrice object, containing the EndUserPrice.
ModelPriceName | Description | Type | Additional information |
---|---|---|---|
EndUserPrice |
Gets or sets the end user price. |
decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{ "EndUserPrice": 2.0 }
application/xml, text/xml
Sample:
<ModelPrice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrainscapeBuyBackApi.Classes"> <EndUserPrice>2</EndUserPrice> </ModelPrice>