Trendsic Platform Service

<back to all web services

RfpDeactivateDocumentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/Rfp/{RfpDocumentUID}/Documents/{ChildRfpDocumentUID}/Deactivate
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class RfpDeactivateDocumentRequest
    {
        public UUID RfpDocumentUID = null;
        public UUID ChildRfpDocumentUID = null;
        
        public UUID getRfpDocumentUID() { return RfpDocumentUID; }
        public RfpDeactivateDocumentRequest setRfpDocumentUID(UUID value) { this.RfpDocumentUID = value; return this; }
        public UUID getChildRfpDocumentUID() { return ChildRfpDocumentUID; }
        public RfpDeactivateDocumentRequest setChildRfpDocumentUID(UUID value) { this.ChildRfpDocumentUID = value; return this; }
    }

    public static class RfpChildrenResponse
    {
        public ResponseStatus ResponseStatus = null;
        public Integer RfpDocumentID = null;
        public ArrayList<RfpDocument> Documents = new ArrayList<RfpDocument>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RfpChildrenResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public Integer getRfpDocumentID() { return RfpDocumentID; }
        public RfpChildrenResponse setRfpDocumentID(Integer value) { this.RfpDocumentID = value; return this; }
        public ArrayList<RfpDocument> getDocuments() { return Documents; }
        public RfpChildrenResponse setDocuments(ArrayList<RfpDocument> value) { this.Documents = value; return this; }
    }

    public static class RfpDocument
    {
        public Integer RfpDocumentID = null;
        public UUID RfpDocumentUID = null;
        public String FileName = null;
        public String ContentType = null;
        public Long ContentLength = null;
        public String S3Key = null;
        public String Status = null;
        public String ErrorMessage = null;
        public String CreatedBy = null;
        public Date CreatedAt = null;
        public Date UpdatedAt = null;
        public Integer ParentRfpDocumentID = null;
        public String DocumentType = null;
        public Boolean IsActive = null;
        
        public Integer getRfpDocumentID() { return RfpDocumentID; }
        public RfpDocument setRfpDocumentID(Integer value) { this.RfpDocumentID = value; return this; }
        public UUID getRfpDocumentUID() { return RfpDocumentUID; }
        public RfpDocument setRfpDocumentUID(UUID value) { this.RfpDocumentUID = value; return this; }
        public String getFileName() { return FileName; }
        public RfpDocument setFileName(String value) { this.FileName = value; return this; }
        public String getContentType() { return ContentType; }
        public RfpDocument setContentType(String value) { this.ContentType = value; return this; }
        public Long getContentLength() { return ContentLength; }
        public RfpDocument setContentLength(Long value) { this.ContentLength = value; return this; }
        public String getS3Key() { return S3Key; }
        public RfpDocument setS3Key(String value) { this.S3Key = value; return this; }
        public String getStatus() { return Status; }
        public RfpDocument setStatus(String value) { this.Status = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public RfpDocument setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public RfpDocument setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public RfpDocument setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public Date getUpdatedAt() { return UpdatedAt; }
        public RfpDocument setUpdatedAt(Date value) { this.UpdatedAt = value; return this; }
        public Integer getParentRfpDocumentID() { return ParentRfpDocumentID; }
        public RfpDocument setParentRfpDocumentID(Integer value) { this.ParentRfpDocumentID = value; return this; }
        public String getDocumentType() { return DocumentType; }
        public RfpDocument setDocumentType(String value) { this.DocumentType = value; return this; }
        public Boolean getIsActive() { return IsActive; }
        public RfpDocument setIsActive(Boolean value) { this.IsActive = value; return this; }
    }

}

Java RfpDeactivateDocumentRequest DTOs

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 /v1/Rfp/{RfpDocumentUID}/Documents/{ChildRfpDocumentUID}/Deactivate HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RfpDeactivateDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChildRfpDocumentUID>00000000-0000-0000-0000-000000000000</ChildRfpDocumentUID>
  <RfpDocumentUID>00000000-0000-0000-0000-000000000000</RfpDocumentUID>
</RfpDeactivateDocumentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RfpChildrenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Documents>
    <RfpDocument>
      <ContentLength>0</ContentLength>
      <ContentType>String</ContentType>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DocumentType>String</DocumentType>
      <ErrorMessage>String</ErrorMessage>
      <FileName>String</FileName>
      <IsActive>false</IsActive>
      <ParentRfpDocumentID>0</ParentRfpDocumentID>
      <RfpDocumentID>0</RfpDocumentID>
      <RfpDocumentUID>00000000-0000-0000-0000-000000000000</RfpDocumentUID>
      <S3Key>String</S3Key>
      <Status>String</Status>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </RfpDocument>
  </Documents>
  <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>
  <RfpDocumentID>0</RfpDocumentID>
</RfpChildrenResponse>