POST api/sign/cancel

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
JobId	string	Required
Subject	string	Required
Text	string	Required
CancelConfirmTo	Collection of string	Required
CancelSignatureReason	string	Required
ExtraParams	Collection of Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "JobId": "sample string 1",
  "Subject": "sample string 2",
  "Text": "sample string 3",
  "CancelConfirmTo": [
    "sample string 1",
    "sample string 2"
  ],
  "CancelSignatureReason": "sample string 4",
  "ExtraParams": [
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<JobCancellation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProjectPortal.SignAPI.Models">
  <CancelConfirmTo xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CancelConfirmTo>
  <CancelSignatureReason>sample string 4</CancelSignatureReason>
  <ExtraParams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
    </d2p1:ArrayOfKeyValueOfstringstring>
    <d2p1:ArrayOfKeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
    </d2p1:ArrayOfKeyValueOfstringstring>
  </ExtraParams>
  <JobId>sample string 1</JobId>
  <Subject>sample string 2</Subject>
  <Text>sample string 3</Text>
</JobCancellation>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'JobCancellation'.

Response Information

Resource Description

ResponseObj

Name	Description	Type	Additional information
job_id		string	None.
message		string	None.

Response Formats

application/json, text/json

Sample:

{
  "job_id": "sample string 1",
  "message": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseObj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProjectPortal.SignAPI.Models">
  <job_id>sample string 1</job_id>
  <message>sample string 2</message>
</ResponseObj>