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

export class RfpDocument
{
    public RfpDocumentID: number;
    public RfpDocumentUID: string;
    public FileName: string;
    public ContentType: string;
    public ContentLength: number;
    public S3Key: string;
    public Status: string;
    public ErrorMessage: string;
    public CreatedBy: string;
    public CreatedAt: string;
    public UpdatedAt?: string;
    public ParentRfpDocumentID?: number;
    public DocumentType: string;
    public IsActive: boolean;

    public constructor(init?: Partial<RfpDocument>) { (Object as any).assign(this, init); }
}

export class RfpChildrenResponse
{
    public ResponseStatus: ResponseStatus;
    public RfpDocumentID: number;
    public Documents: RfpDocument[] = [];

    public constructor(init?: Partial<RfpChildrenResponse>) { (Object as any).assign(this, init); }
}

export class RfpDeactivateDocumentRequest
{
    public RfpDocumentUID: string;
    public ChildRfpDocumentUID: string;

    public constructor(init?: Partial<RfpDeactivateDocumentRequest>) { (Object as any).assign(this, init); }
}

TypeScript RfpDeactivateDocumentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RfpDocumentUID: 00000000000000000000000000000000,
	ChildRfpDocumentUID: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	RfpDocumentID: 0,
	Documents: 
	[
		{
			RfpDocumentID: 0,
			RfpDocumentUID: 00000000000000000000000000000000,
			FileName: String,
			ContentType: String,
			ContentLength: 0,
			S3Key: String,
			Status: String,
			ErrorMessage: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			ParentRfpDocumentID: 0,
			DocumentType: String,
			IsActive: False
		}
	]
}