POST api/CrmPush?projectUid={projectUid}&crmProfileUid={crmProfileUid}&documentKind={documentKind}&jobUid={jobUid}&version={version}&printTemplate={printTemplate}

Request Information

URI Parameters

Name	Type	Additional information
projectUid	string	Required
crmProfileUid	string	Required
documentKind	string	Required
jobUid	string	Required
version	string	None.
printTemplate	string	None.

Body Parameters

None.

Response Information

Resource Description

CrmPushResponse

Name	Type	Additional information
ResponseCode	integer	None.
ErrorString	string	None.
Success	boolean	None.
ScenariosPushed	integer	None.
ScenariosSkipped	integer	None.
Errors	Collection of string	None.
Warnings	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "errorString": "sample string 2",
  "success": true,
  "scenariosPushed": 4,
  "scenariosSkipped": 5,
  "errors": [
    "sample string 1",
    "sample string 2"
  ],
  "warnings": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<CrmPushResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ErrorString>sample string 2</ErrorString>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <ResponseCode>1</ResponseCode>
  <ScenariosPushed>4</ScenariosPushed>
  <ScenariosSkipped>5</ScenariosSkipped>
  <Success>true</Success>
  <Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Warnings>
</CrmPushResponse>