GET api/Transaction/{transactionId}?user={user}
Get an existing transaction by id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
transactionId |
Id of transaction to find |
string |
Required |
user |
Id of the user makign the request (logged in user if left empty) |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
The transaction on success
Collection of errors on failure
Return codes
200 - ok
401 - unauthorized
404 - not found
500 - internal server error
Name | Description | Type | Additional information |
---|---|---|---|
TransactionID |
Transaction id |
string |
None. |
Total_HT |
Total price before tax |
decimal number |
None. |
Total_TTC |
Total price with tax |
decimal number |
None. |
PanierID | integer |
None. |
|
OpDetails |
Details of the transaction |
Collection of OpDetail |
None. |
AutoRenew |
Auto renew transaction |
boolean |
None. |
ModePaiementID | integer |
Required |
|
OpState | byte |
Required |
|
Errors |
Collection of errors for operations that fail |
Collection of Error |
None. |
IpAddress |
Client ip address |
string |
None. |
Currency | string |
None. |
Response Formats
application/json, text/json
{ "TransactionID": "sample string 1", "Total_HT": 2.0, "Total_TTC": 3.0, "PanierID": 4, "OpDetails": [ { "Id": 1.0, "ProduitID": 1, "Period": 1.1, "Quantity": 1, "Pu": 2.0, "IsUpdate": true, "NewQuantity": 1, "PeriodLeft": 1.1, "OldProduitID": 1, "OldPu": 1.0, "Total_HT": 4.0, "OpDetailPacks": [ { "Id": 1.0, "DetailId": 2.0, "ProduitID": 1, "Pu": 3.0, "CartItems": [ { "Id": 1.0, "DetailPackId": 2.0, "Name": "sample string 3", "Handle": "sample string 4", "Class": "sample string 5", "Attributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } } ] } ] } ], "AutoRenew": true, "ModePaiementID": 1, "OpState": 64, "Errors": [ { "Code": 1, "Detail": "sample string 2", "Data": {} } ], "IpAddress": "sample string 8", "Currency": "sample string 9" }
application/xml, text/xml
<Transaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Transaction"> <Currency xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">sample string 9</Currency> <Errors xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models"> <Error> <Code>1</Code> <Data /> <Detail>sample string 2</Detail> </Error> </Errors> <IpAddress xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">sample string 8</IpAddress> <ModePaiementID>1</ModePaiementID> <OpState>64</OpState> <AutoRenew>true</AutoRenew> <OpDetails> <OpDetail> <Id>1</Id> <IsUpdate>true</IsUpdate> <NewQuantity>1</NewQuantity> <OldProduitID>1</OldProduitID> <OldPu>1</OldPu> <OpDetailPacks> <OpDetailPack> <CartItems> <CartItem> <Attributes xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 1</d8p1:Key> <d8p1:Value>sample string 2</d8p1:Value> </d8p1:KeyValueOfstringstring> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 3</d8p1:Key> <d8p1:Value>sample string 4</d8p1:Value> </d8p1:KeyValueOfstringstring> </Attributes> <Class>sample string 5</Class> <DetailPackId>2</DetailPackId> <Handle>sample string 4</Handle> <Id>1</Id> <Name>sample string 3</Name> </CartItem> </CartItems> <DetailId>2</DetailId> <Id>1</Id> <ProduitID>1</ProduitID> <Pu>3</Pu> </OpDetailPack> </OpDetailPacks> <Period>1.1</Period> <PeriodLeft>1.1</PeriodLeft> <ProduitID>1</ProduitID> <Pu>2</Pu> <Quantity>1</Quantity> <Total_HT>4</Total_HT> </OpDetail> </OpDetails> <PanierID>4</PanierID> <Total_HT>2</Total_HT> <Total_TTC>3</Total_TTC> <TransactionID>sample string 1</TransactionID> </Transaction>