GET | /customers/{CustomerId}/giftcontacts |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ContactId | form | string | No | |
Title | form | PersonTitle? | No | Person titleAllowable Values
|
FirstName | form | string | No | |
LastName | form | string | No | |
DateOfBirth | form | DateTime? | No | |
HomePhone | form | string | No | |
MobilePhone | form | string | No | |
form | string | No | ||
Address | form | Address | No |
Mr |
Mrs |
Miss |
Ms |
Dr |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Street | form | string | No | |
City | form | string | No | |
ZipCode | form | string | No | |
State | form | string | No | |
CountryRegionId | form | string | No | |
DPID | form | int | No | |
Suburb | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | 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 /customers/{CustomerId}/giftcontacts HTTP/1.1 Host: azs-stg-lotteries-web.azurewebsites.net Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { offset: 0, total: 0, results: [ { contactId: String, title: Mr, firstName: String, lastName: String, dateOfBirth: 0001-01-01, homePhone: String, mobilePhone: String, email: String, address: { street: String, city: String, zipCode: String, state: String, countryRegionId: String, dpid: 0, suburb: String } } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }