API

<back to all web services

i2cBolsaFamilia

Bolsa Familia [Offline]

The following routes are available for this service:
All Verbs/i2c/BolsaFamilia
Parameters:
NameParameterData TypeRequiredDescription
CPFpathNumberYesNumero do CPF

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

HTTP + XML

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

POST /xml/reply/i2cBolsaFamilia HTTP/1.1 
Host: api.xdata.com.br 
Content-Type: application/xml
Content-Length: length

<i2cBolsaFamilia xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.xpi.net/types">
  <CPF>String</CPF>
</i2cBolsaFamilia>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<i2cBolsaFamiliaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.xpi.net/types">
  <Response>
    <Error>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
        </ResponseError>
      </Errors>
    </Error>
    <Input>
      <InputItem>
        <Key>String</Key>
        <Value>String</Value>
      </InputItem>
    </Input>
    <Output>
      <i2cBolsaFamiliaDtoItem>
        <CPF>String</CPF>
        <MesReferencia>String</MesReferencia>
        <MesCompetencia>String</MesCompetencia>
        <CodigoMunicipioSIAFI>String</CodigoMunicipioSIAFI>
        <UF>String</UF>
        <NomeMunicipio>String</NomeMunicipio>
        <NISFavorecido>String</NISFavorecido>
        <NomeFavorecido>String</NomeFavorecido>
        <ValorParcela>String</ValorParcela>
      </i2cBolsaFamiliaDtoItem>
    </Output>
    <Status>
      <Protocol>00000000-0000-0000-0000-000000000000</Protocol>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <Code>0</Code>
      <Message>String</Message>
      <Detail>String</Detail>
      <Mode>String</Mode>
      <Type>String</Type>
      <Source>String</Source>
      <HTML>String</HTML>
      <Cookie>String</Cookie>
      <URL>String</URL>
    </Status>
  </Response>
</i2cBolsaFamiliaResponse>