Reference for http://api2.redtailtechnology.com/crm/v1/rest/contacts/{CONTACTID}/workflow
Url: http://api2.redtailtechnology.com/crm/v1/rest/contacts/{CONTACTID}/workflow
HTTP Method: PUT
| Message direction | Format | Body |
|---|---|---|
| Request | Xml | Example,Schema |
| Request | Json | Example |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example request Xml body:
<ClientWorkflowUpdate xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Workflow"> <ClientID>2147483647</ClientID> <Complete>true</Complete> <Description>String content</Description> <EndDate>1999-05-31T11:20:00</EndDate> <GroupID>2147483647</GroupID> <Name>String content</Name> <Owner>2147483647</Owner> <RecID>2147483647</RecID> <ResultID>2147483647</ResultID> <StartDate>1999-05-31T11:20:00</StartDate> <StepDescription>String content</StepDescription> <StepID>2147483647</StepID> <Note>String content</Note> </ClientWorkflowUpdate>
The following is an example request Json body:
{
"ClientID":2147483647,
"Complete":true,
"Description":"String content",
"EndDate":"\/Date(928149600000+0000)\/",
"GroupID":2147483647,
"Name":"String content",
"Owner":2147483647,
"RecID":2147483647,
"ResultID":2147483647,
"StartDate":"\/Date(928149600000+0000)\/",
"StepDescription":"String content",
"StepID":2147483647,
"Note":"String content"
}
The following is an example response Xml body:
<ClientWorkflowUpdate xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Workflow"> <ClientID>2147483647</ClientID> <Complete>true</Complete> <Description>String content</Description> <EndDate>1999-05-31T11:20:00</EndDate> <GroupID>2147483647</GroupID> <Name>String content</Name> <Owner>2147483647</Owner> <RecID>2147483647</RecID> <ResultID>2147483647</ResultID> <StartDate>1999-05-31T11:20:00</StartDate> <StepDescription>String content</StepDescription> <StepID>2147483647</StepID> <Note>String content</Note> </ClientWorkflowUpdate>
The following is an example response Json body:
{
"ClientID":2147483647,
"Complete":true,
"Description":"String content",
"EndDate":"\/Date(928149600000+0000)\/",
"GroupID":2147483647,
"Name":"String content",
"Owner":2147483647,
"RecID":2147483647,
"ResultID":2147483647,
"StartDate":"\/Date(928149600000+0000)\/",
"StepDescription":"String content",
"StepID":2147483647,
"Note":"String content"
}
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Workflow" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Workflow" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ClientWorkflowUpdate">
<xs:complexContent mixed="false">
<xs:extension base="tns:ClientWorkflow">
<xs:sequence>
<xs:element minOccurs="0" name="Note" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="ClientWorkflowUpdate" nillable="true" type="tns:ClientWorkflowUpdate" />
<xs:complexType name="ClientWorkflow">
<xs:sequence>
<xs:element minOccurs="0" name="ClientID" type="xs:int" />
<xs:element minOccurs="0" name="Complete" type="xs:boolean" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="EndDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="GroupID" type="xs:int" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Owner" type="xs:int" />
<xs:element minOccurs="0" name="RecID" type="xs:int" />
<xs:element minOccurs="0" name="ResultID" type="xs:int" />
<xs:element minOccurs="0" name="StartDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="StepDescription" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StepID" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="ClientWorkflow" nillable="true" type="tns:ClientWorkflow" />
</xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Workflow" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Workflow" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ClientWorkflowUpdate">
<xs:complexContent mixed="false">
<xs:extension base="tns:ClientWorkflow">
<xs:sequence>
<xs:element minOccurs="0" name="Note" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="ClientWorkflowUpdate" nillable="true" type="tns:ClientWorkflowUpdate" />
<xs:complexType name="ClientWorkflow">
<xs:sequence>
<xs:element minOccurs="0" name="ClientID" type="xs:int" />
<xs:element minOccurs="0" name="Complete" type="xs:boolean" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="EndDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="GroupID" type="xs:int" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Owner" type="xs:int" />
<xs:element minOccurs="0" name="RecID" type="xs:int" />
<xs:element minOccurs="0" name="ResultID" type="xs:int" />
<xs:element minOccurs="0" name="StartDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="StepDescription" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StepID" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="ClientWorkflow" nillable="true" type="tns:ClientWorkflow" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>