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
"use strict";
export class RfpDocument {
    /** @param {{RfpDocumentID?:number,RfpDocumentUID?:string,FileName?:string,ContentType?:string,ContentLength?:number,S3Key?:string,Status?:string,ErrorMessage?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,ParentRfpDocumentID?:number,DocumentType?:string,IsActive?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RfpDocumentID;
    /** @type {string} */
    RfpDocumentUID;
    /** @type {string} */
    FileName;
    /** @type {string} */
    ContentType;
    /** @type {number} */
    ContentLength;
    /** @type {string} */
    S3Key;
    /** @type {string} */
    Status;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    CreatedBy;
    /** @type {string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
    /** @type {?number} */
    ParentRfpDocumentID;
    /** @type {string} */
    DocumentType;
    /** @type {boolean} */
    IsActive;
}
export class RfpChildrenResponse {
    /** @param {{ResponseStatus?:ResponseStatus,RfpDocumentID?:number,Documents?:RfpDocument[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {number} */
    RfpDocumentID;
    /** @type {RfpDocument[]} */
    Documents = [];
}
export class RfpDeactivateDocumentRequest {
    /** @param {{RfpDocumentUID?:string,ChildRfpDocumentUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RfpDocumentUID;
    /** @type {string} */
    ChildRfpDocumentUID;
}

JavaScript 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>