POST models/register
Registers the model for intake. Perform a registration of a model (=an article).
Request Information
URI Parameters
None.
Body Parameters
ModelIntakeRequest object containing ShopCode, ModelId, ImeiNumber and a filled in checklist (see 'models/getchecks/{categoryKey}').
ModelIntakeRequestName | Description | Type | Additional information |
---|---|---|---|
ShopCode |
Gets or sets the shop code. |
string |
Required |
ModelId |
Gets or sets the model identifier. |
integer |
Required |
ImeiNumber |
Gets or sets the imei number. |
string |
Required |
Checklist |
Dictionary of checkids and checkedstate (if checked true else false) |
Dictionary of integer [key] and boolean [value] |
None. |
IntakeType | IntakeType |
None. |
Request Formats
application/json, text/json
Sample:
{ "ShopCode": "sample string 1", "ModelId": 2, "ImeiNumber": "sample string 3", "Checklist": { "1": true, "3": true }, "IntakeType": "Default" }
application/xml, text/xml
Sample:
<ModelIntakeRequest 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> <ImeiNumber>sample string 3</ImeiNumber> <IntakeType>Default</IntakeType> <ModelId>2</ModelId> <ShopCode>sample string 1</ShopCode> </ModelIntakeRequest>
Response Information
Resource Description
Returns a RegisterResponse object containing a RMA number (=the unique id of the registration for intake) and the EndUserPrice (value of the article based on model and checklist including VAT).
RegisterResponseName | Description | Type | Additional information |
---|---|---|---|
Rma |
Gets or sets the rma number. |
string |
None. |
EndUserPrice |
Gets or sets the end user price. |
decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{ "Rma": "sample string 1", "EndUserPrice": 3.0 }
application/xml, text/xml
Sample:
<RegisterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrainscapeBuyBackApi.Classes"> <EndUserPrice>3</EndUserPrice> <Rma>sample string 1</Rma> </RegisterResponse>