POST GetCompsetSID

Request Information

URI Parameters

None.

Body Parameters

CompsetRequest
NameDescriptionTypeAdditional information
Compsets

Collection of integer

None.

OnlyHintProperties

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Compsets": [
    1,
    2
  ],
  "OnlyHintProperties": true
}

text/html

Sample:
{"Compsets":[1,2],"OnlyHintProperties":true}

application/xml, text/xml

Sample:
<CompsetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common">
  <Compsets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Compsets>
  <OnlyHintProperties>true</OnlyHintProperties>
</CompsetRequest>

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

Response Information

Resource Description

ResponseOfListOfSIDCompsetEntity
NameDescriptionTypeAdditional information
Message

string

None.

Status

boolean

None.

Body

Collection of SIDCompsetEntity

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Status": true,
  "Body": [
    {
      "SID": 1,
      "CompsetIDs": [
        1,
        1
      ]
    },
    {
      "SID": 1,
      "CompsetIDs": [
        1,
        1
      ]
    }
  ]
}

text/html

Sample:
{"Message":"sample string 1","Status":true,"Body":[{"SID":1,"CompsetIDs":[1,1]},{"SID":1,"CompsetIDs":[1,1]}]}

application/xml, text/xml

Sample:
<ResponseOfArrayOfSIDCompsetEntityQzIzD0mn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common">
  <Body>
    <SIDCompsetEntity>
      <CompsetIDs xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>1</d4p1:int>
      </CompsetIDs>
      <SID>1</SID>
    </SIDCompsetEntity>
    <SIDCompsetEntity>
      <CompsetIDs xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>1</d4p1:int>
      </CompsetIDs>
      <SID>1</SID>
    </SIDCompsetEntity>
  </Body>
  <Message>sample string 1</Message>
  <Status>true</Status>
</ResponseOfArrayOfSIDCompsetEntityQzIzD0mn>