POST api/TopGetDossierStatus

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ProcessId	string	None.
CompanyId	string	None.
reason	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ProcessId": "sample string 1",
  "CompanyId": "sample string 2",
  "reason": "sample string 3"
}

application/xml, text/xml

Sample:

<RequestDossier xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IT.CarmerFirma.Application.DTO.TopDTO">
  <CompanyId>sample string 2</CompanyId>
  <ProcessId>sample string 1</ProcessId>
  <reason>sample string 3</reason>
</RequestDossier>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseGetDossierStatus

Name	Type	Additional information
Status	string	None.
MsgStatus	string	None.
Data	dossierstatus	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "MsgStatus": "sample string 2",
  "Data": {
    "businessidField": "sample string 1",
    "statusField": "sample string 2",
    "creationdateField": "2023-10-04T11:08:13.3727173-05:00",
    "creationdateFieldSpecified": true,
    "lastactivitydateField": "2023-10-04T11:08:13.3727173-05:00",
    "lastactivitydateFieldSpecified": true,
    "actionField": [
      {
        "timestampField": "2023-10-04T11:08:13.3727173-05:00",
        "errorField": {
          "codField": "sample string 1",
          "msgField": "sample string 2"
        },
        "actionField": "sample string 2",
        "serviceField": "sample string 3",
        "successField": true
      },
      {
        "timestampField": "2023-10-04T11:08:13.3727173-05:00",
        "errorField": {
          "codField": "sample string 1",
          "msgField": "sample string 2"
        },
        "actionField": "sample string 2",
        "serviceField": "sample string 3",
        "successField": true
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseGetDossierStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IT.CarmerFirma.Application.DTO.TopDTO">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/IT.CarmerFirma.Domain.Core.ServiceTop">
    <d2p1:actionField>
      <d2p1:dossieractionresult>
        <d2p1:actionField>sample string 2</d2p1:actionField>
        <d2p1:errorField>
          <d2p1:codField>sample string 1</d2p1:codField>
          <d2p1:msgField>sample string 2</d2p1:msgField>
        </d2p1:errorField>
        <d2p1:serviceField>sample string 3</d2p1:serviceField>
        <d2p1:successField>true</d2p1:successField>
        <d2p1:timestampField>2023-10-04T11:08:13.3727173-05:00</d2p1:timestampField>
      </d2p1:dossieractionresult>
      <d2p1:dossieractionresult>
        <d2p1:actionField>sample string 2</d2p1:actionField>
        <d2p1:errorField>
          <d2p1:codField>sample string 1</d2p1:codField>
          <d2p1:msgField>sample string 2</d2p1:msgField>
        </d2p1:errorField>
        <d2p1:serviceField>sample string 3</d2p1:serviceField>
        <d2p1:successField>true</d2p1:successField>
        <d2p1:timestampField>2023-10-04T11:08:13.3727173-05:00</d2p1:timestampField>
      </d2p1:dossieractionresult>
    </d2p1:actionField>
    <d2p1:businessidField>sample string 1</d2p1:businessidField>
    <d2p1:creationdateField>2023-10-04T11:08:13.3727173-05:00</d2p1:creationdateField>
    <d2p1:creationdateFieldSpecified>true</d2p1:creationdateFieldSpecified>
    <d2p1:lastactivitydateField>2023-10-04T11:08:13.3727173-05:00</d2p1:lastactivitydateField>
    <d2p1:lastactivitydateFieldSpecified>true</d2p1:lastactivitydateFieldSpecified>
    <d2p1:statusField>sample string 2</d2p1:statusField>
  </Data>
  <MsgStatus>sample string 2</MsgStatus>
  <Status>sample string 1</Status>
</ResponseGetDossierStatus>