POST api/v1/gstreturn/send-to-client

Request Information

URI Parameters

None.

Body Parameters

TextToDocAndNoteRequestModel
NameDescriptionTypeAdditional information
JobId

integer

None.

Mode

TextToDocAndNoteModeEnum

None.

IsInternal

boolean

None.

ListQueries

Collection of GSTReturnJobGroupQueryModel

None.

Request Formats

application/json, text/json

Sample:
{
  "JobId": 1,
  "Mode": 0,
  "IsInternal": true,
  "ListQueries": [
    {
      "IsSent": true,
      "Entity": "sample string 2",
      "Priority": 64,
      "PriorityString": "sample string 3",
      "Query": "sample string 4",
      "IdAssigedTo": 1,
      "NameAssigedTo": "sample string 5",
      "DateSent": "2025-04-28T09:15:14.8135758Z",
      "CallCount": 1,
      "Followup": "2025-04-28T09:15:14.8135758Z",
      "Job": "sample string 6",
      "Comment": "sample string 7",
      "ClientID_Subject": 8,
      "GroupSeq": "sample string 9",
      "Location": "sample string 10",
      "JobId": 11,
      "JobQueryId": 12,
      "UserId": 1,
      "QueryScope": "sample string 13"
    },
    {
      "IsSent": true,
      "Entity": "sample string 2",
      "Priority": 64,
      "PriorityString": "sample string 3",
      "Query": "sample string 4",
      "IdAssigedTo": 1,
      "NameAssigedTo": "sample string 5",
      "DateSent": "2025-04-28T09:15:14.8135758Z",
      "CallCount": 1,
      "Followup": "2025-04-28T09:15:14.8135758Z",
      "Job": "sample string 6",
      "Comment": "sample string 7",
      "ClientID_Subject": 8,
      "GroupSeq": "sample string 9",
      "Location": "sample string 10",
      "JobId": 11,
      "JobQueryId": 12,
      "UserId": 1,
      "QueryScope": "sample string 13"
    }
  ]
}

application/xml, text/xml

Sample:
<TextToDocAndNoteRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iPMS.Models.GSTReturn">
  <IsInternal>true</IsInternal>
  <JobId>1</JobId>
  <ListQueries>
    <GSTReturnJobGroupQueryModel>
      <CallCount>1</CallCount>
      <ClientID_Subject>8</ClientID_Subject>
      <Comment>sample string 7</Comment>
      <DateSent>2025-04-28T09:15:14.8135758Z</DateSent>
      <Entity>sample string 2</Entity>
      <Followup>2025-04-28T09:15:14.8135758Z</Followup>
      <GroupSeq>sample string 9</GroupSeq>
      <IdAssigedTo>1</IdAssigedTo>
      <IsSent>true</IsSent>
      <Job>sample string 6</Job>
      <JobId>11</JobId>
      <JobQueryId>12</JobQueryId>
      <Location>sample string 10</Location>
      <NameAssigedTo>sample string 5</NameAssigedTo>
      <Priority>64</Priority>
      <PriorityString>sample string 3</PriorityString>
      <Query>sample string 4</Query>
      <QueryScope>sample string 13</QueryScope>
      <UserId>1</UserId>
    </GSTReturnJobGroupQueryModel>
    <GSTReturnJobGroupQueryModel>
      <CallCount>1</CallCount>
      <ClientID_Subject>8</ClientID_Subject>
      <Comment>sample string 7</Comment>
      <DateSent>2025-04-28T09:15:14.8135758Z</DateSent>
      <Entity>sample string 2</Entity>
      <Followup>2025-04-28T09:15:14.8135758Z</Followup>
      <GroupSeq>sample string 9</GroupSeq>
      <IdAssigedTo>1</IdAssigedTo>
      <IsSent>true</IsSent>
      <Job>sample string 6</Job>
      <JobId>11</JobId>
      <JobQueryId>12</JobQueryId>
      <Location>sample string 10</Location>
      <NameAssigedTo>sample string 5</NameAssigedTo>
      <Priority>64</Priority>
      <PriorityString>sample string 3</PriorityString>
      <Query>sample string 4</Query>
      <QueryScope>sample string 13</QueryScope>
      <UserId>1</UserId>
    </GSTReturnJobGroupQueryModel>
  </ListQueries>
  <Mode>Query</Mode>
</TextToDocAndNoteRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.