digitaluapi

<back to all web services

PartnerInvitesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/partner_invites
PartnerInvitesAdd Parameters:
NameParameterData TypeRequiredDescription
TemplateTextbodystringNo
InviteGuidbodyGuidYes
PartnerAppUserIdbodyintYes
DateCreatedbodyDateTimeOffsetYes
DateSentbodyDateTimeOffset?No
RecipientsbodystringYes
ReferencebodystringNo
RetryCountbodyintYes
StatusCodesIdbodylongYes
PartnerInvitesAddResponse Parameters:
NameParameterData TypeRequiredDescription
TemplateTextformstringNo
InviteGuidformGuidNo
PartnerAppUserIdformintNo
DateCreatedformDateTimeOffsetNo
DateSentformDateTimeOffset?No
RecipientsformstringNo
ReferenceformstringNo
RetryCountformintNo
StatusCodesIdformlongNo
ResponseStatusformResponseStatusNo

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.

POST /partner_invites HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PartnerInvitesAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <TemplateText>String</TemplateText>
  <InviteGuid>00000000-0000-0000-0000-000000000000</InviteGuid>
  <PartnerAppUserId>0</PartnerAppUserId>
  <DateCreated xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateCreated>
  <DateSent xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateSent>
  <Recipients>String</Recipients>
  <Reference>String</Reference>
  <RetryCount>0</RetryCount>
  <StatusCodesId>0</StatusCodesId>
</PartnerInvitesAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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