| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/AvailableGiftCard/{AgentId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgentId | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| GiftCard | form | List<GiftCard> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GiftCardId | form | int | No | |
| AgentId | form | int | No | |
| CardType | form | string | No | |
| CardNumber | form | string | No | |
| ContactId | form | int | No | |
| DateCreated | form | DateTime | No | |
| DateModified | form | DateTime | No | |
| DateDeleted | form | DateTime | No | |
| GiftCardGameSetId | form | string | No | |
| FirstApptDate | form | DateTime | No | |
| IsReferrerCard | form | bool | No | |
| AgentName | form | string | No | |
| ContactName | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/AvailableGiftCard/{AgentId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
GiftCard:
[
{
GiftCardId: 0,
AgentId: 0,
CardType: String,
CardNumber: String,
ContactId: 0,
DateCreated: 0001-01-01,
DateModified: 0001-01-01,
DateDeleted: 0001-01-01,
GiftCardGameSetId: String,
FirstApptDate: 0001-01-01,
IsReferrerCard: False,
AgentName: String,
ContactName: String
}
]
}