POST api/IBriefCaseSend

Request Information

URI Parameters

None.

Body Parameters

IBriefCaseSendDTO
NameDescriptionTypeAdditional information
contentKeys

Collection of IdentificatorDTO

None.

messages

Collection of MessageDTO

None.

notes

string

None.

sendDate

integer

None.

SessionID

string

None.

RepKey

IdentificatorDTO

None.

AppKey

IdentificatorDTO

None.

DeviceID

string

None.

LastUpdateDate

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "contentKeys": [
    {
      "ID": 1
    },
    {
      "ID": 1
    }
  ],
  "messages": [
    {
      "Hcp": {
        "City": "sample string 1",
        "Type": 2,
        "Specialty": "sample string 3",
        "Key": {
          "ID": 1
        },
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "Email": "sample string 6",
        "CompleteName": "sample string 7",
        "Telephone": "sample string 8",
        "UserCoverPath": "sample string 9",
        "CrypId": "sample string 10",
        "DotNameAndSurename": "sample string 11",
        "ErrorNumber": 12,
        "ErrorMessage": "sample string 13",
        "ActionResult": true,
        "OperationResult": 15,
        "UserId": 16,
        "ClientKey": "sample string 17",
        "Name": "sample string 18",
        "Surname": "sample string 19"
      },
      "Comments": "sample string 1"
    },
    {
      "Hcp": {
        "City": "sample string 1",
        "Type": 2,
        "Specialty": "sample string 3",
        "Key": {
          "ID": 1
        },
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "Email": "sample string 6",
        "CompleteName": "sample string 7",
        "Telephone": "sample string 8",
        "UserCoverPath": "sample string 9",
        "CrypId": "sample string 10",
        "DotNameAndSurename": "sample string 11",
        "ErrorNumber": 12,
        "ErrorMessage": "sample string 13",
        "ActionResult": true,
        "OperationResult": 15,
        "UserId": 16,
        "ClientKey": "sample string 17",
        "Name": "sample string 18",
        "Surname": "sample string 19"
      },
      "Comments": "sample string 1"
    }
  ],
  "notes": "sample string 1",
  "sendDate": 2,
  "SessionID": "sample string 3",
  "RepKey": {
    "ID": 1
  },
  "AppKey": {
    "ID": 1
  },
  "DeviceID": "sample string 4",
  "LastUpdateDate": 5
}

application/xml, text/xml

Sample:
<IBriefCaseSendDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceCenter.API.DTO.ServiceCenter.API.DTO.iViewer">
  <AppKey xmlns="http://schemas.datacontract.org/2004/07/ServiceCenter.API.DTO.iInteract">
    <ID>1</ID>
  </AppKey>
  <DeviceID xmlns="http://schemas.datacontract.org/2004/07/ServiceCenter.API.DTO.iInteract">sample string 4</DeviceID>
  <LastUpdateDate xmlns="http://schemas.datacontract.org/2004/07/ServiceCenter.API.DTO.iInteract">5</LastUpdateDate>
  <RepKey xmlns="http://schemas.datacontract.org/2004/07/ServiceCenter.API.DTO.iInteract">
    <ID>1</ID>
  </RepKey>
  <SessionID xmlns="http://schemas.datacontract.org/2004/07/ServiceCenter.API.DTO.iInteract">sample string 3</SessionID>
  <contentKeys xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceCenter.API.DTO.iInteract">
    <d2p1:IdentificatorDTO>
      <d2p1:ID>1</d2p1:ID>
    </d2p1:IdentificatorDTO>
    <d2p1:IdentificatorDTO>
      <d2p1:ID>1</d2p1:ID>
    </d2p1:IdentificatorDTO>
  </contentKeys>
  <messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceCenter.API.DTO.iBriefcase">
    <d2p1:MessageDTO>
      <d2p1:Comments>sample string 1</d2p1:Comments>
      <d2p1:Hcp xmlns:d4p1="http://schemas.datacontract.org/2004/07/ServiceCenter.API.DTO.iInteract">
        <d4p1:ClientKey>sample string 17</d4p1:ClientKey>
        <d4p1:Email>sample string 20</d4p1:Email>
        <d4p1:Name>sample string 18</d4p1:Name>
        <d4p1:OperationResult>15</d4p1:OperationResult>
        <d4p1:Surname>sample string 19</d4p1:Surname>
        <d4p1:UserId>16</d4p1:UserId>
        <d4p1:ActionResult>true</d4p1:ActionResult>
        <d4p1:ErrorMessage>sample string 13</d4p1:ErrorMessage>
        <d4p1:ErrorNumber>12</d4p1:ErrorNumber>
        <d4p1:CompleteName>sample string 7</d4p1:CompleteName>
        <d4p1:CrypId>sample string 10</d4p1:CrypId>
        <d4p1:DotNameAndSurename>sample string 11</d4p1:DotNameAndSurename>
        <d4p1:Email>sample string 6</d4p1:Email>
        <d4p1:FirstName>sample string 4</d4p1:FirstName>
        <d4p1:Key>
          <d4p1:ID>1</d4p1:ID>
        </d4p1:Key>
        <d4p1:LastName>sample string 5</d4p1:LastName>
        <d4p1:Telephone>sample string 8</d4p1:Telephone>
        <d4p1:UserCoverPath>sample string 9</d4p1:UserCoverPath>
        <d4p1:City>sample string 1</d4p1:City>
        <d4p1:Specialty>sample string 3</d4p1:Specialty>
        <d4p1:Type>2</d4p1:Type>
      </d2p1:Hcp>
    </d2p1:MessageDTO>
    <d2p1:MessageDTO>
      <d2p1:Comments>sample string 1</d2p1:Comments>
      <d2p1:Hcp xmlns:d4p1="http://schemas.datacontract.org/2004/07/ServiceCenter.API.DTO.iInteract">
        <d4p1:ClientKey>sample string 17</d4p1:ClientKey>
        <d4p1:Email>sample string 20</d4p1:Email>
        <d4p1:Name>sample string 18</d4p1:Name>
        <d4p1:OperationResult>15</d4p1:OperationResult>
        <d4p1:Surname>sample string 19</d4p1:Surname>
        <d4p1:UserId>16</d4p1:UserId>
        <d4p1:ActionResult>true</d4p1:ActionResult>
        <d4p1:ErrorMessage>sample string 13</d4p1:ErrorMessage>
        <d4p1:ErrorNumber>12</d4p1:ErrorNumber>
        <d4p1:CompleteName>sample string 7</d4p1:CompleteName>
        <d4p1:CrypId>sample string 10</d4p1:CrypId>
        <d4p1:DotNameAndSurename>sample string 11</d4p1:DotNameAndSurename>
        <d4p1:Email>sample string 6</d4p1:Email>
        <d4p1:FirstName>sample string 4</d4p1:FirstName>
        <d4p1:Key>
          <d4p1:ID>1</d4p1:ID>
        </d4p1:Key>
        <d4p1:LastName>sample string 5</d4p1:LastName>
        <d4p1:Telephone>sample string 8</d4p1:Telephone>
        <d4p1:UserCoverPath>sample string 9</d4p1:UserCoverPath>
        <d4p1:City>sample string 1</d4p1:City>
        <d4p1:Specialty>sample string 3</d4p1:Specialty>
        <d4p1:Type>2</d4p1:Type>
      </d2p1:Hcp>
    </d2p1:MessageDTO>
  </messages>
  <notes>sample string 1</notes>
  <sendDate>2</sendDate>
</IBriefCaseSendDTO>

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 'IBriefCaseSendDTO'.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>