POST dosconnect/UpdateApplicantGroup

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
ApplicantGroupID	integer	None.
ApplicantGroup	UpdateApplicantGroupModel	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "ApplicantGroupID": 2,
  "ApplicantGroup": {
    "MailingAddressTypeDD": 1,
    "ApplicantsHasSameAddressFlag": true,
    "ApplicantGroupTypeDD": 2
  }
}

application/xml, text/xml

Sample:

<UpdateApplicantGroupInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <APIKey>sample string 1</APIKey>
  <ApplicantGroup>
    <ApplicantGroupTypeDD>2</ApplicantGroupTypeDD>
    <ApplicantsHasSameAddressFlag>true</ApplicantsHasSameAddressFlag>
    <MailingAddressTypeDD>1</MailingAddressTypeDD>
  </ApplicantGroup>
  <ApplicantGroupID>2</ApplicantGroupID>
</UpdateApplicantGroupInput>

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

Response Information

Resource Description

UpdateBaseOutput

Name	Description	Type	Additional information
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<UpdateBaseOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
</UpdateBaseOutput>