Webservices CITSmart Docs

esta seção destina se a descrever a estrutura de comunicação rest, estabelecida entre aplicativos e o servidor back end atenção citsmart url prefixo de url inalterável, para que você possa acessar os serviços disponibilizados para os aplicativos de mobile todo api que necessita de “sessionid” precisará estar na seção fornecida pelo “login” da api login serviço de autentificação do usuário method get url /cit portal web/rest/usuario/gettoken request { 	"username" "rogerio cassimiro", 	"password" "123456" 	} response { 	"id" 25080, 	"dateedition" "2017 09 12t11 06 28 907 0300", 	"datecreation" "2017 08 10t10 00 51 274 0300", 	"username" "rogerio cassimiro", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074", 	"name" "rogerio cassimiro", 	"version" " 59" 	} fields solicitação 	 username alfanumérico não vazio nem nulo; 	 password alfanumérico não vazio nem nulo; 	resposta 	 id numérico não vazio nem nulo; 	 dateedition timestamp não vazio nem nulo; 	 datecreation timestamp não vazio nem nulo; 	 username alfanumérico não vazio nem nulo; 	 token alfanumérico não vazio nem nulo; 	 name alfanumérico não vazio nem nulo; 	 version numérico não vazio nem nulo; lista departmento lista de serviços dos departamentos a serem usados method get /cit ecm web/integracao /listunidade request { 	"name" "department 1", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response 	 	{ 	"units" \[ 	{ 	"id" 93794, 	"name" "department 1", 	"code" "000001" 	} 	] 	} fields solicitação 	 name alfanumérico não vazio nem nulo 	 token alfanumérico não vazio nem nulo 	resposta 	 units lista vazia e não nula; 	 id numérico não vazio nem nulo 	 name alfanumérico não vazio nem nulo 	 code alfanumérico não vazio nem nulo lista tipo de processo serviço de listagem do tipo de processo de um processo, a ser usado method get /cit ecm web/integracao/listtipoprocesso request { 	"name" "department 1", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"typeprocess" \[ 	{ 	"id" 6967, 	"name" "pattern process", 	"description" "pattern process detailing" 	} 	] 	} fields solicitação 	 name alfanumérico não vazio nem nulo 	 token alfanumérico não vazio nem nulo 	resposta 	 typeprocess lista vazia e não nula; 	 id numérico não vazio nem nulo 	 name alfanumérico não vazio nem nulo 	 description alfanumérico não vazio nem nulo lista nível de acesso do tipo de processo o serviço de listagem de assunto de um processo e / ou documento, a ser usado method get /cit ecm web/integracao/listnivelacessotipoprocesso request { 	"idtypeprocess" "54654", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"levelaccesstypeprocess" \[ 	{ 	"idlevelaccesstypeprocess" 97942, 	"idlevelaccess " "23121", 	"name" "public" 	}, 	{ 	"idlevelaccesstypeprocess" 97947, 	" idlevelaccess" 91426, 	"name" "restrict" 	} 	] 	} fields solicitação idtypeprocess numérico não vazio nem nulo 	 token alfanumérico não vazio nem nulo 	resposta 	 levelaccesstypeprocess lista não vazia nem nula; 	 idlevelaccess numérico não vazio nem nulo 	 idlevelaccesstypeprocess numérico não vazio nem nulo name alfanumérico não vazio nem nulo lista nível de acesso do tipo de documento o serviço de listagem de assunto de um processo e / ou documento, a ser usado method get /cit ecm web/integracao/listnivelacessotipodocumento request { 	"idtypedocument" "54654", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"levelaccesstypedocument" \[ 	{ 	"idlevelaccesstypedocument" 97942, 	" idlevelaccess " "23121", 	"name" "public" 	}, 	{ 	"idlevelaccesstypedocument " 97947, 	"idlevelaccess" 91426, 	"name" "restricted" 	} 	] 	} fields solicitação 	 idtypedocument numérico não vazio nem nulo 	 token alfanumérico não vazio nem nulo 	resposta 	 levelaccestypedocument lista não vazia nem nula; 	 idlevelaccess numérico não vazio nem nulo 	 idlevelaccesstypedocument numérico não vazio nem nulo name alfanumérico não vazio nem nulo lista de assunto o serviço de listagem de assunto de um processo e / ou documento, a ser usado method get /cit ecm web/integracao/listassunto request { 	"name" "hearing meetings" 	"code" "010 3", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"subjects" \[ 	{ 	"id" 6982, 	"code" "010 3", 	"name" "hearing meetings", 	"subject" "010 3 – administration general " 	} 	] 	} fields solicitação 	 name alfanumérico não vazio nem nulo 	 code alfanumérico não vazio nem nulo 	 token alfanumérico não vazio nem nulo resposta 	 subjects lista vazia e não nula; 	 id numérico não vazio nem nulo 	 code alfanumérico não vazio nem nulo 	 name alfanumérico não vazio nem nulo 	 subject alfanumérico não vazio nem nulo lista de hipóteses legais lista de hipóteses legais de um processo ou documento a ser utilizado method get /cit ecm web/integracao/listhipoteselegal request { 	"idlevelaccess" "97947", 	"name" "information name", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"hypoteselegal" \[ 	{ 	"id" 7340, 	"description" "law description", 	"name" "information name" 	} 	] 	} fields solicitação 	 idlevelaccess numérico não vazio nem nulo 	 name alfanumérico não vazio nem nulo 	 token alfanumérico não vazio nem nulo 	resposta 	 hypoteselegal lista vazia e não nula; 	 id numérico não vazio nem nulo description alfanumérico não vazio nem nulo 	 name alfanumérico não vazio nem nulo lista de pessoas lista de pessoas interessadas em um processo ou documento a ser utilizado method get /cit ecm web/integracao/listpessoas request { 	"name" "maycon", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"people" \[ 	{ 	"id" 98064, 	"name" "maycon" 	} 	] 	} fields solicitação 	 name alfanumérico não vazio nem nulo 	 token alfanumérico não vazio nem nulo 	resposta 	 people lista vazia e não nula; 	 id numérico não vazio nem nulo name alfanumérico não vazio nem nulo lista da forma de conferência lista dos formulários de conferência de um processo e/ou documento, a ser usado method get /cit ecm web/integracao/listformaconferencia request { 	"name" "administrative certified copy", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"formconference" \[ 	{ 	"id" 97484, 	"name" "administrative certified copy" 	} 	] 	} fields solicitação 	 name alfanumérico não vazio nem nulo 	 token alfanumérico não vazio nem nulo 	resposta 	 formaconference lista vazia e não nula; 	 id numérico não vazio nem nulo 	 name alfanumérico não vazio nem nulo lista de tipos de mídia lista de tipos de mídia para um documento a ser utilizado method get /cit ecm web/integracao/listtiposuporte request { 	"name" "name type media", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"typesupport" \[ 	{ 	"id" 97975, 	"name" "name type media" 	} 	] 	} 	 fields solicitação 	 name alfanumérico não vazio nem nulo 	 token alfanumérico não vazio nem nulo 	resposta 	 typesupport lista vazia e não nula; 	 id numérico não vazio nem nulo 	 name alfanumérico não vazio nem nulo lista tipos de documento serviço de listagem de tipos de documentos de um documento a ser utilizado method get /cit ecm web/integracao/listtipodocumento request { 	"name" "document type name", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"typedocument" \[ 	{ 	"id" 97949, 	"name" "document type name" 	} 	] 	} fields solicitação 	 name alfanumérico não vazio nem nulo 	 token alfanumérico não vazio nem nulo 	resposta 	 typedocument lista vazia e não nula; 	 id numérico não vazio nem nulo 	 name alfanumérico não vazio nem nulo criar processo serviço de criação de um processo method post /cit ecm web/integracao/processo request { 	"assuntocomplementar" "subject detail", 	"observacaogeral" "general observation", 	"unidade" { 	"id" 40358 	}, 	"tipoprocesso" { 	"id" 40394 	}, 	"nivelacesso" { 	"idnivelacessotipoprocesso" 40395 	}, 	"assunto" { 	"id" 40393 	}, 	"interessados" \[ 	{ 	"interessado" { 	"id" 40355 	} 	} 	], 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"id" "25353", 	"nup" "00001 00002/2016 58" 	} fields solicitação subjectcomplementary alfanumérico não vazio nem nulo 	 observationgeneral alfanumérico não vazio nem nulo 	 unit não vazio nem nulo; 	 id não vazio nem nulo; 	 typeprocess não vazio nem nulo; 	 id não vazio nem nulo; 	 levelaccess não vazio nem nulo; 	 idlevelaccesstypeprocess não vazio nem nulo; 	 hypoteselegal não vazio nem nulo se o nível de acesso difere de público 	 id númerico não vazio nem nulo 	 subject não vazio nem nulo; id não vazio nem nulo; 	 interested pode ser vazio e nulo; 	 pessoal 	 token alfanumérico não vazio nem nulo 	resposta 	 id numérico não vazio nem nulo 	 nup alfanumérico não vazio nem nulo criar documento serviço de ciração de documento method post /cit ecm web/integracao/documento request { 	"numero" "9999", 	"assuntocomplementar" "complementary subject", 	"datareferencia" "2016 08 19t14 45 25 360 0300", 	"unidade" { 	"id" 40358 	}, 	"processo" { 	"id" 40503 	}, 	"tipodocumento" { 	"id" 40426 	}, 	"nivelacesso" { 	"idnivelacessotipodocumento" 40427 	}, 	"hipoteselegal" { 	"id" 5658 	}, 	"assunto" { 	"id" 40393 	}, 	"destinatario" { 	"id" 40355 	}, 	"tiposuportedocumento" { 	"id" 40430 	}, 	"interessados" \[ 	{ 	"interessado" { 	"id" 40355 	} 	} 	], 	"tipoconferencia" { 	"id" 39950 	}, 	"localizacao" "physical location", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"id" "25353", 	"numero" "00001 00002/2016 58" 	} fields solicitação 	 numero alfanumérico não vazio nem nulo; 	 assuntocomplementar alfanumérico não vazio nem nulo; 	 localização alfanumérico não vazio nem nulo; 	 conteudo não vazio nem nulo; 	 o conteúdo do documento deve ser enviado em base64 	 datareferencia timestamp não vazio nem nulo; 	 unidade não vazio nem nulo; 	 id numérico não vazio nem nulo 	 processo não vazio nem nulo; 	 id numérico não vazio nem nulo 	 tipodocumento não vazio nem nulo; 	 id numérico não vazio nem nulo 	 nivelacesso não vazio nem nulo; 	 idnivelacessotipoprocesso numérico não vazio nem nulo 	 hipoteselegal não vazio nem nulo, se o nível de acesso for diferente de público; 	 id numérico não vazio nem nulo 	 assunto não vazio nem nulo; 	 id numérico não vazio nem nulo 	 destinatario não vazio nem nulo; 	 pessoa não vazio nem nulo; 	 id numérico não vazio nem nulo 	 tiposuportedocumento não vazio nem nulo; 	 interessados pode ser vazio e nulo; 	 pessoa não vazio nem nulo; 	 id numérico não vazio nem nulo 	 tipoconferencia boolean não vazio nem nulo; 	 localização alfanumérico não vazio nem nulo, se o atributo tipoconferencia for true; 	 token alfanumérico não vazio nem nulo; 	resposta 	 id numérico não vazio nem nulo; 	 numero não vazio nem nulo; documento upload serviço de criação de documento method post /cit ecm web/integracao/uploadanexo request { 	"file" "9999", 	"iddocumento" "25353", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response n/a fields solicitação iddocumento numérico não vazio nem nulo 	 file não vazio nem nulo 	 token alfanumérico não vazio nem nulo get by id process serviço que recupera detalhes de um processo, de acordo com seu identificador method get /cit ecm web/integracao/getbyidprocesso request { 	"id" 6967 	} response { 	"id" "5252", 	"assuntocomplementar" "complementary subject", 	"observacaogeral" "general observation", 	"datareferencia"\ null, 	"situacao" "in progress", 	"tipoprocesso" { 	"id" 97930, 	"nome" "type reserved process" 	}, 	"nivelacesso" { 	" idnivelacessotipoprocesso " 91428, 	"descricao" "public" 	}, 	"hipoteselegal" { 	"id" 97841, 	"nome" "information name" 	}, 	"assunto" { 	"id" 97839, 	"nome" "adm", 	"assunto" "0001 adm " 	}, 	"interessados" \[ 	{ 	"pessoas" { 	"id" 98064, 	"nome" "maycon" 	} 	} 	], 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} fields solicitação id numérico não vazio nem nulo 	 token alfanumérico não vazio nem nulo 	resposta 	 assuntocomplementar alfanumérico não vazio nem nulo 	 observacaogeral alfanumérico não vazio nem nulo 	 datareferencia 	 unidade não vazio nem nulo; 	 id numérico não vazio nem nulo 	 nome alfanumérico não vazio nem nulo 	 tipoprocesso não vazio nem nulo; 	 id numérico não vazio nem nulo 	 nome alfanumérico não vazio nem nulo 	 nivelacesso não vazio nem nulo; 	 idnivelacessotipoprocesso numérico não vazio nem nulo 	 descricao alfanumérico não vazio nem nulo 	 hipoteselegal não vazio nem nulo, se o nível de acesso for diferente de público 	 id numérico não vazio nem nulo 	 nome alfanumérico não vazio nem nulo 	assunto não vazio nem nulo; 	 id numérico não vazio nem nulo 	 assunto alfanumérico não vazio nem nulo 	interessados pode ser vazio e nulo; 	 pessoa não vazio nem nulo; 	 id numérico não vazio nem nulo 	 nome alfanumérico não vazio nem nulo lista de processo listagem de processos a serem usados por um documento method get /cit ecm web/integracao/listprocesso request { 	"nup" "00010 000012/2016 94", 	"token" "tgt 17 bi06ojwapcune4uamf6zudocyf0gnppxjrosdj66zxtcthzghf citdfsrv074" 	} response { 	"processo" \[ 	{ 	"id" "5252", 	"assuntocomplementar" "complementary subject", 	"nup" "00010 000012/2016 94", 	"status" "complementary subject", 	"tipoprocesso" { 	"id" 97930, 	"nome" "type reserved process" 	}, 	"nivelacesso" { 	"descricao" "público" 	}, 	"assunto" { 	"id" 97839, 	"nome" "adm", 	"assunto" "0001 adm" 	}, 	"hipoteselegal" { 	"id" 97841, 	"nome" "information name hypothesis" 	} 	} 	] 	} fields solicitação nup alfanumérico podendo ser vazio ou nulo; 	 token alfanumérico podendo ser vazio ou nulo 	resposta 	 id numérico não vazio nem nulo 	 assuntocomplementar alfanumérico podendo ser vazio ou nulo 	 status alfanumérico podendo ser vazio ou nulo concluido "concluído"; 	 em andamento "em andamento"; 	 aguardando validacao "aguardando validação " 	 validado "válido"; 	 anexado "anexado"; 	 tipoprocesso não vazio nem nulo; 	 id numérico não vazio nem nulo 	 nome alfanumérico podendo ser vazio ou nulo 	 nivelacesso não vazio nem nulo 	 idnivelacessotipoprocesso numérico não vazio nem nulo 	 descricao alfanumérico podendo ser vazio ou nulo 	 hipoteselegal não vazio nem nulo, se o nível de acesso for diferente de público 	 id numérico não vazio nem nulo 	 nome alfanumérico podendo ser vazio ou nulo 	 assunto não vazio nem nulo; 	 id numérico não vazio nem nulo 	 assunto alfanumérico podendo ser vazio ou nulo 	 hipoteselegal não vazio nem nulo, se o nível de acesso for diferente de público 	 id numérico não vazio nem nulo 	 name alfanumérico podendo ser vazio ou nulo