Rsl.Lotteries

<back to all web services

QueryGiftContacts

Returns the gift contacts associated with customer

The following routes are available for this service:
GET/customers/{CustomerId}/giftcontacts
QueryGiftContacts Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathstringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Contact Parameters:
NameParameterData TypeRequiredDescription
ContactIdformstringNo
TitleformPersonTitle?NoPerson title

Allowable Values

  • Mr
  • Mrs
  • Miss
  • Ms
  • Dr
FirstNameformstringNo
LastNameformstringNo
DateOfBirthformDateTime?No
HomePhoneformstringNo
MobilePhoneformstringNo
EmailformstringNo
AddressformAddressNo
PersonTitle Enum:
Mr
Mrs
Miss
Ms
Dr
Address Parameters:
NameParameterData TypeRequiredDescription
StreetformstringNo
CityformstringNo
ZipCodeformstringNo
StateformstringNo
CountryRegionIdformstringNo
DPIDformintNo
SuburbformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}