digitaluapi

CustomersSegmentsAutoQueryLookup

The following routes are available for this service:
GET	/auto/customerssegments/{Id}
GET	/auto/customerssegments

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
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

**CustomersSegments** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	Yes
TenantsId	form	long	Yes
CustomersId	form	long	Yes
SegmentsId	form	long	Yes
PublicAccessGuid	form	Guid	Yes

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<CampaignCustomersView>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**CampaignCustomersView** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
Name	form	string	No
Description	form	string	No
CustomersId	form	long?	No
FirstName	form	string	No
LastName	form	string	No
IdNumber	form	string	No
PassportNumber	form	string	No
Email	form	string	No
MobileNumber	form	string	No
CustomerUniqueIdentifier	form	string	No
CustomerPublicAccessGuid	form	Guid?	No
CampaignPublicAccessGuid	form	Guid?	No
TenantsId	form	int?	No

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 /auto/customerssegments/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: 0,
			TenantsId: 0,
			CustomersId: 0,
			SegmentsId: 0,
			PublicAccessGuid: 00000000000000000000000000000000
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}