Get asset¶
Returns a single asset
Prerequisites¶
Credentials as described in Authentication
An asset identifier
C#¶
To get asset, first create the instance of CrayonApiClient and get token using the instance.
Then call Assets.GetById() method to get an asset by passing token the asset id.
var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var assetId = <asset identifier>;
var result = client.Assets.GetById(token, assetId);
Request¶
Request Syntax:
Method |
Request URI |
---|---|
GET |
https://api.crayon.com/api/v1/assets/{id}/ |
Request Parameters:
Name |
Type |
Description |
---|---|---|
id |
int |
Identifier of the asset |
Request Headers:
The following HTTP request headers are supported
Header |
Type |
Description |
|
---|---|---|---|
Authorization |
string |
Required. The authorization token in the form Bearer <token>. |
|
Accept |
string |
Specifies the request and response type, “application/json”. |
|
Content-Type |
string |
Specifies the media type of the resource, “application/json”. |
Request Example:
GET $"https://api.crayon.com/api/v1/assets/{id}/"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >
Response¶
If successful, this method returns a Asset resource in the response body.
{
"InvoiceProfile": null,
"Id": 999,
"Status": 3,
"ExternalOrderId": "ExternalOrderId",
"Quantity": 5,
"ExternalProductId": "ExternalProductId",
"ExternalSkuId": "1111",
"Name": "NameOfAsset",
"StartDate": "2023-06-10T08:20:30.123",
"ExpirationDate": "2025-06-10T08:20:30.123",
"ResellerCustomerId": 111,
"Scope": 3,
"AssetType": 1,
"BillingCycle": 4,
"PublisherId": 2,
"ProgramId": 1,
"ReservationId": null,
"ReservationUsedInSubscriptionId": null,
"ReservationUsedInSubscription": null,
"PurchaseCurrency": null,
"PurchasePrice": 1200.00,
"SalesCurrency": "USD",
"SalesPrice": 1500.00,
"CreatedDate": "2018-11-28T15:30:24.357",
"ModifiedDate": "2018-11-28T15:30:24.357",
"ChangedBy": "Username",
"ReservedInstanceArtifactResourceId": null,
"PurchaseDate": null,
"Tags": null,
"AutoRenewEnabled": null,
"ProductVariantId": null
}
Response success and error codes:
Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.
Error Codes |
Description |
---|---|
200 Ok |
The request has succeeded. |
401 Unauthorized |
The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition. |
404 NotFound |
Address was not found. |