digitaluapi

<back to all web services

ClientInvitesLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/client_invites
ClientInvitesLookup Parameters:
NameParameterData TypeRequiredDescription
InviteGuidqueryGuidNo
DateCreatedqueryDateTimeOffsetNo
DateSentqueryDateTimeOffset?No
RecipientsquerystringNo
ReferencequerystringNo
RetryCountqueryintNo
StatusCodesIdquerylongNo
TempateTextquerystringNo
TenantsIdqueryintNo
ClientsUserAuthIdqueryintNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /client_invites HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"InviteGuid":"00000000000000000000000000000000","DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","Recipients":"String","Reference":"String","RetryCount":0,"StatusCodesId":0,"TempateText":"String","TenantsId":0,"ClientsUserAuthId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}]