DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileDetailsWithQueuedDocumentAsNewVersion

Requires Authentication
GetRegistrationprofileDetailsWithQueuedDocumentAsNewVersion Parameters:
NameParameterData TypeRequiredDescription
DocumentIDqueryGuidNo
QueueDocumentIdqueryintNo
IsOffice365ContextqueryboolNo
RegistrationprofileDetails Parameters:
NameParameterData TypeRequiredDescription
StepsformList<RegistrationprofileStep>No
MessagesformList<InformationMessageBase>No
ReadOnlyformboolNo
Registrationprofile Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
NameformstringNo
HintformstringNo
OrderformintNo
RegisterAutomaticallyformboolNo
RegisterInBackgroundformboolNo
ThumbnailUrlformstringNo
ProgCodeformstringNo
VersionControlTypeformintNo
WOPlaceLogoformintNo
WOPrinterBinsformstringNo
SelectAllFilesformboolNo
RegistrationprofileStep Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
NameformstringNo
OrderformintNo
LayoutformRegistrationprofileStepLayoutNo
GroupsformList<RegistrationprofileGroup>No
RegistrationprofileGroup Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
NameformstringNo
LabelformstringNo
OrderformintNo
ColumnIndexformintNo
FieldsformList<RegistrationprofileField>No
LabelLayoutTypeformintNo
RegistrationprofileField Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
DocumentFieldIDformGuidNo
LabelformstringNo
UserControlTypeformstringNo
UserControlPropertiesformList<SerializableKeyValuePair<String,Object>>No
HintformstringNo
OrderformintNo
HasDependableFieldsformboolNo
EntityNameformstringNo
StateformRegistrationProfileFieldStateBaseNo
RegistrationProfileFieldStateBase Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
RequiredformboolNo
VisibleformboolNo
ReadonlyformboolNo
InformationMessageBase Parameters:
NameParameterData TypeRequiredDescription
TypeformMessageTypeNo
SummaryformstringNo
FullMessageformstringNo
FieldNameformstringNo
KeepOpenformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/GetRegistrationprofileDetailsWithQueuedDocumentAsNewVersion HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"__type":"IDB.API.DTO.Registrationprofile.Operations.GetRegistrationprofileDetailsWithQueuedDocumentAsNewVersion, IDB.API.DTO","DocumentID":"00000000-0000-0000-0000-000000000000","QueueDocumentId":0,"IsOffice365Context":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"__type":"IDB.API.DTO.Registrationprofile.RegistrationprofileDetails, IDB.API.DTO","Steps":[{"__type":"IDB.API.DTO.Registrationprofile.RegistrationprofileStep, IDB.API.DTO","ID":"00000000-0000-0000-0000-000000000000","Name":"String","Order":0,"Layout":"OneColumn_12","Groups":[{"__type":"IDB.API.DTO.Registrationprofile.RegistrationprofileGroup, IDB.API.DTO","ID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Order":0,"ColumnIndex":0,"Fields":[{"__type":"IDB.API.DTO.Registrationprofile.RegistrationprofileField, IDB.API.DTO","ID":"00000000-0000-0000-0000-000000000000","DocumentFieldID":"00000000-0000-0000-0000-000000000000","Label":"String","UserControlType":"String","UserControlProperties":[{}],"Hint":"String","Order":0,"HasDependableFields":false,"EntityName":"String","State":{"__type":"IDB.API.DTO.Registrationprofile.RegistrationProfileFieldStateBase, IDB.API.DTO","DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}}],"LabelLayoutType":0}]}],"Messages":[{}],"ReadOnly":false,"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Hint":"String","Order":0,"RegisterAutomatically":false,"RegisterInBackground":false,"ThumbnailUrl":"String","ProgCode":"String","VersionControlType":0,"WOPlaceLogo":0,"WOPrinterBins":"String","SelectAllFiles":false}