POST api/download/genericobjects

Generic Object Information.

Request Information

URI Parameters

None.

Body Parameters

GenericObjectRequest
NameDescriptionTypeAdditional information
GenericObjectTypeId

Generic Object Type Id

 GenericObjectType

None.
TokenGuidId

User GUID - TokenGuidId is a 128-bit globally unique identifier. It is a combination of letters and numbers.

 string

Required

String length: inclusive between 36 and 38

Request Formats

application/json, text/json

Sample: 
{
  "GenericObjectTypeId": 0,
  "TokenGuidId": "sample string 1"
}

application/xml, text/xml

Sample: 
<GenericObjectRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PrecinctAtlasWeb.API.Models.Download">
  <TokenGuidId xmlns="http://schemas.datacontract.org/2004/07/PrecinctAtlasWeb.API.Models">sample string 1</TokenGuidId>
  <GenericObjectTypeId>ChallengeReasons</GenericObjectTypeId>
</GenericObjectRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Success status and message

ReturnMessage
NameDescriptionTypeAdditional information
IsSuccessStatusCode

boolean

None.
StatusCode

HttpStatusCode

None.
Message

Collection of string

None.
ErrorType

string

None.
ErrorCode

string

None.
PayLoadItemCount

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccessStatusCode": false,
  "StatusCode": 100,
  "Message": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorType": "sample string 1",
  "ErrorCode": "sample string 2",
  "PayLoadItemCount": 1
}

application/xml, text/xml

Sample: 
<ReturnMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PrecinctAtlasWeb.API.Models">
  <ErrorCode>sample string 2</ErrorCode>
  <ErrorType>sample string 1</ErrorType>
  <Message xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Message>
  <PayLoadItemCount>1</PayLoadItemCount>
  <StatusCode>Continue</StatusCode>
</ReturnMessage>