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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfClientInvitesLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ClientInvitesLookupResponse>
    <ClientsUserAuthId>0</ClientsUserAuthId>
    <DateCreated xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </DateCreated>
    <DateSent xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </DateSent>
    <InviteGuid>00000000-0000-0000-0000-000000000000</InviteGuid>
    <Recipients>String</Recipients>
    <Reference>String</Reference>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <RetryCount>0</RetryCount>
    <StatusCodesId>0</StatusCodesId>
    <TempateText>String</TempateText>
    <TenantsId>0</TenantsId>
  </ClientInvitesLookupResponse>
</ArrayOfClientInvitesLookupResponse>